Outils pour utilisateurs

Outils du site


Panneau latéral

Forum

wiki:usage

Usage et conventions

Ce qui suit est un ensemble de recommandations concernant les différentes pages du wiki. Ces recommandations permettent de maximiser la bonne tenue et la cohérence de l'ensemble et facilitent la mise en place d'un espace documentaire agréable pour tous.

Édition d'un document

L'interface de saisie est relativement simple et possède un éditeur visuel ; par exemple pour mettre en gras une partie d'un texte, il suffit de sélectionner le texte visé avec la souris et de cliquer sur le bouton « B ». Ne pas hésiter à regarder la syntaxe pour voir les différents modes possibles.

Que ce soit pour la création ou la modification d'un document, il est toujours pratique et agréable de commenter son édition par un message, dénoté Résumé dans l'interface de saisie. Étant un espace collaboratif, il est toujours utile de se mettre à la place des autres éditeurs et de leur laisser des informations pertinentes.

C'est donc une bonne habitude de laisser un message explicatif court permettant de voir rapidement ce qui à été fait sur le document édité.

Par ailleurs, avant d'enregistrer sa page, il est toujours préférable de faire un « Aperçu », évitant de multiples enregistrements pour, par exemple, enlever des fautes de frappes.

Création d'un document

Pour créer une nouvelle page dans le wiki, il suffit de saisir dans la barre d'adresse de votre navigateur l'URL par laquelle on souhaite y accéder ; DokuWiki proposera alors de créer cette page si vos droits sont suffisants.

Un document nouvellement créé devrait toujours avoir un et un seul titre principal (H1). Ce titre est utilisé par de nombreuses fonctionnalités et doit, si possible, refléter au mieux le contenu qui se trouve sur la page. Voyez aussi les conventions de nommage ci-dessous.

La structure générale d'un document est basé sur la notion de « section », celles-ci permettent l'édition d'une partie d'un document seulement et améliorent la maintenance ou l'édition d'un même document par plusieurs personnes, y compris en même temps.

Modification d'un document

Lorsque vous désirez modifier un document, éditez si vous le pouvez la section concernée plutôt que la page entière. Ainsi, vous ne verrouillerez qu'une partie du document, et d'autres personnes pourront éditer le restant de la page. Si votre verrou expire, rafraichissez la page pour tenir compte des éventuelles modifications intervenues entre-temps.

Plus encore que lors d'une création, lors d'une modification, il est agréable et pratique de bien commenter la/les modifications effectuées. Outre l'aspect « historique » du document, cela permet aux différents éditeurs de suivre et comprendre l'évolution du document.

Pensez surtout à indiquer la nature de cette modification (retrait, ajout, reformulation, correction, destruction, création…), suivie du thème sur lequel elle porte. Quelques exemples de bons résumés sont : « Modification d'un document - corrections fautes de frappes », « Ajout section règles du jeu », « Liens externes - Retrait lien publicitaire ». De mauvais résumés sont « Corrections », « Site de pub » …

Si la modification est minime, autant le signaler en cochant la case « Mineur » (à droite de la zone de saisie du résumé). Une correction orthographique ou une reformulation d'un paragraphe sont des exemples de modifications mineures. A contrario, l'ajout d'une nouvelle section, même de petite taille, est considéré comme une modification majeure puisqu'elle remet en cause la structure du document et ajoute un nouveau contenu.

Discuter d'un document

ON NE DISCUTE PAS, bon, plus sérieusement, si vous êtes habitués à Mediawiki/Wikipedia, nous avons un système similaire où pour chaque page vous verrez une option Discussion dans le menu Actions. Cela aura pour effet de créer une page dans Talk correspondant à l'article en cours de visualisation. Vous pouvez alors vous y lâcher. ;-)

Mise à jour: Bon ben finalement, on ne discute pas, cette capacité a été trop peu utilisée et elle devrait être retirée à la prochaine occasion. Pour l'instant on la laisse car elle ne gêne pas beaucoup. N'utilisez pas les pages “discussion” mais venez nous en parler sur le forum si des articles du Wiki vous posent soucis, ce sera mieux comme ça.

Conventions de nommage

Les liens URL au sein du wiki

  • Doivent être écrits intégralement en minuscules.
  • Évitez d'utiliser des articles (le, une, des…).
  • Devraient être au singulier.
  • Trouvez une formulation brève et explicite.
  • Peuvent contenir des espaces pour séparer les mots distincts (convertis en _ par DokuWiki).

Les titres de chaque article

  • Doivent utiliser la balise H1.
  • Commencent par une majuscule.
  • Peuvent être au pluriel.
  • Doivent être relativement courts.
  • Peuvent être composés de plusieurs mots.

Espaces de nommage

Les espaces de nommage nous servent à la fois en tant que catégorie, et en tant que page Wiki.

  • Les 4 principaux sont doc (Documentation), projet (Projets), wiki (Wiki) et english (English); n'en créez pas d'autres.
  • Peuvent contenir autant de sous-espaces que nécessaire.
  • Peuvent être au pluriel.

Chemins des fichiers d'OpenArena

Par convention sur ce wiki, nous nommons les répertoires utilisés par OpenArena pour stoquer ses fichiers $INSTALL_OA (répertoire d'installation du jeu) et $HOME_OA (répertoire propre à l'utilisateur). Sans doute cela facilitera-t-il la rédaction de vos articles ;-).

$INSTALL_OA

C'est là où vous avez choisi de décompresser l'archive du jeu. Ce répertoire contient généralement les exécutables du jeu ainsi que les données graphiques&sons (modèles et cartes contenus dans les .pk3 du pack de base)

$HOME_OA

C'est là où les préférences utilisateur (fichiers q3config.cfg) sont enregistrées. C'est aussi dans ce répertoire que sont téléchargés les nouveaux .pk3 récupérés depuis les serveurs de jeu si vous avez activé l'auto-download. (voir aussi Répertoire utilisateur d'OA)

Autres conventions

La balise box

Elles sont jolies, mais pour uniformiser la présentation du site, quelques recommandations :

  • Fixer à 45% la largeur des boites (pour éviter leur chevauchement lorsqu'elles sont alignées à gauche/droite)
  • Fixer à ?% (on ne s'est pas encore décidé : 80% ? 90% ? 100% ?) la largeur d'une boite dont vous aimeriez qu'elle s'étale sur toute la largeur de la page.

Images

Lorsque vous publiez une capture d'écran, ajoutez ?200 ou ?300 (tailles recommandées) en bout d'URL pour que l'image soit automatiquement redimensionnée.

Traductions

Certains termes anglais sont plus parlants, comme souvent en informatique. Préférez tout de même la version française du mot. Les titres de page en particulier devraient être en français, mais l'espace de nom (visible dans l'URL) qui y est associé peut être écrit en anglais. Exemple :

[[:maps:|Cartes]]
wiki/usage.txt · Dernière modification: 2017/02/20 09:19 (modification externe)