View source for Help:TemplateData

<languages />
{{PD Help Page}}
{{anchor|What is TemplateData?}}
<translate>
<!--T:94-->
<tvar name=1>'''{{ll|Extension:TemplateData|TemplateData}}'''</tvar> is an extension used to store information about a [[<tvar name=2>Special:MyLanguage/Help:Templates</tvar>|wikitext template]] and its parameters so that an editing interface can retrieve and display this information in its template editor, thus making it easier for users to add and edit templates on pages.
</translate>

<translate><!--T:474--> Since April 2019, TemplateData is part of the default user experience for all users on all Wikimedia wikis when they add a template, including unregistered users.</translate>
<translate><!--T:475--> Both the default source and visual editors incorporate it in some way.</translate>
<translate><!--T:476--> It is also used elsewhere by scripts, tools and gadgets.</translate>
<translate><!--T:194--> If you have your own wiki, you will need to install <tvar name=1>{{ll|Extension:TemplateData}}</tvar>.</translate>

<translate><!--T:477--> Adding TemplateData to a template essentially consists of inserting a small block of [[w:JSON|JSON]] code (explained below) on the template's documentation page.</translate>
<translate><!--T:493--> Whilst this may sound complicated, it's rather simple.</translate>
<translate><!--T:478--> There are two main ways you can do this, either manually or by using the TemplateData editor, a graphical user interface located on the "Edit"/"Edit source" pages of templates on wikis with the TemplateData extension installed.</translate>
<translate><!--T:479--> The JSON contains a list of parameters with info about each parameter of the template as well as the template as a whole.</translate>
<translate><!--T:480--> These are outlined below.</translate>

<translate><!--T:481--> Once a template has TemplateData, this information will show in the user interface when a user adds the template, sometimes in place of original info or sometimes as additional info.</translate>
<translate><!--T:482--> In some cases, it may change how the editor behaves when editing or inserting the template.</translate>
<translate><!--T:483--> This can make it much easier for users to identify what they need to do with a template when adding it.</translate>

<translate>
== History == <!--T:484-->
</translate>
<translate><!--T:485--> TemplateData was originally developed in early 2013 with <tvar name=1>{{ll|VisualEditor}}</tvar> in mind, which was in MediaWiki testing stages at the time.</translate>
<translate><!--T:486--> VisualEditor is the main visual editing interface for Wikimedia wikis, and TemplateData allowed it to have a more useful interface when adding templates.</translate>
<translate><!--T:487--> It was officially supported by VisualEditor [[<tvar name=1>Special:MyLanguage/VisualEditor/Portal/TemplateData</tvar>|immediately]].</translate>
<translate><!--T:488--> As VisualEditor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, TemplateData became a part of them as well.</translate>

<translate><!--T:494--> In December 2016, the VisualEditor interface was made available for editing source code as a beta feature.</translate>
<translate><!--T:495--> This was termed the [[2017 wikitext editor]].</translate>
<translate><!--T:496--> This brought the features of TemplateData to source editing for the first time.</translate>

<translate><!--T:489--> In March 2018, [[<tvar name=1>User:Samwilson</tvar>|Sam Wilson]] developed <tvar name=2>{{ll|Extension:TemplateWizard|nsp=0}}</tvar>, a GUI template editor extension for the default Wikimedia source editor, <tvar name=3>{{ll|WikiEditor}}</tvar> (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from TemplateData.</translate>
<translate><!--T:490--> In [[<tvar name=1>w:Wikipedia:Wikipedia Signpost/2019-04-30/Technology report</tvar>|April 2019]], TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis.</translate>
<translate><!--T:491--> This meant that TemplateData was now a default part of both the visual editor and the source editor on Wikimedia wikis.</translate>

<translate>
== Adding or editing TemplateData == <!--T:497-->

<!--T:498-->
To add or edit TemplateData, first navigate to a template's page, located at "/Template:''Templatename''".
</translate>

{{anchor|Prior checks}}
<translate>
=== Prior checks === <!--T:499-->

<!--T:500-->
There are two things you should check before adding or editing TemplateData, in the following order:

<!--T:501-->
# whether the template has a documentation subpage</translate>
<translate>
<!--T:632-->
# whether the template already has TemplateData and whether this is located on the template page or the documentation subpage.

<!--T:502-->
'''Checking for the documentation subpage'''

<!--T:503-->
The first thing to do is identify whether the template has a subpage for its documentation or not.

<!--T:504-->
There are two main ways templates on most Wikimedia wikis store their usage notes and other data that shouldn't be included in the actual template itself, like categories the template should be contained in:

<!--T:505-->
* The vast majority use a documentation subpage.</translate> <translate><!--T:633--> This is a page located at the template's name followed by "/doc".</translate> <translate><!--T:634--> In this case, on the main template page after the template source code, there is only the text "<code><nowiki>{{Documentation}}</nowiki></code>" between <tvar name=1>{{tag|noinclude|open}}</tvar> tags.</translate> <translate><!--T:635--> Here, the {{tl|Documentation}} template [[Special:MyLanguage/Transclusion|transcludes]] all the /doc page's content onto the template page. This makes the template's source code look much cleaner.</translate>
<translate>
<!--T:636-->
* A small minority keep the information on the template's main page, after its source code.</translate> <translate><!--T:637--> In this case, it is contained after "<code><nowiki>{{Documentation|content=</nowiki></code>", which is between <tvar name=1>{{tag|noinclude|open}}</tvar> tags.</translate>

<translate><!--T:506--> You can quickly identify whether a template has a /doc page by checking if the "[[File:Test Template Info-Icon - Version (2).svg|50px]] '''Template documentation'''" (or similar) heading has links like "[view] [edit] [history] [purge]" after it.</translate>
<translate><!--T:638--> This may look slightly different on different wikis.</translate>
<translate><!--T:639--> Rarely, the main template page may still have documentation content even if you see these buttons and there is a /doc page.</translate>
<translate><!--T:640--> This will happen if a user has added a custom /doc page title between "<code><nowiki>{{Documentation|</nowiki></code>" and "<code><nowiki>|content=</nowiki></code>" then added content after "<code><nowiki>|content=</nowiki></code>".</translate>

<translate>
<!--T:507-->
A slightly more reliable way to check is by looking for the notice, "The above documentation is transcluded from Template:''Templatename''/doc" (or similar), in the box at the bottom of the page.

<!--T:508-->
'''If a template doesn't have a documentation subpage'''

<!--T:509-->
If a template doesn't have a documentation subpage, you have two options:

<!--T:510-->
* You can either create it and move its documentation (if it has any) there.</translate> <translate><!--T:641--> After this, you can then add TemplateData to the documentation subpage. This is the preferred option.</translate>
<translate>
<!--T:642-->
* Or, you can add or edit TemplateData on the main template page.

<!--T:511-->
'''Creating the doc subpage and moving the documentation contents'''

<!--T:512-->
On most Wikimedia wikis, you can only create a page if you are a registered user (and, at least on the English Wikipedia, have been for more than four days and have made at least ten edits).

<!--T:513-->
To do this, click "Edit"/"Edit source" on the main template page, and look for the <tvar name=1>{{tag|noinclude|open}}</tvar> tags and their contents, usually at the bottom.

<!--T:514-->
It should look something like this:
</translate>

<syntaxhighlight lang="xml">
<noinclude>
{{Documentation|content=
== Usage ==

Information about usage.

== More example headings ==

More example contents

[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude></syntaxhighlight>

<translate><!--T:515--> It might also have TemplateData already.</translate>
<translate><!--T:643--> This will look something like:</translate>

<syntaxhighlight lang="xml">
<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude></syntaxhighlight>

<translate>
<!--T:516-->
Select everything after "<code><nowiki>|content=</nowiki></code>" and before "<tvar name=1>{{tag|noinclude|close}}</tvar>", cut it, then delete "<code><nowiki>|content=</nowiki></code>", so you are just left with:
</translate>

<syntaxhighlight lang="xml">
<noinclude>
{{Documentation}}
</noinclude></syntaxhighlight>

<translate>
<!--T:517-->
Now, save the page.
</translate>

<translate><!--T:518--> Next, add "/doc" to the URL in the address bar after the template name, and press Enter.</translate>
<translate><!--T:644--> Then, click "Create source".</translate>

<translate><!--T:519--> If your wiki has a {{tl|Documentation subpage}} notice template, add it at the top.</translate>
<translate><!--T:645--> You may also want to add some other templates, like a {{tl|Purge button}} or {{tl|Purge}} link, if your wiki has it.</translate>
<translate><!--T:661--> See [[<tvar name=1>meta:Special:MyLanguage/Help:Template documentation</tvar>|m:Help:Template documentation]] for more info.</translate>

<translate>
<!--T:520-->
Beneath this, paste the contents of the clipboard.
</translate>

<translate><!--T:521--> Next, enclose the categories within <tvar name=1>{{tag|includeonly|open}}</tvar> tags.</translate>
<translate><!--T:646--> This is so that they don't have an effect on the doc subpage, only on the template's main page.</translate>

<translate>
<!--T:522-->
This will look like this:
</translate>

<syntaxhighlight lang="xml">
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly></syntaxhighlight>

<translate><!--T:523--> Some wikis (including [[:en:Template:Sandbox_other|the English Wikipedia]]) have a <nowiki>{{Sandbox other}}</nowiki> template.</translate>
<translate><!--T:647--> Use this if the template can be expected to have a sandbox version, located at "Template:''Templatename''/sandbox".</translate>
<translate><!--T:648--> It will stop the categories from having an effect on the sandbox page.</translate>

<translate>
<!--T:524-->
This will look like this:
</translate>

<syntaxhighlight lang="xml">
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly></syntaxhighlight>

<translate>
<!--T:525-->
After this, click "Publish page".

<!--T:526-->
You can now add or edit the TemplateData on the documentation subpage based on the guidance at [[#Methods]].

<!--T:527-->
'''Adding or editing TemplateData on the main template page'''

<!--T:528-->
If you do not wish to or are unable to create the /doc page, you can add or edit TemplateData on the main template page.
Follow the guidance at [[#Methods]] to do this.

<!--T:529-->
'''If a template has a documentation subpage'''

<!--T:530-->
If a template has a documentation subpage, you should now check whether it already has TemplateData and whether this is located on the template page or the documentation subpage.

<!--T:531-->
Check both the template page and the /doc subpage for the presence of TemplateData documentation; this looks something like this:
</translate>

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>

<translate><!--T:532--> Alternatively, the TemplateData extension can perform this check for you.</translate>
<translate><!--T:649--> Click "Edit" or "Edit source" on either page.</translate>

<translate>
<!--T:533-->
If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:

<!--T:534-->
:"Please note: there is already a TemplateData block on the related page "Template:''Templatename''/doc"", or</translate>
<translate>
<!--T:650-->
:"Please note: there is already a TemplateData block on the related page "Template:''Templatename''""

<!--T:535-->
'''If the template has TemplateData on its documentation subpage'''
</translate>

<translate><!--T:536--> If the template has TemplateData on its documentation subpage, this is the page you should edit.</translate>
<translate><!--T:651--> You can do this by clicking the "[edit]" located after the heading "[[File:Test Template Info-Icon - Version (2).svg|50px]] '''Template documentation'''" (or similar), or, if you are already on the /doc page, by clicking "Edit" or "Edit source" at the top.</translate>
<translate><!--T:652--> Follow the guidance at [[#Methods]] to add or edit the TemplateData.</translate>

<translate>
<!--T:537-->
'''If the template has TemplateData on its main page'''

<!--T:538-->
If the template has TemplateData on its main page, you once again have two options:

<!--T:539-->
* You can either move to its documentation subpage. This is the preferred option.</translate>
<translate>
<!--T:653-->
* Or, you can edit it on the main template page.

<!--T:540-->
'''Moving TemplateData to the documentation subpage'''
</translate>

<translate><!--T:541--> To do this, click "Edit"/"Edit source" on the main template page, and look for the <tvar name=1>{{tag|templatedata|open}}</tvar> tags, enclosed within <tvar name=2>{{tag|noinclude|open}}</tvar> tags.</translate>
<translate><!--T:654--> It should look something like this:</translate>

<syntaxhighlight lang="xml">
<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude></syntaxhighlight>

<translate>
<!--T:542-->
Cut only the <tvar name=1>{{tag|templatedata|open}}</tvar> tags and their contents out of the code, then save the page.

<!--T:543-->
Next, edit the documentation subpage by clicking the "[edit]" located after the heading "[[File:Test Template Info-Icon - Version (2).svg|50px]] '''Template documentation'''" (or similar).

<!--T:544-->
Type a heading, like "TemplateData", then beneath it paste the TemplateData.

<!--T:545-->
You can now edit the TemplateData based on the guidance at [[#Methods]].

<!--T:546-->
'''Editing TemplateData on the main template page'''
</translate>

<translate><!--T:547--> If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page.</translate>
<translate><!--T:655--> See [[#Methods]] for how to edit TemplateData.</translate>

<translate>
<!--T:548-->
'''If the template does not yet have TemplateData but has a doc subpage'''

<!--T:549-->
If the template does not yet have TemplateData, you should add it to the documentation subpage.
</translate>

<translate><!--T:550--> Do this by clicking the "[edit]" located after the heading "[[File:Test Template Info-Icon - Version (2).svg|50px]] '''Template documentation'''" (or similar), or, if you are already on the /doc page, by clicking "Edit" or "Edit source" at the top.</translate>
<translate><!--T:656--> Type a heading, like "TemplateData", then add it beneath this heading.</translate>
<translate><!--T:657--> The section [[#Methods]] explains how to add TemplateData.</translate>

{{anchor|Methods}}
<translate>
=== Methods === <!--T:551-->
</translate>

{{anchor|TemplateData editor}}
<translate>
==== TemplateData editor method ==== <!--T:178-->

<!--T:552-->
This is the simpler way to add or edit TemplateData, possible for inexperienced users.
</translate>

<translate><!--T:96--> The TemplateData editor is a graphical user interface for adding and editing TemplateData.</translate>
<translate><!--T:553--> It is part of the TemplateData extension.</translate>
<translate><!--T:97--> It is accessible by going to any template's page (or documentation subpage) and clicking "Edit" or "Edit source".</translate>

<translate>
<!--T:554-->
After clicking "Edit" or "Edit source", you will see a button above the editing area and page title that says "{{int|templatedata-editbutton}}".
</translate>
[[File:Manage template documentation button for TemplateData 2014.png|453px]]

<translate><!--T:98--> Clicking this button will enter the '''TemplateData Editor'''.</translate>
<translate><!--T:206--> If the page you are on already contains TemplateData, this will automatically show here.</translate>
[[File:TemplateData GUI editor new.png|alt=<translate><!--T:204--> A screenshot of the TemplateData editing tool</translate>|600px|<translate><!--T:205--> The TemplateData editing tool, on a page that contains no TemplateData yet.</translate>]]

<translate>
<!--T:555-->
Features in the above window:

<!--T:556-->
* The top item is "Language". This item allows you to enter text content in multiple different languages, which will show depending on the language setting of the user in Preferences. '''It will not show depending on the language wiki''', as different wikis have entirely different databases of templates. If no language TemplateData exists yet, only the language of the wiki the user is on will be available, but the user can click "Add language" to add more inputs. The language code will show in brackets next to the parameters for which it can be applied to. These include descriptions and labels.</translate>
<translate>
<!--T:557-->
* The next item is the template description. This is the description of the template as a whole and is shown in various places to the user in the template editors while adding a template. This parameter and its effects are outlined [[#Description|here]].</translate>
<translate>
<!--T:558-->
* The third item is the wikitext formatting of the template. This parameter determines how the wikitext should be laid out when the user clicks "Insert", the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are outlined [[#Format|here]].</translate>
<translate>
<!--T:559-->
:If the user chooses "Custom", they will be able to enter a set of wikitext under "Custom format string", according to rules outlined [[#Custom formats|here]], to create a custom layout for the template when the user clicks "Insert".</translate>
<translate>
<!--T:560-->
* The fourth item is "Template parameters". This contains a list of parameters already defined in the TemplateData, if they exist. If there are parameters stated in the template's source code for which no TemplateData exists yet, you may see a button called "Add suggested parameters". These are extracted from the template's source code by looking for <code><nowiki>{{{parametername}}}</nowiki></code> or <code><nowiki>{{{parametername|}}}</nowiki></code>. Clicking "Add suggested parameters" will add these parameters under their names as defined in the source code. This will also show a green notice at the top: "2 new parameters were imported: ''names of parameters''".</translate>
<translate>
<!--T:561-->
* At the bottom is "Add parameter". This allows you to add a parameter manually with a custom name.

<!--T:562-->
The next stage is clicking any one of the parameters in the list. This will allow you to edit that parameter's info.


<!--T:203-->
[[File:TemplateData GUI editor with two parameters.png|alt=Screenshot of the TemplateData editor, showing a second parameter being added|600px]]

<!--T:563-->
All of these features and their effects are outlined at [[#Within a parameter's name|#Within a parameter's name]].
</translate>

{{note|1=<div>
<translate>
<!--T:564-->
* The TemplateData editor will not allow you to change a parameter to a blank "[[#Parameter name|Name]]". If you were to write a parameter in TemplateData with a blank string as a name, this would not cause issues in the 2010 wikitext editor with TemplateWizard, but it would not show up at all in VisualEditor or the 2017 wikitext editor. This is the only mandatory field in the TemplateData editor.</translate>
<translate>
<!--T:565-->
* Clicking "Remove parameter information" will delete the parameter and all its information from the TemplateData. You will not be able to retrieve or undo this in the TemplateData unless you click "X" afterwards. You can undo any changes made after clicking "Apply" by hitting Ctrl+Z.</translate>
<translate>
<!--T:566-->
* Exiting the TemplateData editor after making changes shows a prompt asking if you're sure you want to discard your changes.
</translate></div>
}}

<translate><!--T:567--> When you are finished, click "Apply".</translate>
<translate><!--T:568--> This will automatically insert the TemplateData at the bottom of the page before the <tvar name=1>{{tag|noinclude|close}}</tvar> tag; or, if it already exists, it will update it with the new information without changing its position at all.</translate>
<translate><!--T:569--> The TemplateData text will also be selected when you click "Apply".</translate>

<translate><!--T:570--> The TemplateData editor creates a <code>"paramOrder"</code> parameter at the bottom of the TemplateData or updates it if it already exists.</translate>
<translate><!--T:571--> This contains the current TemplateData parameters in the order they were displayed in the TemplateData editor.</translate>
<translate><!--T:572-->
You can change the paramOrder by dragging the parameters in different orders in the TemplateData editor using the three horizontal bars on the left.
<code>"paramOrder"</code> and its effects are outlined [[#ParamOrder|here]].

<!--T:573-->
After this, click "Save" to save the revision of the page.

==== Manual method ==== <!--T:574-->
</translate>
<translate><!--T:575--> The alternative is to add or edit TemplateData manually. You may need or wish to do this in some cases.</translate>
<translate><!--T:109--> TemplateData's structure is based around the [[w:JSON|JSON]] standard, but you do not need to learn JSON to learn how to place TemplateData.</translate>
<translate><!--T:576--> It follows a few very simple rules and takes only a few dozen possible predefined parameters and values, almost always in a <code><nowiki>"parameter": "value"</nowiki></code> format.</translate>

<translate>
<!--T:577-->
'''Adding TemplateData manually'''

<!--T:578-->
Preconsiderations:

<!--T:579-->
* If you're adding TemplateData on a template's documentation subpage, you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.</translate>
<translate>
<!--T:658-->
* If you're adding TemplateData on a template's main page (which is not preferred; see [[<tvar name=section>#Prior checks</tvar>|#Prior checks]]), you must make sure that it is within the <tvar name=1>{{tag|noinclude}}</tvar> tags.

<!--T:580-->
First, click "Edit" or "Edit source" on the respective page, then go to the position you are adding the TemplateData and write a heading like "TemplateData".

<!--T:582-->
To start adding the TemplateData, type an opening and closing <tvar name=1>{{tag|templatedata|open}}</tvar> tag and a pair of curly brackets on new lines, with an empty line between them:
</translate>

<syntaxhighlight lang="html">
<templatedata>
{

}
</templatedata></syntaxhighlight>

<translate>
<!--T:583-->
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, but some are highly recommended.

<!--T:584-->
Parameters can be in any order, but the order that will best correlate with what shows in the TemplateData documentation and contribute to ease of use for editors is the following:
</translate>

<syntaxhighlight lang="html">
<templatedata>
{
    "description": "",
    "format": "",
    "params": {
        "parameter1": {
            "aliases": ["",""]
            "label": "",
            "description": "",
            "type": ""
        }
    },
    "paramOrder": [
    	""
    ]
}
</templatedata></syntaxhighlight>

<translate>
<!--T:268-->
Also, make sure the parameters within, for example, the <tvar name=1><code>"params"</code></tvar> object are kept within that object, or you will receive an "[[<tvar name=2>#Unexpected property</tvar>|Unexpected property]]" error when you try to save.
</translate>

{{anchor|Example}}
'''<translate><!--T:181--> Example</translate>'''

<translate><!--T:585--> Here is some example TemplateData for a hypothetical cleanup template.</translate>
<translate><!--T:659--> The template would display a notice, and its source code would be programmed to place the page into a dated category based on the month and year entered.</translate>
<translate><!--T:660--> The notice could also contain a link to a talk page section, if specified. The TemplateData would look something like this:</translate>

<syntaxhighlight lang="javascript">
<templatedata>
{
	"description": "Use this template to indicate that an article is in need of cleanup.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was added",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Reason",
			"description": "The reason the article is in need of cleanup",
			"type": "string"
		},
		"talk": {
			"aliases": ["talksection"],
			"label": "Talk page section",
			"description": "The section of the talk page containing relevant discussion",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>
</syntaxhighlight>

<translate>
<!--T:586-->
The corresponding TemplateData documentation would display as the following:
</translate>

<templatedata>
{
	"description": "Use this template to indicate that an article is in need of cleanup.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was added",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Reason",
			"description": "The reason the article is in need of cleanup",
			"type": "string"
		},
		"talk": {
			"aliases": ["talksection"],
			"label": "Talk page section",
			"description": "The section of the talk page containing relevant discussion",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

{{anchor|TemplateData parameters|Description and parameters}}
<translate>
== TemplateData parameters == <!--T:182-->
</translate>
<translate><!--T:266--> Each parameter for TemplateData is listed below with a description and example.</translate>
<translate><!--T:267--> They are also listed at [[<tvar name=1>Special:MyLanguage/Extension:TemplateData#Format</tvar>|Extension:TemplateData#Format]].</translate>

{{note|1=<nowiki/>
* <translate><!--T:269--> This information is current as of February 2020 and may change if new parameters are added or the template editing interfaces get updates to support existing parameters or treat certain parameters differently.</translate>
* <translate><!--T:275--> Wiki markup will not work in descriptions or labels.</translate> <translate><!--T:276--> They are strictly plain text strings.</translate>
* 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. They are replaced by a null string in input forms and by a space elsewhere.
}}

{| class="wikitable"
! style="width: 5%;"| <translate><!--T:271--> Parameter</translate>
! style="width: 75%;"| <translate><!--T:272--> Description</translate>
! style="width: 20%;"| <translate><!--T:273--> Example</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|description|Description|Template description}}
|-
! description
|
<translate><!--T:121--> The <tvar name=description><code>"description"</code></tvar> parameter describes what the template does.</translate>
<translate><!--T:274--> It is optional but highly recommended.</translate>

'''<translate><!--T:277--> Effects</translate>'''

<translate>
<!--T:278-->
On the template documentation page, the description will show in plain text below the "Template data for [template name]" subheading.

<!--T:279-->
In all main editors (<tvar name=1>{{ll|VisualEditor}}</tvar>, the <tvar name=2>{{ll|2017 wikitext editor}}</tvar> and the <tvar name=3>{{ll|2010 wikitext editor}}</tvar> with [[<tvar name=4>Special:MyLanguage/Help:Extension:TemplateWizard</tvar>|TemplateWizard]]), the description shows in two main instances:

<!--T:280-->
* below the template name in each search suggestion when the user is searching for a template</translate>
<translate>
<!--T:281-->
* below the template name in the template editor, while they are adding values to parameters in the template.
</translate>

<translate><!--T:282--> In the VisualEditor and 2017 wikitext editor, the description gets truncated to about 50 characters under each search suggestion, followed by a "<tvar name=1>...</tvar>", but the whole description shows in the main template editor window.</translate>
<translate><!--T:283--> Both are shown in grey text.</translate>

<translate><!--T:284--> In the 2010 wikitext editor with TemplateWizard, the whole description shows under each search suggestion, in grey text.</translate>
<translate><!--T:285--> In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text.</translate>

'''<translate><!--T:286--> If not specified</translate>'''

<translate><!--T:287--> If the description parameter does not exist or is not specified, the text "No description." will be displayed in the TemplateData documentation below the "Template data for [template name]" subheading.</translate>
<translate><!--T:288--> Additionally:</translate>

* <translate><!--T:289--> in VisualEditor and the 2017 wikitext editor, it will behave the same as a template that does not have TemplateData; instead of a description, the following text will display:</translate>

::<code>"The "Template:''Templatename''" template doesn't yet have a description, but there might be some information on the template's page."</code>

* <translate><!--T:290--> in the 2010 wikitext editor with TemplateWizard, the following text will display where the description would be (though not in search suggestions):</translate>

:<code>"No description exists for this template."</code>

:<translate><!--T:291--> This is different to the two standard placeholder descriptions when TemplateData doesn't exist:</translate>

:*<code>"Due to missing TemplateData, parameters for this template have been auto-generated. Please be aware that they may not be accurate."</code>
:*<code>"No parameters could be determined for this template due to absence of TemplateData documentation. You may insert the template without parameters."</code>

| <syntaxhighlight lang="javascript">
"description": "<translate nowrap><!--T:122--> A template for linking to a commons category</translate>",
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|format|Format}}
|-
! format
|
<translate><!--T:195--> The <tvar name=format><code>"format"</code></tvar> parameter describes how the template's wikitext should be laid out.</translate>
<translate><!--T:196--> This can be set to the standard formats of <tvar name=inline><code>"inline"</code></tvar> and <tvar name=block><code>"block"</code></tvar>, or the user can input a set of wikitext symbols to create a custom format; these symbols and some examples are listed in the section [[<tvar name=1>#Custom formats</tvar>|#Custom formats]].</translate>

<translate><!--T:292--> This parameter is not required, but it is recommended.</translate>
<translate><!--T:293--> The default behaviour when this parameter does not exist is inline formatting, and no corresponding notice is displayed in the TemplateData documentation below the table heading.</translate>

'''<translate><!--T:294--> Effects</translate>'''

'''<translate><!--T:295--> Inline:</translate>'''

<translate>
<!--T:197-->
If the parameter is set to <tvar name=inline><code>"inline"</code></tvar>, the template will display a corresponding notice about the preference in its TemplateData documentation, below the table heading, "Template parameters":
</translate>

:<code><nowiki>"[circles and pipes icon] This template prefers inline formatting of parameters."</nowiki></code>

<translate>
<!--T:296-->
When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
</translate>

:<code><nowiki>{{Foo|bar=baz|qux=quux}}</nowiki></code>

'''<translate><!--T:297--> Block:</translate>'''

<translate>
<!--T:198-->
If the parameter is set to <tvar name=block><code>"block"</code></tvar>, the template will display the following preference notice in its TemplateData documentation:
</translate>

:<code><nowiki>"[stacked blocks and pipes icon] This template prefers block formatting of parameters."</nowiki></code>

<translate>
<!--T:298-->
When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so:
</translate>

<pre>{{Foo
| bar = baz
| qux = quux
}}</pre>

'''<translate><!--T:299--> Custom formatting:</translate>'''

<translate>
<!--T:300-->
Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at [[<tvar name=1>#Custom formats</tvar>|#Custom formats]], the template will display the following preference notice in its TemplateData documentation:
</translate>

:<code><nowiki>"[cogwheel icon] This template has custom formatting."</nowiki></code>

<translate>
<!--T:301-->
When inserted, the template will lay its wikitext out as per the given wikitext.
</translate>

| 
<syntaxhighlight lang="javascript">
"format": "inline"
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|params|Params|Multiple parameters}}
|-
! params
|
<translate>
<!--T:123-->
The <tvar name=params><code>"params"</code></tvar> object contains the information for each parameter of the template. It is required, and its parameters can be viewed in the [[<tvar name=1>#Within params</tvar>|#Within params]] section.

<!--T:302-->
It should contain the [[<tvar name=1>#Parameter name</tvar>|name]] of each parameter followed by a set of TemplateData sub-parameters listed in [[<tvar name=2>#Within a parameter's name</tvar>|#Within a parameter's name]].

<!--T:159-->
If there are multiple parameters, separate each parameter object with a comma ''between'' each one, after the closing curly bracket (i.e. not after the last curly bracket).
</translate>

| <syntaxhighlight lang="javascript">
"params": {
    "parameter1": {
        ...    // <translate nowrap><!--T:303--> parameter info</translate>
    },      // <translate nowrap><!--T:160--> comma here</translate>
    "parameter2": {
        ...    // <translate nowrap><!--T:304--> parameter info</translate>
    },      // <translate nowrap><!--T:161--> and here</translate>
    "parameter3": {
        ...    // <translate nowrap><!--T:305--> parameter info</translate>
    }       // <translate nowrap><!--T:306--> but not here</translate>
}
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|paramOrder|ParamOrder|Paramorder}}
|-
! paramOrder
|
<translate>
<!--T:307-->
The <tvar name=1><code>"paramOrder"</code></tvar> object is an optional object that can force the parameters of a template to show in a specific order when added in the template editor.

<!--T:587-->
'''How to use'''
</translate>

<translate><!--T:308--> It is used by adding the parameter <tvar name=1><code>"paramOrder"</code></tvar>, followed by a colon, a space and an open square bracket, then typing the name of each of the template's parameters in speech marks in a desired order, separated by commas.</translate>
<translate><!--T:588--> Finally, end it with a closed square bracket.</translate>
<translate><!--T:589--> This creates an array.</translate>

<translate>
<!--T:309-->
The parameters do not have to be on new lines (they can be <tvar name=1><code>"paramOrder": ["param1","param2","param3"]</code></tvar>), but placing them on new lines may aid in legibility.
</translate>

<translate><!--T:590--> It is recommended that you place <code>"paramOrder"</code> after <code>"params"</code>, like how the TemplateData editor does, because it does not show in the TemplateData documentation but simply forces the order of the parameters.</translate>
<translate><!--T:591--> Someone might want to quickly look at the parameter details and edit them rather than scroll past the <code>"paramOrder"</code>, especially if there are a lot of parameters.</translate>
<translate><!--T:592--> If you do choose to place it somewhere other than the end of the TemplateData, make sure it has a comma at the end.</translate>

<translate>
<!--T:310-->
Every parameter mentioned in the TemplateData must be included, otherwise a "[[<tvar name=1>#Required property</tvar>|Required property]]" error will show.

<!--T:593-->
'''If not specified'''

<!--T:594-->
If <code>"paramOrder"</code> does not exist or is not specified, the template's parameters will display in the order they are declared in the template's source code.
If the source code contains objects inside objects, parameters in outer objects will come first, followed by inner objects.
</translate>

'''<translate><!--T:595--> With other parameters</translate>'''

<translate><!--T:313--> In the 2010 wikitext editor with TemplateWizard, <code>"[[<tvar name=1>#Required</tvar>|required]]"</code> parameters will always appear at the top, regardless of the order in <tvar name=2><code>"paramOrder"</code></tvar>, while <code>"[[<tvar name=3>#Suggested</tvar>|suggested]]"</code> parameters will always appear second, above <tvar name=4><code>"optional"</code></tvar> ones (<code>"[[<tvar name=5>#Deprecated</tvar>|deprecated]]"</code> parameters won't appear at all in this editor; see the description of <tvar name=6><code>"deprecated"</code></tvar> for more info).</translate>
<translate><!--T:314--> <tvar name=1><code>"paramOrder"</code></tvar> will only enforce its order within these categories (i.e., all <tvar name=2><code>"required"</code></tvar> parameters will be in the order specified by <tvar name=1><code>"paramOrder"</code></tvar>, and all <tvar name=3><code>"suggested"</code></tvar> parameters will be too, but all <tvar name=3><code>"suggested"</code></tvar> parameters will appear below all <tvar name=2><code>"required"</code></tvar> parameters).</translate>

<translate>
<!--T:312-->
In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"paramOrder"</code></tvar> forces its order regardless of the status of each parameter.
</translate>

| <syntaxhighlight lang="javascript">
"paramOrder": [
	"date",
	"reason",
	"talk"
]
</syntaxhighlight>
|-
|}

{{anchor|Within params}}
<translate>
=== Within params === <!--T:315-->
</translate>

{| class="wikitable"
! style="width: 5%;"| <translate><!--T:316--> Parameter</translate>
! style="width: 75%;"| <translate><!--T:317--> Description</translate>
! style="width: 20%;"| <translate><!--T:318--> Example</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|Parameter name}}
|-
! ''parameter name''
|
<translate>
<!--T:126-->
The only first-level item of the <tvar name=1><code>params</code></tvar> object is the name of a parameter of the template.

<!--T:127-->
For example, in a template's source code, if you see <tvar name=1><code><nowiki>{{{date}}}</nowiki></code></tvar>, this is a parameter, and this should be added under <tvar name=3><code>"params"</code></tvar> with the name <tvar name=4><code>"date"</code></tvar>.
</translate>

<translate><!--T:319--> You may also see parameters named <tvar name=1><code><nowiki>{{{1}}}</nowiki></code></tvar> or another number (whose TemplateData name should be, for example, <tvar name=2><code>"1"</code></tvar>).</translate>
<translate><!--T:320--> These parameters behave in such a way that, when a user inserts a template, they can omit their name and the equals sign (i.e., <tvar name=1><code><nowiki>|value|</nowiki></code></tvar> instead of <tvar name=2><code><nowiki>|parametername=value|</nowiki></code></tvar>).</translate>
<translate><!--T:321--> Their number indicates which [[<tvar name=1>Special:MyLanguage/Help:Templates#Anonymous parameters</tvar>|unnamed parameter]] they are when multiple unnamed parameters are used.</translate>
<translate><!--T:322--> For example, expect that in</translate>

:<code><nowiki>{{example template|value1|value2}}</nowiki></code>

<translate><!--T:323--> <tvar name=1><code><nowiki>value1</nowiki></code></tvar> is the value of parameter <tvar name=2><code><nowiki>{{{1}}}</nowiki></code></tvar>, and <tvar name=3><code><nowiki>value2</nowiki></code></tvar> is the value of parameter <tvar name=4><code><nowiki>{{{2}}}</nowiki></code></tvar>.</translate>
<translate><!--T:324--> Make sure to describe your TemplateData parameters accordingly.</translate>
<translate><!--T:325--> Note: a user can still force the use of <tvar name=1><code><nowiki>{{{2}}}</nowiki></code></tvar> without <tvar name=2><code><nowiki>{{{1}}}</nowiki></code></tvar> by inserting a parameter named "<tvar name=3><code>2</code></tvar>" in the template editor or typing "<tvar name=4><code><nowiki>|2=</nowiki></code></tvar>" in wikitext.</translate>

<translate>
<!--T:596-->
'''How to use'''
</translate>

<translate><!--T:326--> Each of these "parameter name" objects should contain all of the information about the parameter, in the form of more TemplateData parameters.</translate>
<translate><!--T:327--> These are listed in the following section, [[<tvar name=1>#Within a parameter's name</tvar>|Within a parameter's name]].</translate>

| <syntaxhighlight lang="javascript">
"1": {     // <translate nowrap><!--T:130--> name of the parameter</translate>
    ...    // <translate nowrap><!--T:131--> information about the parameter goes here</translate>
}
</syntaxhighlight>
|-
|}

{{anchor|Within the parameter's name}}
<translate>
==== Within a parameter's name ==== <!--T:328-->
</translate>

{| class="wikitable"
! style="width: 5%;"| <translate><!--T:329--> Parameter</translate>
! style="width: 70%;"| <translate><!--T:330--> Description</translate>
! style="width: 25%;"| <translate><!--T:331--> Example</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|aliases|Aliases|Parameter aliases}}
|-
! aliases
|
<translate><!--T:332--> The <tvar name=1><code>"aliases"</code></tvar> parameter is a optional item for when a template parameter has multiple names.</translate>
<translate><!--T:333--> You can check this by going into the template's source code and looking for:</translate>

:<code><nowiki>{{{parameter1|{{{parameter2}}}}}}</nowiki></code>, or <code><nowiki>{{{parameter1|{{{parameter2|}}}}}}</nowiki></code>

<translate><!--T:336--> This means that if the user inserts either of these parameters with a value, they will perform the same function.</translate>
<translate><!--T:334--> Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value, value of parameter2."</translate>
<translate><!--T:335--> In the second case, it also means, "If parameter2 doesn't exist or have a value, no value."</translate>

<translate><!--T:337--> To insert the <tvar name=1><code>"aliases"</code></tvar> parameter, add the text <tvar name=1><code>"aliases"</code></tvar> followed by a colon, a space and an open square bracket, then typing the name of each of the parameter's aliases in speech marks, separated by commas.</translate>
<translate><!--T:597--> Finally, end it with a closed square bracket.</translate>
<translate><!--T:598--> This creates an array.</translate>
| <syntaxhighlight lang="javascript">
"aliases": ["1", "talk", "talksection"],
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|inherits|Inherits|Similar parameters}}
|-
! inherits
|
<translate><!--T:338--> <tvar name=1><code>"inherits"</code></tvar> is an optional parameter for when a parameter should inherit all of the TemplateData of another parameter.</translate>
<translate><!--T:339--> This can then be overridden by any parameters specified for the inheriting parameter.</translate>

<translate><!--T:340--> To use this parameter, type <tvar name=1><code>"inherits" :</code></tvar> followed by another template parameter's name, such as <tvar name=2><code>"talk"</code></tvar> or <tvar name=3><code>"1"</code></tvar>.</translate>
<translate><!--T:341--> You can then type another specific setting for the parameter underneath if you wish, like <tvar name=1><code>"label" : "A different label"</code></tvar>.</translate>
<translate><!--T:342--> The first parameter will inherit all of the second parameter's properties except this one.</translate>

| <syntaxhighlight lang="javascript">
    "params": {
        "<translate nowrap><!--T:163--> topic1</translate>": {
            "label": "<translate nowrap><!--T:164--> Topic</translate>",
            "description": "<translate nowrap><!--T:165--> A topic mentioned on this disambiguation page</translate>",
            "type": "string"
        },
        "<translate nowrap><!--T:166--> topic2</translate>": {
            "inherits": "<translate nowrap><!--T:167--> topic1</translate>"
        },
        "<translate nowrap><!--T:168--> topic3</translate>": {
            "inherits": "<translate nowrap><!--T:169--> topic1</translate>",
            "label" : "A different label"
        }
    }
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|label|Label}}
|-
! label
|
<translate><!--T:132--> The <tvar name=label><code>"label"</code></tvar> parameter is a human-readable title for the parameter that will be displayed within the template editor.</translate>
<translate><!--T:343--> It displays this in place of the parameter's raw name.</translate>
<translate><!--T:344--> This parameter is optional but highly recommended.</translate>

| <syntaxhighlight lang="javascript">
"label": "<translate nowrap><!--T:345--> Month and year</translate>",
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|Parameter description}}
|-
! description
|
<translate><!--T:134--> Here, <tvar name=description><code>"description"</code></tvar> is a description of the parameter, not the template as a whole.</translate>
<translate><!--T:346--> This description is shown in a tooltip when the user hovers over the "i" symbol next to the parameter in the template editor.</translate>
<translate><!--T:347--> It is optional but highly recommended.</translate>

| <syntaxhighlight lang="javascript">
"description": "<translate nowrap><!--T:348--> The month and year that the template was inserted</translate>",
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|type|Type}}
|-
! type
|
See the [[#Type parameter|#Type parameter]] section.
|
|- style="visibility:collapse"
| colspan="3" | {{anchor|default|Default}}
|-
! default
|
<translate><!--T:354--> Occasionally, a template parameter is programmed to have a default value that is used unless you change it.</translate>
<translate><!--T:355--> The <tvar name=1><code>"default"</code></tvar> item is an optional item intended to tell the user what this value is.</translate>
<translate><!--T:356--> The value does not have to match the actual default and has no functional effect.</translate>
<translate><!--T:137--> You can ignore this parameter if there's no default.</translate>

'''<translate><!--T:357--> Effects</translate>'''

<translate><!--T:358--> In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the "default" text will show as grey text in the input box of any open parameter when it is empty, in the format <code>"Default: ''default text''"</code>.</translate>
<translate><!--T:359--> Additionally, it will show in plain black text in the [[<tvar name=1>#Parameter description</tvar>|parameter description]] (when the user hovers over the "i" symbol).</translate>
<translate><!--T:360--> In VisualEditor and the 2017 wikitext editor, this will be below the parameter description, below "Field is [[<tvar name=1>#Required</tvar>|required]]"/"Field is [[<tvar name=2>#Deprecated</tvar>|deprecated]]", if specified (the 2010 wikitext editor doesn't show this text), and above "[[<tvar name=3>#Example</tvar>|example]]", if specified ("example" does not show in the parameter description in the 2010 wikitext editor).</translate>
<translate><!--T:361--> In the 2010 wikitext editor with TemplateWizard, the "default" text shows directly after the parameter description, on the same line, following a space.</translate>
<translate><!--T:362--> It shows in the same format as the other editors (<code>"Default: ''default text''"</code>).</translate>

'''<translate><!--T:363--> With other parameters</translate>'''

<translate>
<!--T:364-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if "default" is specified, the "example" value will not show in the input box.
</translate>

|
<syntaxhighlight lang="javascript">
"default": "Category:CommonsRoot",
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|autovalue|Autovalue|Auto value}}
|-
! autovalue
|
<translate>
<!--T:155-->
You can specify an "autovalue" for a parameter. When a user adds the template to a page, this value will automatically appear in the input box. For example, many cleanup templates are supposed to have the date added; if you set the autovalue for the template's date parameter to be <code><nowiki>{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}</nowiki></code>, the month and year that the template was added will be filled in automatically.
</translate>

<translate><!--T:365--> This parameter does not force the value to always be this value.</translate>
<translate><!--T:366--> The user can freely change the value that is automatically inputted into the parameter in the template editor.</translate>

'''<translate><!--T:367--> With other parameters</translate>'''

<translate><!--T:368--> In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), <tvar name=1><code>"autovalue"</code></tvar> overrides the visible effects of <tvar name=2><code>"url"</code></tvar> in VisualEditor and the 2017 wikitext editor.</translate>
<translate><!--T:369--> See [[<tvar name=1>#Type</tvar>|the description for <tvar name=2><code>"type"</code></tvar>]] for more info.</translate>

|
<syntaxhighlight lang="javascript">
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|example|Example}}
|-
! example
|
<translate>
<!--T:370-->
The <tvar name=1><code>"example"</code></tvar> value is an optional value intended to display an example input to show how the parameter is used.
</translate>

'''<translate><!--T:371--> Effects</translate>'''

<translate><!--T:372--> In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), it shows a grey text in the input box of any open parameter when it is empty, in the format <code>"e.g. ''example text''"</code>.</translate>
<translate><!--T:373--> Additionally, in VisualEditor and the 2017 wikitext editor, it shows the same text in black, non-italic font below the parameter description (and below the "default" text, if specified).</translate>

'''<translate><!--T:374--> With other parameters</translate>'''

<translate>
<!--T:375-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "example" will not show in the input box if "default" is specified.
</translate>

|
<syntaxhighlight lang="javascript">
"example": "January 2013",
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|required|Required}}
|-
! required
|
<translate><!--T:144--> We then have <tvar name=required><code>"required"</code></tvar>, which can be set to either <tvar name=true><code>true</code></tvar> or <tvar name=false><code>false</code></tvar>.</translate>
<translate><!--T:237--> If you don't specify, it will be assumed to be <tvar name=false><code>false</code></tvar>.</translate>

<translate>
<!--T:145-->
This specifies whether filling out the parameter is mandatory for that template.
</translate>

'''<translate><!--T:376--> Effects</translate>'''

<translate>
<!--T:238-->
This status has several effects in VisualEditor and the <tvar name=1>{{ll|2017 wikitext editor}}</tvar>:
</translate>
*<translate><!--T:239--> it makes the parameter automatically show up when a user inserts a template;</translate>
*<translate><!--T:240--> it shows a grey asterisk next to the parameter label;</translate>
*<translate><!--T:377--> it shows a black asterisk within the input box, on the right;</translate>
*<translate><!--T:241--> it shows the grey, italic text "Field is required" below the parameter description;</translate>
*<translate><!--T:242--> it makes the input box glow red if the user clicks away without entering a value;</translate>
*<translate><!--T:243--> if a user attempts to insert the template without a value in the required parameter, it will show them a prompt, asking if they are sure.</translate> <translate><!--T:244--> If they confirm, it will insert the parameter with a blank value.</translate> <translate><!--T:245--> It will not stop them from inserting the template, though, and it does not result in a visible error by itself (though templates can be programmed to display an error when a required parameter is not filled in).</translate>

<translate><!--T:246--> In the <tvar name=1>{{ll|2010 wikitext editor}}</tvar> with [[<tvar name=2>Special:MyLanguage/Help:Extension:TemplateWizard</tvar>|TemplateWizard]], like in the other editors, it causes the parameter to automatically show up when a user inserts a template, but in this editor the parameter cannot be removed.</translate>
<translate><!--T:378--> It also does not display "Field is required" in the parameter description; rather, it lists the parameter on the side under "Required parameters".</translate>
<translate><!--T:247--> 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".</translate>

'''<translate><!--T:379--> With other parameters</translate>'''

<translate><!--T:248--> In VisualEditor and the 2017 wikitext editor, the "deprecated" status does not override the functionality of this parameter, but in the 2010 wikitext editor with TemplateWizard it does.</translate>
<translate><!--T:249--> See the description of "deprecated" for more info.</translate>

|
<syntaxhighlight lang="javascript">
"required": true
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|suggested|Suggested}}
|-
! suggested
|
<translate><!--T:146--> There is <tvar name=suggested><code>"suggested"</code></tvar>, which can be set to either <tvar name=true><code>true</code></tvar> or <tvar name=false><code>false</code></tvar>.</translate>
<translate><!--T:469--> If you don't specify, it will be assumed to be <tvar name=1><code>false</code></tvar>.</translate>

<translate>
<!--T:147-->
This is a status for parameters that are not "required" but are recommended to be high value (but not mandatory) for template users.
</translate>

'''<translate><!--T:380--> Effects</translate>'''

<translate><!--T:250--> In VisualEditor and the <tvar name=1>{{ll|2017 wikitext editor}}</tvar>, it causes the parameter to automatically show up when a user inserts a template.</translate>
<translate><!--T:251--> If the parameter has an autovalue set, this will also automatically be in the parameter's input box.</translate>
<translate><!--T:252--> It has no other effect and doesn't show any additional text or warnings.</translate>

<translate><!--T:253--> In the <tvar name=1>{{ll|2010 wikitext editor}}</tvar> with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Suggested parameters".</translate>
<translate><!--T:254--> The user can then click a "+" next to the parameter to add it to the template.</translate>

'''<translate><!--T:381--> With other parameters</translate>'''

<translate><!--T:255--> The "required" status overrides the functionality of this status in all main editors (VisualEditor, the 2017 wikitext editor and the 2010 wikitext editor).</translate>
<translate><!--T:256--> It also overrides the displayed "suggested" status in TemplateData documentation (it will display "required" if both "required" and "suggested" are set to <tvar name=true><code>true</code></tvar>).</translate>

|
<syntaxhighlight lang="javascript">
"suggested": true
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|deprecated|Deprecated}}
|-
! deprecated
|
<translate><!--T:189--> Finally, there is <tvar name=deprecated><code>"deprecated"</code></tvar>, which can be set to <tvar name=true><code>true</code></tvar>, <tvar name=false><code>false</code></tvar>, or a string describing what users should instead do.</translate>
<translate><!--T:192--> If you don't specify, it will be assumed to be <tvar name=false><code>false</code></tvar>.</translate>

<translate><!--T:190--> This is a status for parameters that should not be used any more but still exist for the time being.</translate>
<translate><!--T:191--> This could be because uses of the template are being moved from one set of parameters to another.</translate>

'''<translate><!--T:382--> Effects</translate>'''

<translate><!--T:259--> 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 "Field is deprecated" is shown below the parameter description.</translate>
<translate><!--T:260--> It does not affect the functionality or usability of the parameter or show any additional warnings.</translate>

<translate><!--T:257--> 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.</translate>
<translate><!--T:258--> Inputting a string has the same effect as <tvar name=1><code>true</code></tvar>.</translate>

<translate>
<!--T:261-->
In the 2010 wikitext editor with TemplateWizard, setting this value as <tvar name=true><code>true</code></tvar> does not allow the parameter to be added or seen.
</translate>

'''<translate><!--T:383--> With other parameters</translate>'''

<translate>
<!--T:263-->
If you set both this and "suggested" as <tvar name=true><code>true</code></tvar>, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor both functionalities will be retained; the parameter will automatically show up when a user inserts a template, but it will have the "deprecated" warnings around it.
</translate>

<translate><!--T:264--> If you set both this and "required" as <tvar name=true><code>true</code></tvar>, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor it will have the same functionality as only "required"; the parameter will automatically show up when a user inserts a template, and it will have the "required" warnings around it.</translate>
<translate><!--T:265--> This is the same for if you set "deprecated", "suggested" and "required" as <tvar name=1><code>true</code></tvar>.</translate>

<translate>
<!--T:262-->
In the 2010 wikitext editor with TemplateWizard, "deprecated" overrides the parameters "required" and "suggested".
</translate>

|<syntaxhighlight lang="javascript">
"deprecated": "<translate nowrap><!--T:229--> Please use 'publicationDate' instead.</translate>"
</syntaxhighlight>
|- style="visibility:collapse"
| colspan="3" | {{anchor|suggestedvalues}}
|-
! <translate><!--T:662--> suggested values</translate>
|
<translate><!--T:663--> The parameter property <tvar name=suggestedvalues><code>suggestedvalues</code></tvar> lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. This can be done either directly in JSON or using the TemplateData editor (no coding required). </translate>
<translate><!--T:664--> You can add suggested values to be displayed in the VisualEditor for parameters which have their type set to one of the following options:</translate>

* content
* line
* string
* number
* unknown
* unbalanced wikitext.
<translate>
<!--T:665-->
Other types (<tvar name=types>file, page, template, user, date, boolean, URL</tvar>) 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.
</translate>

'''<translate><!--T:666--> Editing TemplateData as JSON in wikitext</translate>'''

<translate>
<!--T:667-->
To add suggested values to any parameter type, add the new property <tvar name=suggestedvalues-1>"suggestedvalues"</tvar> to the parameter in JSON. The <tvar name=suggestedvalues-2>“suggestedvalues”</tvar> attribute must be a list of strings.
</translate>

'''Editing TemplateData with the TemplateData Editor'''

# <translate><!--T:668--> Click on "Manage TemplateData".</translate>
# <translate><!--T:669--> Click on the name of the parameter you want to add suggested values to.</translate>
# <translate><!--T:670--> If it’s not already done, set parameter type to one of the following: content, line, string, number, unknown or unbalanced wikitext. A new input field "Suggested values" will appear. If the parameter is already set to one of these types, the input field should already be visible.</translate>
# <translate><!--T:671--> Type in the suggested value(s), including any spaces and special characters, and press enter to add the value(s) to the list.</translate>

'''Effects'''

<translate><!--T:672--> 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.</translate>
|<syntaxhighlight lang="javascript">
	"suggestedvalues": [
		"Journal",
		"Book",
		"Newspaper",
		"Magazine"
	]
</syntaxhighlight>
|-
|}

<translate>
<!--T:384-->
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

<!--T:148-->
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive but means you can't break anything). Should you run into errors, explain on the [[<tvar name=1>Special:MyLanguage/VisualEditor/Feedback</tvar>|feedback page]] what you were trying to do, and we will be happy to help.

<!--T:230-->
Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

<!--T:149-->
Note that each item of information is enclosed in quotation marks (except for <tvar name=true><code>true</code></tvar> and <tvar name=false><code>false</code></tvar>) and separated from the next bit by a comma (unless it's the last one).
</translate>

{{anchor|Type parameter}}
<translate>
===== Type parameter ===== <!--T:397-->
</translate>
<translate><!--T:138--> The <tvar name=type><code>"type"</code></tvar> parameter is meant to signal to a template editor the nature of a parameter's value.</translate>
<translate><!--T:349--> 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.</translate>
<translate><!--T:350--> This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.</translate>

<translate>
<!--T:599-->
'''How to use'''

<!--T:600-->
It is used by adding the <code>"type"</code> parameter, followed by a colon and a space, then adding any of the values listed in the table below in speech marks.

<!--T:601-->
Example:
</translate>

<syntaxhighlight lang="javascript">
"type": "string",
</syntaxhighlight>

<translate>
<!--T:602-->
'''Effects'''

<!--T:603-->
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.

<!--T:604-->
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 [[phab:T55613|T55613]]. A similar effort to get TemplateWizard to support the boolean value is tracked in [[phab:T200664|T200664]].

<!--T:399-->
The currently known effects are listed as follows.
</translate>

{| class="wikitable"
|+ {{Anchor|Type parameter table}}
! style="width: 10%;"| Value
! style="width: 90%;"| Description
|- style="visibility:collapse"
| colspan="3" | {{anchor|unknown|Unknown}}
|-
! unknown
|
<translate>
<!--T:605-->
The <code>"unknown"</code> value is the default type value if no type is set. It can also be set manually,  by typing <code>"type": "unknown"</code>.

<!--T:606-->
'''Effects'''

<!--T:607-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), <code>"unknown"</code> has no visible effects compared to a template without TemplateData.
</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|number|Number}}
|-
! number
|
<translate>
<!--T:400-->
The <tvar name=1><code>"number"</code></tvar> value is intended for numerical values, including negative values and decimals.

<!--T:608-->
'''Effects'''

<!--T:401-->
* In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"number"</code></tvar> has no visible effect.</translate>
<translate>
<!--T:402-->
* In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"number"</code></tvar>  causes the input box to display a "<tvar name=2>+</tvar>" and "<tvar name=3>-</tvar>" button on either side, which can raise or lower a number value in the input box, and the user can only type numbers into the box.</translate> <translate><!--T:403--> The buttons can also lower the number into negatives.</translate>

<translate>
<!--T:609-->
'''With other parameters'''

<!--T:440-->
* In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"number"</code></tvar> overrides the effects of <tvar name=2><code>"[[#Autovalue|autovalue]]"</code></tvar>; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".
</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|string|String}}
|-
! string
|
<translate>
<!--T:404-->
The <tvar name=1><code>"string"</code></tvar> value is intended for any string of plain text.

<!--T:610-->
'''Effects'''

<!--T:405-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), <tvar name=1><code>"string"</code></tvar> has no visible effect compared to <tvar name=2><code>"unknown"</code></tvar>.</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|line|Line}}
|-
! line
|
<translate>
<!--T:406-->
The <tvar name=1><code>"line"</code></tvar> value is intended for content that should be forced to stay on one line.

<!--T:611-->
'''Effects'''
</translate>

* <translate><!--T:407--> In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"line"</code></tvar> prevents a parameter's input box from allowing new lines, which are usually possible in these editors.</translate>
* <translate><!--T:408--> In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"line"</code></tvar> has no visible effect (input boxes do not allow new lines by default in this editor).</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|boolean|Boolean}}
|-
! boolean
|
<translate>
<!--T:612-->
The <code>"boolean"</code> value is intended for a value that is either true, false or unknown. This is intended by the [[Special:MyLanguage/Extension:TemplateData#Param object|manual]] to be represented by a "1", "0" or blank value.

<!--T:613-->
'''Effects'''

<!--T:614-->
As of February 2020, none of the main Wikimedia editors (VisualEditor, 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects.

<!--T:674-->
With the <tvar name=1><code>autovalue:0</code></tvar> checkbox appears in the VisualEditor, which can be switched on and off.
</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|date|Date}}
|-
! date
|
<translate>
<!--T:615-->
The <code>"date"</code> value is intended for a date in the YYYY-MM-DD ([[:en:ISO 8601|ISO 8601]]) format; for example, 2014-05-22. The [[Special:MyLanguage/Extension:TemplateData#Param object|TemplateData manual]] also designates it as being intended for ISO 8601 date–time combinations, such as 2014-05-22T16:01:12Z", but in practice no major editing interface as of February 2020 uses it in this fashion, and almost all major Wikimedia template parameters take dates and times separately.

<!--T:616-->
'''Effects'''

<!--T:617-->
* In VisualEditor and the 2017 wikitext editor, <code>"date"</code> has no visible effect.

<!--T:618-->
* In the 2010 wikitext editor with TemplateWizard, <code>"date"</code> makes the parameter input box about a third shorter and adds a dropdown calendar, allowing the user to choose a date input. It also displays the grey example text in the input box "YYYY-MM-DD". If an input does not conform to this standard, the box glows red, however the editor will always output a date conforming to the standard (if numbers are entered) or nothing (if only text or nothing is entered).

<!--T:619-->
'''With other parameters'''

<!--T:620-->
* In the 2010 wikitext editor with TemplateWizard, <code>"date"</code> overrides the effects of <code>"[[#Autovalue|autovalue]]"</code>; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "date".</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|url|Url|URL}}
|-
! url
|
<translate>
<!--T:409-->
The <tvar name=1><code>"url"</code></tvar> value is intended for a URL, with Internet protocol (e.g., "<tvar name=2>https://</tvar>" or "//") included.

<!--T:621-->
'''Effects'''

<!--T:410-->
* In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"url"</code></tvar> makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text.</translate> <translate><!--T:411--> This second effect is similar to that of the "<tvar name=1><code>[[#Required|required]]</code></tvar>" setting, but it does not warn the user if they attempt to insert the template without a valid URL.</translate> <translate><!--T:412--> It also occurs with any status setting (such as "<tvar name=1><code>[[#Suggested|suggested]]"</code></tvar>" or "<tvar name=2><code>[[#Deprecated|deprecated]]</code></tvar>").</translate>
<translate>
<!--T:413-->
* In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"url"</code></tvar> has no visible effect.
</translate>

'''<translate><!--T:438--> With other parameters</translate>'''

<translate>
<!--T:439-->
* In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"autovalue"</code></tvar> overrides the visible effects of <tvar name=2><code>"url"</code></tvar>: when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|wiki-page-name|Wiki-page-name}}
|-
! {{nowrap|wiki-page-name}}
|
<translate>
<!--T:414-->
The <tvar name=1><code>"wiki-page-name"</code></tvar> value is intended for a page name on a wiki.

<!--T:622-->
'''Effects'''

<!--T:415-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), <tvar name=1><code>"wiki-page-name"</code></tvar> makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as articles on Wikipedia, which can be selected.</translate> <translate><!--T:416--> Namespaces can also be defined in the search.</translate> <translate><!--T:417--> Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line.</translate> <translate><!--T:418--> It has no other visible effect and doesn't prevent a non-page from being inputted.</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|wiki-file-name|Wiki-file-name}}
|-
! {{nowrap|wiki-file-name}}
|
<translate>
<!--T:419-->
The <tvar name=1><code>"wiki-file-name"</code></tvar> value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.

<!--T:623-->
'''Effects'''

<!--T:420-->
* In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"wiki-file-name"</code></tvar> has no visible effect.</translate>
<translate>
<!--T:421-->
* In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"wiki-file-name"</code></tvar> makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected.</translate> The file names do not contain the "File:" namespace prefix. <translate><!--T:422--> The dropdown menu also shows the thumbnail of the files.</translate> <translate><!--T:423--> It has no other visible effect and doesn't prevent a non-file from being inputted.</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|wiki-template-name|Wiki-template-name}}
|-
! {{nowrap|wiki-template-name}}
|
<translate>
<!--T:424-->
The <tvar name=1><code>"wiki-template-name"</code></tvar> value is intended for the name of a template.

<!--T:624-->
'''Effects'''

<!--T:425-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), <tvar name=1><code>"wiki-template-name"</code></tvar> makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected.</translate> <translate><!--T:426--> Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line.</translate> <translate><!--T:427--> It has no other visible effect and doesn't prevent a non-template from being inputted.</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|wiki-user-name|Wiki-user-name}}
|-
! {{nowrap|wiki-user-name}}
|
<translate>
<!--T:428-->
The <tvar name=1><code>"wiki-user-name"</code></tvar> value is intended for a username on a wiki.

<!--T:625-->
'''Effects'''

<!--T:429-->
In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), <tvar name=1><code>"wiki-user-name"</code></tvar> makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected.</translate> <translate><!--T:430--> Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line.</translate> <translate><!--T:431--> It has no other visible effect and doesn't prevent a non-username from being inputted.</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|content|Content}}
|-
! content
|
<translate>
<!--T:432-->
The <tvar name=1><code>"content"</code></tvar> value is intended for wikitext of page content, for example, links, images or text formatting.

<!--T:626-->
'''Effects'''

<!--T:433-->
* In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"content"</code></tvar> has no visible effect.</translate>
<translate>
<!--T:434-->
* In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"content"</code></tvar> makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.
</translate>
|- style="visibility:collapse"
| colspan="3" | {{anchor|unbalanced-wikitext|Unbalanced-wikitext}}
|-
! {{nowrap|unbalanced-wikitext}}
|
<translate>
<!--T:435-->
The <tvar name=1><code>"unbalanced-wikitext"</code></tvar> value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.

<!--T:627-->
'''Effects'''

<!--T:436-->
* In VisualEditor and the 2017 wikitext editor, <tvar name=1><code>"unbalanced-wikitext"</code></tvar> has no visible effect.</translate>
<translate>
<!--T:437-->
* In the 2010 wikitext editor with TemplateWizard, <tvar name=1><code>"unbalanced-wikitext"</code></tvar> makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.
</translate>
|}

{{anchor|Custom formats}}

=== <translate><!--T:213--> Custom formats</translate> ===
<translate>
<!--T:385-->
When editing the <tvar name=1><code>"format"</code></tvar> value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
</translate>

* <code><nowiki>{{</nowiki></code> - <translate><!--T:386--> start of the template</translate>
* <code><nowiki>_</nowiki></code> - <translate><!--T:387--> content (e.g., string, integer or parameter).</translate> <translate><!--T:388--> This underscore serves to indicate the minimum length of a value in characters and can be repeated, like <tvar name=1><code><nowiki>_______</nowiki></code></tvar>.</translate> <translate><!--T:389--> If this length is not reached, it fills the remaining characters with spaces.</translate> <translate><!--T:390--> This can be used to align all equals signs to a specific position after a parameter (if used with <tvar name=1><code>\n</code></tvar> for new lines).</translate>
* <code><nowiki>|</nowiki></code> - <translate><!--T:391--> pipe (separates parameters)</translate>
* <code><nowiki>=</nowiki></code> - <translate><!--T:392--> equals sign (precedes the value of a parameter)</translate>
* <translate><!--T:393--> <tvar name=1><code>\n</code></tvar> or pressing the enter key - new line (this will display as <tvar name=2><code>↵</code></tvar> in the entry field)</translate>
* <code><nowiki> </nowiki></code> - <translate><!--T:394--> space (can be used with <code>\n</code> to indent new lines)</translate>
* <code><nowiki>}}</nowiki></code> - <translate><!--T:395--> end of the template</translate>

<translate>
<!--T:396-->
The wikitext should at least meet the minimum of <code><nowiki>{{_|_=_}}</nowiki></code>, otherwise there will be an invalid format string error.
</translate>

{| class="wikitable"
|+ <translate><!--T:214--> Examples of formats you can use</translate>
! style="width:25%" | <translate><!--T:215--> Objective</translate>
! <translate><!--T:216--> Format string</translate> 
! <translate><!--T:217--> Output</translate>
|-
| <translate><!--T:218--> Inline formatting</translate>
| <code style="white-space: pre-wrap;"><nowiki>{{_|_=_}}</nowiki></code> <br/> <code>inline</code>
| <pre>{{Foo|bar=baz|qux=quux}}{{Bar}}</pre>
|-
| <translate><!--T:219--> Block formatting</translate>
| <code style="white-space: pre-wrap;"><nowiki>{{_\n| _ = _\n}}</nowiki></code> <br/> <code>block</code>
| <pre>{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}</pre>
|-
| <translate><!--T:220--> No space before the parameter name, each template on its own line</translate>
| <code style="white-space: pre-wrap;"><nowiki>\n{{_\n|_ = _\n}}\n</nowiki></code>
| <pre>{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}</pre>
|-
| <translate><!--T:221--> Indent each parameter</translate>
| <code style="white-space: pre-wrap;"><nowiki>{{_\n |_ = _\n}}</nowiki></code>
| <pre>{{Foo
 |bar = baz
 |qux = quux
}}{{Bar
}}</pre>
|-
| <translate><!--T:222--> Align all parameter names to a given length</translate>
| <code style="white-space: pre-wrap;"><nowiki>{{_\n|_______________ = _\n}}\n</nowiki></code> || <pre>{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar
}}</pre>
|-
| <translate><!--T:223--> Pipe characters at the end of the previous line</translate>
| <code style="white-space: pre-wrap;"><nowiki>{{_|\n _______________ = _}}</nowiki></code>
| <pre>{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}</pre>
|-
| <translate><!--T:224--> Inline style with more spaces, must be at start of line</translate>
| <code style="white-space: pre-wrap;"><nowiki>\n{{_ | _ = _}}</nowiki></code>
| <pre>{{Foo | bar = baz | qux = quux}}
{{Bar }}</pre>
|-
| <translate><!--T:225--> Template at the start of a line, indent-aligned parameters, pipe beforehand</translate>
| <code style="white-space: pre-wrap;"><nowiki>\n{{_ |\n  _______________ = _}}</nowiki></code>
| <pre>{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}</pre>
|}

{{anchor|Blank boilerplate}}
<translate>
=== Blank boilerplate === <!--T:187-->

<!--T:170-->
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.
</translate>

<syntaxhighlight lang="javascript"><templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata></syntaxhighlight>

<translate>
==Errors== <!--T:231-->

===Syntax error in JSON / Bad JSON format=== <!--T:232-->

<!--T:234-->
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).

<!--T:235-->
"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.

<!--T:441-->
This error can come up quite frequently while editing a template's TemplateData manually. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.
</translate>

:<translate><!--T:442--> Examples of trailing commas:</translate>

<syntaxhighlight lang="javascript"><templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": "", // <-- This comma shouldn't be here.
        }, // <-- This comma shouldn't be here.
    }, // <-- This comma shouldn't be here.
}
</templatedata></syntaxhighlight>

:<translate><!--T:443--> Examples of missing commas:</translate>

<syntaxhighlight lang="javascript"><templatedata>
{
    "description": "",
    "format": "inline" // <-- A comma should be here.
    "params": {
        "1": {
            "label": "",
            "description": "" // <-- A comma should be here.
            "type": ""
        }
    }
}
</templatedata></syntaxhighlight>

:<translate><!--T:444--> Example of missing quotation marks:</translate>

<syntaxhighlight lang="javascript">
"description": An example description // <-- This text should have quotation marks.
</syntaxhighlight>

<translate>
<!--T:236-->
To fix these errors, you can either look for the errors in the code yourself, or you can enter the JSON block into an external JSON validator, such as <tvar name=1>[[#jsonlint|JSONLint]]</tvar>, and it will highlight the problematic commas and keys that should be removed.

<!--T:233-->
Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: <tvar name=1>{{phab|T128029}}</tvar>), as the JavaScript parser is less strict and allows invalid JSON.
</translate>

{{anchor|Required property}}
<translate>
=== Required property "paramOrder(''number'')" not found.=== <!--T:451-->
</translate>
<translate><!--T:452--> This error occurs if you state a parameter in <tvar name=1><code>"[[#Params|params]]"</code></tvar> that is not stated in <tvar name=2><code>"[[#ParamOrder|paramOrder]]"</code></tvar>.</translate>
<translate><!--T:453--> The number in the square brackets refers to the parameter in <tvar name=1><code>"paramOrder"</code></tvar> that is missing. It refers to its order in the sequence, but it is one less than its actual position, since <tvar name=1><code>"paramOrder"</code></tvar> is an array; 0 is the first one, 1 is the second, etc.</translate>

<syntaxhighlight lang="javascript">
"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Error: Required property "paramOrder[2]" not found.
</syntaxhighlight>

<translate><!--T:454--> To fix this, make sure all parameters stated in <tvar name=1><code>"params"</code></tvar> are listed in <tvar name=2><code>"paramOrder"</code></tvar>.</translate>
<translate><!--T:455--> Alternatively, you can remove the <tvar name=1><code>"paramOrder"</code></tvar> object to remove this error.</translate>

<translate>
=== Invalid value for property "paramOrder(''number'')". === <!--T:456-->
</translate>
<translate><!--T:457--> This error occurs if you state a parameter in <tvar name=1><code>"[[#ParamOrder|paramOrder]]"</code></tvar> that is not stated in <tvar name=2><code>"[[#Params|params]]"</code></tvar>.</translate>
<translate><!--T:458--> The number in the square brackets refers to the parameter in <tvar name=1><code>"paramOrder"</code></tvar> that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since <tvar name=1><code>"paramOrder"</code></tvar> is an array; 0 is the first one, 1 is the second, etc.</translate>

<syntaxhighlight lang="javascript">
"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- This parameter is not stated in "params", but it should be.
    "talk"
]

// Error: Invalid value for property "paramOrder[1]".
</syntaxhighlight>

<translate><!--T:459--> To fix this, make sure all parameters stated in <tvar name=1><code>"paramOrder"</code></tvar> are listed in <tvar name=2><code>"params"</code></tvar>.</translate>
<translate><!--T:460--> Alternatively, you can remove the <tvar name=1><code>"paramOrder"</code></tvar> object to remove this error.</translate>

<translate>
=== Property "<tvar name=1>params.''parametername''.required</tvar>" is expected to be of type "boolean". === <!--T:461-->

<!--T:462-->
This error occurs if you put quotation marks around the value of either <code>"[[<tvar name=1>#Required</tvar>|required]]"</code> or <code>"[[<tvar name=2>#Suggested</tvar>|suggested]]"</code>.
</translate>

<syntaxhighlight lang="javascript">
"suggested": "true" // <-- These quotation marks shouldn't be here.
</syntaxhighlight>

<translate><!--T:463--> These are boolean values, not strings, therefore they require no quotation marks.</translate>
<translate><!--T:464--> To fix this, remove any quotation marks around the values <tvar name=1><code>true</code></tvar> or <tvar name=2><code>false</code></tvar> for these parameters.</translate>

<translate>
=== Property "format" is expected to be ... === <!--T:446-->

<!--T:447-->
If the <tvar name=1><code>"[[#Format|format]]"</code></tvar> parameter exists but its value is not <tvar name=2><code>"inline"</code></tvar>, <tvar name=3><code>"block"</code></tvar> or a valid format string, you will see the error message "Property "format" is expected to be "inline", "block", or a valid format string."
</translate>

<syntaxhighlight lang="javascript">
"format": "notinline"

// Error : Property "format" is expected to be "inline", "block", or a valid format string.
</syntaxhighlight>

<translate><!--T:448--> To fix this, make sure the value after <code>"format": </code> equals <tvar name=1><code>"inline"</code></tvar> or <tvar name=2><code>"block"</code></tvar> and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of <tvar name=3><code><nowiki>{{_|_=_}}</nowiki></code></tvar> 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 [[<tvar name=4>#Custom formats</tvar>|#Custom formats]] for the syntax for custom formats.</translate>
<translate><!--T:450--> Alternatively, you can remove the <tvar name=1><code>"format"</code></tvar> parameter to remove this error.</translate>

{{anchor|Unexpected property}}
<translate>
=== Unexpected property "''parametername''". === <!--T:470-->
</translate>
<translate><!--T:628--> This error occurs if you state a parameter that does not exist in TemplateData.</translate>
<translate><!--T:629--> This is probably due to spelling mistakes.</translate>

<syntaxhighlight lang="javascript"><templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- spelling mistake
            "type": ""
        }
    }
}
</templatedata></syntaxhighlight>

<translate>
<!--T:471-->
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.

<!--T:472-->
For example, you might have written the parameter <tvar name=2><code>"[[#Label|label]]"</code></tvar> under the root TemplateData object instead of inside <tvar name=3><code>"[[#Params|params]]"</code></tvar>:</translate>

<syntaxhighlight lang="javascript"><templatedata>
{
    "description": "",
    "format": "inline",
    "label": "", // <-- incorrectly placed parameter
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata></syntaxhighlight>

<translate>
<!--T:492-->
Alternatively, if the unexpected parameter is under a template parameter inside <tvar name=1><code>"params"</code></tvar>, you'll see its name after "params.''parametername''." in the error.
</translate>

<translate><!--T:473--> To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location.</translate>
<translate><!--T:630--> Additionally, make sure you don't state any parameters that don't exist for a TemplateData object.</translate>
<translate><!--T:631--> You can check which parameters exist for an object in the section [[<tvar name=1>#TemplateData parameters</tvar>|#TemplateData parameters]].</translate>

<translate>
=== Required property "params" not found. === <!--T:465-->
</translate>
<translate><!--T:466--> This error occurs if there is no <tvar name=1><code>"[[#Params|params]]"</code></tvar> object in the TemplateData.</translate>
<translate><!--T:467--> This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes.</translate>
<translate><!--T:468--> See [[<tvar name=1>#Params</tvar>|the section above]] on how to add the <tvar name=2><code>"params"</code></tvar> parameter.</translate>

{{anchor|Limitations and questions}}
<translate>
== Limitations and feedback == <!--T:179-->
</translate>
* '''<translate><!--T:103--> Missing features</translate>''' – <translate><!--T:104--> TemplateData is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please [<tvar name=bugzilla>https://phabricator.wikimedia.org/maniphest/task/create/?projects=MediaWiki-extensions-TemplateData</tvar> let us know].</translate>
* '''<translate><!--T:105--> Delays in showing in templates</translate>''' – <translate><!--T:106--> After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in the visual editor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page ''without making any change and without adding any edit summary''.</translate>
* '''<translate><!--T:107--> Current issues</translate>''' – <translate><!--T:108--> A list of current bugs and feature requests is available [[<tvar name=bugzilla>phabricator:maniphest/query/5OLCQh34NZjK/#R</tvar>|in the Wikimedia bug tracker]].</translate>

{{anchor|Other tools}}
<translate>
== Other tools == <!--T:188-->
</translate>
; {{ll|Help:Extension:TemplateWizard}}: <translate><!--T:227--> A toolbar dialog window for entering template wikitext via an form built from TemplateData.</translate>
; [http://tools.wikimedia.pl/~mlazowik/templatedata/ TemplateData Wizard]: <translate><!--T:172--> A tool that generates TemplateData through an interactive interface.</translate>
; [[w:User:Salix alba/TDSkell|Skeleton TemplateData generator]]: <translate><!--T:173--> A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.</translate>
; {{anchor|jsonlint}}[https://jsonlint.com/ JSONLint]: <translate><!--T:174--> A tool that allows you to validate manually-written JSON to help find errors in the syntax.</translate>
* <translate><!--T:175--> [<tvar name=url>{{fullurl:Special:PagesWithProp|propname=templatedata&propname-other=}}</tvar> List of all templates with TemplateData] on this wiki</translate>
* <translate><!--T:176--> With [[w:de:Template:TemplateData|dewiki template TemplateData]] template data is shown in a box, and the template is added to a [[w:de:category:Vorlage:mit_TemplateData|category]] of templates with template data</translate>
* <translate><!--T:673--> <tvar name=1>https://query.wikidata.org/</tvar> and [[<tvar name=2>d:Wikidata:SPARQL query service/Query Helper</tvar>|Query Helper]]</translate>