Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
wiki:tags [Le 11/02/2011, 11:21] thibault.lemaitre maj : ajout section problèmes |
wiki:tags [Le 13/01/2022, 09:51] (Version actuelle) bcag2 [Les tags de version : Bionic, Focal...] màj |
||
---|---|---|---|
Ligne 4: | Ligne 4: | ||
====== Les « tags » ====== | ====== Les « tags » ====== | ||
- | <note tip>Cette page est une sous partie de la page [[:wiki/chantiers|des chantiers du wiki]]</note> | + | **//Cette page est une sous partie de la page [[:wiki/chantiers|des chantiers du wiki]]//** |
- | Dans la documentation, les tags (liens normalement situés au-dessus du trait en haut de page (lui même situé au-dessus du titre de la page)) permettent de créer des liens entre toutes les pages facilement. Comme l'explique [[#Les « topics »|cette section]], toutes les pages contenant un même tag peuvent être listées très facilement afin de voir quelle pages parlent de tel ou tel sujet. Les tags sont en quelque sorte utilisés pour catégoriser une page. | + | Dans la documentation, les [[wpfr>Tag_(métadonnée)|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 [[#Les « topics »|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. | Pour que les tags fonctionnent correctement, veillez à respecter les quelques règles qui suivent. | ||
Ligne 13: | Ligne 13: | ||
===== Syntaxe ===== | ===== Syntaxe ===== | ||
- | Pour utiliser des //tags// (mots-clés) dans les pages du wiki : | + | Pour utiliser des //tags// (mots-clés) dans les pages de la documentation : |
<code>{{tag>liste des tags}}</code> | <code>{{tag>liste des tags}}</code> | ||
- | Les tags de cette //liste des tags// sont séparés par des espaces. Pour inclure une espace dans le nom du tag, remplacez-la par un tiret bas. Vous pouvez voir une liste des tags utilisés dans la documentation sur la page [[:catégories]]. | + | **__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 : | ||
+ | <code>{{tag>Bionic Xenial matériel audio tutoriel BROUILLON}}</code> | ||
===== Recommandations ===== | ===== Recommandations ===== | ||
- | * Un tag doit correspondre à une **page existante**, ainsi lorsqu'on clique sur le tag, on est redirigé vers cette page | + | ==== Les tags de version : Bionic, Focal... ==== |
- | * Choisissez vos tags parmi **[[:thesaurus|les tags existants]]** | + | **__Utiliser uniquement les tags de [[:lts|version LTS]]__**, sauf si la page ou un de ses chapitres concerne une version intermédiaire bien spécifique.\\ |
- | * Ne pas créer un nouveau tag s'il ne peut être placé sur 5 pages ou plus : voir [[:wiki:tag2|Suppression de Tags]] | + | Le cycle de vie des versions intermédiaires étant trop court (9 mois) pour maintenir correctement à jour la documentation. |
- | * S'il y a des **espaces**, ils sont matérialisés par un **tiret bas** « _ ». | + | |
- | * Les tags doivent être au **singulier**. | + | |
- | * Les tags devant être **accentués** le sont. Exemples : [[:matériel]], [[:système]], [[:sécurité]], etc. | + | |
- | <code>{{tag>matériel système sécurité}}</code> | + | **__À 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 : [[:tag_ancien|les anciens tags]]). | ||
- | * Les tags doivent être intégralement écrits en **minuscule**. Quelques **exceptions** : le tag **BROUILLON** doit être écrit en **majuscules** afin qu'il soit visible, les tags des **versions d'Ubuntu** peuvent prendre **une majuscule**. | + | **__Utiliser uniquement l'adjectif du nom de code de la version__ :** |
+ | * Ubuntu 20.04 : Focal | ||
+ | * Ubuntu 18.04 : Bionic | ||
- | * Les tags des versions d'Ubuntu (Dapper, Hardy, Karmic, Lucid, Maverick, ...) correspondent aux versions pour lesquelles la page est valide; ils sont utiles pour toutes les pages de la documentation sauf les [[:portail|portails]]. On utilise uniquement l'adjectif du nom de code de la version. [[:tag_ancien|Plus d'informations à ce sujet]]. | ||
- | * Les tags doivent suivre l'ordre suivant : | + | **Exception** : les pages [[:portail|portails]] n'ont pas besoin de ces tags. |
- | <code>{{tag><Versions d'Ubuntu> <domaine_principal> <domaines spécifiques> <autres_tags> <tutoriel si c'est un tutoriel ou autre> BROUILLON}}</code> | + | :!: Si il y a des tags de [[:old-releases|versions plus anciennes (fin de vie)]], il faut nettoyer la page des informations relatives à ces versions et supprimer ensuite les tags associés. |
- | * On fait suivre la liste des tags d'un trait pour bien séparer du texte grâce à la syntaxe : | ||
- | <code>----</code> | ||
- | Ce qui donne | ||
- | ---- | ||
+ | ==== 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 **[[:thesaurus|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 [[:wiki:tag2|suppression des tags trop peu utilisés]]. | ||
+ | |||
+ | |||
+ | ==== Tags particuliers ==== | ||
- | ===== 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. | 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 : | 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 | + | * [[: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, | + | * [[: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, |
- | * [[:a_recycler]] : pour les pages qui peuvent être intéressante dans leur contenus mais qui doivent être intégrée à d'autres pages, | + | * [[:À_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'ont pense supprimer mais auxquelles ont attend une éventuelle ré-écriture. | + | * [[:À_SUPPRIMER]] : pour les pages que l'on pense supprimer mais pour lesquelles on attend une éventuelle ré-écriture. |
===== Les « topics » ===== | ===== Les « topics » ===== | ||
Ligne 63: | Ligne 78: | ||
D'autres syntaxes sont également possibles : | D'autres syntaxes sont également possibles : | ||
+ | <code> | ||
{{topic>tag1 +tag2}} (tag1 ET tag2) | {{topic>tag1 +tag2}} (tag1 ET tag2) | ||
{{topic>tag1 -tag2}} (tag1 SAUF tag2) | {{topic>tag1 -tag2}} (tag1 SAUF tag2) | ||
{{topic>tag1 tag2}} (tag1 OU tag2) | {{topic>tag1 tag2}} (tag1 OU tag2) | ||
+ | </code> | ||
Pour plus de détails, se référer à l'[[doku>plugin:tag#topic|aide de l'élément Topic sur DokuWiki]]. | Pour plus de détails, se référer à l'[[doku>plugin:tag#topic|aide de l'élément Topic sur DokuWiki]]. | ||
- | ===== Les « nuages de tags » ===== | ||
- | |||
- | Pour afficher les tags utilisés sur la documentation, utilisez cette syntaxe : | ||
- | |||
- | <code>~~TAGCLOUD:number~~</code> | ||
- | |||
- | Remplacer //number// par le nombre de tag que vous voulez afficher (compris entre 1 et 999). Si vous ne préciser pas //number// (ou que vous le laisser), 50 tags sont affichés. | ||
- | |||
- | La page [[:catégories]] utilise cette syntaxe. | ||
- | |||
- | ===== Problèmes connus ===== | ||
- | Les balises topics, précédemment présentées ne fonctionnent pas toujours correctement, sans que la cause soit bien déterminée. Ce problème fait l'objet du rapport de bogue [[https://bugs.launchpad.net/ubuntu-fr-doc/+bug/400175|suivant]]. | + | ===== Tags à supprimer ==== |
- | Ce problème a également lieu quand on recherche toutes les pages contenant un certain tag, comme c'est le cas dans beaucoup de liens de [[:wiki:tag2|la page sur la suppression des tags trop peu utilisés]]. | + | Avec le temps des tags apparaissent par erreur ou ne sont plus nécessaires. |
- | Pour savoir si ce bogue a lieu en ce moment, le lien [[:?do=showtag&tag=maverick|suivant]] devrait vous donner bien plus que 5 résultats (tag maverick). | + | Il existe deux pages pour répertorier ces tags : |
+ | * [[:wiki:tag2|La page sur la suppression des tags trop peu utilisés]] | ||
+ | * [[:tag_ancien|La page des tags des versions d'Ubuntu qui ont cessé d'être supportées]] | ||
- | ===== Voir aussi ===== | + | 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. |
- | * Le système de tag est un plugin de Dokuwiki : plus d'infos sur ce plugin [[doku>plugin:tag|ici]] | + | En cas de doutes, la [[http://listes.ubuntu-fr.org/info/ubuntu_wiki-fr|liste de discussion de la documentation]] et le [[http://webchat.freenode.net/?channels=ubuntu-fr-doc|salon IRC #ubuntu-fr-doc]] sont là pour trouver de l'aide. |
- | * Le nuage de tag est un plugin distinct du pugin tag : plus d'infos sur ce plugin [[doku>plugin:cloud|ici]] | + | |