Pour l'utiliser, il faut déjà activer le module et ajouter le filtre dans l'administration Drupal. Ensuite il y a deux modes d'utilisation : code et traces.
Mode \"code\"
Il s'agit du mode classique de colorisation de code. On l'obtient en encadrant le fragment par une balise <code type="un langage" caption="un titre">. L'attribut caption est optionnel et permet d'ajouter un titre au fragment de code. L'attribut type reçoit le langage à utiliser pour le fragment. Il s'agit de n'importe quel langage reconnu par GeSHI, autant dire que la liste est longue. Le résultat, pour du PHP est le suivant :
* Prepare the texte for being displayed :
* - remove extra left margin
* - replace special characters
*
*/
function _code_highlighter_prepare_text($text) {
// Calculating minimum left margin
$test=str_replace("\t", str_repeat(" ",code_highlighter_tabulation_size()),$test);
$lines= explode("\n", $text);
$ident= 255;
foreach ($lines as $line) {
$iPos= 0;
if (strlen(trim($line)) != 0) {
while ((($char= substr($line, $iPos, 1)) == " ") && ($iPos < strlen($line))) {
$iPos++;
}
if ($iPos < $ident) {
$ident= $iPos;
}
}
}
}
La même chose avec des numéros de ligne :
- # vérifie que la machine cible est allumée et initialize la sauvegarde
- sub check_host {
- # analyse des arguments
- %host = (
- fs => "ssh",
- method => "rdiff",
- root => "",
- @_
- );
- $host{address}=$host{name};
- }
- $host{path}="$storage_path/$host{name}";
- mkpath ($host{path});
- # on vérifie que le host est bien UP
- my $ping = Net::Ping->new("icmp");
- my $is_up = $ping->ping($host{address});
- $ping->close();
- if (!$is_up) {
- # le host est down, rien à faire de plus
- trace_debug("'$host{name}' is down, leaving.");
- }
- }
Je n'avais pas pensé à l'origine que ce code puisse intéresser certains. Il est donc tout vilain à l'intérieur 
Dés que j'aurais le temps, j'y mettrais un grand coup de propre.
Mode \"traces\"
Ce mode là n'est pas présent dans les autre système de colorisation. Il s'agit de mettre en valeur une série d'opérations en ligne de commande et les résultats associés. Cela peut être des traces de Bash, Groovy, etc...
On obtient se mode en encadrant le fragment par une balise <traces type="un langage" caption="un titre">. L'attribut caption est optionnel et permet d'ajouter un titre au fragment de code. L'attribut type reçoit le langage à utiliser pour le fragment. Il s'agit là ausi de n'importe quel langage reconnu par GeSHI.
Jusque là c'est très proche de code. La différence se situe au niveau du traitement effectué sur le fragment. Le système l'interprète ligne à ligne. Lorsqu'un motif $$ est détecté sur une ligne, elle est coupée en deux fragments, le premier est considéré comme étant une invite (prompt), le second une commande du langage spécifiée dans l'attribut type et sera donc colorisée par GeSHI. Si la ligne ne contient aucun motif $$, elle est considérée comme étant le résultat d'une commande précédente. A noter que les commentaires à la mode du langage cible sont utilisables en posant un motif $$ juste avant, en tout début de ligne (invite vide). Ce qui nous donne :
- gaston$$$ ls -la : une invite (gaston$) et une commande (ls -la)
- root#$$ useradd gaston : une invite (root#) et une commande (useradd)
- $$# un commentaire
- Un résultat....
L'avantage de l'approche $$ plutôt que de chercher à interpréter ce qu'est une invite sur une ligne est qu'il est possible de mixer un peu les langages. Par exemple lorsque qu'une commande Bash donne lieu à un sous-interpréteur, par exemple ftp :
Ou encore
Bascule texte simple / texte colorisé
Un peu de Javascript/JQuery permet lorsque l'utilisateur survole la zone avec sa souris, d'afficher un petit bouton en bas à droite permettant de basculer alternativement de texte non colorisé à texte colorisé. Ceci lui permet de faire des copier/coller sans problèmes.
]]>