Publié par Jérémie Bresson dans les docs Jmini (http://docs.jmini.fr) à l’adresse (http://docs.jmini.fr/code/utiliser-fshl).

Dernière mise à jour : Vendredi 10 octobre 2008

Comment utiliser FSHL ?

Dans cet article j’ai comparé différentes méthodes pour colorer du code source. Voici le guide d’utilisation de FSHL. Librement adapté de How to use FSHL, cet article détail le code à utiliser pour utiliser et paramétrer FSHL.

Coloration Syntaxique du PHP dans FSHL

Si vous cherchez du code déjà prêt à l’emplois (copier-coler), regardez le sous-dossier « examples » de l’archive d’installation.

Voici un premier exemple pour monter l’utilisation de base de FSHL

1) Inclure la librairie dans le projet :

require_once(__CHEMIN_VERS_FSHL__ . '/fshl/fshl.php');

2) Préparer le texte à colorer :

$your_supa_dupa_text = "--\tinsert into\t`superb_table`\n";

$your_supa_dupa_text .= "\tINSERT INTO\t`superb_table`\tVALUES (1, 9, 0, 3, 0);\n";

$your_supa_dupa_text .= "\tINSERT INTO\t`superb_table`\tVALUES (8, 0, 0, 3, 0);\n";

Extrait du fichier fshl/examples/simple.php.

Il est également possible d’utiliser la fonction file_get_contents() pour récupérer le contenu d’un fichier.

3) Choisissez les options :

$output_module = 'HTML_UTF8';

$start_language = 'SQL';

$output_module est le module utilisé pour l’affichage. ‘HTML_UFT8′ désigne une sortie au format XHTML encodé en UFT8.
$start_language est le langage au début du code.

La liste des valeurs possibles se trouvent dans la documentation :

[fichier !INSTALL.txt] $output_module = {HTML, HTML_HP, HTML_UTF8, HTML_HP_UTF8, …}. …_HP ajoute les liens depuis les fonctions vers l’aide. …_UTF8 permet l’encodage au format UFT8.

[Supported languages] $start_language = {HTML, HTMLonly, CSS, PHP, JS, CPP, JAVA, SQL, PY, …}

4) Executer le code

Il faut instancier la classe fshlParser :

$parser = new fshlParser($output_module);

Il faut ensuite appeler la fonction qui colore le fichier.
Le resultat est retourné par la fonction highlightString().
On l’affiche dans la page HTML encadrée par une balise <pre>.

echo '<pre class="normal">';

echo $parser->highlightString($start_language, $your_supa_dupa_text);

echo '</pre>';

Où sont les couleurs ?

FSHL n’ajoute jamais la feuille de style à la sortie. Il se contente de d’ajouter des classes css au code, et il faut ajouter la feuille de style correspondante à la page qui affiche le code.
Une feuille de style de démonstration est est donné dans l’archive à télécharger : fshl/styles/COHEN_style.css
Il est possible de la placer n’importe où et de la modifier selon les besoins.

Voir aussi

Les mots-clés de cet article : FSHL, php

Cet article est dans la catégorie : Code

docs.jmini.fr

Les docs Jmini