Conseils de rédaction

Il est recommandé de consulter la source Wiki de ce document pour voir les exemples proposés. Si vous préférez la syntaxe MediaWiki ou d'autres Wiki, il est également possible de travailler avec certaines -- même si non recommandé.

Liens internes

Un lien interne est une référence à un autre document du Wiki. La forme la plus simple est de taper le nom du document sous forme de WikiName. Il est également possible de TaperSimplementUnePhraseEntreCrochets, ce qui référence automatiquement un WikiName (attention par défaut à éviter les caractères accentués). Une dernière forme est la forme libre: un texte libre référence un document -- consultez la forme brute de ce document pour bien comprendre!

C'est à vous de choisir la forme la plus naturelle et la légèreté qui vous convient.

NB: pour la publication -- contrairement au Wiki -- la dernière forme (libre) sera en général préférée, ce qui cache le nommage interne du Wiki.

Evitez cependant des documents quasiment vide avec des PDF (ou pire, documents Microsoft Word) attachés. Pour que l'esprit du Wiki (modifiable collaborativement) survive, il faut écrire le contenu en mode Wiki!

Liens externes

En règle générale, il est mieux de procéder comme dans la section précédente, sous "forme libre" (soit p.ex. ceci est un lien). On peut tolérer des exceptions si les liens sont regroupés dans une section Références.

Structure d'un document recommandée

Hiérarchie

• titre de premier niveau (trois tirets, +!! Ce document) -- en mode "caché"
• un TOC (table of content, table des matières)
• ensuite les diverses sections en 2e niveau (trois tirets, ++)
• si nécessaire hiérarchiser encore plus
• une section de références (trois tirets, ++ Références) peut référencer d'autres documents internes ou externes
• le document finira par une section administrative (trois tirets, ++!! Administratif) en mode caché qui peut contenir le ou les auteurs, des commentaires (TODO p.ex.) ainsi que les droits d'accès éventuels.

(voir WebTopicEditTemplate)

Publication

Quelques conseils de publication:

• cacher les auteurs, la section administrative (p.ex. droits d'accès) derrière un couple de tags %STOPPUBLISH% ... %STARTPUBLISH%. S'assurer que les sections invisibles le sont bien dans la TOC (trois tirets, ++!!)
• éviter de référencer des documents internes
• donner un titre aux documents (à préciser!)

-- MarcSCHAEFER - 09 May 2009