Help:TemplateData/fr

 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.

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 « »/«  » 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 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é. Cela a amené les fonctionnalités de TemplateData à l'édition source pour la première fois.

En mars 2018, Sam Wilson a développé, une extension graphique de l'éditeur de modèle pour l'éditeur de source par défaut de Wikimedia, (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.

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 :

Alors le modèle Documentation transclut la sous-page /Documentation dans la page du modèle. Cela rend le code source nettement plus lisible.
 * la plupart utilise une page de documentation.
 * Vous pouvez rapidement identifier si un modèle a une page /doc en vérifiant si le titre de la « Test Template Info-Icon - Version (2).svg Documentation du modèle » (ou équivalent) a des liens comme « [view] [edit] [history] [purge] » à suivre.

Dans ce cas, c'est contenu après, quii est entre tags.
 * une petite minorité enregistre directement ces informations sur la page principale, après le code source.

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 «  » et «   » et a ensuite ajouté du contenu après «   ».

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
To create the documentation subpage, click ""/"" on the main template page; look for the tags and their contents (usually at the bottom).

It should look something like this:

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

Select everything after " " and before "" and cut it into your clipboard or save it in a temporary document. Delete " ", leaving only the following:

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 tags so that they apply only to the template's main page:

Many wikis have a  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:

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 tag followed by an array inside curly brackets:  ). Alternatively, the TemplateData extension can perform this check for you. Click "" or "" 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:

or

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 "" or "" 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 ""/"" on the main template page, and look for the tags, enclosed within  tags. It should look something like this:

Cut only the 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 "" or "" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section #Methods explains how to add TemplateData.

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

After clicking "" or "", you will see a button above the editing area and page title that says "".



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 "" 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 "", the two main types being  (on one line) and   (on new lines). This parameter and its effects are outlined here.
 * If the user chooses "", they can enter wikitext under "" according to rules outlined here, in order to create a custom layout for the template when the user clicks "".


 * 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 "". The editor extracts these suggestions from the template's source code by looking for  or  . Clicking "" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "".
 * At the bottom of the window you see an "" 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.

When finished, click "". This will automatically insert the TemplateData at the bottom of the page before the 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 "".

The TemplateData editor creates a  parameter at the bottom of the TemplateData (or updates it if it already exists). contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor. You can change the  by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. and its effects are described here. After this, click "" 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  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  tags.

Click "" or "" 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 tag and a pair of curly brackets on new lines, with an empty line between them:

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:

L'ordre des paramètres n'affecte pas le fonctionnement, tant que, ceux à l'intérieur, par exemple de l'objet  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:

The corresponding TemplateData documentation would display as follows:

{	"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": " ", "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" ] }

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.

Avec un nom de paramètre
Note: if neither,   nor   are set as   for a parameter, its status will show as   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  et  ), et séparée de la suivante par une virgule (sauf pour la dernière).

Paramètre de type
Le paramètre  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  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Exemple :

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.

Formats personnalisés
When editing the  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   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  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.

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.

/ 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. Pages that contain invalid JSON may throw alarming "" 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  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  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  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

Pour corriger ceci, assurez vous que tous les paramètres présents dans  sont listés dans. Vous pouvez également supprimer l'objet  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  or.

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  or   for these parameters.

Property "format" is expected to be ... (La propriété "format" est normalement...)
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "".

To fix this, make sure the value after  equals   or   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  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.

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  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, 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  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.

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

 * : 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.
 * [ Liste de tous les modèles avec TemplateData] sur ce wiki
 * Sur la version allemande de Wikipédia, avec le modèle TemplateData, les template data sont affichées dans une boîte de dialogue, et le modèle est ajouté dans une catégorie des modèles ayant des template data.
 * https://query.wikidata.org/ et Query Helper (assistant de requête)