Extension:TemplateData

Manuel des extensions MediaWiki

TemplateData État de la version : stable
Implémentation	Balise , API
Description	Permet d'enregistrer, de retrouver et de visualiser des informations à propos des templates
Auteur(s)	Timo Tijhof, Moriel Schottlender, James Forrester, Trevor Parscal, Bartosz Dziewoński, Marielle Volz, ...
Dernière version	0.1.2 (Mises à jour constantes)
Politique de compatibilité	Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki	>= 1.43
PHP	5.4+
Modifie la base de données	Non
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (Phabricator · GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code
Paramètres $wgTemplateDataUseGUI
Balises ‎<templatedata>
Accroches utilisées EditPage::showEditForm:fields EditPage::showEditForm:initial MultiContentSave OutputPageBeforeHTML ParserFetchTemplateData ParserFirstCallInit ResourceLoaderRegisterModules
Téléchargements trimestriels	272 (Ranked 19th)
Utilisé par les wikis publics	6,971 (Ranked 24th)
Traduire l’extension TemplateData sur translatewiki.net si elle y est disponible
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension TemplateData introduit une balise ‎<templatedata> et une API qui ensemble permettent aux contributeurs de spécifier comment les modèles et leurs paramètres doivent être utilisés. Cette information est disponible sous forme de table synthétique bien formatée pour les utilisateurs finaux, et sous forme d'API JSON permettant aux autres systèmes (comme VisualEditor ) de construire des interfaces pour travailler avec les modèles. Voir Aide:TemplateData pour une aide plus approfondie.

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé TemplateData dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'TemplateData' );
  

•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

L'extension TemplateData fonctionne grâce à une balise ‎<templatedata> définie dans le wikicode d'une page de modèle (en option, il peut être transclus à partir d'une page différente également). Il est conçu pour être compatible avec l'affichage commun que beaucoup de wikis utilisent, en faisant la transclusion de la documentation du modèle à partir d'une page séparée (mais ceci n'est pas nécessaire). Le contenu de cette balise ‎<templatedata> doit être du JSON valide qui utilise le format décrit ci-dessous; notez que toutes les descriptions doivent être en texte brut (il n'est pas permis de mettre du wikicode à l'intérieur des données du modèle).

Quand un bloc ‎<templatedata> est inclus dans une page, l'extension TemplateData réalise les contrôles suivants lorsque la page est sauvegardée :

1. Le contenu doit être du JSON valide;
2. Chaque élément de la structure JSON doit être du type attendu tel que spécifié ci-dessous (c'est à dire un objet, un tableau, ou une primitive); et
3. pour les éléments qui ont une liste spécifique de valeurs possibles (par exemple : le type d'un paramètre), la valeur dans l'objet JSON doit correspondre à l'une de ces valeurs.

Dès qu'un de ces contrôles échoue, le serveur n'est pas autorisé à sauvegarder et un message d'erreur est affiché au-dessus de la page de modification.

Pour les éléments à valeur automatique (autovalue), T4700 empêche subst: de travailler dans tout modèle ajouté à l'intérieur d'une balise, y compris les balises ‎<ref> et ‎<gallery>. Le bloc TemplateData s'enregistre bien mais le wikicode résultant ne sera pas analysé correctement lorsque le modèle sera utilisé.

Evitez d'utiliser {{#tag:templatedata}} car il empêche le fonctionnement de l'éditeur de données du modèle.

Ci-dessous vous avez une version visualisée des données JSON telle qu'elles sont définies sur la page du modèle entourées des balises ‎<templatedata>‎</templatedata>. La spécification du format est disponible dans le dépôt TemplateData . Référez-vous à Specification.md pour la dernière version.

L'objet TemplateData est un élément racine JSON encapsulé dans un élément ‎<templatedata> sur la page du modèle.

Maps est une structure de donnée unique qui se décompose en plusieurs sous-niveaux. Le second niveau est communément appelé un objet map.

{
	"proveit": {
		"main": "title",
		"textarea": [
			"quote"
		]
	},
	"citoid": {
		"title": "title",
		"url": "url",
		"publisher": "publisher",
		"publicationTitle": "work",
		"date": "date",
		"ISSN": [
			"issn"
		],
		"ISBN": [
			"isbn"
		],
		"contributor": "others",
		"author": [
			[
				"first",
				"last"
			],
			[
				"first2",
				"last2"
			],
			[
				"first9",
				"last9"
			]
		],
		"editor": [
			[
				"editor-first",
				"editor-last"
			]
		]
	}
}

Une chaîne textuelle brute de format libre (par exemple autre chose que du wikicode ou du HTML), dans la langue du contenu du wiki, ou un objet contenant ces chaînes et pour lequel la clé est le code de langue.

La valeur par défaut pour tous les champs de InterfaceText est null.

Si c'est une chaîne, elle doit contenir une chaîne non-localisée dans la langue du contenu du wiki local.

Si c'est un objet, celui-ci doit faire la correspondance suivante :

Exemple de correspondance d'objets :

Exemple de structure TemplateData telle qu'elle est spécifiée dans le wikicode sur la page du modèle.

<templatedata>
{
    "description": "Label unsigned comments in a conversation.",
    "params": {
        "user": {
            "label": "User's name",
            "type": "wiki-user-name",
            "required": true,
            "description": "User name of person who forgot to sign their comment.",
            "aliases": ["1"]
        },
        "date": {
            "label": "Date",
            "suggested": true,
            "description": {
                "en": "Timestamp of when the comment was posted, in YYYY-MM-DD format."
            },
            "aliases": ["2"],
            "autovalue": "{{subst:#time:Y-m-d}}"
        },
        "year": {
            "label": "Year",
            "type": "number"
        },
        "month": {
            "label": "Month",
            "inherits": "year"
        },
        "day": {
            "label": "Day",
            "inherits": "year"
        },
        "comment": {
            "required": false
        }
    },
    "sets": [
        {
            "label": "Date",
            "params": ["year", "month", "day"]
        }
    ],
    "maps": {
        "ExampleConsumer": {
            "foo": "user",
            "bar": ["year", "month", "day"],
            "quux": [
                "date",
                ["day", "month"],
                ["month", "year"],
                "year"
            ]
        }
    }
}
</templatedata>

Ci-dessous vous trouverez la manière dont l'exemple précédent sera affiché sur la page du modèle :

Voir l'aide générée sur Special:ApiHelp/templatedata. L'appel de cet exemple (formaté pour que ce soit lisible pour un humain) est :

Ceci renvoie les données de modèle pour Modèle:Cite web. Le bloc ‎<templatedata>...‎</templatedata> pour ce modèle est sur la page de documentation du modèle transclus, soit fr:Template:Cite web/doc.

La structure JSON fournie dans la réponse à une requête HTTP GET est un peu différente de celle qui est définie dans le bloc ‎<templatedata>...‎</templatedata> . Dans la réponse à la requête vers l'API, l'extension TemplateData fait les modifications suivantes dans l'objet JSON :

• Ajoute deux objets encapsulants :
  1. Un objet Pages global contenant un ou plusieurs objets Page
  2. Un objet avec une clé numérique : un objet Page
• Additions/modifications de l'objet TemplateData actuel
  1. Ajoute la clé title avec le nom de la page de laquelle les données ont été demandées (par exemple « Template:Cite web »).
  2. Ajoute la clé sets
  3. Modifie toutes les occurences de TemplateText qui sont simplement des chaînes vers les objets avec une seule clé pour le code de langue Wikipedia actuel
  4. Enlève toutes les clés inherits .
     • Ajoute toutes les propriétés du paramètre à partir duquel un héritage est défini, et qui ne sont pas réécrasées par les clés définies explicitement dans l'objet Parameter qui hérite.
  5. Ajoute les valeurs par défaut pour toutes les clés dans chaque objet Parameter qui n'a pas été explicitement défini ou hérité.

La réponse à une requête API pour la structure TemplateData dans la section Exemple (ci-dessus) peut être vu :

• En format HTML : https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
• Tel que délivré par l'API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

• Extension:TemplateWizard  – interface utilisateur pour sélectionner et insérer le wikicode des modèles, en fonction de leurs TemplateData.
• GitHub: jeblad/TemplateData – version alternative, avec quelques fonctionnalités Lua.
• Modèle traductible
• Wikibase/Maps TemplateData

Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki.

Cette extension est incluse dans les fermes de wikis ou les hôtes suivants et / ou les paquets : BlueSpice Canasta Debian Fandom Miraheze MyWikis ProWiki semantic::core ShoutWiki wiki.gg WikiForge Cette liste ne fait pas autorité. Certaines fermes de wikis ou hôtes et / ou paquets peuvent contenir cette extension même s'ils ne sont pas listés ici. Vérifiez toujours cela avec votre ferme de wikis ou votre hôte ou votre paquet avant de confirmer.