Comment appliquer de la coloration syntaxique aux zones de code des fiches ?

Certaines fichothèques ont vocation à documenter du code informatique (comme celle utilisée pour ce site). La coloration syntaxique du code permet de le rendre beaucoup plus lisible. Celle-ci n’est cependant pas activée par défaut.

Pour l’activer, il faut ajouter dans les attributs de la fichothèque (Commande CNF-02 Modification des attributs de la fichothèque) l’attribut bdfuser:includescripts=codemirror. La présence de cet attribut va ajouter les appels à la bibliothèque CodeMirror (version 5) dans le gabarit HTML par défaut.

Ensuite, il faut ensuite indiquer pour chaque zone de code quel est le langage informatique utilisé : le script recherche pour ça l’existence d’un attribut data-type. La syntaxe pour ajouter un tel attribut est la suivante :

[(-type=xml)]
+++
<root>
...
</root>
+++

Rappel : -type= est un raccourci pour data-type=

La bibliothèque CodeMirror inclut automatiquement les modes clike, css, htmlmixed, javascript, properties et xml. Elle inclut également des colorations syntaxiques propres à la fichothèque (case attributes, ficheblock, subsettree, tableexport, uicomponents).

La valeur [(-type=)] doit être un des modes indiqués au paragraphe précédent ou un type MIME reconnu par un de ces modes (par exemple, application/typescript qui sera traité par le mode javascript).

Les valeurs ci-dessous sont également acceptées comme alias :

• html pour htmlmixed

• ini pour properties

• java pour text/x-java

• js pour javascript

Petite précision : lors de l’affichage de la section en prévisualisation, la coloration syntaxique est automatiquement appliquée que l’attribut bdfuser:includescripts soit défini ou non ; en outre, l’utilisation de la bibliothèque CodeMirror a pour conséquence de faire disparaitre les références aux numéros de ligne.