Contenu | Rechercher | Menus

Les « tags »

Cette page est une sous partie de la page des chantiers du wiki

Dans la documentation, les tags (parfois nommés étiquettes) sont les liens situés au-dessus du trait en haut de page (au-dessus du titre de la page). Ils permettent de créer des liens entre toutes les pages facilement. Comme l'explique cette section, toutes les pages contenant un même tag peuvent être listées très facilement afin de voir quelles pages parlent de tel ou tel sujet. Les tags sont en quelque sorte utilisés pour catégoriser les différentes pages de la documentation.

Pour que les tags fonctionnent correctement, veillez à respecter les quelques règles qui suivent.

Syntaxe

Pour utiliser des tags (mots-clés) dans les pages de la documentation :

{{tag>liste des tags}}

Respectez ces règles de syntaxe :

  • Les tags doivent être au singulier.
  • Les tags devant être accentués le sont. Exemples : matériel, système, sécurité, etc.
  • S'il y a des espaces dans le nom d'un tag, ils sont matérialisé(s) par un tiret bas « _ ».
  • Les différents tags sont simplement séparés par une espace : ne pas mettre de virgule (ou de point-virgule) car la virgule qui apparaît sur la page est ajoutée automatiquement !
  • Les tags doivent être écrits en minuscule à l'exception des tags de travail tels que BROUILLON, VÉTUSTE, À_RECYCLER, À_SUPPRIMER, …
    Et les tags des versions qui prennent une majuscule au début de l'adjectif.
  • Les tags doivent être dans l'ordre versions puis catégorie principale, catégorie secondaire, compléments, tags de travail.

Exemple :

{{tag>Oneiric Precise matériel audio tutoriel BROUILLON}}

Recommandations

Les tags de version : Lucid Precise Quantal Raring

À mettre obligatoirement pour :

  • Informer que la page est valable pour les versions indiquées.
  • Répertorier les pages qui sont à jour.
  • Répertorier les pages qui ne sont pas à jour ou qui contiennent des informations devenues inutiles (voir : les anciens tags).

Utiliser uniquement l'adjectif du nom de code de la version :

  • Ubuntu 13.04 : Raring
  • Ubuntu 12.10 : Quantal
  • Ubuntu 12.04 : Precise
  • Ubuntu 10.04 : Lucid

Exception : les pages portails n'ont pas besoin de ces tags.

:!: Si il y a des tags de versions plus anciennes, il faut nettoyer la page des informations relatives à ces versions et supprimer ensuite les tags associés.

Choisir les bons tags

  • Un tag doit correspondre à une page existante, ainsi lorsqu'on clique sur le tag, on est redirigé vers cette page.
  • Choisissez vos tags parmi les tags existants.
  • Ne pas créer un nouveau tag s'il ne peut être placé sur 5 pages ou plus : voir la page sur la suppression des tags trop peu utilisés.

Tags particuliers

Pour le fonctionnement interne de la documentation certains tags peuvent être placés sur des pages spécifiques afin d'attirer l'attention.

Ces tags sont :

  • BROUILLON : ce tag indique que la page doit être relue, est en cours de rédaction ou doit être améliorée,
  • VÉTUSTE : pour les pages n'ayant pas d'informations récentes et n'ayant pas été validées pour une version encore supportée,
  • À_RECYCLER : pour les pages qui peuvent être intéressante dans leur contenus mais qui doivent être intégrée à d'autres pages,
  • À_SUPPRIMER : pour les pages que l'on pense supprimer mais pour lesquelles on attend une éventuelle ré-écriture.

Les « topics »

Pour lister les pages ayant un tag particulier utilisez cette syntaxe :

{{topic>nom_du_tag}}

Si vous venez d'ajouter un tag à une page et qu'une page listant les pages contenant ce tag via « le wikicode topic » ne contient pas votre page, cela est peut-être dû au fait que votre page ne contient pas de titre de niveau 1. Veillez à bien structurer votre page de manière sémantique (c'est-à-dire avec des titres, etc.).

D'autres syntaxes sont également possibles :

  {{topic>tag1 +tag2}}           (tag1 ET tag2)
  {{topic>tag1 -tag2}}           (tag1 SAUF tag2)
  {{topic>tag1 tag2}}            (tag1 OU tag2)

Pour plus de détails, se référer à l'aide de l'élément Topic sur DokuWiki.

Tags à supprimer

Avec le temps des tags apparaissent par erreur ou ne sont plus nécessaires.

Il existe deux pages pour répertorier ces tags :

Ces tags en trop doivent être supprimés, et les pages doivent être relues et mises à jour en conséquence. Par exemple si il s'agit de tags de versions, il faut supprimer les informations relatives à ces versions. Si il s'agit de tags peu utilisés mais pointant vers des pages existantes, pensez à mettre ces liens dans le descriptifs où c'est souvent leur place.

En cas de doutes, la liste de discussion de la documentation et le salon IRC #ubuntu-fr-doc sont là pour trouver de l'aide.


wiki/tags.txt · Dernière modification: Le 12/11/2013, 20:10 par 0ol
Le contenu de ce wiki est sous licence : CC BY-SA v3.0