Toute contribution à la documentation de Swisslinux.org est la bienvenue. Néanmoins, dans l'intérêt de nos visiteurs, nous avons fixé une série de règles à adopter afin d'harmoniser les différentes pages du wiki. Nous vous conseillons de copier le code de notre page modèle et de l'adapter en fonction de vos besoins. Consultez également les pages déjà existantes pour vous faire une idée de la façon de rédiger et de mettre en forme vos textes.

Les coordinateurs se chargent d'éventuellement déplacer, modifier ou scinder les pages afin d'organiser le mieux possible l'information. Vous pouvez également les joindre par email ou messagerie instantanée si vous avez des questions précises concernant la rédaction d'article. Référez-vous à la page des projets pour connaître les personnes responsables de la documentation.

Le moteur utilisé est DokuWiki. Veuillez tout d'abord vous familiariser avec la syntaxe, si vous ne la connaissez pas. (Vous verrez, elle est très simple.) Il y a des règles générales à respecter ainsi que quelques-unes concernant l'organisation du wiki et la syntaxe.

1. Exprimez-vous dans un français correct (orthographe et grammaire) et vousoyez votre lectorat. Evitez les tournures orales.
2. N'utilisez pas des abréviations comme “infos”, “conf”, etc. ni des anglicismes tels que “l'user”, “le package”, “plugin”, etc. N'utilisez pas non plus le pronom indéfini “on”.
3. Evitez de surcharger votre documentation avec des phrases d'humour et des émoticônes (“smileys”). Banissez les phrases au second degré : tout le monde ne comprendra pas forcément votre humour.
4. Limitez vous à l'essentiel et n'hésitez pas à renvoyer votre lecteur vers d'autres pages de documentation lorsque les informations qu'elles contiennent ne sont pas essentielles pour votre page. Elle restera courte et le lecteur aura une meilleure vue d'ensemble. Il pourra chercher de lui-même des informations plus précises s'il en a besoin en suivant les pistes que vous lui aurez données, grâce, par exemple, à un renvoi vers wikipédia à l'aide de liens “interwiki” :

   [[wpfr>article|Titre de l'article]]  // Pour Wikipédia (en français)

5. Expliquez à l'utilisateur l'effet de chaque commande, et ne rédigez pas des articles qui se résument à une succession de commandes à copier “bêtement”.
6. Vous pouvez agrémenter votre article avec des images (logos de distribution ou de programmes) ainsi que des captures d'écran, mais gardez à l'esprit que celles-ci doivent illustrer votre propos et non le remplacer. Les captures d'écran doivent être commentées dans votre texte. Préférez des captures de fenêtres plutôt que des captures d'écran complètes qui noient l'information.

1. Placez votre page dans la catégorie la plus appropriée. Consultez l'index de la documentation.
2. Au sommet de chaque page se trouve un en-tête contenant les informations suivantes : sujet, distribution, niveau, auteur. (hormis pour la documentation “générale”)

   >**Sujet** : sujet de l'article
   >**Distribution** : pour quelle distribution (version) a été rédigée la documentation 
   >**Niveau** : Débutant, Facile, Intermédiaire, Difficile, Expert
   >**Auteur** : [[utilisateurs:pseudonyme]] 

3. Lorsque vous êtes en train de rédiger un article, veuillez insérer le code suivant au sommet de la page afin de faire apparaître le panneau “En travaux!”

   {{:wiki:travaux.png|:wiki:travaux.png}} 

   que vous enlèverez une fois l'article relu et approuvé par le groupe de projet “Wiki”.

4. Vous êtes également priés de placer sur une page en travaux après chaque titre de niveau 2 une des icônes suivantes afin d'informer vos (re)lecteurs sur le statut du paragraphe qu'il est en train de lire :
   Not OK! si vous planifier de rédiger quelque chose à cet endroit, mais que cela n'a pas encore été fait.

    {{:wiki:nok.png |:wiki:nok.png}}

   En cours! si le paragraphe est en cours de rédaction ou en attente de relecture/correction.

    {{:wiki:encours.png |:wiki:encours.png}} 

   OK! si le paragraphe a été relu (éventuellement corrigé) et approuvé.

   {{:wiki:ok.png |:wiki:ok.png}}

   Les icônes seront retirées en même temps que le panneau “En travaux” par les responsables du wiki.

5. Afin de mettre en évidence certaines parties de votre article, vous disposez de différents types de notes.

   <note></note>

   vous permet de faire une remarque à vos lecteurs.

   <note important></note>

   vous permet de signaler quelque chose d'important à vos lecteurs.

   <note tuyau></note>

   vous permet de donner une astuce à vos lecteurs.

   <note bloquante></note>

   vous permet d'arrêter vos lecteurs et de les faire réfléchir.

6. A la fin de l'article, prévoyez une section “Liens” afin de citer vos sources et/ou de renvoyer éventuellement votre lecteur vers de la documentation plus élaborée et plus complète.
7. Utilisez parcimonieusement les notes de bas de page, surtout si vous rédigez de longues sections.
8. Pour activer une discussion dans votre article ou réafficher une discussion archivée, utilisez le code suivant :

   ~~DISCUSSION~~

   Pour cacher (archiver) la discussion :

   ~~DISCUSSION:off~~

   Pour afficher une discussion, mais sans la possibilité d'y ajouter de nouvelles contributions :

   ~~DISCUSSION:closed~~

Lors de la rédaction de vos pages, veuillez observez les règles typographiques suivantes :

1. Les balises

   <code></code>

   sont à utiliser pour toutes les commandes à entrer dans un terminal. Les commandes qui ne requiert pas les droits superutilisateur (root) sont précédées d'un signe dollar ($), alors celles qui les nécessitent sont précédées d'un dièse (#).
   Exemple :

   $ su - 
   # apt-get update

2. Les balises

   <file></file>

   sont à utiliser pour donner le contenu d'un fichier ou des lignes à ajouter à un fichier.
   Exemple :

   Option "XkbVariant" "fr"

3. Utilisez '' '' pour introduire des noms de fichiers ou de paquets ou des commandes dans du texte.
   Exemple : “Pour consultez le manuel, utilisez la commande man ”.
4. Lorsque vous introduisez une image, pensez à rajouter systématiquement une description pour ceux qui consulteraient la documentation avec un navigateur qui n'affiche pas les images.

   {{http://www.swisslinux.org/logo.png|Logo}}

5. Veuillez redimensionner (et centrer) vos captures d'écran, car certains de vos lecteurs peuvent avoir une petite résolution d'écran

   {{ http://www.swisslinux.org/logo.png?100X100 |Logo}}

   (valeur conseillée : 640×480) Il est aussi possible de mettre plusieurs captures sur la même ligne (sans les centrer).

   {{http://www.swisslinux.org/logo.png |Logo}}{{http://www.swisslinux.org/logo.png |Logo}}

Le wiki est un outil de collaboration. N'hésitez pas à y participer mais veuillez respecter les règles suivantes afin d'assurer une bonne coordination entre les différents contributeurs.

1. Ne supprimez jamais du texte que vous n'avez pas rédigé vous-même. Utilisez les balises

   <del></del>

   et attendez que l'auteur original ou un membre du groupe de projet “Wiki” supprime ledit texte. La correction de la grammaire et des fautes d'orthographe n'est pas soumise à cette règle.

2. N'effacez jamais de la documentation obsolète, contentez-vous de signaler au lecteur que l'article n'est plus d'actualité et renvoyez-le à la documentation actualisée.
3. Lorsque vous complétez un article, ajoutez votre nom à la liste des rédacteurs et précisez ce que vous avez ajouté afin qu'il soit possible de vous contacter.
4. Evitez de surcharger une page de commentaires. Mettez-les en italique et faites-les brefs. Isolez-les du reste du texte.

1. Le wiki de Swisslinux.org est multilingue. La navigation entre les pages de différentes langues sur le même sujet s'effectue à l'aide de la barre de langue.

   <note langues>
   Autres langues | Andere Sprachen | Altre lingue :
   
   {{wiki:fr.png}}[[fr:documentation:sujet|Français]] | {{wiki:de.png}}[[de:dokumentation:sujet|Deutsch]] | {{wiki:it.png}}[[it:documentazione:sujet|Italiano]]
   </note>

   N'oubliez pas de modifier les liens de la barre de langue selon vos besoins (“sujet”).

2. A la création d'une nouvelle page, vous êtes priés d'insérer la barre de langue et d'ajouter la note suivante, invitant les utilisateurs à traduire votre article.

   <note>
   Cette page n'est actuellement disponible qu'en (français, allemand, italien).
   
   **Vous pouvez aider à la traduction!**
   ----
   Diese Seit ist zur Zeit nur auf (Französisch, Deutsch, Italienisch) verfügbar.
   
   **Sie können mit der Übersetzung helfen!**
   ----
   Questa pagina è disponibile soltanto in (francese, tedesco, italiano) per il momento.
   
   **Potete aiutare con la traduzione.**
   
   </note>
   

3. Tant que la page n'a pas été traduite, les liens sur les autres pages du wiki (table des matières, etc.) redirigent vers la page dans la langue originale. Ces liens sont précédés par un drapeau adéquat :

{{wiki:fr.png}}
{{wiki:de.png}}
{{wiki:it.png}}