Difference between revisions of "FR/FAQ/Regles"

Revision as of 12:49, 15 May 2009

Quelques règles concernant la mise à jour de cette FAQ

• Règle N°1 : Tout le monde est fortement invité à y participer :-)
• Règle N°2 : Il ne faut pas créer de niveaux supplémentaires dans la hiérarchie de la FAQ pour éviter autant que possible de modifier les liens des entrées de FAQ car ceux-ci sont souvent référencés par d'autres pages et d'autres sites.
• Règle N°3 : Une entrée de FAQ devra autant que possible être placée sous un titre de paragraphe existant.
• Règle N°4 : Chaque entrée de FAQ sera un simple numéro sur 3 chiffres pour éviter de se creuser la tête à trouver un nom explicite et pour garder une cohérence avec l'ancienne FAQ.
• Règle N°5 : Chaque entrée de FAQ commencera par un titre sous la forme == Le Titre de la FAQ == et comportera le plus souvent des listes d'actions en commençant la ligne par le signe *. Pour encadrer un texte (faire une citation), il faut commencer la ligne par un espace.
• Règle n°6 : Le html sera évité tant que possible et la simplicité dans le code wiki doit être privilégiée.
• Règle n°7 : Ne faire que des liens internes à la FAQ lorsqu'une faq renvoie à une autre et non pas des renvois externes, soit pour être précis :

[[Titre de la faq]] en syntaxe wiki, plutôt que [[http://fr............| Titre de la faq]] 

• Règle N°8 : Pour insérer une image, il est conseillé d'utiliser un nom commençant par Fr. et indiquant le chemin où elle est utilisée. Exemple :

Fr.FAQ_Base_027_Les_Tables.png

• Règle N°9 : Si vous relisez une FAQ et n'avez trouvé aucune erreur, vous pouvez signaler que vous l'avez relue (et donc validée) dans l'onglet "Discussion".
• Règle N°10 : Les FAQ sont numérotées. Je pense qu'il est intéressant de conserver le principe de la numérotation pour plusieurs raisons :
  • Le lien est plus simple à afficher, copier/coller et mémoriser
  • Cela permet de gérer le nom des images plus facilement
  • Il est possible à tout moment de modifier le titre de la FAQ sans que cela change son lien
  • Pour retrouver facilement le dernier numéro de disponible, il est possible d'utiliser ce lien :
    • http://wiki.services.openoffice.org/mwiki/index.php?title=Special%3APrefixindex&from=Fr.openoffice.org%2FFAQ%2FBase pour Base ;
    • puis de modifier le dernier mot du préfixe pour chercher dans le module qui vous intéresse : Calc, Draw, Generale, Impress, Math, Writer, Xml,...
• Règle N°11 : Tout le monde peux modifier les règles ci-dessus car nous sommes sur un Wiki :-)