Ceci est une ancienne révision du document !


Règles de rédaction

Vous souhaitez participer à la Bible de NPDS en partageant vos connaissances? C'est une merveilleuse idée ;-)

Cependant, dans le but de fournir une documentation homogène, il est important que vous lisiez (et respectiez) ces quelques consignes.

Bon amusement! :-D

Nom et titre des pages

Le nom des pages doit n’être long que d'un seul mot, sauf si c'est réellement insuffisant.
Ce mot doit être au singulier.

Chaque page doit commencer par un titre (balise H1, ======). Ce titre doit être explicite. Evitez d'utiliser des déterminants ou le nom de la catégorie dans laquelle la page se trouve.

Rédaction

Dans le but de rédiger une Bible valable, il faut que nous gardions une certaine homogénéité dans la rédaction. Inspirez-vous des pages déjà présentes.

  • N'hésitez pas à lire le guide de la syntaxe wiki
  • Un tableau est souvent plus judicieux qu'une liste. Exemple
  • Il faut structurer ses pensées. Certaines choses doivent êtres dites avant les autres et mises dans des sous-titres cohérents. Exemple
  • Quand on parle d'un fichier, on met toujours un / devant pour signaler qu'il est à la base de npds. Exemple
  • A complèter

L'orthographe et la syntaxe sont des qualités appréciées.

Catégories

Sauf cas rares, toutes les pages sont mises dans des catégories (le coin des codeurs, configuration, forums, …)

Chacune de ces catégories possède une page start contenant une description de cette catégorie et une liste vers les sous-catégories et pages dépendantes.
Si vous créez une nouvelle catégorie ou sous-catégorie, commencez par créer la page catégorie:start en vous inspirant des pages déjà présentes

Il est dès lors interdit de mettre des informations à la racine de la Bible, c'est à dire sur la page start des catégories.
Il faut donc modifier une page existante ou créer une page dans cette catégorie.

Liens

Lorsque vous créez un lien, par défaut il est relatif, ce qui signifie dans la même catégorie.

Pour aller dans une autre catégorie, c'est-à-dire faire un lien absolu, il faut commencer par “deux-points” (:)

Par exemple, vous écrivez dans la catégorie Publication et vous voulez linker vers la page upload qui se trouve dans la catégorie configuration. Tapez donc

[[:configuration:upload]]

Pour linker vers la première page d'une catégorie, il faut utiliser la page start. Exemple :

[[:configuration:start]]

Les messages d'en-têtes

Ce wiki met à votre disposition plusieurs messages à mettre au début de votre page. Inscrivez le code en dessous du titre de votre page

Ébauche

Cette page est une ébauche, ce qui signifie qu'elle n'est pas terminée et/ou que vous pouvez l'améliorer en partageant vos connaissances
{{message>ébauche}}

Brut

Cette page n'a pas encore été mise en forme, il n'y a que le texte brut. Nous vous serions reconnaissants si vous preniez le temps de la mettre en forme ;-)
{{message>brut}}

A documenter

Cette page a été créée car nous pensons qu'il est important de documenter cette fonction, mais nous n'avons pas encore rédigé cette documentation.

Vous pouvez partager vos connaissances en rédigeant, même partiellement, la documentation de cette fonction.

{{message>todo}}

Index


Utilisateur

Vous n'ètes pas identifié. Vous pouvez vous inscrire ou vous connecter.



Page