Help:TemplateData/fr



Qu'est-ce que TemplateData ?
TemplateData (en français, « DonnéesStructurées ») 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 l'édition de ces derniers avec l'ÉditeurVisuel.

TemplateData permet aux utilisateur d'écrire du code dans la page d'un modèle, ou dans toute page qui y est transcluse (typiquement sa documentation). Une fois que le modèle dispose des données structurées ajoutées par un utilisateur, il peut être correctement édité via l'ÉditeurVisuel. Il ne faut pas s'effrayer du code à écrire dans la page des modèles, il est en fait très simple.



Syntaxe du TemplateData
La syntaxe du TemplateData est basé 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, n'importe où dans la sous-page de documentation, comme ceci :

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
Les descriptions dans les balises &lt;templatedata&gt; 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 :

Le résultat qui s'afficherait alors dans la documentation ressemble à ceci : {       "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.", "type": "string", "required": true }       } }



Description et paramètres
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ée de guillemets (excepté pour  et $flase), et séparées du texte par une virgule (à moins que le fragment d'information en question soit le dernier de la liste).



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

Par exemple,  pourrait aussi être écrit   ou.

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



Paramètres multiples
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 :



Paramètres similaires
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 fourni l'ensemble des informations pour le premier d'entre eux, et les autres pourront « hériter » leurs informations de celui-ci.



Limitations et questions

 * 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 un null edit sur la page du modèle lui-même (pas sur la sous-page de documentation). Pour effectuer un null edit, 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.



Outils

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — Un programme en javascript qui permet d'ajouter TemplateData plus facilement (actuellement présent uniquement en français).