Ligne éditoriale d'Andesi

Cette page n'est ni finie, ni figée. En cas de doute, merci d'en débattre sur le forum. — orgrim 07/09/2009 14:57

Comment participer

Pour participer au wiki d'Andesi, c'est très simple, il suffit d'en faire la demande de cette façon et de commencer à écrire son article :

  1. Avoir un compte sur le forum ou s'y enregistrer
  2. Demander un accès au wiki sur le forum ou envoyer un mail par l'intermédiaire du forum aux admins: orgrim, arnaud ou ioguix. Selon votre motivation, l'accès vous sera sûrement donné :-).
  3. Lire la suite de cette page
  4. Editer le wiki

Organisation du wiki

Voici quelques grandes lignes à respecter pour que wiki ne deviennent pas un gros basard, même si c'est inhérent à tout wiki qui se respecte.

Règles de base

  • Les articles doivent concerner Debian, bien évidemment.
  • Les articles doivent être assez conséquent, il ne s'agit pas d'un blogue ou on poste des liens
  • Les articles doivent être rédigés en français correct et sans fautes (la relecture sert à ça)
  • Les articles doivent être testés, le contenu technique doit fonctionner sur la Debian stable du moment

Les rubriques

Les articles sont regroupés par rubrique, dont le choix n'est arbitraire. Par exemple :

  • “admin” pour les articles montrant comment gérer certains logiciels spécifiques à Debian
  • “logiciels” pour configurer des logiciels et services
  • “materiel” pour faire fonctionner des périphériques en particulier
  • “réseau” pour ce qui concerne le réseau
  • etc.

Pour correctement choisir la rubrique où sera stocké l'article, le mieux est de naviguer dans l'index des pages (lien en bas) pour déterminer la rubrique la mieux adaptée.

Aussi, le wiki permet de faire des liens dans tout les sens, ce qui permet de faire des références entre articles de rubriques différentes, plutôt que d'écrire des sections qui s'éloigne du propose de l'article et de la rubrique.

Enfin, on peut tout à faire modifier les articles s'il le faut. Par exemple, un article devenu trop gros ou ayant du contenu redondant peut tout à fait être refactorisé avec d'autres articles et dans des rubriques différentes.

Relecture

Encore une fois, on se base sur le forum, on commence à prendre l'habitude de créer une discussion (dont le titre est préfixé par [wiki] ) pour discuter de son article dans le forum "Ce site".

La règle proposée ici est d'indiquer grâce à une <note> le status de la page. On crée donc la page avec son nom définitif, ce qui évite le renommage (peu pratique) de la page si elle s'appelle “ma-doc_brouillon”, puis “ma-doc_a_relire”, etc.

Mises à jour

Il serait sympa de maintenir à jour les articles ou de les marquer obsolète. Un peu comme les cadres d'information de wikipedia. Pour faire pareil, on peut utiliser les balises <note> pour indiquer un éventuel status particulier de la page à mettre en haut de celle-ci.

Trucs et astuces

Voici quelques conseils pour faciliter la prise en main de dokuwiki.

Se renseigner avec d'agir

En cas de doute, ou pour ménager ses efforts en évitant de réécrire un article existant, il vaut toujours mieux jeter un coup d'oeil à l'index des pages. Si vous ne savez par ou déposer votre page, mieux vaut demander sur le forum.

Liens

Comme indiqué dans le guide de la mise en page de dokuwiki, les liens sont créés en utiliser des doubles crochets, on peut changer la représentation sur la page par un texte suivant un pipe entre les crochets. On peut faire des rubriques ou namespaces en utilisant : dans le lien :

Syntaxe Description Résultat Commentaire
[[wiki]] Dans le namespace courant wiki
[[..:accueil]] Relatif vers la page “accueil” du namespace parent ..
[[site:wiki]] Vers une page dans un namespace différent wiki
[[site:]] Vers la page par défaut du namespace donné site site:site ou site:accueil
[[:accueil]] En absolu par rapport au site accueil
[[paquets:Mémento des commandes de gestion des paquets]] Transformation du texte des liens, tout ce qui est avant le : est caché Mémento des commandes de gestion des paquets
[[materiel:|Configurer son matériel]] Avec un titre Configurer son matériel

Les liens sont toujours assainis :

  • Les blancs sont remplacés par des tirets
  • Tout le texte est mis en minuscules
  • Les caractères accentués sont remplacés par la lettre sans accent

Pour les liens vers la page d'accueil d'une rubrique, il faut laisser faire dokuwiki en utilisant [[Rubrique:]] pour lui permettre d'afficher le liens de la page d'accueil de la rubrique dans la trace en haut (“Vous êtes ici:”). La page de présentation de la rubrique est donc la page par défaut déterminée par dokuwiki :

  • Soit le nom du namespace
  • Soit la page “accueil” dans ce namespace

Ensuite, les namespaces sont comme des répertoires. D'ailleurs, ils sont gérés de cette façon en interne. On peut donc mettre plusieurs niveau, pour créer des sous-rubriques. Par exemple : [[Rubrique:Sous Rubrique:]]

Enfin, la puissance du wiki réside dans la possibilité de faire des liens dans tous les sens. Il ne faut pas hésiter à en faire pour que la navigation soit la plus aisée possible. Sinon, on se retrouve tout le temps à repartir de la page racine de la documentation.

Tags

On peut tagger les pages avec des mots clés en utilisant la syntaxe suivante :

{{tag>tag1 tag2}}

Toutes les pages du wiki devraient être tagguées pour que le plugin soit vraiment efficace. En respectant les conditions suivantes :

  • Déclarer les tags en première ligne de la page, sinon ils sont affichés là où ils sont déclarés.
  • Ne pas mettre d'accents ni aucun caractères spéciaux, parce que le texte du tag se retrouvera passé dans une URL via le nuage de tag
  • Le séparateur est l'espace, donc un tag = un mot

Créer une page

La procédure est simple :

  1. Aller sur la page d'accueil de la rubrique choisie
  2. Editer les page d'accueil de la rubrique
  3. Ajouter un lien vers la nouvelle page
  4. Sauvegarder
  5. Cliquer sur le lien fraîchement ajouté
  6. Cliquer sur le bouton “Créer cette page”
  7. Ecrire la page

Supprimer ou déplacer des pages

Pour supprimer une page, il suffit de l'éditer, puis d'enregistrer un contenu totalement vide.

Il y a deux façons de déplacer une page :

  • Sauvegarder le source, supprimer la page, la recréer et mettre à jour tous les liens y faisant référence (argh!)
  • Demander à un admin (orgrim, arnaud ou ioguix) d'utiliser le plugin magique pour le faire.

Dans tous les cas déplacer/renommer les pages est fastidieux, une bonne gestion des liens est nécessaire. Dans tout les cas, il vaut mieux demander conseil sur le forum. On peut très bien commencer un article dans un éditeur de texte à la maison avant de le publier sur le wiki.

Utiliser le bac à sable

C'est fait pour. Le playground (in English please) est fait pour tester la syntaxe du wiki, essayer les plugins et s'entraîner avant de sauter dans le grand bain.

Discussions

Merci d'aller sur le forum pour ça. Le mieux est de répondre à des fils existants concernant le wiki ou d'en lancer avec en préfixant le titre par [wiki].

 
site/ligne-editoriale.txt · Dernière modification: 11/12/2010 19:10 par orgrim