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. Ci-dessous vous trouverez la manière dont l'exemple précédent sera affiché sur la page du modèle : {   "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
Voir l'aide générée sur Special:ApiHelp/templatedata. L'appel de cet exemple (formaté pour que ce soit lisible pour un humain) est :

Ce qui renvoie les données de modèle pour Modèle:Cite web. Le bloc ... pour ce modèle est sur la page de documentation du modèle transclus, soit en:Template:Cite web/doc.

Ajouts et modifications du JSON reçu de l'API
La structure JSON fournie dans la réponse à une requête HTTP Get est un peu différente de celle qui est définie dans le block ... . Dans la réponse à la requête vers l'API, l'extension TemplateData fait les modifications suivantes dans l'objet JSON :
 * Ajoute deux objets encapsulants :
 * Un objet Pages global contenant un ou plusieurs objets Page
 * Un objet avec une clé numérique : un objet Page
 * Additions/modifications de l'objet TemplateData actuel
 * Ajoute la clé  avec le nom de la page de laquelle les données ont été demandées (par exemple « Template:Cite web »).
 * Ajoute la clé  et le tableau en utilisant l'ordre dans lequel les paramètres apparaissent dans la clé   à l'intérieur de l'objet TemplateData sur la page du modèle.
 * Ajoute la clé
 * Modifie toutes les occurences de TemplateText qui sont simplement des chaînes vers les objets avec une seule clé pour le code de langue Wikipedia actuel
 * Enlève toutes les clés.
 * Ajoute toutes les propriétés du paramètre à partir duquel un héritage est défini, et qui ne sont pas réécrasées par les clés définies explicitement dans l'objet Parameter qui hérite.
 * Ajoute les valeurs par défaut pour toutes les clés dans chaque objet Parameter qui n'a pas été explicitement défini ou hérité.

Exemple d'objet JSON fourni par l'API
La réponse à une requête API pour la structure TemplateData dans la section Exemple (ci-dessus) peut être vu :
 * En format HTML : https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * Tel que délivré par l'API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

Voir aussi

 * – interface utilisateur pour sélectionner et insérer le wikicode des modèles, en fonction de leurs TemplateData.
 * GitHub: jeblad/TemplateData – version alternative, avec quelques fonctionnalités Lua.