Extension:TemplateData/fr

L'extension TemplateData introduit une balise et une API qui ensemble permettent   aux éditeurs de spécifier comment les modèles doivent être invoqués. Cette information est disponible sous forme de table synthétique pour les utilisateurs finaux, et sous forme d'API JSON permettant aux autres systèmes (tels que VisualEditor) de construire des interfaces pour travailler avec des modèles et leurs paramètres. Voir pour une aide plus approfondie.

Édition
L'extension TemplateData fonctionne grâce à une balise définie dans le wikicode d'une page de modèle (en option, il peut être transclus à partir d'une page différente également). Il est conçu pour être compatible avec l'affichage commun que beaucoup de wikis utilisent, en faisant la transclusion de la documentation du modèle à partir d'une page séparée (mais ceci n'est pas nécessaire). Ce contenu de la balise doit être du JSON valide qui utilise le format décrit ci-dessous; notez que toutes les descriptions doivent être en texte brut (il n'est pas permis de mettre du wikicode à l'intérieur des données du modèle).

Quand un bloc est inclus dans une page, l'extension TemplateData réalise les contrôles suivants lorsque la page est sauvegardée :


 * 1) Le contenu doit être du JSON valide;
 * 2) Chaque élément de la structure JSON doit être du type attendu tel que spécifié ci-dessous (c'est à dire objet, tableau, ou une primitive); et
 * 3) Pour les éléments qui ont une liste spécifique de valeurs possibles (par exemple :  ), la valeur dans l'objet JSON doit correspondre à l'une de ces valeurs.

Si un de ces contrôle échoue, le serveur ne sera pas autorisé à sauvegarder et un message d'erreur sera affiché au-dessus de la page d'édition.

Pour les éléments à valeur automatique (autovalue), bug 2700 empêche  de travailler dans tout modèle qui est ajouté à l'intérieur d'un, y compris les balises  et. Le bloc TemplateData s'enregistre bien mais le wikicode résultant ne sera pas analysé correctement lorsque le modèle sera utilisé.

Notez que vous ne pouvez pas utiliser  à la place de.

Format
Ci-dessous vous avez une version visualisée des données JSON telle qu'elles sont définies sur la page du modèle entouré avec les balises. La spécification du format est disponible dans le dépôt TemplateData. Référez-vous à Specification.md pour la dernière version.

Objet TemplateData
L'objet TemplateData est un élément racine JSON encapsulé dans un élément  sur la page du modèle.

InterfaceText (chaîne ou objet)
Une chaîne textuelle brute de format libre (par exemple autre chose que du wikicode ou du HTML), dans la langue du contenu du wiki, ou un objet contenant ces chaînes et pour lequel la clé est le code de langue.

La valeur par défaut pour tous les champs de InterfaceText est.

Type String
Si c'est une chaîne, elle doit contenir une chaîne non-localisée dans la langue du contenu du wiki local.

Type Object
Si c'est un objet, celui-ci doit faire la correspondance suivante :

Exemple
Exemple de structure TemplateData telle qu'elle est spécifiée dans le wikicode sur une page de modèle. Below is how the above example would be displayed on the template page: {   "description": "Label unsigned comments in a conversation.", "params": { "user": { "label": "User's name", "type": "wiki-user-name", "required": true, "description": "User name of person who forgot to sign their comment.", "aliases": ["1"] },       "date": { "label": "Date", "suggested": true, "description": { "en": "Timestamp of when the comment was posted, in YYYY-MM-DD format." },           "aliases": ["2"], "autovalue": "" },       "year": { "label": "Year", "type": "number" },       "month": { "label": "Month", "inherits": "year" },       "day": { "label": "Day", "inherits": "year" },       "comment": { "required": false }   },    "sets": [ {           "label": "Date", "params": ["year", "month", "day"] }   ],    "maps": { "ExampleConsumer": { "foo": "user", "bar": ["year", "month", "day"], "quux": [ "date", ["day", "month"], ["month", "year"], "year" ]       }    } }

API
See the generated help at Special:ApiHelp/templatedata. A sample invocation (formatted for human readability) is:

This returns the template data for Template:Cite web. The ... block for this template is on its transcluded template documentation page, en:Template:Cite web/doc.

Additions and changes to JSON as received from the API
The JSON structure provided in response to an API HTTP get request is significantly different than that which is defined in the ... block. In response to the API request, extension TemplateData makes the following changes to the JSON object:
 * Adds two wrapping objects:
 * An overall Pages Object containing one or more Page Objects
 * An object with a numeric key: a Page Object


 * Additions/changes to the actual TemplateData Object
 * Add the  key with the name of the page from which the data was requested (e.g. "Template:Cite web").
 * Add the  key and array using the order in which the parameters occur in the   key within the TemplateData Object on the template page.
 * Add the  key
 * Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
 * Remove all  keys.
 * Add all properties from parameter from which an inheritance is defined which are not superseded by explicitly defined keys in the inheritor's Parameter Object.
 * Add default values for all keys in each Parameter Object which have not been explicitly defined or inherited.

Example of JSON object provided by API
The response to an API request for the TemplateData structure in the Example of TemplateData structure WikiText on template page section (above) can be seen:
 * In HTML format: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * As delivered by the API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

Voir aussi

 * – user interface for selecting and inserting templates' wikitext, based on their TemplateData.
 * GitHub: jeblad/TemplateData – alternate version with some Lua functionality.