Help:TemplateData

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:TemplateData and the translation is 100% complete.

Other languages:
अङ्गिका • ‎العربية • ‎asturianu • ‎azərbaycanca • ‎تۆرکجه • ‎български • ‎বাংলা • ‎català • ‎čeština • ‎dansk • ‎Deutsch • ‎Zazaki • ‎Ελληνικά • ‎emiliàn e rumagnòl • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎føroyskt • ‎français • ‎Frysk • ‎galego • ‎hrvatski • ‎magyar • ‎Հայերեն • ‎Bahasa Indonesia • ‎Ilokano • ‎italiano • ‎日本語 • ‎ქართული • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मराठी • ‎Nederlands • ‎occitan • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎русский • ‎Scots • ‎سنڌي • ‎slovenščina • ‎svenska • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎ייִדיש • ‎中文
PD Note : lorsque vous modifiez cette page, vous acceptez de placer votre contribution sous licence CC0. Plus d'informations sont disponibles sur les pages d'aide du projet domaine public.
PD

Qu'est-ce que TemplateData ?[edit]

TemplateDataExtension:TemplateData est un moyen de stocker des informations au sujet d’un modèle et des ses paramètres, de manière à ce que l’éditeur visuel puisse les récupérer et les afficher dans l’outil d’inclusion de modèles, rendant ainsi plus facile l’édition de pages utilisant ce modèle.

L’extension TemplateData est installée sur tous les wikis WMF. Si vous avez votre propre wiki, vous devrez installer Extension:TemplateData.

La syntaxe TemplateData permet aux utilisateur d'écrire de petits morceaux de données structurées dans une page de modèle, ou à transclure dans une page de modèle (par exemple sur sur la page de documentation d'un modèle). Une fois qu'un modèle a ces données structurées, il peut être affiché correctement dans l'ÉditeurVisuel. Bien que cela puisse sembler compliqué, c'est en fait très simple.

Éditeur de données TemplateData[edit]

Il y a un outil intégré pour modifier les TemplateData de façon simple.

Pour utiliser l'éditeur TemplateData, allez dans la page du modèle (ou dans sa sous page de documentation) et cliquez sur le bouton "Edit". Ceci fera apparaître un bouton nommé "Manage TemplateData", juste au dessus de la fenêtre ouverte d'édition :

Manage template documentation button for TemplateData 2014.png

Appuyez sur ce bouton pour entrer dans l'outil d'interface utilisateur pour l'édition des TemplateData.

A screenshot of the TemplateData editing tool

L’éditeur vous permet d’ajouter les paramètres du modèle et de positionner les attributs les plus courants. Si la page que vous modifiez contient déjà un bloc TemplateData, les informations déjà documentées sera automatiquement affichées lorsque vous ouvrez la bonne page dans l’éditeur TemplateData. Dans la première boîte de dialogue, vous pouvez ajouter ou mettre à jour une courte description du modèle en texte seul. Après cela, vous pouvez utiliser les boutons « Ajouter des paramètres suggéré(s) » et « Ajouter un paramètre » pour documenter les noms et les attributs des paramètres que le modèle utilise. Vous pouvez lister le nom du paramètre, tous ses alias, l’intitulé et la description qui sera affichée pour les utilisateurs. Vous pouvez aussi proposer un exemple sur la façon d’utiliser le paramètre. Le seul champ obligatoire est le Nom (le premier champs de chaque ligne), qui est l’endroit où vous inscrivez le nom exact du paramètre, avec la casse correcte. Dans le menu déroulant « Type », vous pouvez choisir le type du contenu que le paramètre doit recevoir, tel qu’une chaîne (pour les messages en texte seul), une page (pour les liens vers d’autres pages), ou une date. Si le modèle produit une erreur lorsque ce paramètre n’est pas rempli, marquez ce paramètre comme « Obligatoire ». Si le paramètre est souvent utilisé ou recommandé, marquez-le comme « Suggéré ». Le bouton « Supprimer le paramètre » retire de TemplateData l’entrée concernant le paramètre.

Screenshot of the TemplateData editor, showing a second parameter being added

Lorsque vous avez fini de documenter chacun des paramètres, cliquez sur « Appliquer » pour insérer la syntaxe TemplateData pré-formatée dans le champ d’édition. Vous devez ensuite encore enregistrer la page en utilisant le bouton classique « Enregistrer » sous le champ d’édition.

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

Limitations et questions[edit]

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

Structure des TemplateData[edit]

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

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

<templatedata>
{
    ...       // Le contenu du TemplateData va ici
}
</templatedata>

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

Exemple[edit]

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

<templatedata>
{
    "description": "Un modèle pour créer un lien vers une catégorie Commons à propos d’un article",
    "params": {
        "1": {
            "label": "Catégorie Commons",
            "description": "La catégorie Commons vers laquelle vous voulez créer le lien.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

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

Un modèle pour créer un lien vers une catégorie Commons à propos d’un article

Template parameters

Parameter Description Type Status
Catégorie de Commons 1

La catégorie de Commons vers laquelle vous voulez créer un lien.

Default
Category:CommonsRoot
Example
empty
Auto value
empty
String required

Description et paramètres[edit]

description Le premier drapeau est une "description", qui renseigne sur ce que fait le modèle.
"description": "Un modèle pour créer un lien vers une catégorie Commons",
format Le suivant est "format", qui indique comment la représentation en wikitexte du modèle doit être interprétée. Ça peut être soit "inline" (default) ou "block".

Si le paramètre est positionné à "inline", la représentation en wikitexte sera créée sans espace blanc, comme ceci :

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

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

{{Foo
| bar = baz
| qux = quux
}}
"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.

Tous les paramètres qui suivent sont inclus dans la section "params"

"params": {
    ...    // les paramètres vont ici
}
  Dans chaque sous-section des paramètres, le premier tag est le nom du paramètre du modèle, dans le modèle.

Si le paramètre a un nom, mettons {{{lien-catégorie}}}, ce tag sera "lien-catégorie".

Si le paramètre n’a pas de nom, c’est-à-dire que c’est seulement un nombre comme {{{1}}}, ce tag sera "1".

Toutes les informations à propos de ce paramètre seront incluses dans la section qui commence avec le nom du paramètre.

"1": {     // nom du paramètre
    ...    // les informations sur ce paramètre viennent ici
}
label Ensuite, nous avons "label", dans lequel vous pouvez indiquer un titre lisible par un humain, pour le paramètre qui sera affiché dans l’éditeur de modèle.
"label": "Catégorie Commons",
description Nous avons ensuite "description" : cette fois, c’est une description du paramètre, pas du modèle dans sa globalité.
"description": "La catégorie de Commons vers laquelle vous voulez créer un lien.",
default Ensuite vient "default". Certains modèles ont une valeur par défaut qui est utilisée si vous ne la changez pas. Cet item indique à l’utilisateur ce qu’est la valeur par défaut pour ce paramètre.

Vous pouvez ignorer ce paramètre s’il n’y a pas de valeur par défaut.

"default": "Category:CommonsRoot",
type Après, nous avons "type", qui contrôle comment l’éditeur de modèle interprétera ce paramètre. Ça peut être :
  • "string": un ensemble de caractères, comme cette phrase ;
  • "number": un ensemble de chiffres ;
  • "wiki-user-name": un ensemble de caractères qui représente un nom d’utilisateur ;
  • "wiki-page-name": un ensemble de caractères qui représente un titre de page ;
  • "wiki-file-name": un nom de fichier.
"type": "string",
required Nous avons ensuite "required" (obligatoire), qui peut être positionné à true ou false.

Cela contrôle simplement si ce paramètre est obligatoire pour ce modèle. Si vous ne le spécifiez pas, il est supposé être false.

"required": true
suggested Nous avons ici "suggested" (suggéré), qui peut être positionné à true ou false.

C’est le statut pour les paramètres qui ne sont pas « obligatoires » mais qui sont recommandés car importants pour les utilisateurs du modèle. Si vous ne le spécifiez pas, il est supposé être false.

"suggested": true
deprecated

Enfin vient "deprecated" (usage abandonné), qui peut être positionné à true, false ou à une chaîne de caractères décrivant ce que les utilisateurs doivent faire plutôt.

Ce statut est à utiliser pour les paramètres qui ne doivent plus être utilisés, mais qui continuent d’exister quelque temps. Une raison peut être que le modèle a de nouveaux noms de paramètres. Si vous ne le spécifiez pas, il est supposé être false.

"deprecated": "Please use 'publicationDate' instead."

Une fois que vous avez fini, cliquez sur « Enregistrer ». Si vous avez fait des erreurs, vous ne pourrez pas enregistrer (ce qui peut être troublant, mais garantit que vous ne pouvez rien casser). Si vous avez des erreurs, vous pouvez les expliquer sur la page des retours ce que vous essayez de faire, et nous serons heureux de vous aider.

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

Alias de paramètre[edit]

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

Par exemple, {{Commons|category=Apples}} peut être écrit comme {{Commons|Apples}} ou {{Commons|link=Apples}}.

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

    "params": {
        "catégorie": {
            ...
            "aliases": ["1", "lien"]
        }

Valeur automatique[edit]

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

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

    "params": {
        "date": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Paramètres multiples[edit]

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

    "params": {
    "1": {
        ...
    },      // notez la virgule ici
    "2": {
        ...
    },      // et ici
    "3": {
        ...
    }
    }

Paramètres similaires[edit]

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

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

Structure vierge[edit]

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

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

Autres outils[edit]