====== Indications à l'usage des rédacteurs ======



===== Création de page =====

**Ne pas créer une page en faisant un nouveau lien dans une page existante** mais en passant par la barre d'URL du navigateur (vous aurez tout le temps de faire le lien plus tard).

Les noms de page doivent être **en Anglais** et assez court (3 termes au maximum, séparés par "-").

Assurez vous de placer la page dans un namespace adéquat et vérifiez toujours que vous n'allez pas créer une page dans un namespace inexistant.

===== Titres =====

Faites un usage raisonné des titres dans une page. Toujours commencer par un titre de premier niveau.

Evitez les titres trop longs.

Si une page devient trop hiérarchisée, le découpage du sujet en plusieurs pages est à envisager.


===== Rédaction =====

  * on rédige sobrement, 
  * on renvoie si besoin sur une entrée de [[glossary]] (qu'on complète immédiatement), 
  * on pose des liens vers les autres parties de la doc quand c'est utile
  * si on se dit que tel point risque d'amener des questions, on ajoute le binz dans la FAQ de la section

===== Syntaxe Wiki =====

La syntaxe Wiki est [[wiki:syntax|assez simple]] et vous disposez d'une barre d'outils dans le bloc d'édition du texte pour vous aider.

===== Liens internes =====

**Ne jamais faire de lien interne copiant/collant l'URL de celle-ci.**

Utilisez au maximum les URLs relatives à la page en cours. Par exemple, préférer **.:plugins** à **:2.0:contribute:plugins**. 

==== Notes ====
 
Pour créer une note, il suffit de faire comme ceci pour une note simple :

<code>
<note>
le texte de la note
</note>
</code>

Vous pouvez également ajouter les mots "tip", "important", "warning" ou "related" à la note pour identifier respectivement une astuce, une remarque importante, un avertissement ou des liens connexes. Par exemple :

<note>
Pour une note normale

<nowiki><note></note></nowiki>
</note>

<note important>
Pour une note importante

<nowiki><note important></note></nowiki>
</note>

<note warning>
Pour une note "attention, danger"

<nowiki><note warning></note></nowiki>
</note>

<note tip>
Pour une note d'astuce

<nowiki><note tip></note></nowiki>
</note>

<note related>
Pour une note de liens connexes

  * <nowiki><note related>  * Le lien</note></nowiki>
</note>
===== Sommaire automatique =====

Le plugin **pagetoc** permet de réaliser le lien vers une page donnée du wiki et d'éventuellement y ajouter automatiquement le plan de celle-ci. Exemple :

<code>
{{{pagetoc
:2.0:usage:entries
}}}
</code>

Il est possible de mettre plusieurs noms de pages dans une entrée **pagetoc**, comme ceci :

<code>
{{{pagetoc
:2.0:usage:entries
:2.0:usage:tags
}}}
</code>

Deux modificateurs permettent de contrôler le résultat, ils se placent après le nom de page. Le premier modificateur est un titre alternatif de la page et le second permet de ne pas afficher le plan (|x dans l'exemple). Par exemple :

<code>
{{{pagetoc
:2.0:usage:entries|Super documentation|x
}}}
</code>