Wiki - Comment fonctionne la syntaxe wiki ?

Le wiki est orienté "sémantique", c'est à dire qu'on indique ce qu'est le texte (à quoi il correspond) et ainsi sa présentation est standardisé pour tout le monde (sur tout le site).

Lors de l'édition d'un champs wiki, la barre d'outil propose une icône "bouée" rubberRing , qui vous permet d'ouvrir une aide en ligne et vous rappelle la syntaxe complète et toutes les possibilités offertes par les champs wiki.
Ouvrez rubberRing l'aide wiki pour voir la syntaxe au fil des explications suivantes.

capture de l'aide en ligne wiki

Pour rédiger un article avec des sections et sous-sections, on décrit la structure via des titres de différent niveaux.

Pour mettre en forme le texte on utilisera les outils suivant :

  • Gras pour mettre en avant
  • Italique pour pour différencier
  • Chasse Fixe pour un exemple ou terme technique succinct
  • Gras Italique et Chasse Fixe grasse pour quelques cas particuliers

Vous disposez aussi d'une syntaxe pour réaliser des listes à puce ou numérotées et à plusieurs niveaux.

L'outil d'insertion d'image utilise la syntaxe la plus simple, indiquant directement l'adresse de l'image, mais vous pouvez modifier pour préciser des restrictions sur la taille de l'image à afficher. Une miniature de l'image sera automatiquement générée pour l'affichage.

La balise media vous permet d'incorporer automatiquement un lecteur adapté pour visionner/écouter directement le média depuis la page wiki.

La syntaxe des liens est assez polyvalente, par id ou par nom, ou par id avec un autre texte affiché. Les liens externes sont reconnus automatiquement mais la syntaxe permet de définir un texte de remplacement.

D'autres éléments plus complexes sont disponibles :

  • Tableaux (Les espaces dans chaque cellules détermine l'alignement du texte)
  • Citation (balise quote)
  • Code brut / bloc technique (balise verbatim)
  • Boites de messages d'information, d'avertissement ou d'erreur (respectivement les balises info, disclaimer et error)
  • Notes de marge, pour ajouter un commentaire local, une précision sur une ligne (balise note)

Viens ensuite la liste des snippets, qui sont des balises qui commencent par un '@' et qui permettent de faire appel à des fonctions avancées. Certain modules ajoutent leur propres snippets pour enrichir les capacités des wiki.

Enfin les éléments qui terminent la page d'aide sont ajoutés par des modules.

Les plus courant sont ceux ajouté par le module wiki et qui servent à définir le résumé et à insérer le sommaire des pages Wiki. On pourra aussi retrouver la balise code fournie par le module de coloration syntaxique, et les émoticônes du module émoticônes.