Help:TemplateData/fr

Qu'est-ce que TemplateData ?
 est un moyen de stocker des informations au sujet d’un modèle et des ses paramètres, de manière à ce que l’éditeur visuel puisse les récupérer et les afficher dans l’outil d’inclusion de modèles, rendant ainsi plus facile l’édition de pages utilisant ce modèle.

L’extension TemplateData est installée sur tous les wikis WMF. Si vous avez votre propre wiki, vous devrez installer Extension:TemplateData.

La syntaxe TemplateData permet aux utilisateur d'écrire de petits morceaux de données structurées dans une page de modèle, ou à transclure dans une page de modèle (par exemple sur sur la page de documentation d'un modèle). Une fois qu'un modèle a ces données structurées, il peut être affiché correctement dans l'ÉditeurVisuel. Bien que cela puisse sembler compliqué, c'est en fait très simple.

Éditeur de données TemplateData
Il y a un outil intégré pour modifier les TemplateData de façon simple.

Pour utiliser l'éditeur TemplateData, allez dans la page du modèle (ou dans sa sous page de documentation) et cliquez sur le bouton "Edit". Ceci fera apparaître un bouton nommé "", juste au dessus de la fenêtre ouverte d'édition : Appuyez sur ce bouton pour entrer dans l'outil d'interface utilisateur pour l'édition des TemplateData. L’éditeur vous permet d’ajouter les paramètres du modèle et de positionner les attributs les plus courants. Si la page que vous modifiez contient déjà un bloc TemplateData, les informations déjà documentées sera automatiquement affichées lorsque vous ouvrez la bonne page dans l’éditeur TemplateData. Dans la première boîte de dialogue, vous pouvez ajouter ou mettre à jour une courte description du modèle en texte seul. Après cela, vous pouvez utiliser les boutons « Ajouter des paramètres suggéré(s) » et « Ajouter un paramètre » pour documenter les noms et les attributs des paramètres que le modèle utilise.

Vous pouvez lister le nom du paramètre, tous ses alias, l’intitulé et la description qui sera affichée pour les utilisateurs. Vous pouvez aussi proposer un exemple sur la façon d’utiliser le paramètre. Le seul champ obligatoire est le Nom (le premier champs de chaque ligne), qui est l’endroit où vous inscrivez le nom exact du paramètre, avec la casse correcte. Dans le menu déroulant « Type », vous pouvez choisir le type du contenu que le paramètre doit recevoir, tel qu’une chaîne (pour les messages en texte seul), une page (pour les liens vers d’autres pages), ou une date. Si le modèle produit une erreur lorsque ce paramètre n’est pas rempli, marquez ce paramètre comme « Obligatoire ». Si le paramètre est souvent utilisé ou recommandé, marquez-le comme « Suggéré ». Le bouton « Supprimer le paramètre » retire de TemplateData l’entrée concernant le paramètre. Lorsque vous avez fini de documenter chacun des paramètres, cliquez sur « Appliquer » pour insérer la syntaxe TemplateData pré-formatée dans le champ d’édition. Vous devez ensuite encore enregistrer la page en utilisant le bouton classique « Enregistrer » sous le champ d’édition.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.

Limitations and questions

 * Fonctionnalités manquantes — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
 * Problèmes en cours — A list of current bugs and feature requests is available in the Wikimedia bug tracker.

Structure des TemplateData
TemplateData's structure is based around the JSON standard, and is fairly simple. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

The first thing to do is to type out a pair of  tags, anywhere on the template's documentation subpage, like so:

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.

Exemple
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

Ceci apparaîtrait, dans le modèle, ainsi :

{   "description": "A template for linking to a commons category about an article", "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 }   } }

Description et paramètres
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:

Multiple parameters
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Other tools

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data