Help:TemplateData/fr

Qu'est-ce que TemplateData ?
 est un moyen de stocker des informations au sujet d’un modèle wikitext et de ses paramètres, de manière à ce que l’éditeur visuel puisse les récupérer et les afficher dans son éditeur de modèles, rendant ainsi plus facile l’édition de pages qui utilisent 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 utilisateurs d'écrire de petits morceaux de données structurées dans une page de modèle, ou qu'il soit inclus dans une page de modèle (par exemple sur la page de documentation du modèle). Une fois qu'un modèle a ces données structurées, il peut être affiché correctement dans l'Éditeur Visuel. 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 manière plus 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 sont 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 NN 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 champ 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 du TemplateData l’entrée concernant le paramètre. Lorsque vous avez fini de documenter chacun des paramètres, cliquez sur « Appliquer » pour insérer le TemplateData pré-formaté dans le champ d’édition. Vous devez ensuite encore enregistrer la page en utilisant le bouton classique « Enregistrer » sous le champ d’édition.

Attention : l’éditeur TemplateData placera le TemplateData soit sur la page du modèle, soit sur sa sous-page de documentation. Vous déterminez l’endroit où le TemplateData sera ajouté en ouvrant (en éditant) la page où vous voulez que le TemplateData soit. Toutefois, si plusieurs blocs de TemplateData sont placés sur un même modèle, seul un de ces blocs de TemplateData sera utilisé. S’il y a déjà un TemplateData sur une page, alors vous devez éditer la page où le TemplateData a été ajouté précédemment pour éviter de créer accidentellement plusieurs blocs de TemplateData.

Limitations et questions

 * Fonctionnalités manquantes — TemplateData est vraiment un exemple d’outil qui a été créé avec de nouvelles fonctionnalités, dans l’espoir que les utilisateurs aideraient à guider le développement de fonctionnalités telles qu’ils le désirent. Si vous voulez demander de nouvelles fonctionnalités pour TemplateData, faites-le-nous savoir.
 * Retards dans l'affichage des modèles — Après que TemplateData ait été ajouté à un modèle, les métadonnées devraient être visibles immédiatement lorsque le modèle est ouvert dans l’éditeur visuel. Toutefois, il est possible que cela prenne plusieurs heures avant que les métadonnées ne soient affichées. Vous pouvez forcer la mise à jour en faisant une modification vide sur la page du modèle lui-même (pas la sous-page de documentation). Pour faire une modification vide, ouvrez la page du modèle en édition et enregistrez la page sans faire du tout de changements ni ajouter de résumé de modification.
 * Problèmes en cours — Une liste des bogues actuels et des demandes de fonctionnalités est disponible sur le gestionnaire de bugs Wikimedia.

Où est TemplateData
TemplateData doit être sur la page qu'il décrit, ou être inclus dedans. A l'intérieur d'un modèle, il doit typiquement être entouré de balises. Concernant le rendu d'une page normale, il affiche la documentation générées automatiquement comme indiqué dans #Example.

Structure des TemplateData
La structure TemplateData est basée sur le standard JSON. Notez que toutes les descriptions dans TemplateData doivent être en texte seul (pas de wikitexte, pas de liens, etc.).

La première chose à faire est de taper une paire de balises, n’importe où sur la sous-page de documentation, comme ceci :

Cela fait savoir au logiciel que tout ce qu’il y a entre ces deux balises sera TemplateData et que cela sera référencé lorsque le modèle sera utilisé.

Exemple
Les descriptions suivantes suivent un schéma standard ; supposons que vous avez un modèle appelé « Commons » pour créer un lien vers une catégorie de Commons à propos d’un sujet. Il prend un paramètre obligatoire : le nom de la catégorie sur Commons. Le TemplateData ressemblerait à quelque chose comme ça :

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

{   "description": "Un modèle pour créer un lien vers une catégorie Commons à propos d’un 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
Une fois que vous avez fini, cliquez sur « Enregistrer ». Si vous avez fait des erreurs, vous ne pourrez pas enregistrer (ce qui peut être troublant, mais garantit que vous ne pouvez rien casser). Si vous avez des erreurs, vous pouvez les expliquer sur la page des retours ce que vous essayez de faire, et nous serons heureux de vous aider.

Notez que toutes les informations sont entourées par des guillemets droits (") (sauf pour  et  ) et séparés du texte par une virgule (à moins que ce soit la dernière).

Alias de paramètre
Quelques modèles permettent qu’un même paramètre ait plusieurs noms différents.

Par exemple,  peut être écrit comme   ou.

Pour ajouter cette information dans TemplateData, vous devez simplement ajouter les alias dans les informations du paramètre :

Valeur automatique
Vous pouvez spécifier une « valeur automatique » pour un paramètre. Lorsque les utilisateurs ajoutent le modèle sur une page, cette valeur peut être ajoutée automatiquement. Par exemple, plusieurs modèles pour l’entretien des pages ont besoin que la date soit ajoutée ; si vous spécifiez une valeur automatique pour le paramètre date du modèle, alors la date sera complétée automatiquement.

Pour ajouter cette information dans TemplateData, ajoutez simplement la valeur automatique dans les informations du modèle. Il est possible que vous ayez besoin d’utiliser  pour faire que les valeurs soient permanentes :

Paramètres multiples
Si vous avez plusieurs paramètres, répétez simplement chaque section (en commençant au tag "1") et remplissez comme vous le désirez. Notez que si un modèle a plusieurs paramètres, vous devez les séparer par une virgule dans le TemplateData, comme ceci :

Paramètres similaires
Lorsqu’un modèle a plusieurs paramètres, il est possible que certains d’entre eux soient du même type. Dans ce cas, vous n’avez besoin de remplir les propriétés que pour le premier et leurs autres peuvent « hériter » des propriétés de celui-ci.

Structure vierge
Vous pouvez copier la structure vierge ci-dessous pour ajouter un nouveau TemplateData à un modèle. Seuls les tags les plus courants sont présents.

Autres outils

 * TemplateDataEditor — Un script utilisateur facilite le processus d’ajout de TemplateData. Il existe actuellement en français (contient des traductions en anglais, italien, japonais et coréen) et peut facilement être traduit dans d’autres langues.
 * TemplateData Wizard — Un outil qui génère un TemplateData grâce à une interface interactive.
 * Skeleton TemplateData generator — Un outil qui lit le wikicode source d’un modèle, essaye de trouver tous les paramètres utilisés et donne un squelette avec les paramètres listés.
 * JSONLint — Un outil qui vous permet de valider un JSON écrit à la main pour trouver les erreurs dans la syntaxe.
 * Liste de tous les modèles avec TemplateData sur ce wiki
 * Sur dewiki, avec TemplateData, les données du modèle sont affichées dans une boîte de dialogue et le modèle est ajouté dans une catégorie des modèles avec TemplateData.