Extension:TemplateData

**MediaWiki extensions manual**
Bestand:OOjs UI icon advanced.svg TemplateData Release status: stableLua-fout: callParserFunction: function "#translation" was not found.[[Category:stable extensions{{#translation:}}]]
Bestand:Screenshot of TemplateData extension.png
Implementation	Lua-fout: callParserFunction: function "#translation" was not found.
Description	<translate> Allows to store, retrieve and visualise information about templates</translate>
Author(s)	Timo Tijhof, Moriel Schottlender, James Forrester, Trevor Pascal, Bartosz Dziewoński, Marielle Volz, ...
Latest version	Lua-fout: callParserFunction: function "#translation" was not found. (<translate> Continuous updates</translate>)
MediaWiki	1.25+. <translate> TemplateData master is only supported with core's master; otherwise, use matching branches (e.g. TemplateData REL1_26 with core REL1_26, or matching WMF release branches).</translate>
PHP	5.4+
Database changes	No
License	Lua-fout: callParserFunction: function "#translation" was not found.
Download	Download extension Git ^[?]: Download Git master browse repository (GitHub) commit history code review [[Category:Extensions in Wikimedia version control{{#translation:}}]]
Parameters $wgTemplateDataUseGUI
Tags `<templatedata>`
Hooks used ParserFirstCallInit [[Category:ParserFirstCallInit extensions{{#translation:}}]] PageContentSave [[Category:PageContentSave extensions{{#translation:}}]] ResourceLoaderTestModules [[Category:ResourceLoaderTestModules extensions{{#translation:}}]] ResourceLoaderRegisterModules [[Category:ResourceLoaderRegisterModules extensions{{#translation:}}]] EditPage::showEditForm:initial [[Category:EditPage::showEditForm:initial extensions{{#translation:}}]]
Translate the Extension:TemplateData extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

[[Category:All extensions{{#translation:}}]]

<translate> The TemplateData extension introduces a <tvar|1><templatedata></> tag and an API which together allow editors to specify how templates should be invoked.</translate> <translate> This information is available as a nicely-formatted table for end-users, and as a JSON API, which enables other systems (e.g. VisualEditor) to build interfaces for working with templates and their parameters.</translate> <translate> See {{<tvar|1>ll|Help:TemplateData#Custom formats</>|Help:TemplateData#Custom formats}} for in-depth help.

Installation

</translate>

Download and place the file(s) in a directory called Extension:TemplateData in your extensions/ folder.

Add the following code at the bottom of your LocalSettings.php: <syntaxhighlight lang="php">

wfLoadExtension( 'Extension:TemplateData' );

</syntaxhighlight>

Sjabloon:Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of <syntaxhighlight lang="php" inline="true">wfLoadExtension( 'Extension:TemplateData' );</syntaxhighlight>, you need to use: <syntaxhighlight lang="php"> require_once "$IP/extensions/Extension:TemplateData/Extension:TemplateData.php"; </syntaxhighlight>

Editing data

The TemplateData extension works through having a <tvar|1><templatedata></> tag defined in the wikitext of a template page (optionally it can be transcluded from a different page as well).</translate> <translate> This is designed to be compatible with the common layout many wikis have of transcluding template documentation from a separate page (but is not required).</translate> <translate> This content of the <tvar|1><templatedata></> tag must be valid JSON using the format described below; note that all descriptions must be in plain text (no wikitext is accepted inside the template data).

When a <tvar|1><templatedata></> block is included on a page, the TemplateData extension performs the following checks when the page is being saved:

The contents must be valid JSON;</translate>

Each item within the JSON structure must be of the expected type as specified below (e.g. object, array, or a primitive); and</translate>

For those items which have a specified list of possible values (e.g. <tvar|1>params.yourParameterName.type</>), the value in the JSON object must match one of those values.

If any of these checks fails, the server will not be permitted saving and an error message will be displayed above the edit page.

For autovalue items, [[<tvar|1>bugzilla:2700</>|bug 2700]] prevents <tvar|2>subst:</> from working in any template that is added inside a <tvar|3><tag></>, including <tvar|4><ref></> and <tvar|5><gallery></> tags.</translate> <translate> The TemplateData block will save correctly, but the resulting wikitext will not be parsed correctly when the template is used.

Note that you cannot use <tvar|1>{{#tag:templatedata}}</> in lieu of <tvar|2><templatedata></>. </translate>

Format

The below is a visualised version of the JSON data as defined on the template page enclosed by <templatedata></templatedata> tags. The formal specification is available in the TemplateData repository. Refer to Specification.md for the latest version.

TemplateData object

The TemplateData object is a JSON root element enclosed in a <templatedata> element on the template page.

Key	Type	Description
`description`	InterfaceText or `null`	A brief description of the template. It must be in plain text. Once filled, it can be displayed as caption when editing a single template and perhaps in search results when users pick one of many. The default is `null`.
`params`	Object containing Param objects	An object that maps each parameter name of the template to a corresponding Param object describing the properties of that parameter.
`paramOrder`	Array containing parameter name strings	The logical order in which parameters should be displayed. The array contains each parameter key exactly once. Each string must be a valid key in the `params` object. If this key does not exist in the `<templatedata></templatedata>` structure on the template page, it is added to the structure provided by the API using the order in which the parameters occur within the TemplateData object.
`sets`	Array containing Set objects	An array containing set specifications. A set is a group of parameters that should be used together. The default is []. Note that the `sets` functionality is still in development.
`format`	string, either `inline` or `block`	How the template's wikitext representation SHOULD be laid out. The default is `inline`. See Help:TemplateData#Custom_formats for other custom formats.
`maps`	A Maps object	An object that maps a simplified name of a third party consumer of the template data (i.e. Citoid, Wikidata, etc.) to an object that in turn maps a name of a consumer parameter to one or more corresponding names of template parameters.

Param object

Key Type Default Description

label InterfaceText null A (very) brief name for the parameter. Try to keep under 20-ish characters.

description InterfaceText null A brief description of the parameter, for users to know which to pick from an option list.

required boolean false Whether the parameter is required for the template to work (true if this parameter must be specified).

suggested boolean false Whether the parameter is suggested for the template to be useful (true if this parameter should be specified).

deprecated boolean or string false Whether the parameter is deprecated; this can be a string of instructions for the user detailing what instead the user can do, or be simply true.

aliases Array containing strings [] List of aliases. An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Aliases are not documented in a separate Parameter object. If they need more information, they should be in their own property marked "deprecated".

default InterfaceText null The default value used by the template if no value is assigned to the parameter, or a description thereof.

autovalue string null A dynamically-generated default value in wikitext, such as today's date or the editing user's name; this will often involve wikitext substitution, such as {{subst:CURRENTYEAR}}.

example InterfaceText null An example text for the parameter, to help users fill in the proper value.

type

string

"unknown"

The type of the parameter, for (soft) type hinting. One of:

String Value	Type of Parameter
"unknown"	Assumed type if not set
"number"	Any numerical value (without decimal points or thousand separators)
"string"	Any textual value
"line"	Short text field – use for names, labels, and other short-form fields
"boolean"	A boolean value ('1' for true, '0' for false, '' for unknown), see three-valued logic.
"date"	A date in ISO 8601 format, e.g. "2014-05-09" or "2014-05-09T16:01:12Z"
"wiki-page-name"	A valid MediaWiki page name for the current wiki. Doesn't have to exist, but if not, should be a valid page name which could be created.
"wiki-file-name"	A valid MediaWiki file name for the current wiki. Doesn't have to exist, but if not, should be a valid file name which could be uploaded. Should not include the namespace (e.g. "Foo.svg" not "File:Foo.svg" or "Bild:Foo.svg").
"wiki-template-name"	A valid MediaWiki Template name for the current wiki.
"wiki-user-name"	A valid MediaWiki user name for the current wiki. Doesn't have to exist, but if not, should be a valid user name which could be created. Should not include the namespace (e.g. "Foo" not "User:Foo" or "Usario:Foo").
"content"	Page content in wikitext, such as text style, links, images, etc.
"unbalanced-wikitext"	Raw wikitext that should not be treated as standalone content because it is unbalanced – for example, templates concatenating incomplete wikitext as a bigger whole, such as `{{echo\|before=<u>\|after=</u>}}`

inherits string none
substituted The name key of another parameter (must be a valid key in the params object). The current Parameter Object will inherit properties from the specified Parameter Object, with local properties overriding the inherited ones.

Set object

Key

Type

Default

Description

—

Array of Arrays

[]

The type of the parameter, for (soft) type hinting. One of:

Set Object
Key	Object or primitive type	Description
`label`	InterfaceText	A (very) brief name for the parameter set. Try to keep under 20-ish characters.
`params`	Array of strings	One or more names of parameters to include in the set (each must be a valid key in the `params` object). A parameter may be in multiple sets. Not every parameter must be in a set.

Maps object

Key	Type	Default	Description
name of consumer	object	{}	An object that maps a name of a consumer to an object that in turn maps a name of a consumer parameter to one or more corresponding names of template parameters. The names of the template parameters can be specified either as a string (one name), an array of strings (several names), or an array of arrays of strings (several sets of names); each of these strings must be a valid key in the `params` object elsewhere in the same template's TemplateData. A specific template parameter may be in multiple maps, and it may be used in the values of multiple keys in a given map, but not every template parameter must be in a map. A shortened example from English Wikipedia's Template:Cite_news#TemplateData illustrates the structure of a maps object. { "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" ] ] } }

InterfaceText (string or object)

A free-form plain-text string (i.e. no wikitext or HTML) in the content-language of the wiki, or an object containing those strings keyed by language code.

The default value for all InterfaceText fields is null.

String type

If it is a string, it must contain a non-localized string in the content language of the local wiki.

Object type

If it is an object, the object must have this mapping:

Key	Type	Description
Wikipedia language code	string	Localized string for use on the Wikipedia corresponding to the given language code.

Example of object mapping:

Key	Value
"en"	"Welcome to Wikipedia"
"de"	"Willkommen bei Wikipedia"
"fe"	"Bienvenue sur Wikipédia"
"nl"	"Welkom op Wikipedia"
"it"	"Benvenuti su Wikipedia"
"es"	"Bienvenidos a Wikipedia"
"ru"	"Добро пожаловать в Википедию"

Example

An example TemplateData structure as specified within wikitext on a template page. <syntaxhighlight lang="javascript"><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></syntaxhighlight> Below is how the above example would be displayed on the template page:

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

API

See the generated help at Special:ApiHelp/templatedata. A sample invocation (formatted for human readability) is:

api.php?action=templatedata&titles=Template:Cite%20web&format=jsonfm [try in ApiSandbox]

This returns the template data for Template:Cite web. The <templatedata>...</templatedata> block for this template is on its transcluded template documentation page, en:Template:Cite web/doc.

Additions and changes to JSON as received from the API

The JSON structure provided in response to an API HTTP get request is significantly different than that which is defined in the <templatedata>...</templatedata> block. In response to the API request, extension TemplateData makes the following changes to the JSON object:

Adds two wrapping objects:

An overall Pages Object containing one or more Page Objects
An object with a numeric key: a Page Object

Additions/changes to the actual TemplateData Object

Add the title key with the name of the page from which the data was requested (e.g. "Template:Cite web").
Add the paramOrder key and array using the order in which the parameters occur in the params key within the TemplateData Object on the template page.
Add the sets key
Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
Remove all inherits keys.

Add all properties from parameter from which an inheritance is defined which are not superseded by explicitly defined keys in the inheritor's Parameter Object.

Add default values for all keys in each Parameter Object which have not been explicitly defined or inherited.

Visualised differences in a TemplateData JSON object delivered by the API

JSON Root
Key	Type	Description
`pages`	Page Object	The page object (contains one key which is the page number). If multiple pages were requested at one time there will be multiple Page Objects.

Page Object
Key	Type	Description
(page number)	TemplateData Object	The TemplateData Object containing the information payload. The key is a static page number for the template page from which the JSON data was requested.

TemplateData Object (added by API)
The following key is added to the root of the JSON object which is enclosed in `<templatedata>` tags on the template page.
Key	Type	Default
`title`	string	The page name of the template (e.g. "Template:Cite web"). This key is not contained in the JSON structure on the template page. It is added to the structure by the MediaWiki software in route to delivery via the API.
`paramOrder`	Array containing parameter name strings	The logical order in which parameters should be displayed. The array contains each parameter key exactly once. Each string must be a valid key in the `params` object. If this does not exist in the `<templatedata></templatedata>` structure on the template page, it is added to the structure as provided by the API using the order in which the parameters occur within the TemplateData object.
`sets`	Array containing Set Objects	An array containing set specifications. A set is a group of parameters that should be used together. If this does not exist on the template page it is added as an empty array to the structure provided by the API.

Parameter Objects from API
Key	Type	Description
`label`	InterfaceText	translated to InterfaceText object, if not already in that format.
`required`	boolean	If not defined, default value of false added.
`description`	InterfaceText or `null`	If defined as a string, converted to a InterfaceText object. If not defined, key is added with a `null` value.
`deprecated`	boolean or string	If not defined, default value of false added.
`aliases`	Array of strings	If not defined, a default empty array is assigned (i.e. [] ).
`default`	string	If not defined, default of "" is assigned.
`type`	string	If not defined, default of "unknown" is assigned.
`inherits`	removed	This key is removed and all inherited keys are added. Keys defined for the current parameter take precedence and any keys not defined on either the current param, or the one from which it inherits are given the default value.

InterfaceText (Object or `null`):
An object containing strings keyed by language code.
Key	Object or primitive type	Description
Object (containing localized strings by Wikipedia language code) If a TemplateData field on the template page contains a string, not an object with localized strings, MediaWiki translates it into an InterfaceText Object with a string assigned to the key name of the source Wikipedia Wikipedia language code. The default for all InterfaceText fields is `null`.
(Wiki language code)	string	Localized string for use on the Wikipedia corresponding to the Wikipedia language code.

Example of JSON object provided by API

The response to an API request for the TemplateData structure in the Example of TemplateData structure WikiText on template page section (above) can be seen:

In HTML format: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
As delivered by the API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

Configuration

</translate>

<translate> Variable</translate>	<translate> Default</translate>	<translate> Description</translate>
`$wgTemplateDataUseGUI`	`true`	<translate> Experimental dialog interface to edit templatedata JSON</translate>

Extension:TemplateData

Inhoud

Installation

Editing data

Format

TemplateData object

Param object

Set object

Maps object

InterfaceText (string or object)

String type

Object type

Example

API

Additions and changes to JSON as received from the API

Visualised differences in a TemplateData JSON object delivered by the API

Example of JSON object provided by API

Configuration

See also

Navigatiemenu

Extension:TemplateData

Installation

Editing data

Format

TemplateData object

Param object

Set object

Maps object

InterfaceText (string or object)

String type

Object type

Example

API

Additions and changes to JSON as received from the API

Visualised differences in a TemplateData JSON object delivered by the API

Example of JSON object provided by API

Configuration

See also

Navigatiemenu

Zoeken