Aide:TemplateData

This page is a translated version of the page Help:TemplateData and the translation is 30% complete.
Outdated translations are marked like this.
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 permettant de stocker des informations au sujet d’un modèle wikitext et de ses paramètres, de manière à ce qu'une interface d'édition puisse les récupérer et les afficher dans son éditeur de modèles, rendant ainsi plus facile pour les utilisateurs l’ajout et la modification de modèles dans 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 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 sur les pages « Modifier »/« Modifier le wikicode » d'un modèle sur les wikis avec l'extension TemplateData installée. Les données JSON contiennent une liste de paramètres avec des informations sur chaque paramètre du modèle et le modèle lui-même.

Quand un modèle a des TemplateData, les informations sont affichées quand un utilisateur ajoute le modèle, parfois à la place de l'information d'origine, parfois comme information supplémentaire. Dans certains cas, cela peut changer le comportement de l'éditeur lors de la modification ou l'insertion du 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 sur la page du modèle "/Modèle:nom du modèle".

Vérification de l'état actuel

Before adding or editing TemplateData, check whether the template has a documentation subpage. Then check whether the template already contains TemplateData and, if so, whether it's located on the template page or the documentation subpage.

Be sure to check whether a subpage exists. If you add TemplateData to a template's main page while a subpage exists with TemplateData, the TemplateData in the main page will override the data on the subpage.

Sous-pages de documentation

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

  • la plupart utilise une page de documentation.

Alors le modèle {{Documentation}} transclut la sous-page /Documentation dans la page du modèle. Cela rend le code source nettement plus lisible.

    • Vous pouvez rapidement identifier si un modèle a une page /doc en vérifiant si le titre de la «   Documentation du modèle » (ou équivalent) a des liens comme « [view] [edit] [history] [purge] » à suivre.
  • une petite minorité enregistre directement ces informations sur la page principale, après le code source.

Dans ce cas, c'est contenu après {{Documentation|content=, quii est entre tags ‎<noinclude>.

Different wikis may present all this differently. Rarement, la page principale du modèle a toujours le contenu de sa documentation, même si vous voyez ces boutons et qu'il y a une page /doc. 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= ».

Une méthode légèrement plus fiable pour vérifier est de regarder si la note "La documentation si dessus est issue de la sous page de documentation du modèle" (ou équivalent), dans la boite en bas de la page.

Modèles sans sous-pages de documentation

If a template doesn't have a documentation subpage, create it and move the template's documentation there (or a placeholder for it). Then you can add TemplateData to the documentation subpage.

Créer la sous page de documentation et déplacer le contenu de la documentation
On many Wikimedia wikis, you can only create a page if you have been a registered user there for a number of days and have made a minimum number of edits.

To create the documentation subpage, click "Modifier"/"Modifier le wikicode" on the main template page; look for the ‎<noinclude> tags and their contents (usually at the bottom).

It should look something like this:

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

Information about usage.

== More example headings ==

More example contents

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

You may also find that it already contains TemplateData. If so, it will look something like this:

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

Select everything after "|content=" and before "‎</noinclude>" and cut it into your clipboard or save it in a temporary document. Delete "|content=", leaving only the following:

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

Save the template page.

Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press ↵ Enter, then choose the option to create a new page.

If this wiki has a {{Documentation subpage}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{Purge button}} or {{Purge}} link (if supported by the wiki in question). See m:Help:Template documentation for more info.

Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).

Wrap any categories in ‎<includeonly> tags so that they apply only to the template's main page:

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

Many wikis have a {{Sandbox other}} template. Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:

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

Finally, publish the page.

You can now add and edit the TemplateData on the documentation subpage using the instructions described in #Methods.

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

If you can't create the /doc page, you can add and edit TemplateData on the template's main page by following the instructions in #Methods.

If a template has a documentation subpage, check both the main page and the documentation subpage for the presence of TemplateData (the ‎<templatedata> tag followed by an array inside curly brackets: {}).

Alternatively, the TemplateData extension can perform this check for you. Click "Modifier" or "Modifier le wikicode" on either page. If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:

Veuillez noter : il y a déjà une section TemplateData sur la page liée « $1 ».

or

Veuillez noter : il y a déjà une section TemplateData sur la page liée « $1 ».

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

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading "  Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Modifier" or "Modifier le wikicode" at the top. Follow the guidance at #Methods to add or edit the TemplateData.

If the template has TemplateData on its main page

If the template has TemplateData on its main page, you once again have two options:

  • You can either move to its documentation subpage. This is the preferred option.
  • Or, you can edit it on the main template page.

Déplacer un TemplateData vers la sous page de documentation

To do this, click "Modifier"/"Modifier le wikicode" on the main template page, and look for the ‎<templatedata> tags, enclosed within ‎<noinclude> tags. It should look something like this:

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

Cut only the ‎<templatedata> tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading "  Template documentation" (or similar).

Type a heading, like "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at #Methods.

Éditer TemplateData sur la page principale du modèle

If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See #Methods for how to edit TemplateData.

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

If the template does not yet have TemplateData, you should add it to the documentation subpage.

Do this by clicking the "[edit]" located after the heading "  Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Modifier" or "Modifier le wikicode" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section #Methods explains how to add TemplateData.

Méthodes

Méthode de l'éditeur TemplateData

This is a simple way to add or edit TemplateData, recommended for less experienced users.

L'éditeur TemplateData est une interface graphique pour ajouter et modifier TemplateData. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "Modifier" or "Modifier le wikicode".

After clicking "Modifier" or "Modifier le wikicode", you will see a button above the editing area and page title that says "Gérer TemplateData".

 

Cliquer sur ce bouton permet d'entrer dans l'éditeur TemplateData. L'éditeur vous permet d'ajouter les paramètres du modèle et d'y attribuer les valeurs les plus courantes. Si la page que vous avez déjà éditée contient un bloc de TemplateData, l'information déjà documentée sera automatiquement affichée quand vous ouvrirez la page adéquate dans l'éditeur de TemplateData.

 

Features in the above window:

  • The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData exists, the interface will only offer users the wiki's own language, but users can click "Ajouter des traductions" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
  • The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
  • The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Appliquer", the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are outlined here.
If the user chooses "Personnalisation", they can enter wikitext under "Chaîne de format personnalisé" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Appliquer".
  • The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "Ajouter 2 paramètres suggérés". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "Ajouter 2 paramètres suggérés" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 nouveaux paramètres ont été importés : names of parameters.".
  • At the bottom of the window you see an "Ajouter un paramètre" button. This allows you to add a parameter manually with a custom name.

Continue to the next step by clicking any one of the parameters in the list. This will allow you to edit that parameter's info.

 

All of these features and their effects are outlined in the section #Within a parameter's name.

  • The TemplateData editor will not allow you to change a parameter to a blank "Nom". Parameters in TemplateData that somehow acquire blank strings as names will not cause issues in the 2010 wikitext editor with TemplateWizard, but neither VisualEditor nor the 2017 wikitext editor will display them at all. This is the only mandatory field in the TemplateData editor.
  • Clicking "Supprimer le paramètre" will delete the parameter and all its information from the TemplateData. You can't retrieve or undo this in the TemplateData unless you click "X" afterwards. You can undo any changes made after clicking "Appliquer" by hitting Ctrl+Z.
  • Exiting the TemplateData editor after making changes prompts you to confirm that you want to discard your changes.

When finished, click "Supprimer le paramètre". This will automatically insert the TemplateData at the bottom of the page before the ‎</noinclude> tag; or, if already present, it will be updated with the new information without changing its position. The TemplateData text will also be selected when you click "Supprimer le paramètre".

The TemplateData editor creates a "paramOrder" parameter at the bottom of the TemplateData (or updates it if it already exists). "paramOrder" contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor. You can change the "paramOrder" by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. "paramOrder" and its effects are described here.

After this, click "Enregistrer" to save your revision of the page.

Méthode manuelle

You can also add or edit TemplateData manually. La structure des TemplateData est basée sur le standard JSON. Notez que toutes les descriptions dans un TemplateData doivent être en texte brut (pas de wikitexte, pas de liens, etc.). TemplateData follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a "parameter": "value" format.

ajouter TemplateData manuellement

Considerations:

  • If you're adding TemplateData on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
  • If you're adding TemplateData on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the ‎<noinclude>...‎</noinclude> tags.

Click "Modifier" or "Modifier le wikicode" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".

Many wikis have a {{TemplateData header}} template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.

To start adding TemplateData, type an opening and closing ‎<templatedata> tag and a pair of curly brackets on new lines, with an empty line between them:

<templatedata>
{

}
</templatedata>

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at #TemplateData parameters. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to TemplateData documentation and makes the content easiest to use for editors:

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

L'ordre des paramètres n'affecte pas le fonctionnement, tant que, ceux à l'intérieur, par exemple de l'objet "params" restent dans l'objet.

Exemple

Here is some example TemplateData for a hypothetical cleanup template. Such a template would display a notice and place the page into a dated category based on the month and year entered. The notice might also contain a link to a talk page section. The TemplateData would look something like this:

<templatedata>
{
	"description": "Use this template to indicate that an article is in need of cleanup.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was added",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Reason",
			"description": "The reason the article is in need of cleanup",
			"type": "string"
		},
		"talk": {
			"aliases": ["talksection"],
			"label": "Talk page section",
			"description": "The section of the talk page containing relevant discussion",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

The corresponding TemplateData documentation would display as follows:

Use this template to indicate that an article is in need of cleanup.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Month and yeardate

The month and year that the template was added

Example
January 2013
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringsuggested
Reasonreason 1

The reason the article is in need of cleanup

Stringoptional
Talk page sectiontalk talksection

The section of the talk page containing relevant discussion

Stringoptional

Description et paramètres

Chaque paramètre de TemplateData est listé ci-dessous avec une description et un exemple. Ils sont également listés sur Extension:TemplateData#Format.

  • Ces informations sont à jour en février 2020 et peuvent changer si de nouveaux paramètres sont ajoutés ou si les éditeurs de modèles reçoivent des mises à jour pour traiter certains paramètres différemment ou corriger certains comportements.
  • La syntaxe wiki ne marchera pas dans les descriptions ou les étiquettes. Ce sont purement des chaînes de texte brut.
  • New lines ("<tvar name=1>\n</tvar>") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, VisualEditor or the 2017 wikitext editor), even though they show in the auto-generated TemplateData documentation. They are replaced by a null string in input forms and by a space elsewhere.
Paramètre Description Exemple
description

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

Effets

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]".

In all main editors (VisualEditor , the Éditeur de wikicode 2017 and the WikiEditor with TemplateWizard), the description shows in two main instances:

  • 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

In the VisualEditor and 2017 wikitext editor, the description gets truncated to about 50 characters under each search suggestion, followed by a "...", but the whole description shows in the main template editor window. Both are shown in grey text.

In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text.

Si non spécifié

If the description parameter does not exist or is not specified, the text "Aucune description." will be displayed in the TemplateData documentation below the "Template data for [template name]" subheading. Additionally:

  • in VisualEditor and the 2017 wikitext editor, it will behave the same as a template that does not have TemplateData; instead of a description, the following text will display:
« $1 »
  • in the 2010 wikitext editor with TemplateWizard, the following text will display where the description would be (except in search suggestions):
« Aucune description n’existe pour ce modèle. »
This is different from the two standard placeholder descriptions in cases when TemplateData doesn't exist:
  • « $1 »
  • « $1 »
"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é. Elle peut prendre pour valeur les formats communs "inline" ($default) et "block" ou bien un format personnalisé ; voir ici pour plus de détails.

This parameter is not required, but it is recommended. The default behavior when this parameter does not exist is inline formatting, and no corresponding notice is displayed in the TemplateData documentation below the table heading.

Conséquences

En ligne :

Si le paramètre est positionné à "inline", cela créera une représentation en wikitexte sans espace blanc, comme ceci :

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

When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:

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

Block:

Si le paramètre est positionné à "block", cela créera une représentation en wikitexte avec des sauts de lignes et des espaces entre chaque partie, comme ceci :

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

When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so:

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

Custom formatting:

Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will display the following preference notice in its TemplateData documentation:

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

When inserted, the template will lay its wikitext out as per the given wikitext.

"format": "inline"
params

Il y a ensuite une étiquette "params", qui indique que les sections qui suivent recouvrent chacun des paramètres du modèle.

It should contain the name of each parameter followed by a set of TemplateData sub-parameters listed in #Within a parameter's name.

Si vous avez plusieurs paramètres, répétez simplement chaque section (en commençant par l'étiquette "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 :

"params": {
    "parameter1": {
        ...    // parameter info
    },      // notez la virgule ici
    "parameter2": {
        ...    // parameter info
    },      // et ici
    "parameter3": {
        ...    // parameter info
    }       // mais pas ici
}
paramOrder

The "paramOrder" object is an optional object that causes the parameters of a template to be displayed in a specific order when added in the template editor.

Comment l'utiliser

Add the parameter "paramOrder", followed by a colon, a space and an open square bracket, then type the name of each of the template's parameters in double quotation marks (") in the desired order, separated by commas. End with a closed square bracket (creating an array).

The parameters need not be on new lines (they may be written as "paramOrder": ["param1","param2","param3"]), but placing them on new lines often helps readability.

We recommend you place "paramOrder" after "params", as the TemplateData editor does; it isn't displayed in the TemplateData documentation but simply forces the order of the parameters. A future editor may wish to quickly look through the parameter details and edit them rather than scrolling past the "paramOrder", especially if there are a lot of parameters. If you do choose to place paramOrder somewhere besides the end of the TemplateData, end it with a comma.

You must include every parameter mentioned in the TemplateData; otherwise a "Propriété « properlyname » obligatoire non trouvée." error will show.

Si ce n'est pas défini

Without "paramOrder", the template's parameters will display in the order in which the template's source code declares them. If the source code contains objects inside objects, the parameters in outer objects will come first, followed by inner objects.

Avec les autres paramètres

In the 2010 wikitext editor with TemplateWizard:

  • "required" parameters always appear at the top, regardless of the order in "paramOrder".
  • "suggested" parameters will always appear second, above "optional" ones.
  • "deprecated" parameters won't appear at all in this editor; see the description of "deprecated" for more info.
  • "paramOrder" will only enforce its order within these categories (i.e., all "required" parameters will be in the order specified by "paramOrder", and all "suggested" parameters will be too, but all "suggested" parameters will appear below all "required" parameters).

In VisualEditor and the 2017 wikitext editor, "paramOrder" forces its order regardless of the status of each parameter.

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

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

For example, in a template's source code, {{{date}}} denotes a parameter, and it should be added under "params" with the name "date".

You may also see parameters named {{{1}}} or another number (whose TemplateData name should be, for example, "1"). Parameters like this prevent a user inserting a template from having to type the parameter name and the equals sign (i.e., |value| instead of |parametername=value|). When there are multiple unnamed parameters, the number identifies which unnamed parameter is being referred to. For example, in:

{{example template|value1|value2}}

value1 is the value of parameter {{{1}}}, and value2 is the value of parameter {{{2}}}. Describe your TemplateData parameters accordingly.

Note: a user can still force the use of {{{2}}} without {{{1}}} by inserting a parameter named "2" in the template editor or typing "|2=" in wikitext. Finally, note that "aliases" creates alternatives to the parameter name which can be used interchangeably, and "label" replaces the parameter name in the user interface with the specified label (for situations in which the parameter name is not human readable or easily understood).

Comment l'utiliser

Each of these "Nom du paramètre" objects should contain all of the information about the parameter, in the form of more TemplateData parameters. These are listed in the following section, Within a parameter's name.

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

Avec un nom de paramètre

Parameter Description Example
aliases

The optional "aliases" parameter allows a template parameter to have multiple names. You can check this by going into the template's source code and looking for:

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

or

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

This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value."

To insert the "aliases" parameter, add the text "aliases" followed by a colon, a space and an open square bracket, then typing the name of each of the parameter's aliases in quotation marks, separated by commas. End with a closed square bracket, creating an array.

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

"inherits" is an optional parameter for when a parameter should inherit all of the TemplateData of another parameter. This can then be overridden by any parameters specified for the inheriting parameter.

To use this parameter, type "inherits" : followed by another template parameter's name, such as "talk" or "1". You can then type another specific setting for the parameter underneath if you wish, like "label" : "A different label". The first parameter will inherit all of the second parameter's properties except this one.

    "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. The label is displayed in place of the parameter's raw name at all times, including when an alias is used in the wikitext. 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é. This description appears below the parameter name (a long descriptions will be shortened with a button to optionally expand it). C'est facultatif mais hautement recommandé.

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

See the [[<tvar name=1>#Type parameter</tvar>|#Type parameter]] section.

default

Some template parameters have a default value; the value is used unless overridden by the user. The "default" item is an optional item, documentary only, that is intended to communicate this default value to the user. The value need not match the actual default (if there is one) and has no functional effect. (Not to be confused with "autovalue", which is a functional parameter that fills in a field for the user.)

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the "default" text will show as grey text in the input box of any open parameter when it is empty, in the format "Default: default text". Additionally, it will show in plain black text in the parameter description (when the user hovers over the "i" symbol). In VisualEditor and the 2017 wikitext editor, this will be below the parameter description, below "Field is required"/"Field is deprecated", if specified (the 2010 wikitext editor doesn't show this text), and above "example", if specified ("example" does not show in the parameter description in the 2010 wikitext editor). In the 2010 wikitext editor with TemplateWizard, the "default" text shows directly after the parameter description, on the same line, following a space. It shows in the same format as the other editors ("Default: default text").

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if "default" is specified, the "example" value will not show in the input box.

"default": "Category:CommonsRoot",
autovalue

A parameter can be assigned an "autovalue". When a user adds the template to a page, this value will automatically appear in the input box. For example, many cleanup templates need the date added; setting the "autovalue" for the template's date parameter to be {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, the month and year that the template was added will be filled in automatically.

This value can be overwritten by the user in the template editor.

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "autovalue" overrides the visible effects of "url" in VisualEditor and the 2017 wikitext editor. See the description for "type" for more info.

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

The "example" parameter is optional and documentary only; its value contains an example that helps the template's user understand the correct way to fill in the parameter (not to be confused with "suggested"; see that entry for more information).

Conséquences

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the "default" text, if specified).

Avec d'autres paramètres

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "example" will not show in the input box if "default" is specified.

"example": "January 2013",
required

Nous avons ensuite "required" (obligatoire), qui peut être positionné à true ou false. Si vous ne le spécifiez pas, il est supposé être à false.

Cela contrôle simplement si ce paramètre est obligatoire pour ce modèle.

Conséquences

This status has several effects in VisualEditor and the Éditeur de wikicode 2017 :

  • it displays the parameter automatically when a user inserts the template;
  • it shows a black asterisk within the input box, on the right;
  • it shows the grey, italic text "Le champ est obligatoire." below the parameter description;
  • it makes the input box glow red if the user clicks away without entering a value;
  • if a user attempts to insert the template without a value in the required parameter, it will show them a prompt, asking if they are sure. If they confirm, it will insert the parameter with a blank value. It will not stop them from inserting the template, though, and it does not result in a visible error by itself (though templates can be programmed to display an error when a required parameter is not filled in).

In the WikiEditor with Aide:Extension:Assistant de modèle , as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. It also does not display "Le champ est obligatoire." in the parameter description; rather, it lists the parameter on the side under "Paramètres obligatoires". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format".

With other parameters

In VisualEditor and the 2017 wikitext editor, the "deprecated" status does not override the functionality of this parameter, but in the 2010 wikitext editor with TemplateWizard it does. See the description of "deprecated" for more info.

"required": true
suggested

Nous avons ici "suggested" (suggéré), qui peut être défini à true ou false. Si vous ne le spécifiez pas, il est supposé être à false.

Use "suggested" for parameters that are not mandatory but strongly recommended for template users to provide. When filling in this parameter, a user will see this suggestion.

Conséquences

In VisualEditor and the Éditeur de wikicode 2017 , it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings.

In the WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Paramètres suggérés". The user can then click a "+" next to the parameter to add it to the template.

With other parameters

The "required" status overrides the functionality of this status in all main editors (VisualEditor, the 2017 wikitext editor and the 2010 wikitext editor). It also overrides the displayed "suggested" status in TemplateData documentation (it will display "required" if both "required" and "suggested" are set to 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

The effect of this parameter in VisualEditor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "Le champ est obsolète. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings.

Despite the fact that it can take a string, as of January 2020 none of the main editors (VisualEditor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users. Inputting a string has the same effect as true.

In the 2010 wikitext editor with TemplateWizard, setting this value as true does not allow the parameter to be added or seen.

With other parameters

If you set both this and "suggested" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor both functionalities will be retained; the parameter will automatically show up when a user inserts a template, but it will have the "deprecated" warnings around it.

If you set both this and "required" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor it will have the same functionality as only "required"; the parameter will automatically show up when a user inserts a template, and it will have the "required" warnings around it. This is the same for if you set "deprecated", "suggested" and "required" as true.

In the 2010 wikitext editor with TemplateWizard, "deprecated" overrides the parameters "required" and "suggested".

"deprecated": "Utilisez 'publicationDate' à la place."
suggested values

The parameter property suggestedvalues lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. This can be done either directly in JSON or using the TemplateData editor (no coding required). You can add suggested values to be displayed in the VisualEditor for parameters which have their type set to one of the following options (reference):

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

Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the VisualEditor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the VisualEditor.

Editing TemplateData as JSON in wikitext

To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings.

Editing TemplateData with the TemplateData Editor

  1. Click on "Gérer TemplateData".
  2. Click on the name of the parameter you want to add suggested values to.
  3. If it’s not already done, set parameter type to one of the following: content, line, string, number, unknown, unbalanced wikitext. A new input field "Valeurs suggérées" will appear. If the parameter is already set to one of these types, the input field should already be visible.
  4. Type in the suggested value(s), including any spaces and special characters, and press enter to add the value(s) to the list.

Effects

Once the values have been added to TemplateData, the VisualEditor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually.

	"suggestedvalues": [
		"Journal",
		"Book",
		"Newspaper",
		"Magazine"
	]

Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

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 expliquer sur la page des retours 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 droits (") (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. In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this TemplateData value, such as to only allow the user to enter valid values that match the specified type. This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.

Comment l'utiliser

It is used by adding the "type" parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Exemple :

"type": "string",

Effets

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

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

Value Description
unknown

The "unknown" value is the default type value if no type is set. It can also be set manually by typing "type": "unknown".

Effets

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "unknown" has no visible effects compared to a template without TemplateData.

number

The "number" value is intended for numerical values, including negative values and decimals.

Effets

  • In VisualEditor and the 2017 wikitext editor, "number" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "number" causes the input box to display a "+" and "-" button on either side, which can raise or lower a number value in the input box, and the user can only type numbers into the box.
The buttons can also lower the number into negatives.

Avec d'autres paramètres

  • In the 2010 wikitext editor with TemplateWizard, "number" overrides the effects of "autovalue"; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".
string

The "string" value is intended for any string of plain text.

Effets

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "string" has no visible effect compared to "unknown".

line

The "line" value is intended for content that should be forced to stay on one line.

Effets

  • In VisualEditor and the 2017 wikitext editor, "line" prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
  • In the 2010 wikitext editor with TemplateWizard, "line" has no visible effect (input boxes do not allow new lines by default in this editor).
boolean

The "boolean" value is intended for a value that is either true, false or unknown. This is intended by the manual to be represented by a "1", "0" or blank value.

Effets

As of February 2020, none of the main Wikimedia editors (VisualEditor, 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects.

With the autovalue:0 checkbox appears in the VisualEditor, which can be switched on and off.

date

The "date" value is intended for a date in the YYYY-MM-DD (ISO 8601) format; for example, 2014-05-22. The TemplateData manual also designates it as being intended for ISO 8601 date–time combinations, such as 2014-05-22T16:01:12Z", but in practice no major editing interface as of February 2020 uses it in this fashion, and almost all major Wikimedia template parameters take dates and times separately.

Effets

  • In VisualEditor and the 2017 wikitext editor, "date" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "date" makes the parameter input box about a third shorter and adds a dropdown calendar, allowing the user to choose a date input. It also displays the grey example text in the input box "YYYY-MM-DD". If an input does not conform to this standard, the box glows red, however the editor will always output a date conforming to the standard (if numbers are entered) or nothing (if only text or nothing is entered).

Avec d'autres paramètres

  • In the 2010 wikitext editor with TemplateWizard, "date" overrides the effects of "autovalue"; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "date".
url

The "url" value is intended for a URL, with Internet protocol (e.g., "https://" or "//") included.

Effets

  • In VisualEditor and the 2017 wikitext editor, "url" makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text.
This second effect is similar to that of the "required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested"" or "deprecated").
  • In the 2010 wikitext editor with TemplateWizard, "url" has no visible effect.

With other parameters

  • In VisualEditor and the 2017 wikitext editor, "autovalue" overrides the visible effects of "url": when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
wiki-page-name

The "wiki-page-name" value is intended for a page name on a wiki.

Effets

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-page-name" makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as articles on Wikipedia, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.

wiki-file-name

The "wiki-file-name" value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.

Effets

  • In VisualEditor and the 2017 wikitext editor, "wiki-file-name" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "wiki-file-name" makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected.
The file names do not contain the "File:" namespace prefix. The dropdown menu also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.
wiki-template-name

The "wiki-template-name" value is intended for the name of a template.

Effets

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-template-name" makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.

wiki-user-name

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

Effets

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-user-name" makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.

content

The "content" value is intended for wikitext of page content, for example, links, images or text formatting.

Effets

  • In VisualEditor and the 2017 wikitext editor, "content" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "content" makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.
unbalanced-wikitext

The "unbalanced-wikitext" value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.

Effects

  • In VisualEditor and the 2017 wikitext editor, "unbalanced-wikitext" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "unbalanced-wikitext" makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

Formats personnalisés

When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.

  • {{ - start of the template
  • _ - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like _______. If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with \n for new lines).
  • | - pipe (separates parameters)
  • = - equals sign (precedes the value of a parameter)
  • \n or pressing the enter key - new line (this will display as in the entry field)
  • - space (can be used with \n to indent new lines)
  • }} - end of the template

The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.

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.

En plus, si vous essayez d'ouvrir ce JSON non valide avec l'éditeur graphique de données de modèle, vous verrez le message d'erreur « Bad JSON format ».

These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the TemplateData editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.

The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (tâche T128029). Pages that contain invalid JSON may throw alarming "Erreur interne" messages. To fix these errors, your best bet is to use a JSON validator (see above).

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

This error occurs if you state a parameter in "params" that is not stated in "paramOrder". The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.

"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Error: Required property "paramOrder[2]" not found.

To fix this, make sure all parameters stated in "params" are listed in "paramOrder". Alternatively, you can remove the "paramOrder" object to remove this error.

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

This error occurs if you state a parameter in "paramOrder" that is not stated in "params". The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.

"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- This parameter is not stated in "params", but it should be.
    "talk"
]

// Error: Invalid value for property "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"".)

This error occurs if you put quotation marks around the value of either "required" or "suggested".

"suggested": "true" // <-- These quotation marks shouldn't be here.

Ce sont des valeurs booléennes et non des chaînes de caractères; c'est pourquoi elles n'ont pas besoin de guillemets. To fix this, remove any quotation marks around the values true or false for these parameters.

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

If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "La propriété « format » doit être « inline », « block » ou une chaîne de format valide.".

"format": "notinline"

// Error : Property "format" is expected to be "inline", "block", or a valid format string.

To fix this, make sure the value after "format": equals "inline" or "block" and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of {{_|_=_}} and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the "format" parameter to remove this error.

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

This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- spelling mistake
            "type": ""
        }
    }
}
</templatedata>

It also occurs if you state a parameter in any TemplateData object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one TemplateData object under another object that it doesn't belong to.

For example, you might have written the parameter "label" under the root TemplateData object instead of inside "params":

<templatedata>
{
    "description": "",
    "format": "inline",
    "label": "", // <-- incorrectly placed parameter
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Alternatively, if the unexpected parameter is under a template parameter inside "params", you'll see its name after "params.parametername." in the error.

To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

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. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. 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 pour l'affichage dans les 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.