code

Structure du code

La structuration d'une aide en ligne correspond à la structure attendue par Gitbook.

Voir la doc officielle Gitbook.

Multilinguisme

TO DOC

Contenu

La syntaxe utilisée est le markdown, à l'instar de l'ensemble des produits Isogeo. La rédaction doit respecter au mieux les règles de la syntaxe (voir https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md.)

Images

Les images sont stockées :

• le dossier assets à la racine du dépôt si elles ne sont pas liées à une langue
• le dossier {lang}/assets si elles sont liées à une langue (par exemple avec un texte inclus dans une capture). Exemple : fr/assets.

Chaque image a un texte de remplacement qui sert aussi de légende.

Plugins

Certains plugins Gitbook sont systématiquement utilisés dans les documentations Isogeo. Ils sont listés dans les fichiers package.json de chaque dépôt. Voici un bref descriptif :

Plugin	Description
ga	Suivi Google Analytics
html-minifier	Compacte les fichiers HTML / JS / CSS produits par Gitbook. pour réduire leur poids. Attention à bien configurer pour éviter les conflits.
image-captions	Ajoute des légende sous les images et génère une table des images
page-toc	Table des matières en haut de chaque page
sitemap-general	Sitemap pour le référencement (SEO)
timeline	Frise verticale (pour les notes de version)
toggle-headers	Replie automatiquement les sections
youtube	Insère proprement des vidéos Youtube

Les plugins sont configurés via le fichier book.json.