Help:TemplateData

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:TemplateData and the translation is 100% complete.

Other languages:
asturianu • ‎azərbaycanca • ‎български • ‎বাংলা • ‎català • ‎dansk • ‎Deutsch • ‎Zazaki • ‎emiliàn e rumagnòl • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎føroyskt • ‎français • ‎Frysk • ‎galego • ‎hrvatski • ‎magyar • ‎Հայերեն • ‎Bahasa Indonesia • ‎Ilokano • ‎italiano • ‎日本語 • ‎ქართული • ‎한국어 • ‎Lëtzebuergesch • ‎मराठी • ‎Nederlands • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎русский • ‎Scots • ‎slovenščina • ‎svenska • ‎українська • ‎中文
PD Note: Lorsque vous modifiez cette page, vous acceptez de libérer votre contribution en vertu de CC0. Voir Public Domain Help Pages pour plus d'informations.
PD


Qu'est-ce que TemplateData ?[edit | edit source]

TemplateData (en français, « Code pour modèles ») est une façon de stocker les informations sur les paramètres d'un modèle, afin que l'ÉditeurVisuel puisse les récupérer et les afficher pour faciliter leur modification avec l'ÉditeurVisuel.

La syntaxe TemplateData permet aux utilisateurs d'écrire du code dans une page d'un modèle, ou à transcrire dans une page de modèle (comme sur une page de documentation d'un modèle). Une fois qu'un modèle a ces données structurées, il peut être correctement affiché dans VisualEditor. Bien que cela puisse sembler complexe, il est effectivement très facile d'écrire du code dans un modèle.

Éditeur de code pour modèle[edit | edit source]

Il existe un outil intégré pour modifier TemplateData simplement.

Pour utiliser l'éditeur TemplateData, rendez-vous sur la page du modèle (ou sa sous-page de documentation) et cliquez sur le bouton « Édition ». Cela affichera un autre bouton appelé « Manage TemplateData » juste au dessus de la fenêtre d'édition:
Manage template documentation button for TemplateData 2014.png
Cliquez ce bouton pour ouvrir l'outils graphique d'édition de TemplateData.
A screenshot of the TemplateData editing tool
L'éditeur permet d'ajouter une ligne par paramètre de modèle et de définir les valeurs les plus courantes. Si la page que l'on édite contient déjà un bloc de TemplateData, alors l'information déjà documenté sera automatiquement affichée quand vous ouvrez la bonne page dans l'éditeur de TemplateData. Dans le premier champ, on peut ajouter ou mettre à jour une courte description textuelle du modèle. Après cela, on peut utiliser les boutons "Importer les paramètres" ou "Ajouter des paramètres" pour documenter les noms et valeurs des paramètres que le modèle utilise. On peut renseigner le nom du paramètre, ses alias, son label(i. e. le nom dans l'éditeur visuel) et la description qui seront affichés à l'utilisateur. Le seul champ requis est Nom (la première colonne de chaque ligne), qui est le nom exact, sensible à la casse (majuscule-minuscule), du paramètre. Dans le menu pop-up, on peut choisir le type du contenu du paramètre, comme string (un texte), page (un lien vers une autre page), ou dates. Si le modèle doit produire une erreur lorsque le champ n'est pas rempli, marquez-le "Requis". Si le paramètre est généralement utilisé ou conseillé, alors marquez-le "Suggéré". Le bouton "Supprimer" enlève la ligne du paramètre dans TemplateData.
Screenshot of the TemplateData editor, showing a second parameter being added

Quand vous avez fini de documenter chaque paramètre, cliquez sur "Appliquer" pour insérer le TemplateData pré-formaté dans la zone d'édition. Vous avez toujours à sauvegarder la page, en utilisant le classique bouton "Enregistrer" en bas de la zone d'édition.

Attention: L'éditeur TemplateData placera le bloc TemplateData soit directement sur la page du modèle soit sur sa sous-page de documentation. On peut déterminer où le TemplateData sera inséré en éditant la page où l'on veut le placer. Cependant, si plusieurs blocs TemplateData sont dans le même modèle, alors un seul parmi eux sera utilisé. S'il y a déjà un TemplateData sur la page, alors il faut éditer la page où le bloc a été placé pour éviter de créer plusieurs blocs TemplateData.

Syntaxe du TemplateData[edit | edit source]

La syntaxe du TemplateData est basée sur un format JSON standard, et est vraiment simple à manipuler. Notez que toutes les descriptions du TemplateData doivent être du texte standard (pas de wikicode, pas de lien, etc.).

La première chose à faire est d'écrire une paire de balises <templatedata>, n'importe où dans la sous-page de documentation, comme ceci :

<templatedata>
{
        ...                            <-- Le contenu du TemplateData va ici
}
</templatedata>

Cela indique au logiciel que tout ce qui est entre les balises est du TemplateData et devrait être référencé lorsque le modèle est utilisé.

Exemple[edit | edit source]

Les descriptions dans les balises <templatedata> suivent une présentation uniforme. Imaginons que vous ayez un modèle appelé « Commons » pour lier un sujet vers une catégorie de Commons. La données du TemplateData devraient ressembler à quelque chose comme ça :

<templatedata>
{
        "description": "Modèle pour lier un sujet vers une catégorie de Commons",
        "params": {
                "1": {
                        "label": "Catégorie de Commons",
                        "description": "La catégorie de Commons vers laquelle vous voulez créer un lien.",
                        "default": "Category:CommonsRoot",
                        "type": "string",
                        "required": true
                }
        }
}
</templatedata>

Le résultat qui s'afficherait alors dans la documentation ressemble à ceci :

Modèle pour lier un sujet vers une catégorie de Commons

Template parameters
Parameter Description Type Default Auto value Status
Catégorie de Commons 1 La catégorie de Commons que vous voulez lier. string Category:CommonsRoot empty required

Description et paramètres[edit | edit source]


La première étiquette se nomme "description", et décrit ce que le modèle fait.
"description": "Modèle pour lier un sujet vers une catégorie de Commons",

Il y a ensuite l'étiquette "params", qui sert à introduire la liste des paramètres du modèle.

Toutes les étiquettes qui suivent seront incluses dans la section introduite par "params".

"params": {
        ...            <-- les paramètres vont ici
}

Pour chaque sous-section d'un paramètre, la première étiquette est le nom du paramètre du modèle présent dans le code source du modèle.

Si le paramètre a un nom, comme {{{lien catégorie}}}, cette étiquette serait "lien catégorie".

Si le paramètre est sans nom, c'est à dire s'il est juste un nombre comme {{{1}}}, l'étiquette serait "1".

Tous les fragments d'information à propos du paramètre sont incluses dans la section qui commence avec son nom.

        "1": {                 <-- nom du paramètre
                ...            <-- les informations à propos du paramètre vont ici
        }

Ensuite, nous avons "label", dans lequel vous mettez un titre lisible pour le paramètre qui sera affiché dans l'éditeur de modèle.
                "label": "Catégorie de Commons",

Nous avons ensuite l'étiquette "description" : cette fois, il s'agit de la description du paramètre, pas de celle du modèle.
                "description": "La catégorie de Commons que vous voulez lier.",

Ensuite vient "default", qui définit la valeur par défaut pour le paramètre. Quelques modèles ont une valeur par défaut qui est utilisée à moins qu'on ne la change. Ce mot-clé indique à l'utilisateur la valeur par défaut pour ce paramètre.

Vous pouvez ignorer ce paramètre si il n'y a pas de valeur par défaut.

                "default": "Category:CommonsRoot",

Après, nous avons "type", qui permet à l'éditeur du modèle de savoir comment il interprètera le paramètre. Ce peut être :
  • "string": une séquence de caractères, comme cette phrase ;
  • "number": une suite de chiffres ;
  • "wiki-user-name": une suite de caractères qui représentent un nom d'utilisateur ;
  • "wiki-page-name": une séquence de caractères qui représentent un titre de page.
  • "wiki-file-name": un nom de fichier.
                "type": "string",

Vient "required", qui peut prendre comme valeur true ou false.

Cela sert simplement à contrôler si le paramètre rempli est obligatoire pour ce modèle.

                "required": true

Et finalement, on trouve "suggested", qui prend les valeurs true (vrai) ou false (faux).

C'est un statut pour les paramètres qui ne sont par 'requis' mais recommandé d'être renseigné(mais sans obliger) pour les utilisateurs du modèle. Si vous ne le spécifiez pas, il sera mis par défaut à false.

                "suggested": true

Une fois que vous avez fini de remplir les champs, cliquez sur « Publier ». Si vous avez fait des erreurs, la sauvegarde n'aura pas lieu (cela peut paraître perturbant, mais c'est avant tout une sécurité).

Si vous rencontrez des anomalies, expliquez sur la page de retour d'expérience ce que vous essayiez de faire, et nous serons heureux de vous aider.

Notez que chaque fragment d'information est entouré de guillemets anglais (sauf pour true et false), et séparé du texte par une virgule (à moins que le fragment d'information en question soit le dernier de la liste).

Alias des paramètres[edit | edit source]

Certains modèles autorisent différents noms pour un même paramètre.

Par exemple, {{Commons|catégorie=Pommes}} pourrait aussi être écrit {{Commons|Pommes}} ou {{Commons|lien=Pommes}}.

Pour ajouter cette information au TemplateData, vous devez simplement ajouter les alias aux informations relatives au paramètre :

        "params": {
                "catégorie": {
                        ...
                        "aliases": ["1", "lien"]
                }

Valeur automatique[edit | edit source]

On peut spécifier une "autovalue"(valeur automatique) pour un paramètre. Quand les utilisateurs ajoutent le modèle à la page, cette valeur sera ajouté automatiquement. Par exemple, de nombreux modèles de maintenance ont besoin d'avoir la date ajoutée; si vous spécifiez une "autovalue" pour le paramètre "date" du modèle, alors la date sera remplie automatiquement.

Pour ajouter cette information au TemplateData, ajoutez simplement le mot-clé autovalue aux informations du paramètre. Vous pouvez utiliser en plus subst: pour faire correspondre les valeurs:

        "params": {
                "date": {
                        ...
                        "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
                }

Paramètres multiples[edit | edit source]

Si le modèle a plusieurs paramètres, il suffit de répéter l'opération avec d'autres sections (juste après la section pour le paramètre "1") et de les remplir comme bon vous semble. Notez que si un modèle a plusieurs paramètre, vous devez les séparer par une virgule dans le TemplateData, comme ceci :

        "params": {
                "1": {
                        ...
                },                     <-- remarquez la virgule ici
                "2": {
                        ...
                },                     <-- et ici
                "3": {
                        ...
                }
        }

Paramètres similaires[edit | edit source]

Parfois, quand un modèle a plusieurs paramètres, certains d'entre eux peuvent contenir les mêmes informations. Dans ce cas, vous avez seulement besoin de fournir l'ensemble des informations pour le premier d'entre eux, et les autres pourront « hériter » leurs informations de celui-ci.

        "params": {
                "sujet1": {
                        "label": "Sujet",
                        "description": "Un sujet mentionné sur cette page d'homonymie",
                        "type": "string"
                },
                "sujet2": {
                        "inherits": "sujet1"
                },
                "sujet3": {
                        "inherits": "sujet1"
                },
        }

Patron à copier[edit | edit source]

Vous pouvez copier le patron ci-dessous pour ajouter de nouvelles métadonnées TemplateData à un modèle. Il contient les informations les plus courantes.

<templatedata>
{
        "description": "",
        "params": {
                "1": {
                        "label": "",
                        "description": "",
                        "type": ""
                },
                "2": {
                        "label": "",
                        "description": "",
                        "type": ""
                }
        }
}
</templatedata>

Limitations et questions[edit | edit source]

  • Fonctionnalités manquantes — TemplateData est un très bon exemple d'outil qui a été mis en place avec peu de fonctionnalités, en espérant que les utilisateurs aideront à guider au développement de ce dernier en fonction des besoins. Si vous voulez demander de nouvelles fonctionnalités pour TemplateData, merci de nous le faire savoir.
  • Retards d'affichage dans les modèles — Après avoir ajouté TemplateData à un modèle, les métadonnées devraient être visibles immédiatement quand le modèle est modifié via l'ÉditeurVisuel. Cependant, il est possible qu'il faille plusieurs heures avant que les métadonnées apparaissent. Vous pouvez forcer la mise à jour en faisant une « modification vide » sur la page du modèle lui-même (pas sur la sous-page de documentation). Pour effectuer une « modification vide », il suffit simplement de cliquer sur « Modifier » dans la page du modèle, puis de publier sans faire aucun changement.
  • Problèmes actuels — Une liste des anomalies actuelles et des fonctionnalités demandées est disponible dans Bugzilla.

Autres outils[edit | edit source]