Docs Jmini » FSHL http://docs.jmini.fr docs.jmini.fr Thu, 18 Feb 2010 09:47:54 +0000 http://wordpress.org/?v=2.9.2 en hourly 1 Comment utiliser FSHL ? http://docs.jmini.fr/code/utiliser-fshl http://docs.jmini.fr/code/utiliser-fshl#comments Thu, 09 Oct 2008 22:56:02 +0000 Jérémie Bresson http://docs.jmini.fr/?p=46 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 dans 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.

]]> http://docs.jmini.fr/code/utiliser-fshl/feed 0 Coloration syntaxique – Méthodes http://docs.jmini.fr/notes/coloration-syntaxique http://docs.jmini.fr/notes/coloration-syntaxique#comments Thu, 09 Oct 2008 21:55:36 +0000 Jérémie Bresson http://docs.jmini.fr/?p=39 Lire du code source n’est jamais très facile. Lorsque l’on souhaite en publier sur son site web, il est important de le mettre joliment en forme, pour faciliter sa lecture. L’utilisation de la balise <pre> (pour respecter les esapces, tabulations et sauts de ligne), le changement de police et la coloration du texte sont des incontournables.
Retrouver les fichiers de test utilisés en pièce-jointe de cet article.
Il existe plusieurs solutions pour colorer du code source. Chacune à ses avantages et ses inconvénients. Cet article recense différente méthodes :

Avec un éditeur de texte :

TextMate :

De nombreux éditeurs de texte réalisent la coloration du code en cours de saisie. Certain d’entre eux (dont le mien TextMate) propose d’exporter le texte saisi au format HTML pour le réafficher dans un navigateur web comme il apparaît dans l’éditeur.

Dans TextMate il faut sélectionner le menu action dans la barre sous la fenêtre de l’éditeur, puis choisir TextMate et l’option « Create HTML From Document » (ou « Create HTML From Selection »). L’option « Create CSS from Current Theme » permet de récupérer la feuille de style associé.

Coloration syntaxique du PHP dans TextMate

avec TextMate

Avec des scripts en PHP :

(exécution côté serveur)

fshl :

Script qui colore rapidement et correctement les une dizaine de langage courants. Gère très bien le mélange de langages (CSS, JS, PHP) dans l’HTML.
Page du projet.
Test en ligne
Comment utiliser FSHL ? sur ce site.

Coloration dans FSHL

avec FSHL

GeSHi – Generic Syntax Highlighter :

Projet assez ancien qui supporte de très nombreux langages de programmation (une centaine). Il a la réputation d’être une usine à gaz.
Page du projet
Test en ligne
Implémentation dans un plugin wordpress : WP-Syntax

Coloration dans GeSHi

avec GeSHi

PHPaintCode par derfum :

(anciennement Coloration Syntaxique)
Limité à la coloration du PHP. Support en Français.
Page du projet

Coloration dans PHPaintCode

avec PHPaintCode

Fonction PHP :

Il existe une fonction PHP qui colorie le code PHP d’un document. Il n’y a pas de feuille de style, on ne peux donc pas choisir les couleurs.

avec la fonction highlight-file()

avec highlight-file()

Par des scripts en javascript :

(exécution côté client)

syntaxhighlighter

Page du projet
Implémentation dans un plugin wordpress : Google Syntax Highlighter for WordPress

Coloration avec syntaxhighlighter

avec syntaxhighlighter

A lire sur le web :

]]> http://docs.jmini.fr/notes/coloration-syntaxique/feed 0