Modèle:métadonnées/Documentation

Documentation du modèle

Ceci est la page de documentation de Modèle:métadonnées. [rafraîchir] · [modifier] · [historique]

Utilisation :

Le modèle {{métadonnées}}, placé préférablement en bas d’une page (avant les catégories), permet de mentionner sur une page donnée si celle-ci dispose de métadonnées supplémentaires stockées dans une sous-page nommée /:data, et permet aussi d’en ajouter en générant un lien permettant de créer la sous-page de métadonnées (à partir du patron Modèle:métadonnées/patron).

Placé à l’intérieur d’une sous-page de métadonnées /:data (dans sa section noinclude à la fin, avec un paramètre non vide comme ici une astérisque), il ne sert qu'à documenter la sous-page elle-même, formater un peu son contenu (au format Wiki), et d'afficher une aide sur la façon de renseigner les métadonnées ; de plus il autocatégorise cette page de métadonnées elle-même dans la Catégorie:Métadonnées.

Paramètres du modèle {{métadonnées}}:

Dans les deux cas (dans l’article ou dans la sous-page de métadonnées), il n’y a besoin d’aucun autre paramètre et ce modèle s’utilise avec la simple syntaxe {{métadonnées}}.

On ne peut mettre un paramètre (pour l'instant) que dans la sous-page de métadonnées elle-même, afin d’indiquer le nom de la page de base sur laquelle portent les métadonnées (ce n’est utile et ne devrait être fait que pour les métadonnées de l’espace de noms principal, qui ne prend pas réellement en charge les sous-pages et qui ne permet pas de déterminer le nom de la page de base à partir de la page courante : à terme, les métadonnées de l'espace principal devraient être placées dans un espace de noms séparé prenant en charge les sous-pages, ou bien l’espace de noms principal sera modifié pour prendre en charge les sous-pages). Si on ne précise pas ce paramètre, les métadonnées seront tout de même accessibles, mais la page de métadonnées ne pourra pas afficher de lien de retour vers l’article principal et n’affichera qu’un lien vers la page de métadonnées courante elle-même.

Format des sous-pages de métadonnées :

Une sous-page de métadonnées /:data contiendra le code suivant :

<includeonly>{{#switch:{{{1|}}}

| variable1 = valeur1

| variable2 = valeur2

|}}</includeonly><noinclude>{{métadonnées}}</noinclude>

Le #switch ne doit pas retourner une valeur par défaut pour les noms de variables qu’il ne connaît pas ; dans ce cas la page de métadonnées devrait retourner un texte entièrement vide (y compris si on l’inclut sans préciser son premier paramètre pour indiquer le nom de la variable à sélectionner).
Cependant toutes les variables de métadonnées devraient aussi avoir des noms de variables et des valeurs courtes, la totalité de la sous-page devant rester courte et facile à maintenir. Il vaut mieux utiliser d’autres sous-pages que /:data pour stocker des métadonnées plus longues consistant en un texte formaté sur plusieurs paragraphes ou générant des tableaux.
Il est conseillé de ne mettre qu’une seule variable par ligne, comme dans l’exemple donné ici, ou dans le modèle préchargé à partir du patron lors de la création de la sous-page.
Attention : tous les caractères entre le signe = avant la valeur et le symbole séparateur | sont conservés dans la valeur retournée par le switch, y compris les espaces et sauts de ligne (qui peuvent alors devenir gênants pour leur utilisation dans certaines autres pages ou modèles consultant les métadonnées).
En revanche les blancs et sauts de ligne entre le symbole séparateur | (avant le nom d’une variable) et le signe = (après le nom de la variable) sont ignorés par le #switch : on peut donc insérer des lignes blanches séparatrices et des lignes de commentaires HTML entre  en cas de besoin, pour grouper ou commenter des variables. Les lignes blanches permettent aussi d’afficher la page de métadonnées elle-même avec des sauts de paragraphes visibles sur la page (mais les commentaires HTML ne seront pas affichés) mais ignorés lors de la consultation des métadonnées par les modèles qui y accèdent.
Note : par convention, les métadonnées stockées dans la sous-page /:data sont globales à toute la page à laquelle est attachée la sous-page. Mais si la page contient des sections spécifiques pour chaque langue, les variables de métadonnées propres à chaque langue devraient être suffixées par un point (.) suivi du code de la langue. Il est recommandé d’utiliser des noms de variables à la fois courts (symboliques) mais précis (pour éviter des conflits d’interprétation par différents modèles), et d’utiliser les codes de langue standards comme suffixes dans les noms de variables spécifiques à une langue donnée.

Utilisation des métadonnées pour stocker et gérer des clés de tri dans les catégories :

Si ces métadonnées définissent la variable nommée « clé de tri », celle-ci sera utilisée comme clé de tri secondaire pour la génération de la clé de tri par défaut avec le modèle {{clé de tri}}. Les métadonnées permettent également de définir des clés de tri spécifiques pour chaque langue, utilisables via le modèle {{sous-catégoriser par langue}} qui sait les lire. Consulter la documentation de ce modèle.
Les variables de clé de tri doivent s’appeler :
- soit « clé de tri » pour le tri par défaut d’une page (la valeur ne sera utilisée parle modèle {{clé de tri}} placé en base d’une page que si le modèle y est employé sans aucun paramètre), et clé de tri.
- soit « clé de tri.code-langue » pour une clé spécifique à une langue donnée et qui ne remplace la clé de tri par défaut uniquement que cette langue.
Il peut y avoir dans la sous-page de métadonnées autant de clés de tri que nécessaire pour les différentes langues contenues dans la page utilisant ce modèle, ainsi que d’autres variables de métadonnées propres à la page entière ou aux sections de langue.

Autres utilisations des métadonnées :

Elles peuvent contenir d’autres renseignement que les pages de catégories ne savent pas gérer correctement (ou de façon trop lourde) au sujet de n’importe quelle page, tels que :

des correspondances indiquant un radical Han et un nombre de traits pour un sinogramme donné ;
des romanisations diverses ;
des drapeaux ou indicateurs d’avancement de projet ou de relecture/révision ;
diverses variables de contexte au sujet de la page qui permettent d’éviter de répéter un même paramètre lors de l’appel de sous-modèles demandant systématiquement ces valeurs.

Voir aussi :