AS201281 Wiki

Your check engine light is on!

User Tools

Site Tools


wiki:categories_pages_guide

Guide de création des catégories et pages

Afin de garder un wiki le plus propre possible il est demandé de respecter quelques conventions lors de la création de catégories et de pages. Ces conventions ont été posées plus ou moins arbitrairement mais elles permettent de garder une structure uniforme et donc de se retrouver très rapidement dans le wiki. Merci donc de suivre ces conventions pour éviter de devoir retravailler une partie du wiki.

Création d'une catégorie

Si vous estimez que lorsque vous créez une page celle-ci ne rentre dans aucune des catégories déjà présentes il est fortement recommandé d'en créer une nouvelle. Les catégories de plus au niveau sont directement visibles depuis la page principale du wiki (par exemple la catégorie Programmation). Celles-ci contiennent généralement des sous-catégories (par exemple Programmation contient la sous-catégorie Java).

La création d'une catégorie se fait à l'aide du caractère séparateur “:”. Il est possible également d'utiliser des chemins relatifs un peu comme dans un système de fichiers avec le caractère “.” et la répétition de ce dernier “..”. De plus pour des questions historiques, les catégories et pages sont écrites en anglais merci donc de continuer dans cette lignée. Chaque catégorie et sous-catégorie (etc…) doit comporter une page nommée “main”. Cette page contiendra un bref résumé de la catégorie et des liens vers toutes les pages de cette dernière.

Ainsi, pour créer une catégorie de plus au niveau, sur la page principale du wiki on créera un lien avec une syntaxe de ce genre :

[[ma_catégorie_en_anglais:main|Ma catégorie]]

Ce code générera un lien vers la page principale d'une nouvelle catégorie qui sera créée automatiquement lors de l'édition de la page “main”.

Pour créer une sous-catégorie, on se rendra alors sur la page “main” de la catégorie précédemment créée pour l'éditer puis on fera un lien de ce type :

[[.:ma_sous_catégorie_en_anglais:main|Ma sous-catégorie]]

Il est important de noter le “.:” de début ainsi que toujours la page “main”.

Toutes ces petites conventions sont à appliquer quelque soit le niveau de la catégorie.

Création d'une page

La création d'une page se fait sans trop de contraintes. Il suffit simplement que cette page soit référencée dans une des pages “main” d'une catégorie ou sous-catégorie. Il est bien que cette page comporte un titre ainsi qu'éventuellement une brève introduction donnant au lecteur une idée de quoi elle parle. Comme les catégories, le nom de la page dans le lien doit être en anglais pour les mêmes raisons. Pour référencer une page dans une catégorie on utilise la même syntaxe que celle vue précédemment.

[[.:ma_catégorie:ma_sous_catégorie:ma_page|Ma page]].

La ponctuation, l'aération du texte, la concision ainsi que illustrations par images, codes, lignes de commandes sont grandement appréciées surtout si la page donne un tutoriel.

Autres documentations

wiki/categories_pages_guide.txt · Last modified: 2021/01/04 21:41 (external edit)