Help:TemplateData/fr



Qu'est-ce que TemplateData ?
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
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é « » juste au dessus de la fenêtre d'édition: Cliquez sur ce bouton pour ouvrir l'outil graphique d'édition de TemplateData. 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 sera fournie à l'utilisateur. Le seul champ requis est le champ Nom (la première case 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 date. Si le modèle doit renvoyer une erreur lorsque le champ n'est pas rempli, marquez-le comme « 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.

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
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, 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 que vous voulez lier.", "default": "Category:CommonsRoot", "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é de guillemets anglais (sauf pour  et  ), 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
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 ajouter les alias aux informations relatives au paramètre :



Valeur automatique
On peut spécifier une valeur par défaut (champ « autovalue ») pour les paramètres. Lorsque le modèle est utilisé dans une page, cette valeur sera utilisée automatiquement. Par exemple, de nombreux modèles de maintenance ont besoin de disposer de la date ; si vous spécifiez une valeur par défaut pour le paramètre « date » de ces modèles, alors la date sera fournie automatiquement.

Pour ajouter cette information au TemplateData, ajoutez simplement le mot-clé autovalue aux informations du paramètre. L'utilisation de  peut simplifier la définition de la valeur pour ce champ :



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



Patron à copier
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.



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 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

 * TemplateDataEditor — Un script utilisateur qui simplifie l'ajout de TemplateData. Il existe actuellement en français, est traduit en anglais, italien, japonais, coréen, ... et peut facilement être traduit dans d'autres langues.
 * TemplateData Wizard — Un outil interactif qui génère un TemplateData.
 * Skeleton TemplateData generator — Un outil qui lit le wikicode d'un modèle, cherche les paramètres utilisés et produit un squelette de TemplateData avec tous les paramètres trouvés.
 * JSONLint — Un outil qui permet de valider du JSON écrit manuellement, afin de trouver les erreurs de syntaxe.
 * Liste de tous les modèles avec TemplateData sur ce wiki