Aide:TemplateData
 |
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.
|
|
TemplateData est une extension qui stocke les informations et les paramètres associés à un modèle wikitext template 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 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 sur le modèle lui-même (voir plus bas pour les détails).
Les modèles qui ont des TemplateData afficheront 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 sur la page du modèle "/Modèle:nom du modèle".
Vérification de l'état actuel
Avant d'ajouter ou 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 de sa sous-page de documentation.
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 le 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/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 /Documentation en vérifiant si le titre de la «
Documentation du modèle » (ou équivalent) a des liens comme « [voir] [modifier] [historique] [purger] ».
- Vous pouvez rapidement identifier si un modèle a une page /Documentation en vérifiant si le titre de la «
- 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 au bas de la page similaire à "La documentation ci-dessus est issue de la sous-page de documentation du modèle" (ou équivalent).
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 à la sous-page de documentation.
Créer la sous page de documentation et déplacer le contenu de la documentation
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 « .svg){kind=icon}
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
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 « 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 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 ».
Cliquer sur ce bouton permet d'entrer dans l'éditeur TemplateData. Si la page que vous éditez contient une section TemplateData, elle sera automatiquement affichée ici.
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.
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.
- 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.
- 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>
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.
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é.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| mois et année | date | Mois et année au cours de laquelle le modèle a été ajouté
| String | suggested |
| Motif | motif 1 | Motif pour lequel l'article doit être réorganisé | String | optional |
| Section de la page de discussion | discussion section de discussion | Section de la page de discussion contenant la discussion correspondante | String | optional |
Paramètres de TemplateData
Tous les paramètres TemplateData disponibles sont énumérés ci-dessous avec une description et un exemple. Ils sont également répertoriés avec plus de détails techniques à Extension:TemplateData#Format.
- 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 marchera pas dans les descriptions ou les étiquettes. Ce sont purement des chaînes de texte brut.
- New lines ("
\n") 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. 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 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]". 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 :
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. 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 :
|
"description": "Un modèle pour créer un lien vers une catégorie de Commons",
|
| format |
La suivante est 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 a la valeur
Lorsqu'il est ajouté, le modèle affiche ainsi son wikicode sur une seule ligne, sans espace entre les éléments :
Bloc : Si le paramètre est défini sur
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 : 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:
Quand il sera ajouté, le modèle développera son wikicode au travers du wikicode indiqué. |
"format": "inline"
|
| params |
L'objet It should contain the name of each parameter followed by a set of TemplateData sub-parameters listed in #Within a parameter's name. 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 |
The Comment l'utiliser Add the parameter Il n'est pas utile que les paramètres soient sur des lignes séparées (on peut les écrire comme We recommend you place 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 Avec les autres paramètres Dans l'éditeur de wikicode 2010 avec TemplateWizard :
In VisualEditor and the 2017 wikitext editor, |
"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 For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of 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
ou
Cela signifie que si l'utilisateur ajoute l'un quelconque de ces paramètres avec une valeur, il réalisera la même fonction. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." Dans le second cas, cela signifie également, Si parameter2 n'existe pas ou s'il a pour valeur : aucune valeur. To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
Pour utiliser ce paramètre, entrez |
"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": "Mois et année",
|
| description |
A l'intérieur de chaque objet nommé après un paramètre, |
"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 |
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 Actions In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the Avec d'autres paramètres In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
Vous pouvez assigner Cette valeur peut être modifiée par l'utilisateur dans l'éditeur de modèle. Avec d'autres paramètres In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The 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 Avec d'autres paramètres In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| required |
Nous avons ensuite 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 :
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". Avec d'autres paramètres In VisualEditor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
Here we have Use Conséquences In VisualEditor and the Éditeur de wikicode 2017, it causes the parameter to automatically show up when a user inserts a template. 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. 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". L'utilisateur peut ensuite cliquer sur « + » à côté du paramètre pour l'ajouter au modèle. Avec d'autres paramètres The |
"suggested": true
|
| deprecated |
Enfin vient 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. Il n'impacte pas la fonction ou l'utilisation du paramètre et n'affiche pas d'avertissements supplémentaires. 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.
Entrer une chaîne de caractères a le même effet que In the 2010 wikitext editor with TemplateWizard, setting this value as Avec les autres paramètres If you set both this and If you set both this and Dans l'éditeur de wikicode 2010 avec TemplateWizard, |
"deprecated": "Utilisez 'publicationDate' à la place."
|
| valeurs suggérées |
The parameter property
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. 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
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",
"Livre",
"Journal",
"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 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 feedback 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.
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
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.
| Valeur | Description | |
|---|---|---|
| unknown |
Effets In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
La valeur Effets
Avec d'autres paramètres
| |
| string |
La valeur Effets In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
La valeur Effets
| |
| boolean |
La valeur Effets 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 | |
| date |
The Effets
Avec d'autres paramètres
| |
| url |
La valeur Effets
required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. Cela se produit également dès que l'on met à jour un état (comme « suggested" » ou « deprecated »).
Avec d'autres paramètres
| |
| wiki-page-name |
La valeur Effets In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
La valeur Effets
| |
| wiki-template-name |
La valeur Effets In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
La valeur Effets In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| content |
La valeur Effets
| |
| unbalanced-wikitext |
The Actions
| |
Formats personnalisés
When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- début du modèle_- contenu (comme, chaîne, entier ou paramètre). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like_______. 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\npour de nouvelles lignes).|- pipe (barre verticale qui sépare les paramètres)=- signe égal (précède la valeur d'un paramètre)\nor pressing the enter key - new line (this will display as↵in the entry field)\npour indenter les nouvelles lignes)}}- fin du modèle
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| 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 dans l'éditeur GUI de TemplateData.
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). 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)
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"
]
// Erreur: Required property "paramOrder[2]" not found. (la propriété n'existe pas)
To fix this, make sure all parameters stated in "params" are listed in "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".
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", // <-- 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"".)
"suggested": "true" // <-- Ces points d'interrogation 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.
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"
// Erreur : la propriété « format » suppose valoir « inline », « block », ou tout autre chaîne au format valide.
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.
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 de prononciation.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- erreur de prononciation
"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.
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 moms 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.
- 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)