Aide:TemplateData

From mediawiki.org
This page is a translated version of the page Help:TemplateData and the translation is 100% complete.
PD Note : si vous modifiez cette page, vous acceptez de placer votre contribution sous licence CC0. Plus d’informations sont disponibles sur les pages d’aide concernant le domaine public.
PD

TemplateData est une extension qui stocke les informations et les paramètres associés à un modèle de wikicode et les met à la disposition d'une interface d'édition qui peut les récupérer et les présenter dans un éditeur de modèles -- tout cela aide les utilisateurs à ajouter et à modifier des modèles sur les pages.

Depuis avril 2019 la fonctionnalité TemplateData fait partie de l'expérience utilisateur par défaut pour tous les utilisateurs de tous les wikis Wikimedia lorsqu'ils ajoutent un modèle, même pour les utilisateurs non enregistrés. A la fois l'Editeur de source et l'Editeur Visuel l'intègrent à leur manière, comme le font beaucoup de scripts, d'outils et de gadgets. Si vous souhaitez avoir cette fonctionnalité sur votre propre wiki, installez l' Extension:TemplateData .

Ajouter TemplateData à un modèle pour utiliser cette extension consiste à insérer simplement un petit bloc JSON (expliqué ci-dessous) dans la page de documentation du modèle. Vous pouvez le faire manuellement ou avec l'éditeur TemplateData, une interface utilisateur graphique à laquelle vous pouvez accéder aux pages « Modifier »/« Modifier le wikicode » d'un modèle sur les wikis ayant l'extension TemplateData installée. Les données JSON contiennent la liste des paramètres du modèle avec les informations sur chacun d'entre eux et sur le modèle global lui-même (voir ci-dessous pour les détails).

Les modèles qui ont des TemplateData affichent ces informations dans l'interface utilisateur quand un utilisateur ajoute le modèle. Dans certains cas, cela changera le comportement de l'éditeur lors de la modification ou l'insertion du modèle, facilitant grandement le parcours des étapes nécessaires pour ajouter ce modèle.

Historique

À l'origine, TemplateData a été développé début 2013 pour VisualEditor qui était en phase de test MediaWiki à l'époque. VisualEditor est l'interface d'édition principale pour les wikis Wikimedia, et TemplateData lui a permis d'avoir une interface plus utilisable pour l'ajout de modèles. Il a été officiellement supporté par VisualEditor immédiatement. Alors que VisualEditor était déployé sur les différents wikis Wikimedia majeurs en tant que fonctionnalité par défaut de 2013 à 2016, TemplateData a aussi été embarqué.

En décembre 2016, l'interface VisualEditor a été rendue disponible pour l'édition du code source en tant que fonctionnalité bêta. Cela a été appelé Éditeur de wikicode 2017 . Cela a amené les fonctionnalités de TemplateData à l'édition source pour la première fois.

En mars 2018, Sam Wilson a développé TemplateWizard , une extension graphique de l'éditeur de modèle pour l'éditeur de source par défaut de Wikimedia, WikiEditor (aussi connu comme l'éditeur wikitexte 2010), conçu pour faciliter l'ajout de modèles en utilisant les informations de TemplateData. En avril 2019, TemplateWizard est devenu une fonctionnalité par défaut de l'éditeur de wikitext 2010 sur tous les wikis Wikimedia. Cela signifiait que TemplateData faisait désormais partie par défaut de l'éditeur visuel et de l'éditeur source sur les wikis Wikimedia.

Ajouter ou modifier TemplateData

Pour ajouter ou modifier les TemplateData, allez d'abord sur la page du modèle « /Modèle:nom du modèle ».

Vérification de l'état actuel

Avant d'ajouter ou de modifier des TemplateData, vérifiez si le modèle a une sous-page de documentation. Ensuite vérifiez si le modèle contient déjà des TemplateData, et dans ce cas si elles sont placées dans la page du modèle ou dans sa sous-page de documentation.

Assurez-vous de vérifier qu'une sous-page existe. Si vous ajoutez des TemplateData dans la page principale du modèle alors qu'il existe une sous-page avec des TemplateData, les TemplateData de la page principale seront prioritaires sur celles de la sous-page.

Sous-page de documentation

Concernant les modèles et sur la plupart des wikis Wikimedia, il y a deux techniques pour enregistrer le manuel d'utilisation et les autres données comme les catégories, qui ne doivent pas être incluses dans la partie exécutable du modèle :

  • la plupart des modèles gardent leur mode d'emploi et les autres données n'appartenant pas au modèle lui-même dans une sous-page de documentation « /Modèle:Nom du modèle/doc ». Sur de telles pages, le modèle {{Documentation }} transclut le contenu entier de la sous-page /doc dans la page du modèle ce qui rend le code source du modèle, plus lisible.
    • Les modèles qui possèdent des sous-pages de documentation ont un titre comme « Test Template Info-Icon - Version (2).svg Documentation du modèle » suivi de liens comme « [voir] [modifier] [historique] et [purger] ».
  • quelques pages de modèles placent directement ces informations dans la page d'accueil du modèle. Dans ce cas, il s'agit du contenu qui suit {{Documentation|content= et qui est compris entre les balises ‎<noinclude>.

Sur des wikis différents, tout ceci peut apparaître différemment. Il est rare que la page d'accueil du modèle contienne encore la documentation même si vous avez tout coché; cela arrive quand un utilisateur a ajouté une page /doc avec un titre personnalisé entre « {{Documentation| » et « |content= » et a ensuite ajouté du contenu après « |content= ».

Vous pouvez aussi chercher une note en bas de la page similaire à « La documentation ci-dessus est transcluse de Modèle:NomDuModèle/doc ».

Modèles sans sous-page de documentation

Si un modèle n'a pas de sous-page de documentation, créez-la et placez-y la documentation du modèle (ou son point d'entrée). Vous pourrez ensuite ajouter TemplateData à cette sous-page de documentation.

Créer la sous page de documentation et déplacer le contenu de la documentation
Sur de nombreux wikis Wikimedia, vous ne pouvez créer une page que si vous êtes un utilisateur enregistré depuis un certain nombre de jours et que vous avez effectué un nombre minimum de modifications.

Pour créer la sous-page de documentation, cliquez sur « Modifier  » / «  Modifier le wikicode  » de la page d'accueil du modèle ; cherchez les balises ‎<noinclude> et leur contenu (habituellement en bas).

Cela devrait se présenter ainsi :

<noinclude>
{{Documentation|content=
== Usage ==

Information about usage.

== More example headings ==

More example contents

[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>

Vous pouvez également constater qu'il y a déjà des TemplateData. Si c'est le cas, cela ressemblera à :

<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Selectionnez tout ce qui suit « |content= » et jusqu'avant « ‎</noinclude> » puis copiez-le dans votre presse papier ou enregistrez-le dans un document temporaire. Supprimez « |content= », en ne laissant que :

<noinclude>
{{Documentation}}
</noinclude>

Enregistrez alors la page du modèle.

Maintenant, pour créer la nouvelle sous-page, regardez dans la barre d'adresse de votre navigateur et ajoutez /doc à la fin de l'URL. Cliquez sur ↵ Enter, puis choisissez l'option pour créer une nouvelle page.

Si ce wiki possède un modèle de notification {{Documentation subpage }}, ajoutez-le en haut de la nouvelle page. Vous souhaitez peut-être également ajouter d'autres modèles, tels qu'un lien {{Purge button }} ou {{Purge }} (s'il est pris en charge par le wiki en question). Voir m:Help:Template documentation pour d'autres informations.

Insérez le texte que vous avez coupé ou enregistré du texte précédent (sous la notice du modèle, si c'est le cas).

Encadrez les catégories avec des balises ‎<includeonly> afin qu'elles ne s'appliquent que sur la page d'accueil du modèle :

<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>

Beaucoup de wikis possèdent un modèle {{Sandbox other}}. Utilisez ce modèle ici s'il est possible que le modèle que vous modifiez existe dans une version bac à sable (située dans Template:NomDuModèle/sandbox) afin d'empêcher les catégories de s'appliquer à la page du bac à sable :

<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>

Publiez enfin la page.

Vous pouvez maintenant ajouter et modifier les TemplateData de la sous-page de documentation en utilisant les règles décrites ici.

Ajouter ou modifier les TemplateData sur la page principale du modèle

Si vous ne pouvez pas créer la page /doc, vous pouvez ajouter et modifier les TemplateData sur la page d'accueil du modèle en suivant les instructions décrites ici.

Si un modèle possède une sous-page de documentation, vérifiez à la fois la page d'accueil et la sous-page de documentation quant à la présence de TemplateData (balise ‎<templatedata> suivie d'un tableau encadré d'accolades : {}).

Par ailleurs l'extension TemplateData peut faire ce contrôle pour vous. Cliquez sur « Modifier » ou «  Modifier le wikicode  » sur chaque page. Si le modèle possède déja des TemplateData sur l'une des pages, vous verrez une notice jaune en haut de la page disant soit :

Veuillez noter : il y a déjà une section TemplateData sur la page liée « Modèle:'''NomDuModèle'''/doc ».

ou

Veuillez noter : il y a déjà une section TemplateData sur la page liée « Modèle:'''NomDuModèle''' ».

Si le modèle a des TemplateData sur la sous page de documentation

Si le modèle possède des TemplateData sur sa page de documentation, c'est celle-ci que vous devrez modifier. Pour faire cela cliquez sur « [edit]  » qui se trouve après le titre « Test Template Info-Icon - Version (2).svg Template documentation » (ou équivalent) ou si vous êtes déjà sur la page /doc, cliquez sur « Modifier » ou « Modifier le wikicode » en haut. Suivez les règles suivantes pour ajouter ou modifier les TemplateData.

Si le modèle possède des TemplateData sur sa page d'accueil

Si le modèle possède des TemplateData sur sa page d'accueil, vous avez encore une fois deux options :

  • Vous pouvez aller sur sa page de documentation. C'est l'option recommandée.
  • Ou vous pouvez les modifier sur la page d'accueil du modèle.

Déplacer les TemplateData vers la sous page de documentation

Pour faire cela cliquez sur « ‎<noinclude> » / « Modifier » de la page d'accueil du modèle et cherchez les balises ‎<templatedata> à l'intérieur des balises ‎<noinclude> . Ce qui devrait ressembler à quelque chose comme :

<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Exemple de paramètre",
            "description": "Exemple de description de paramètre",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Retirez du code simplement les balises ‎<templatedata> avec leur contenu, et enregistrez la page.

Ensuite, modifiez la sous-page de la documentation en cliquant sur [edit] qui se trouve après le titre Test Template Info-Icon - Version (2).svg Template documentation (ou équivalent).

Saisissez un titre, comme « TemplateData  » puis collez les TemplateData en-dessous.

Vous pouvez maintenant mettre à jour les TemplateData en vous appuyant sur les règles décrites ici.

Éditer TemplateData sur la page principale du modèle

Si vous ne souhaitez pas déplacer les TemplateData vers la page /doc , vous pouvez les modifer sur la page principale du modèle. Voir les méthodes sur la manière de modifier les TemplateData.

Si le modèle n'a pas encore de TemplateData mais a une sous page de documentation

Si le modèle ne possède pas encore de TemplateData, vous devez les ajouter sur la sous-page de documentation.

Pour faire cela cliquez sur « [edit]  » qui se trouve après le titre « Test Template Info-Icon - Version (2).svg Template documentation » (ou équivalent) ou si vous êtes déjà sur la page /doc, cliquez sur Modifier ou Modifier le wikicode en haut. Entrez un titre tel que TemplateData, puis ajoutez-les sous ce titre. Cette section explique comment ajouter les TemplateData.

Méthodes

Méthode de l'éditeur TemplateData

Ceci est une manière facile pour ajouter ou modifier les TemplateData, recommandée pour les utilisateurs moins expérimentés.

L'éditeur TemplateData est une interface graphique utilisateur pour ajouter et modifier TemplateData. Il fait partie de l'extension TemplateData, disponible sur toutes les pages des modèles (ou de la sous-page de documentation) en cliquant sur « Modifier » ou « Modifier le wikicode » .

Après avoir cliqué sur « Modifier » ou « Modifier le wikicode », un bouton apparaît au-dessus de la zone de modification et le titre de la page devient « Gérer TemplateData ».

Manage template documentation button for TemplateData 2014 fr.png

Cliquer sur ce bouton permet d'entrer dans l'éditeur de TemplateData. Si la page que vous éditez contient une section TemplateData, elle sera automatiquement affichée ici.

Une capture d'écran de l'outil d'édition TemplateData

Fonctionnalités de la fenêtre ci-dessus :

  • L'élément supérieur sélectionne la langue du texte de l'interface. Cela vous permet d'entrer le contenu textuel dans plusieurs langues, affiché aux utilisateurs en fonction des paramètres de leurs Préférences et non basé sur la langue du wiki; des wikis différents possèdent des bases de données de modèles complètement différentes. S'il n'existe pas de TemplateData par langue, l'interface ne propose à l'utilisateur que la langue propre au wiki mais les utilisateurs peuvent cliquer sur « Ajouter des traductions  » pour ajouter plus d'entrées. Le code de langue est affiché entre crochets à côté des paramètres sur lesquels il peut être appliqué, tels que les descriptions et les étiquettes.
  • L'élément suivant est la description du modèle. Il s'agit de la description globale; elle est affichée aux utilisateurs à différents endroits des éditeurs de modèle lors de l'ajout d'un modèle. Ce paramètre et ses actions sont détaillés ici.
  • Le troisième élément contrôle la mise en forme du wikicode du modèle. Ce paramètre détermine la manière dont le wikicode est affiché lorsque l'utilisateur clique sur « Appliquer » ; les deux possibilités principales sont "inline" (sur une même ligne) et "block" (sur des lignes séparées). Ce paramètre et ses actions sont détaillés ici.
Si l'utilisateur choisit « Personnalisation », il peut entrer le wikicode sous « Chaîne de format personnalisé » en suivant les règles décrites ici, afin de créer un affichage personnalisé pour le modèle quand l'utilisateur clique sur « Appliquer ».
  • Le quatrième élément configure les paramètres d'un modèle. Ce champ les affiche sous forme de liste s'ils ont déja été définis dans TemplateData. Si le code source du modèle spécifie des paramètres qui n'ont pas de TemplateData, un bouton « Ajouter 2 paramètres suggérés » apparait. L'éditeur extrait ces suggestions du code source du modèle en cherchant {{{parametername}}} ou {{{parametername|}}}. En cliquant sur « Ajouter 2 paramètres suggérés » vous ajouterez ces paramètres en utilisant leur nom tel qu'il est déclaré dans le code source. Une information en vert apparait aussi en haut, comme par exemple « 2 nouveaux paramètres ont été importés : nom des paramètres. » .
  • En bas de la fenêtre le bouton « Ajouter un paramètre » vous permet d'ajouter manuellement un paramètre avec son nom personnalisé.

Continuez jusqu'à l'étape suivante en cliquant sur n'importe quel paramètre de la liste. Ceci vous permet de modifier les informations associées à ce paramètre.

Capture d'écran de l'éditeur TemplateData montrant l'ajout d'un second paramètre

Toutes ces fonctions et leurs actions sont décrites dans cette section.

  • L'éditeur des TemplateData ne vous permet pas d'assigner un espace « Nom » à un paramètre. Les paramètres de TemplateData qui quelque fois reçoivent une chaîne vide comme nom ne créent pas de problème dans l'éditeur de wikicode 2010 avec TemplateWizard, et ni l'Editeur visuel ni l'éditeur de wikicode 2017 ne les afficheront. C'est le seul champ obligatoire de l'éditeur des TemplateData.
  • En cliquant sur « Supprimer le paramètre » vous supprimez de TemplateData, le paramètre avec toutes les informations qui lui sont associées. Vous ne pouvez pas revenir en arrière pour les récupérer ni annuler ceci à l'intérieur de TemplateData sauf si vous cliquez ensuite sur « X ». Vous pouvez annuler toute modification faite après « Appliquer » en cliquant sur Ctrl+Z.
  • La sortie de l'éditeur des TemplateData après avoir réalisé les modifications vous demande de confirmer l'annulation de vos modifications.

Lorsque vous avez terminé, cliquez sur « Supprimer le paramètre ». Ceci va automatiquement insérer les TemplateData en bas de la page, avant la balise ‎</noinclude>; ou, si elles sont déjà présentes, elles seront mises à jour avec les nouvelles informations sans en modifier la position. Le texte des TemplateData sera également sélectionné quand vous cliquerez sur « Supprimer le paramètre  ».

L'éditeur des TemplateData crée un paramètre "paramOrder" au bas de TemplateData (ou le met à jour s'il existe déjà). "paramOrder" contient les paramètres actuels de TemplateData dans l'ordre affiché par leur éditeur. Vous pouvez changer "paramOrder" en faisant glisser les paramètres vers le haut ou vers le bas dans l'éditeur des TemplateData en utilisant les trois barres horizontales de gauche. "paramOrder" et ses conséquences sont décrites ici.

Puis, cliquez sur « Enregistrer » pour enregistrer votre version de la page.

Méthode manuelle

Vous pouvez aussi ajouter ou modifier manuellement les TemplateData. TemplateData est écrit en JSON, mais vous n'avez pas besoin d'apprendre JSON pour savoir comment créer TemplateData. TemplateData suit quelques règles très simples et n'accepte qu'une petite douzaine de paramètres prédéfinis avec leur valeurs, typiquement en suivant un format "parameter": "value".

Ajouter TemplateData manuellement

Cas :

  • Si vous ajoutez les TemplateData à la sous-page de documentation d'un modèle (ce qui est recommandé), vous pouvez les ajouter n'importe où sur la page ; vérifiez si la Wikipedia de votre langue a un endroit préféré pour ces données. Par exemple, pour la Wikipedia anglophone, les TemplateData se trouvent typiquement en bas de la page de documentation ; par contre, sur la Wikipedia allemande, elles sont en haut.
  • Si vous ajoutez des TemplateData à la page d'accueil d'un modèle, ce qui (n'est pas recommandé; voir les vérifications initiales ici), vous devez vous assurer qu'elles sont encadrées avec des balises ‎<noinclude>...‎</noinclude>.

Cliquez sur « Modifier» ou « Modifier le wikicode » en fonction de la page, puis allez à l'endroit de la page où vous voulez ajouter les TemplateData et placez le titre : TemplateData.

Plusieurs wikis ont un modèle {{TemplateData header}} qui ajoute une courte notice concernant les TemplateData. Si c'est le cas avec votre wiki, ajoutez-la après le titre.

Pour commencer à ajouter les TemplateData, entrez une balise ‎<templatedata> ouvrante et fermante et une paire d'accolades sur de nouvelles lignes séparées par une ligne vide :

<templatedata>
{

}
</templatedata>

Puis créez une indentation sur la ligne vide entre les deux accolades et commencez à ajouter les paramètres. Le détail des paramètres est donné ici. La plupart sont facultatifs ; certains sont très recommandés.

Les paramètres peuvent être dans un ordre quelconque, mais suivent l'ordre qui se rapproche le mieux de la documentation des TemplateData rendant le contenu plus facile à utiliser pour les éditeurs :

<templatedata>
{
    "description": "",
    "format": "",
    "params": {
        "parameter1": {
            "aliases": ["",""]
            "label": "",
            "description": "",
            "type": ""
        }
    },
    "paramOrder": [
    	""
    ]
}
</templatedata>

Assurez-vous que les paramètres, par exemple dans l'objet "params", restent à l'intérieur de cet objet, sinon vous déclencherez une erreur "Propriété « properlyname » non attendue." lorsque vous tenterez d'enregistrer.

Exemple

Voici quelques exemples de TemplateData pour une réorganisation hypothétique d'un modèle. Un tel modèle est censé afficher une notice et placer la page dans une catégorie datée basée sur le mois et l'année de la saisie. Il est également possible que la notice contienne un lien vers une section de la page de discussion. Les TemplateData vont donc ressembler à ceci :

<templatedata>
{
	"description": "Utilisez ce modèle pour signaler qu'un article doit être réorganisé.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Mois et année",
			"description": "Mois et année au cours de laquelle le modèle a été ajouté",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "janvier 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Motif",
			"description": "Motif pour lequel l'article doit être réorganisé",
			"type": "string"
		},
		"talk": {
			"aliases": ["section de discussion"],
			"label": "Section de la page de discussion",
			"description": "Section de la page de discussion contenant la discussion correspondante",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

La documentation correspondante de TemplateData s'affiche ainsi :

Utilisez ce modèle pour signaler qu'un article doit être réorganisé.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
mois et annéedate

Mois et année au cours de laquelle le modèle a été ajouté

Example
janvier 2013
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringsuggested
Motifmotif 1

Motif pour lequel l'article doit être réorganisé

Stringoptional
Section de la page de discussiondiscussion section de discussion

Section de la page de discussion contenant la discussion correspondante

Stringoptional

Paramètres de TemplateData

Tous les paramètres TemplateData disponibles sont énumérés ci-dessous avec leur description et un exemple. Ils sont également répertoriés avec plus de détails techniques sur le format des TemplateData ici.

  • Ces informations sont à jour en novembre 2021 et peuvent changer si de nouveaux paramètres sont ajoutés ou si les interfaces d'édition des modèles sont mises à jour pour prendre en charge les paramètres existants ou traiter certains paramètres différemment.
  • La syntaxe wiki ne fonctionne pas dans les descriptions ni dans les étiquettes. Ce sont purement des chaînes de texte brut.
  • Les passages à la ligne (« \n ») dans les descriptions, les étiquettes, les exemples ou les valeurs par défaut n'apparaissent pas dans aucun des éditeurs principaux (TemplateWizard, l'Editeur visuel ou l'éditeur de wikicode 2017 wikitext), bien qu'ils apparaissent dans la documentation auto-générée des TemplateData. Ils sont remplacés par la chaîne vide dans les formulaires de saisie et ailleurs par un espace.
Paramètre Description Exemple
description

Le paramètre "description" décrit ce que fait le modèle. C'est optionnel mais fortement recommandé.

Actions

Sur la page de documentation du modèle, la description s'affichera en texte brut sous la section "Données du modèle [nom du modèle]".

Dans chaque éditeur principal (VisualEditor , le Éditeur de wikicode 2017 et le WikiEditor avec l'assistant de modèles), la description s'affiche dans deux instances principales :

  • Sous le nom du modèle dans chaque suggestion de recherche lorsqu'un utilisateur cherche un modèle
  • sous le nom du modèle dans l'éditeur de modèles, lorsque l'on ajoute des valeurs aux paramètres du modèle

Dans l'Editeur visuel et dans l'éditeur de wikicode 2017, les descriptions sont tronquées à 50 caractères environ sous chaque suggestion de recherche, et suivies par un « ... », mais la description est affichée entièrement dans la fenêtre principale de l'éditeur de modèles. Les deux apparaissent en texte grisé.

Dans la fenêtre principale de l'éditeur de modèle, les descriptions qui dépassent quatre lignes (soit environ 540 caractères) sont présentées en texte noir et avec un ascenseur séparé.

Si non spécifié

Si le paramètre de description n'existe pas ou qu'il n'est pas spécifié, le texte « Aucune description.  » sera affiché dans la documentation des TemplateData sous le sous-titre « Template data pour [NomDuModèle]  ». Et aussi :

  • Dans l'Editeur visuel et dans l'éditeur de wikicode 2017, cela se comporte comme si c'était un modèle qui n'aurait pas de TemplateData; au lieu d'avoir une description, on affiche le texte suivant :
« Le modèle « Template:NomDuModèle » n'a pas encore de description, mais la page du modèle peut contenir des informations. »
  • dans l'éditeur de wikicode 2010 avec le TemplateWizard, le texte suivant s'affiche à l'endroit de la description (sauf pour les suggestions de recherche) :
« Aucune description n’existe pour ce modèle. »
C'est différent des deux endroits standards prévus pour les descriptions dans le cas où les TemplateData sont absentes :
  • « Parce que les TemplateData sont absentes, les paramètres de ce modèle ont été générés automatiquement. Notez-bien qu'ils peuvent ne pas être à jour. »
  • « Aucun paramètre ne peut être déterminé pour ce modèle car il n'existe pas de documentation concernant les TemplateData. Vous pouvez ajouter le modèle sans paramètre. »
"description": "Un modèle pour créer un lien vers une catégorie de Commons",
format

La suivante est "format", qui indique comment le wikitexte du modèle sera inséré. Il peut s'agir des formats standards "inline" et "block", ou l'utilisateur peut saisir un ensemble de symboles wikitext pour créer un format personnalisé ; ces symboles et quelques exemples sont listés dans la section des formats personnalisés ici.

Ce paramètre n'est pas obligatoire mais il est recommandé. Le comportement par défaut lorsque ce paramètre n'existe pas est le format en mode ligne, sans notice d'information correspondante affichée dans la documentation des TemplateData sous l'entête du tableau.

Conséquences

En ligne :

Si le paramètre vaut "inline", le modèle affichera un avis correspondant à la préférence dans sa documentation TemplateData, sous le titre du tableau, "Paramètres du modèle" :

{{int|quotation-marks|[<translate>circles and pipes icon</translate>] {{int|templatedata-doc-format-inline}}}}

Lorsqu'il est ajouté, le modèle affiche ainsi son wikicode sur une seule ligne, sans espace entre les éléments :

{{Foo|bar=baz|qux=quux}}

Bloc :

Si le paramètre vaut "block", le modèle affichera l'avis de préférence suivant dans sa documentation TemplateData :

{{int|quotation-marks|[<translate>stacked blocks and pipes icon</translate>] [[int|templatedata-doc-format-block}}}}

Lorsque vous ajoutez ce modèle, il va distribuer chacun de ses paramètres sur une ligne distincte, avec un espace entre chaque élément, de la manière suivante :

{{Foo
| bar = baz
| qux = quux
}}

Formats personnalisés :

Notez aussi que si le paramètre est initialisé avec une chaîne wikicode personnalisée, conformément aux règles sur les formats personnalisés énoncées ici, le modèle affichera la notice des préférences dans la documentation de ses TemplateData :

"[<translate>cogwheel icon</translate>] {{int|templatedata-doc-format-custom}}"

Quand il sera ajouté, le modèle développera son wikicode au travers du wikicode indiqué.

"format": "inline"
params

L'objet "params" contient les informations pour chaque paramètre du modèle. Il est obligatoire, et ses paramètres peuvent être consultés dans cette section.

ll doit contenir le nom de chaque paramètre suivi d'un ensemble de sous-paramètres de Templatedata listés ici dans le paragraphe du non de paramètre.

S'il y a plusieurs paramètres, placez une virgule entre chaque objet paramètre, mais n'en ajoutez pas après la dernière accolade (voir exemple).

"params": {
    "parameter1": {
        ...    // informations sur le paramètre
    },      // notez la virgule ici
    "parameter2": {
        ...    // informations sur le paramètre
    },      // et ici
    "parameter3": {
        ...    // informations sur le paramètre
    }       // mais pas ici
}
paramOrder

L'objet "paramOrder" est facultatif et sert à afficher les paramètres du modèle dans un ordre donné lorsquils sont ajoutés dans l'éditeur de modèle.

Comment l'utiliser

Ajoutez le paramètre "paramOrder", suivi de deux-points, d'un espace et d'un crochet ouvrant, puis entrez le nom de chaque paramètre du modèle entre guillemets (") dans l'ordre souhaité, et séparés par des virgules. Terminez avec un crochet fermant (créant ainsi un tableau).

Il n'est pas utile que les paramètres soient sur des lignes séparées (on peut les écrire comme "paramOrder": ["param1","param2","param3"]), mais le fait de les écrire ainsi facilite souvent la lecture.

Nous vous recommandons de placer "paramOrder" après "params", comme le fait l'éditeur de TemplateData; ceci ne figure pas dans la documentation de TemplateData mais force simplement l'ordre des paramètres. Un éditeur prochain pourrait parcourir rapidement les détails des paramètres et les modifier plutôt que de revenir en arrière sur les "paramOrder", particulièrement si les paramètres sont trop nombreux. Si vous souhaitez placer paramOrder quelque part près de la fin des TemplateData, terminez-le avec une virgule.

Vous devez inclure chauqe paramètre mentionné dans les TemplateData; sinon une erreur Propriété « properlyname » obligatoire non trouvée." apparaîtra.

Si ce n'est pas défini

Sans "paramOrder", les paramètres du modèle s'affichent dans l'ordre dans lequel ls code source les a déclarés. Si celui-ci contient des objets à l'intérieur d'autres objets, les paramètres des objets externes arriveront en premier, suivis par ceux des objets internes.

Avec les autres paramètres

Dans l'éditeur de wikicode 2010 avec TemplateWizard :

  • les paramètres "required" apparaisssent toujours en haut, quelque soit l'ordre dans "paramOrder".
  • les paramètres "suggested" apparaîtront toujours en second, au-dessus des "optional" premiers.
  • les paramètres "deprecated" n'apparaîtront pas dans cet éditeur; voir la description de "deprecated" pour plus d'informations.
  • "paramOrder" ne fait que mettre en valeur l'ordre à l'intérieur des catégories (par exemple tous les paramètres "required" seront dans l'ordre spécifié par "paramOrder", ainsi que tous les paramètres "suggested", mais ces derniers apparaîtront en dessous des paramètres "required").

Dans l'Editeur visuel et l'éditeur de wikicode 2017, "paramOrder" force l'ordre quelque soit la valeur de chaque paramètre.

"paramOrder": [
	"date",
	"reason",
	"talk"
]

Parmi les paramètres

Paramètre Description Exemple
Nom du paramètre

Le seul élément de niveau un de l'objet params est le nom d'un paramètre du modèle.

Par exemple, dans le code source d'un modèle, {{{date}}} représente un paramètre, et il doit être ajouté sous "params" avec le nom "date".

Il est également possible de voir des paramètres appelés {{{1}}} ou un autre numéro (pour lequel le nom dans TemplateData est par exemple "1"). Les paramètres tels que celui-ci empêche les utilisateurs qui insèrent un modèle, de taper le nom du paramètre et le signe égal (comme |value| au lieu de |parametername=value|). Lorsque plusieurs paramètres non nommés existent, le numéro identifie le paramètre non nommé dont il s'agit. Par exemple, dans :

{{example template|value1|value2}}

value1 est la valeur du paramètre {{{1}}}, et value2 est la valeur du paramètre {{{2}}}. Décrivez respectivement les paramètres de votre TemplateData.

Notez-bien : un utilisateur peut toujours forcer l'utilisation de {{{2}}} sans {{{1}}} en insérant un paramètre appelé « 2 » dans l'éditeur de modèle ou en entrant « |2= » dans le wikicode. Enfin, notez que "aliases" crée des alternatives aux noms des paramètres qui peuvent être utilisées de manière interchangeable et "label" remplace le nom du paramètre dans l'interface utilisateur par le texte spécifié (dans les cas où le nom du paramètre n'est pas lisible par un humain ou facilement compréhensible).

Comment l'utiliser

Chacun de ces objets « Nom du paramètre » doit contenir toutes les informations concernant le paramètre sous la forme de paramètre supplémentaire TemplateData. Ils sont listés dans la section suivante.

"1": {     // nom du paramètre
    ...    // les informations sur ce paramètre viennent ici
}

Avec un nom de paramètre

Paramètre Description Exemple
aliases

Le paramètre facultatif "aliases" permet à un paramètre de modèle d'avoir plusieurs noms. Vous pouvez vérifier cela en allant dans le code source du modèle et rechercher :

{{{parameter1|{{{parameter2}}}}}}

ou

{{{parameter1|{{{parameter2|}}}}}}

Cela signifie que si l'utilisateur ajoute l'un quelconque de ces paramètres avec une valeur, il réalisera la même fonction. Litéralement équivaut à « Value of parameter1. Si parameter1 n'existe pas ou s'il a pour valeur : valeur de parameter2. » Dans le second cas, cela signifie également, Si parameter2 n'existe pas ou s'il a pour valeur : aucune valeur.

Pour insérer le paramètre "aliases", ajoutez le texte "aliases" suivi de deux-points, d'un espace et d'un crochet ouvrant, puis entrez le nom d'alias de chacun des paramètres entre guillemets et séparés par des virgules. Fermez avec un crochet fermant pour créer un tableau.

"aliases": ["1", "talk", "talksection"],
inherits

"inherits" est un paramètre optionnel utilisé lorsqu'un paramètre doit hériter de toutes les TemplateData d'un autre paramètre. Ceci peut ensuite être réécrasé par tout paramètre spécifié comme paramètre d'héritage.

Pour utiliser ce paramètre, entrez "inherits" : suivi d'un autre nom de paramètre de modèle, tel que "talk" ou "1". Vous pouvez ensuite entrer une autre valeur particulière pour initialiser le paramètre associé si vous le souhaitez, comme "label" : "A different label". Le premier paramètre héritera de toutes les propriétés du second paramètre sauf de celle-là.

    "params": {
        "sujet1": {
            "label": "Sujet",
            "description": "Un sujet mentionné sur cette page d’homonymie",
            "type": "string"
        },
        "sujet2": {
            "inherits": "sujet1"
        },
        "sujet3": {
            "inherits": "sujet1",
            "label" : "A different label"
        }
    }
label

Ensuite, nous avons "label", dans lequel vous pouvez indiquer pour le paramètre un titre lisible par un humain, qui sera affiché dans l’éditeur de modèle. L'étiquette est affichée à chaque fois à la place du nom brut du paramètre, même si un alias est utilisé dans le wikicode. Ce paramètre est optionnel mais très recommandé.

"label": "Mois et année",
description

A l'intérieur de chaque objet nommé après un paramètre, "description" est la description du paramètre, pas du modèle dans sa globalité. Cette description apparait sous le nom du paramètre (une longue description sera tronquée et un bouton la développera optionnellement). C'est facultatif mais hautement recommandé.

"description": "Le mois et l'année à laquelle le modèle a été inséré.",
type

Voir la section du paramètre Type.

default

Certains paramètres du modèle ont une valeur par défaut; celle-ci est utilisée à moins d'être redéfinie par l'utilisateur. L'élément "default" est optionnel, présent à titre documentaire seulement, sert à communiquer à l'utilisateur cette valeur par défaut. Il n'est pas utile que la valeur corresponde à la valeur actuelle par défaut (s'il y en a une) et n'a pas de conséquence fonctionnelle. (A ne pas confondre avec "autovalue", qui est un paramètre fonctionnel correspondant à un champ de l'utilisateur.)

Actions

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et le 2010 avec TemplateWizard), le texte "default" apparaît en gris dans la boîte de saisie de chaque paramètre ouvert lorsque celui-ci est vide, sous le format suivant "Default: texte par défaut ". En plus, il affichera la description du paramètre en simple texte noir (lorsque l'utilisateur survolera le symbole « i »). Dans l'Editeur visuel et l'éditeur de wikicode 2017 cela se trouve sous la description du paramètre, en dessous de « Champs obligatoire » / « Champs obsolète » s'il est spécifié (l'éditeur de wikicode 2010 n'affiche pas ce texte), et au-dessus de « exemple » s'il est spécifié ("example" n'apparait pas dans la description du paramètre dans l'éditeur de wikicode 2010). Dans l'éditeur de wikicode 2010 avec le TemplateWizard, le texte de "default" est affiché directement après la description du paramètre, sur la même ligne et précédé d'un espace. Il affiche dans le même format que les autres éditeurs ("Default: texte par défaut").

Avec d'autres paramètres

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et 2010 avec TemplateWizard), si "default" est spécifié, la valeur "example" ne s'affiche pas dans la boîte de saisie.

"default": "Category:CommonsRoot",
autovalue

Vous pouvez assigner "autovalue" à un paramètre. When a user adds the template to a page, this value will automatically appear in the input box. Par exemple, plusieurs modèles qui réorganisent ont besoin d'ajouter la date ; en initialisant "autovalue" à {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}} pour le paramètre date du modèle, le mois et l'année durant laquelle le modèle a été ajouté sera rempli automatiquement.

Cette valeur peut être modifiée par l'utilisateur dans l'éditeur de modèle.

Avec d'autres paramètres

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "autovalue" réécrase les effets visibles de "url" dans l'Editeur visuel et l'éditeur de wikicode 2017. Voir la description de "type" pour d'autres informations.

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example

Le paramètre "example" est facultatif et a un rôle documentaire uniquement; sa valeur contient un exemple qui aide l'utilisateur du modèle à comprendre la manière correcte de remplir le paramètre (à ne pas confondre avec "suggested"; voir ce sujet pour plus d'informations).

Conséquences

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), cette propriété est affichée sous la description du paramètre (et en-dessous du texte "default" s'il est spécifié).

Avec d'autres paramètres

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "example" ne s'affiche pas dans la boîte de saisie si « default » est spécifié.

"example": "January 2013",
required

Nous avons ensuite "required" (obligatoire), qui peut être positionné à true ou false. Si elle n'est pas spécifiée, la valeur par défaut est false.

Il détermine si le remplissage du paramètre donné est obligatoire pour le modèle.

Conséquences

Cet état a plusieurs conséquences sur l'Editeur Visuel et le Éditeur de wikicode 2017  :

  • il affiche le paramètre automatiquement lorsqu'un utilisateur ajoute le modèle;
  • il affiche un astérisque noir dans la boîte de saisie, sur la droite;
  • affiche le texte gris en italique « Le champ est obligatoire. » sous la description du paramètre;
  • cela fait apparaître la boîte d'entrée en rouge si l'utilisateur clique en dehors sans entrer de valeur ;
  • si un utilisateur essaie d'insérer un modèle sans donner de valeur pour le paramètre requis, un message apparaît pour lui demander s'il est certain de l'opération. Si c'est confirmé, le paramètre sera inséré avec une valeur vide. Cela ne les empêche pas d'insérer le modèle et ne provoque pas l'affichage d'une erreur visible en soi (bien que les modèles peuvent être programmés pour afficher une erreur lorsqu'un paramètre obligatoire n'est pas rempli).

Dans WikiEditor avec Aide:Extension:Assistant de modèle , tout comme avec les autres éditeurs, il affiche le paramètre automatiquement lorsqu'un utilisateur insère le modèle, mais le paramètre ne peut pas être supprimé avec aucun éditeur. Il n'affiche pas non plus « Le champ est obligatoire. » dans la description du paramètre mais il liste le paramètre sur le côté, sous « Paramètres obligatoires ». A part cela, le comportement général est le même qu'avec les autres éditeurs, sauf que l'invite indique que l'entrée « ne correspond pas au format attendu ».

Avec d'autres paramètres

Dans l'Editeur visuel et l'éditeur de wikicode 2017 l'état "deprecated" n'écrase pas la fonction de ce paramètre, mais dans l'éditeur de wikicode 2010 avec TemplateWizard il l'écrase. Voir la description de "deprecated" pour d'autres informations.

"required": true
suggested

Le paramètre "suggested" peut valoir true ou false. S'il n'est pas spécifié, la valeur par défaut est false.

Utilisez "suggested" pour les paramètres qui ne sont pas obligatoires mais que l'on recommande fortement aux utilisateurs de fournir. Lorsque ce paramètre est renseigné, l'utilisateur voit cette suggestion.

Conséquences

Dans l'Editeur visuel et le Éditeur de wikicode 2017 , cela fait que le paramètre s'affiche automatiquement lorsqu'un utilisateur insère un modèle. Si le paramètre possède une valeur automatique définie, elle figurera également dans sa boîte de saisie. Il n'a pas d'autre action et n'affiche pas de texte ni d'avertissements supplémentaires.

Avec le WikiEditor et TemplateWizard, on ne place pas le paramètre dans le modèle automatiquement mais à la place on l'affiche sur le côté, sous « Paramètres suggérés ». L'utilisateur peut ensuite cliquer sur « + » à côté du paramètre pour l'ajouter au modèle.

Avec d'autres paramètres

L'état "required" réécrase les fonctions de cet état dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010). Cela réécrase l'état affiché de "suggested" dans la documentation de TemplateData (on affiche "required" si à la fois "required" et "suggested" sont mis à true).

"suggested": true
deprecated

Enfin vient "deprecated" (usage déconseillé), qui peut être positionné à true, false ou à une chaîne de caractères décrivant ce que les utilisateurs devraient faire à la place. Si vous ne le spécifiez pas, la valeur par défaut est false.

Cet état concerne les paramètres qui ne doivent plus être utilisés, mais qui continuent d’exister pour le moment. Cela pourrait être parce que l'utilisation du modèle est en train de basculer d'un jeu de paramètres à un autre.

Conséquences

L'action de ce paramètre dans l'Editeur visuel et dans l'éditeur de code 2017 est d'afficher un point d'exclamation gris après l'étiquette du paramètre lorsqu'il est inséré, et dans la bulle d'information du paramètre, d'afficher sous la description du paramètre, le texte suivant « Le champ est obsolète. motif de l'obsolescence » en italiques grises. Il n'impacte pas la fonction ou l'utilisation du paramètre et n'affiche pas d'avertissements supplémentaires.

En dépit du fait qu'il peut accepter une chaîne de caractères, depuis janvier 2020 aucun éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010) n'affiche le contenu de cette chaîne quelque part aux utilisateurs. Entrer une chaîne de caractères a le même effet que true.

Dans l'éditeur de wikicode 2010 avec TemplateWizard, la valeur true empêche le paramètre d'être ajouté et affiché.

Avec les autres paramètres

Si vous mettez à la fois ceci à true en même temps que "suggested", l'état du paramètre va indiquer "deprecated" dans la documentation des TemplateData, mais dans l'Editeur visuel et l'éditeur de wikicode 2017 les deux fonctions seront gardées; le paramètre apparaîtra automatiquement lorsque l'utilisateur va insérer le modèle, mais sera accompagné des avertissements "deprecated".

Si vous mettez à la fois ceci à true en même temps que "required", l'état du paramètre va indiquer "deprecated" dans la documentation des TemplateData, mais dans l'Editeur visuel et l'éditeur de wikicode 2017 la fonction sera la même et ce sera celle de "required"; le paramètre apparaîtra automatiquement lorsque l'utilisateur va insérer le modèle, mais sera accompagné des avertissements "required". C'est la même chose que lorsque vous initialisez "deprecated", "suggested" et "required" avec true.

Dans l'éditeur de wikicode 2010 avec TemplateWizard, "deprecated" réécrase les paramètres "required" et "suggested".

"deprecated": "Utilisez 'publicationDate' à la place."
valeurs suggérées

La propriété de paramètre suggestedvalues vous permet de définir une liste des valeurs du paramètre affichées dans l'Editeur visuel de l'utilisateur sous la forme d'un menu déroulant pour permettre la sélection. Ceci peut être fait soit directement en JSON, soit en utilisant l'éditeur de TemplateData (sans écrire de code). Vous pouvez ajouter des valeurs suggérées à afficher dans l'Editeur visuel pour les paramètres qui ont leur type initialisé à l'une des valeurs suivantes (référence) :

  • content
  • line
  • string
  • number
  • unknown
  • unbalanced wikitext

Les autres types (file, page, template, user, date, boolean, URL) ne sont pas actuellement pris en charge car ils ont déjà des fonctionnalités spéciales dans l'Editeur visuel, comme l'autocomplétion, qui interférerait avec le menu déroulant pour les valeurs suggérées dans l'Editeur visuel.

Modifier le JSON des TemplateData du wikicode

Pour ajouter les valeurs suggérées à n'importe quel type de paramètre, ajoutez la nouvelle propriété "suggestedvalues" au paramètre en JSON. L'attribut “suggestedvalues” doit être une liste de chaînes de caractères.

Mise à jour des TemplateData avec l'éditeur de TemplateData

  1. Cliquez sur « Gérer TemplateData ».
  2. Cliquez sur le nom du paramètre auquel vous voulez ajouter les valeurs suggérées.
  3. Si ce n'est pas déjà fait, mettez le type du paramètre à l'une des valeurs suivantes : content, line, string, number, unknown, unbalanced wikitext. Un nouveau champs de saisie « Valeurs suggérées » apparaîtra. Si le paramètre correspond déjà à l'une des valeurs de ce type, le champs de saisie doit déjà être visible.
  4. Entrez la ou les valeurs suggérées, y compris les espaces et les caractères spéciaux, et appuyez sur la touche Entrée pour les ajouter à la liste.

Effects

Une fois que les valeurs ont été ajoutées à TemplateData, l'Editeur visuel va les afficher dans une combo box (une liste déroulante dans laquelle les utilisateurs peuvent aussi entrer une valeur personnalisée) pour les types du paramètre listés au-dessus. L'utilisateur sélectionne la valeur choisie en cliquant dessus. Si la liste des valeurs est longue -- par exemple une liste d'états qui composent un pays -- l'utilisateur peut taper les premières lettres dans le champs, à la suite de quoi la liste sera filtrée pour aficher uniquement les valeurs qui contiennent le texte tapé. Pour modifier la valeur entrée, il faut simplement effacer le champs et la liste déroulante complète sera affichée à nouveau. Si l'utilisateur a besoin d'une valeur qui n'appartient pas à la liste (par exemple, « message personnel » ) il peut la saisir manuellement.

	"suggestedvalues": [
		"Journal",
		"Livre",
		"Journal",
		"Magazine"
	]

Notez-bien que si ni "required", ni "suggested" ni "deprecated" ne sont mis à true pour un paramètre, son état sera affiché comme "optional" de la documentation de TemplateData.

Une fois que vous avez terminé, appuyez sur "Enregistrer". Si vous avez fait des erreurs, vous ne pourrez pas sauvegarder (ce qui est perturbant mais signifie que vous ne pouvez rien casser). Si vous rencontrez des erreurs, expliquez sur la page des commentaires de l'Editeur visuel ce que vous avez essayé de faire, et nous serons heureux de vous aider.

Signalons que si vous abusez d’un modèle astucieux pour générer dynamiquement les TemplateData, il ne pourra pas y avoir de vérification des erreurs avant la sauvegarde.

Notez que chaque information est entourée par des guillemets (") (sauf pour true et false), et séparée de la suivante par une virgule (sauf pour la dernière).

Paramètre de type

Le paramètre "type" signale à l'éditeur de modèles la nature de la valeur d'un paramètre. Dans certains cas, les éditeurs de modèles ont été programmés pour modifier l'interface utilisateur pour un paramètre donné en fonction de sa valeur dans les TemplateData, simplement pour permettre à l'utilisateur d'entrer des valeurs valides correspondant au type. Ce paramètre n'a pas de conséquence sur le paramètre du modèle ni sur sa valeur; il contrôle simplement la manière dont les éditeurs de modèles voient et traitent le paramètre en mode édition.

Comment l'utiliser

Est utilisé en ajoutant le paramètre "type", suivi par deux-points et un espace, puis en ajoutant toute valeur listée dans la table ci-dessous encadrée de guillemets.

Exemple :

"type": "string",

Actions

Depuis février 2020, seuls 5 des 13 valeurs de type ont un effet visible dans l'Editeur visuel et l'éditeur de wikicode 2017, alors que 8 d'entre-eux ont des effets visibles dans le TemplateWizard.

Il est possible que les actions de certaines valeurs puissent changer avec la mise à jour des éditeurs de modèles qui les prennent en charge. Un exemple d'effort pour l'Editeur visuel et pour l'éditeur de wikicode 2017 est suivi dans la tâche Phabricator T55613. Un effort similaire pour obtenir que TemplateWizard prenne en charge les valeurs booléennes est suivi dans T200664.

Les effets actuellement connus sont listés ci-après.

Valeur Description
unknown

"unknown" est la valeur du type par défaut utilisée quand le type n'est pas indiqué. On peut aussi le déclarer manuellement en saisissant "type": "unknown".

Actions

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "unknown" n'a pas d'effet visible comparé à un modèle sans TemplateWizard.

number

La valeur "number" sert pour les valeurs numériques, y compris pour les valeurs négatives et décimales.

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "number" n'a pas d'effet visible.
  • Dans l'editeur de wikicode 2010 avec TemplateWizard, "number" fait que la boîte de saisie affiche un bouton « + » et « - » de chaque côté, ce qui permet d'augmenter ou de diminuer la valeur d'un nombre dans la boîte de saisie, et obliger l'utilisateur à n'entrer que des chiffres. Les boutons permettent aussi d'atteindre les valeurs numériques négatives.

Avec d'autres paramètres

  • Dans l'éditeur de wikicode 2010 avec TemplateWizard, "number" réécrase l'action de "autovalue"; la valeur de "autovalue" ne sera pas automatiquement placée dans la boîte de saisie si le type du paramètre est "number".
string

La valeur "string" est utilisée pour toute chaîne de texte brut.

Actions

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "string" n'a pas d'effet visible comparé à "unknown".

line

La valeur "line" est utilisée pour un contenu qui doit rester sur une ligne.

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "line" empêche d'entrer de nouvelles lignes dans la boîte de saisie du paramètre, ce qui est généralement possible avec ces éditeurs.
  • Dans l'éditeur de wikicode 2010 avec le TemplateWizard, "line" n'a pas d'effet visible (par défaut les boîtes de saisie ne permettent pas de passer à la ligne dans cet éditeur).
boolean

La valeur "boolean" est utilisée pour une valeur qui est soit vraie, fausse ou inconnue. Le manuel indique qu'elle sera représentée par un 1, 0 ou une valeur vide.

Actions

Comme depuis février 2020, aucun éditeur principal de Wikimedia (parmi le VisualEditor, l'éditeur de wikicode 2017 ou celui de 2010 avec TemplateWizard) n'utilisent cette valeur. Il n'a pas d'effet visible.

Avec autovalue:0 une case à cocher apparaît dans l'Editeur Visuel qui peut être activé ou désactivé.

date

La valeur "date" sert aux dates de format AAAA-MM-JJ (ISO 8601) ; par exemple 2014-05-22. Le manuel de TemplateData la désigne également pour représenter l'association date-heure en ISO 8601, comme «  2014-05-22T16:01:12Z  », mais en pratique aucun interface d'édition majeur depuis février 2020 ne l'utilise de cette manière, et presque tous les paramètres de la majorité des modèles Wikimedia récupèrent les dates et les heures de manière séparée.

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "date" n'a pas d'effet visible.
  • Dans l'éditeur de wikicode 2010 avec TemplateWizard, "date" raccourcit la boîte de saisie du paramètre d'environ un tiers de sa largeur en ajoutant un calendrier déroulant, ce qui permet à l'utilisateur d'entrer une date en la sélectionnant. Il affiche également le texte de l'exemple en gris dans la boîte de saisie « AAAA-MM-JJ ».

Si une entrée ne correspond pas à ce format, la boîte s'affiche en rouge, mais l'éditeur affichera toujours une date conforme au format (si vous entrez des nombres) ou rien du tout (si vous n'entrez que du texte ou rien du tout).

Avec d'autres paramètres

  • Dans l'éditeur de wikicode 2010 avec TemplateWizard, "date" réécrase l'action de "autovalue"; la valeur de "autovalue" ne sera pas automatiquement placée dans la boîte de saisie si le type du paramètre est "date".
url

La valeur "url" est utilisée pour les URLs, en leur ajoutant le protocole Internet (tel que « https:// » ou « // »).

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "url" affiche une icône de lien externe à gauche, dans la boîte de saisie et la met en rouge lorsque l'utilisateur clique ailleurs sans entrer d'URL valide avec son protocole Internet valide (tel que « https:// » , « ftp:// » ou « // ») suivi d'un texte. Cette seconde action est similaire à celle du paramètre « required  », mais elle n'avertit pas l'utilisateur s'il essaie d'insérer le modèle sans URL valide. Cela se produit également dès que l'on met à jour un état (comme « suggested" » ou « deprecated »).
  • Dans l'éditeur de wikicode 2010 avec le TemplateWizard, "url" n'a pas d'effet visible.

Avec d'autres paramètres

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "autovalue" réécrase l'action visible de "url" : si les deux sont positionnés, la boîte de saisie ne contient pas d'icône d'URL et ne devient pas rouge lorsque l'utilisateur clique ailleurs sans entrer d'URL valide.
wiki-page-name

La valeur "wiki-page-name" est utilisée pour le nom d'une page de wiki.

Actions

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "wiki-page-name" fait que la boîte de saisie affiche un menu déroulant de suggestions contenant une liste de pages du wiki, telles que les articles de Wikipedia pour en faire la sélection. Les espaces de noms peuvent également être définis dans la recherche. En plus, dans l'Editeur visuel et dans l'éditeur de wikicode 2017, cela force la boîte de saisie à n'occuper qu'une seule ligne. Il n'a pas d'autre effet visible et n'empêche pas d'entrer autre chose qu'une page.

wiki-file-name

La valeur "wiki-file-name" est utilisée pour le nom d'un fichier hébergé soit localement sur un wiki, soit sur Wikimedia Commons.

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "wiki-file-name" n'a pas d'effet visible.
  • Dans l'éditeur de wikicode 2010 avec TemplateWizard, "wiki-file-name" affiche dans la boîte de saisie du paramètre un menu déroulant de suggestions contenant une liste de fichiers locaux avec ceux de Wikimedia Commons pour en faire la sélection. Les noms de fichier ne contiennent pas le préfixe de l'espace de noms « File: ». Le menu déroulant affiche aussi la vignette des fichiers. Il n'a pas d'autre effet visible et n'empêche pas d'entrer autre chose qu'un fichier.
wiki-template-name

La valeur "wiki-template-name" est utilisée pour le nom du modèle.

Actions

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "wiki-template-name" fait que la boîte de saisie affiche un menu déroulant de suggestions contenant une liste de modèles pour en faire la sélection. En plus, dans l'Editeur visuel et dans l'éditeur de wikicode 2017, cela force la boîte de saisie à n'occuper qu'une seule ligne. Il n'a pas d'autre effet visible et n'empêche pas d'entrer autre chose qu'un modèle.

wiki-user-name

La valeur "wiki-user-name" est supposée être un nom d'utilisateur du wiki.

Actions

Dans chaque éditeur principal (Editeur visuel, éditeur de wikicode 2017 et celui de 2010 avec TemplateWizard), "wiki-user-name" fait que la boîte de saisie affiche un menu déroulant de suggestions contenant une liste de noms d'utilisateurs pour en faire la sélection. En plus, dans l'Editeur visuel et dans l'éditeur de wikicode 2017, cela force la boîte de saisie à n'occuper qu'une seule ligne. Il n'a pas d'autre effet visible et n'empêche pas d'entrer autre chose qu'un nom d'utilisateur.

content

La valeur "content" sert au wikicode du contenu de la page, par exemple les liens, les images ou la mise en forme du texte.

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "content" n'a pas d'effet visible.
  • Dans l'éditeur de wikicode 2010 avec TemplateWizard, "content" augmente la hauteur de la boîte de saisie du paramètre d'une ligne et autorise les nouvelles lignes, ce que les boîtes de saisie habituelles de l'éditeur de wikicode 2010 ne permettent pas.
unbalanced-wikitext

La valeur "unbalanced-wikitext" sert au wikicode qui n'est pas autonome par exemple il lui manque une balise ouvrante ou fermante ou bien il fait référence à d'autres parties de wikicode.

Actions

  • Dans l'Editeur visuel et l'éditeur de wikicode 2017, "unbalanced-wikitext" n'a pas d'effet visible.
  • Dans l'éditeur de wikicode 2010 avec TemplateWizard, "unbalanced-wikitext" diminue la hauteur de la boîte de saisie du paramètre d'une ligne et autorise les nouvelles lignes, ce que les boîtes de saisie habituelles de l'éditeur de wikicode 2010 ne permettent pas.

Formats personnalisés

Lorsque vous modifiez la valeur "format", vous créez les formats personnalisés en entrant un ensemble de symboles wikicode et en utilisant les règles prédéfinies.

  • {{ - début du modèle
  • _ - contenu (comme, chaîne, entier ou paramètre). Ce caractère souligné sert à indiquer la longueur minimale d'une valeur en nombre de caractères et peut être répété, comme _______. Si cette longueur n'est pas atteinte, les caractères restants sont remplacés par des espaces. Ceci peut être utilisé pour aligner tous les signes égal sur une position spécifique après un paramètre (dans le cas où on utilise \n pour de nouvelles lignes).
  • | - pipe (barre verticale qui sépare les paramètres)
  • = - signe égal (précède la valeur d'un paramètre)
  • \n ou presser la touche Entrée - passe à la ligne suivante (sera affiché en tant que dans le champs de saisie)
  • - espace (peut être utilisé avec \n pour indenter les nouvelles lignes)
  • }} - fin du modèle

Le wikicode doit valoir au minimum {{_|_=_}}, sinon vous recevrez un message d'erreur concernant un format non valide.

Exemples de formats que vous pouvez utiliser
Objectif Chaîne de format Rendu
Formatage en ligne {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Formatage en bloc {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar}}
Pas d’espace avant le nom du paramètre,

chaque modèle sur sa propre ligne

\n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar}}
Indenter chaque paramètre {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar}}
Aligner tous les noms de paramètres à une longueur donnée {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar}}
Les caractères barre verticale mis à la fin de la ligne précédente {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Style en ligne avec plus d’espaces, doit être au début de la ligne. \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Modèle au début de la ligne, paramètres indentés et alignés, barre verticale sur la ligne précédente. \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

Structure vierge

Vous pouvez copier la structure vierge ci-dessous pour ajouter un nouveau TemplateData à un modèle. Seules les étiquettes les plus courantes sont incluses.

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Erreurs

Erreur de syntaxe dans JSON. / Bad JSON format (Erreur syntaxique JSON / Mauvais format JSON)

Ces erreurs apparaissent lorsque vous sauvegardez TemplateData, souvent modifié manuellement, avec du code JSON présent non valide (clés ou paramètres dupliqués, virgules absentes ou en trop, etc...) dans l'Editeur Visuel ou l'éditeur de wikicode 2017.

"Erreur de syntaxe dans JSON." apparaît dans VisualEditor et l'éditeur wikitext 2017 ; "Bad JSON format" apparaît lors de l'édition avec l'éditeur de l'interface utilisateur de TemplateData.

Ces erreurs peuvent être difficiles à détecter et revêtent des formes différentes dans les listes. La meilleure manière pour les éviter est de modifier les données du modèle exclusivement avec l'éditeur de TemplateData; la meilleure manière de les détecter une fois qu'elles sont apparues est d'utiliser un valideur JSON externe, tel que JSONLint, qui mettra en évidence les erreurs et vous aidera a les corriger.

L'éditeur de wikicode 2010 ne vérifie pas le code JSON non valide grâce à un ancien bogue pas encore corrigé (tâche T128029). Les pages contenant du code JSON non valide affichent des messages d'alarme « Erreur interne ». Pour corriger ces erreurs, le plus simple est d'utiliser un valideur de code JSON (voir ci-dessus).

Required property "paramOrder(number)" not found. (La propriété requise "ParamOrder(number)" n'a pas été trouvée)

Cette erreur apparaît si vous utilisez un paramètre dans "params" qui n'est pas utilisé dans "paramOrder". Le numéro entre crochets fait référence au paramètre de "paramOrder" qui manque. Il s'agit de son ordre dans la séquence et correspond à la position moins 1, car "paramOrder" est un tableau; 0 est le premier index, 1 le second, etc.

"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- Ce paramètre n'est pas évoqué dans "paramOrder", mais il le devrait.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Erreur: Required property "paramOrder[2]" not found. (la propriété   n'existe pas)

Pour corriger cela, vérifiez que tous les paramètres utilisés dans "params" sont listés dans "paramOrder". Vous pouvez aussi supprimer l'objet "paramOrder" pour supprimer cette erreur.

Invalid value for property "paramOrder(number)". (Valeur incorrecte de la propriété "paramOrder(numéro)").

Cette erreur apparaît si vous utilisez un paramètre dans "paramOrder" qui n'est pas utilisé dans "params". Le numéro entre crochets fait référence au paramètre de "paramOrder" qui ne doit pas être là. Il s'agit de son ordre dans la séquence et correspond à la position moins 1, car "paramOrder" est un tableau; 0 est le premier index, 1 le second, etc.

"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- Ce paramètre n'est pas évoqué dans "params", mais il le devrait.
    "talk"
]

// Erreur : valeur non valide pour la propriété «  paramOrder[1] ».

Pour corriger ceci, assurez vous que tous les paramètres présents dans "paramOrder" sont listés dans "params". Vous pouvez également supprimer l'objet "paramOrder" pour éliminer cette erreur.

Property "params.parametername.required" is expected to be of type ""boolean"". (La propriété "params.parametername.required" doit être de type ""boolean"".)

Cette erreur se produit lorsque vous mettez des guillemets autour de la valeur de "required" ou de "suggested".

"suggested": "true" // <-- Ces guillemets ne doivent pas être ici.

Ce sont des valeurs booléennes et non des chaînes de caractères; c'est pourquoi elles n'ont pas besoin de guillemets. Pour corriger cela, supprimez les guillemets autour des valeurs true ou false pour ces paramètres.

Property "format" is expected to be ... (La propriété "format" est normalement...)

Si le paramètre "format" existe et que sa valeur n'est ni "inline", ni "block", ni une chaîne de format valide, le message d'erreur « La propriété « format » doit être « inline », « block » ou une chaîne de format valide. » est affiché.

"format": "notinline"

// Erreur : la propriété « format  » suppose valoir « inline  », « block  », ou tout autre chaîne au format valide.

Pour corriger cela, vérifiez que la valeur après "format": est égale à "inline" ou "block" et qu'il n'y a pas de fautes d'orthographe. Egalement, si c'est du wikicode, vous povez vérifier qu'il contient un minimum de {{_|_=_}} et qu'il n'y a pas d'erreur de syntaxe qui pourrait faire échouer un modèle, comme deux fois le signe égal, ou des crochets absents ou en double; voir la section des formats personnalisés pour la syntaxe des formats correspondants. Vous pouvez également supprimer le paramètre "format" pour faire disparaître cette erreur.

Unexpected property "parametername". (Propriété inattendue "NomDuParamètre".)

Cette erreur apparaît lorsque vous utilisez un paramètres qui n'est pas dans les TemplateData. Ceci est probablement du à des erreurs d'orthographe.

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- erreur d'orthographe
            "type": ""
        }
    }
}
</templatedata>

Cela se produit aussi si vous utilisez le paramètre de n'importe quel objet TemplateData qui n'est pas un parametre de cet objet même. Il peut s'agit d'une erreur d'orthographe, ou vous avez écrit le paramètre d'un objet TemplateData sous un autre objet auquel il n'appartient pas.

Par exemple, il est possible que vous ayez déclaré le paramètre "label" à la racine de l'objet TemplateData au lieu de le mettre à l'intérieur de "params" :

<templatedata>
{
    "description": "",
    "format": "inline",
    "label": "", // <-- paramètre mal positionné
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

De manière similaire, si le paramètre inattendu se trouve sous un paramètre du modèle à l'intérieur de "params", vous verrez son nom après "params.NomDuParamètre." dans l'erreur.

Pour corrigez cela, vérifiez qu'ils n'y a pas de fautes d'orthographe dans les noms des paramètres, et vérifiez aussi que ces paramètres sont positionnés correctement. Assurez-vous aussi que vous n'utilisez aucun paramètre en dehors de ceux déclarés dans l'objet TemplateData. Vous pouvez voir les paramètres existants pour un objet dans la section Paramètres des TemplateData.

Required property "params" not found. (La propriété requise "params" n'a pas été trouvée.)

Cette erreur (Propriété "params" demandée mais non trouvée) apparaît quand il n'existe pas d'objet "params" dans les TemplateData. Ceci est un objet nécessaire, car il contient tous les détails de chaque paramètre, donc pour corriger cette erreur, assurez-vous qu'il est bien ajouté et qu'il n'y a pas de fautes d'orthographe. Voir la section ci-dessus sur la manière d'ajouter le paramètre "params".

Limitations et avis

  • Fonctionnalités manquantes – TemplateData est vraiment un exemple d’outil qui a été créé avec de peu de 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 a é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 aucun changement 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.

Autres outils

Aide:Extension:Assistant de modèle
Une fenêtre de dialogue de la barre d'outils pour entrer le code wiki du modèle via un formulaire construit à partir de TemplateData.
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.