Le Wiki est le concept présenté par cette documentation. Il se présente sous la forme d'une hiérarchie de contenus. Contrairement à du contenu enregistré dans le formalisme d'un texte riche, le Wiki est saisi en tant que texte brut et sa mise en forme est générée à partir d'une syntaxe définie.

Organisation du Wiki

Chaque article du Wiki est enregistré dans une arborescence de sections Wiki. La racine de cet arbre est un conteneur nommé ensemble de sections Wiki. Ce conteneur doit être placé dans un espace de publication. Dans l'exemple de hiérarchie Nuxeo suivant, l'élément "Documentation technique" est un ensemble de sections Wiki et l'élément "Exploitation" est une section Wiki :

L'intérêt de ce Wiki par rapport à une documentation statique est, outre son aspect collaboratif, l'ajout de liens vers d'autres contenus.

Logique de publication

La saisie ainsi que la présentation du Wiki suit une logique de publication. La syntaxe est volontairement minimaliste et il y a peu de différents types de contenus acceptés.

Texte

Le texte est structuré exclusivement sous forme de paragraphes. Pour créer un nouveau paragraphe, il faut laisser au minimum une ligne vide dans le texte brut source. Ainsi, un simple retour à la ligne ne créé pas de nouveau paragraphe et le retour de ligne n'est donc pas pris en compte dans le rendu. Il est possible d'appliquer les styles suivants au texte (voir la syntaxe) :

gras ;
italique ;
souligné.

Afin de structurer ce texte, il est possible de créer des titres (voir la syntaxe). Trois niveaux sont disponibles pour ces titres. Les titres peuvent disposer d'un identifiant, permettant la création de liens pointant vers ces derniers. Il est également possible de créer des listes, numérotées ou non (voir la syntaxe). Ces listes ne peuvent avoir qu'un seul niveau hiérarchique.

Liens et URL Web

Afin de faciliter la navigation au sein de la documentation, un Wiki se doit de présenter un grand nombre de liens. Trois types de liens sont proposés (voir la syntaxe) :

Des liens externes, dont le contenu est accessible à partir d'une adresse Internet ;
Des liens internes vers du contenu de la section courante ;
Des liens internes vers d'autres sections, identifiées à partir de leur URL Web.

Une section peut être identifiée à partir de son identifiant technique ou de son chemin de publication. Puisque les identifiants techniques ainsi que les chemins de publication peuvent être modifiés (suite à un export/import, ou à la restructuration de l'arborescence), la notion de URL Web a été ajoutée au Wiki. Ces URL Web permettent d'identifier de manière permanente un contenu du Wiki et sont donc utilisées pour la contextualisation des liens internes.

Images

Les images affichées dans le contenu peuvent provenir soit des images enregistrées dans l'objet Nuxeo section Wiki, soit de sources externes. La sélection d'une image depuis Nuxeo se fait à partir de son indice, accessible depuis le lien d'accès à l'image (voir la syntaxe).

Notes

Le Wiki accepte trois types de notes correspondant aux niveaux d'informations suivants (voir la syntaxe) :

Information ;
Avertissement ;
Interdiction.

Il est également possible de créer des notes non typées. Exemples : Ceci est une information. Ceci est un avertissement !

Tableaux

Il est intéressant de présenter certaines données sous la forme de tableaux, selon un style prédéfini (voir la syntaxe). La liste des styles disponibles est la suivante :

Par défaut : un tableau simple avec des bordures ;
Enumération : un tableau au style aéré, sans bordure.

Syntaxe

La plupart des Wiki (tels que Wikipedia) utilisent une syntaxe simplifiée nommée "Créole", qui exploite des mots-clé simples. Pour ce Wiki, la syntaxe retenue est celle du langage XML, plus structurée et qui offre plus de souplesse notamment concernant l'ajout d'attributs aux balises.

Style

La syntaxe des balises simples de style est la suivante :


    Texte en gras
    Texte italique
    Texte souligné

Liens

La syntaxe des liens est la suivante :


    Lien externe vers le site www.example.com
    Lien interne vers le titre d'identifiant "test" de la section courante
    Lien interne vers la section dont l'URL Web vaut "exemple"

L'attribut "href" est obligatoire.

Titres

La syntaxe des titres est la suivante :


    Titre de niveau 1
    Titre de niveau 2
    Titre de niveau 3

L'attribut "id" est facultatif.

Images

La syntaxe d'insertion d'images provenant respectivement d'une source externe ou de la section courante est la suivante :

L'attribut "src" est obligatoire. Le nombre "2" correspond à l'indice de l'image dans Nuxeo. La valeur de cet indice peut être identifiée depuis le lien présenté par Nuxeo :

Notes

La syntaxe des notes est la suivante :


    Information
    Avertissement
    Interdiction
    Note non typée

Tableaux

La syntaxe des tableaux est directement inspirée de la syntaxe simplifiée XHTML. Les balises reconnues sont les suivantes :

\ : déclaration du tableau ;

: nouvelle ligne ;

: cellule entête ;

: cellule. Exemple :

Listes

La syntaxe des listes est la suivante :


    
      Elément 1
      Elément 2
    
    
    
      Elément numéroté 1
      Elément numéroté 2