Help:TemplateData/nqo

 ߦߋ߫ ߘߐ߬ߥߙߊ߬ߟߌ ߘߏ߫ ߟߋ߬ ߘߌ߫ ߞߊ߬ ߥߞߌߞߟߏߜߍ ߞߙߊߞߏ ߞߌ߬ߓߊ߬ߙߏ߬ߦߊ ߟߎ߬ ߟߊߡߊ߲߬ߘߌ߫ ߊ߬ ߣߴߊ߬ ߟߊ߬ߓߍ߲߬ߢߐ߲߰ߡߦߊ߬ߘߊ߸ ߏ߬ ߘߐ߫ ߢߐ߲߯ߕߍߞߣߍ ߡߊ߬ߦߟߍ߬ߡߊ߲߬ߠߌ߲ ߘߌ߫ ߛߴߊ߬ ߖߊ߬ߛߏ߲߬ ߠߴߊ߬ ߣߌ߫ ߞߊ߬ ߞߌ߬ߓߊ߬ߙߏ߬ߦߊ ߏ߬ ߟߊߓߊ߯ߙߊ߫ ߊ߬ ߞߙߊߞߏ ߡߊߦߟߍ߬ߡߊ߲ ߘߐ߫߸ ߏ߬ ߦߴߊ߬ ߞߍ߫ ߟߊߣߐ߰ߦߊ߬ ߟߊ߫ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߟߎ߬ ߓߟߏ߫ ߞߵߊ߬ ߟߊߘߏ߲߬ ߞߐߜߍ ߟߎ߬ ߟߴߊ߬ ߣߌ߫ ߞߵߊ߬ ߡߊߦߟߍ߬ߡߊ߲߫ ߞߐߜߍ ߟߎ߬ ߟߊ߫.

ߞߊ߬ߦߌ߯ ߂߀߁߉ ߞߏ߲ߞߏߘߌ߬ߓߌ ߟߊ߫߸ ߞߙߊߞߏߘߕߊ ߦߋ߫ ߓߐߛߎ߲ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߟߐ߲ߕߊ ߝߊ߲߭ ߘߏ߫ ߟߋ߬ ߘߌ߫ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߓߍ߯ ߦߋ߫ ߥߞߌߔߋߘߌߦߊ ߥߞߌ ߟߎ߬ ߓߍ߯ ߞߊ߲߬߸ ߣߴߊ߬ߟߎ߫ ߞߊ߬ ߞߙߊߞߏ ߘߏ߫ ߝߙߊ߬, ߤߊߟߌ߬ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߜߊ߲߬ߞߎ߲߬ߓߊߟߌ ߟߎ߬ ߝߣߊ߫. ߢߊ߫ ߝߌ߬ߟߊ߫ ߞߊ߲߬ ߓߐߛߎ߲ ߛߎ߲ ߣߌ߫ ߦߋߢߊ߫ ߡߊߦߟߍߡߊ߲ ߡߊ߬ߦߟߍ߬ߡߊ߲߬ߠߊ ߟߎ߬ ߓߍ߯ ߟߊߘߏ߲߬ ߠߊ߫ ߛߌߟߊ ߘߏ߫ ߝߍ߬. ߊ߬ ߦߋ߫ ߟߊߓߊ߯ߙߊ߫ ߟߊ߫ ߞߊ߲ߞߕߐߡߊ߬ ߛߑߞߙߌߔߕߛ ߟߊ߫߸ ߖߐ߯ߙߊ߲ ߠߴߊ߬ ߣߌ߫ ߜ߭ߊߘߑߜ߭ߍߕߛ ߟߎ߫ ߟߊ߫. ߌ ߖߘߍ߬ߞߊ߬ߣߌ߲߬ ߥߞߌ ߦߴߌ ߓߟߏ߫߸ ߌ ߡߊ߬ߞߏ ߘߌ߫ ߛߋ߫ ߡߊߞߍ ߡߊ߬.

ߞߙߊߞߏߘߕߊ ߝߙߊ߬ߟߌ ߞߙߊߞߏ ߘߏ߫ ߟߊ߫߸ ߏ߬ ߛߏ߯ߙߏߣߍ߲߫ ߦߋ߫ ߓߑߟߐߞ ߘߋ߬ߣߍ߲ JSON ߘߏߝߙߍߕߍ (ߏ߬ ߘߊ߲߬ߕߍ߰ߣߍ߲߬ ߦߋ߫ ߘߎ߰ߟߊ ߘߐ߫) ߞߙߊߞߏ ߘߐ߬ߛߙߋ߬ߦߊ߬ߟߌ ߞߐߜߍ ߘߐ߫. ߒ߬ߞߊ߬ ߏ߬ ߘߌ߫ ߛߋ߫ ߝߙߋߞߋ߫ ߟߊ߫߸ ߞߵߊ߬ ߕߘߴߊ߬ ߣߐ߰ߡߊ߲߬ߓߊ ߟߋ߬. ߌ ߘߌ߫ ߛߋ߫ ߣߌ߲߬ ߞߍ߫ ߟߊ߫ ߛߌߟߊ߫ ߓߊߖߎߡߊ߫ ߝߌ߬ߟߊ߫ ߝߍ߬߸ ߞߵߊ߬ ߞߍ߫ ߓߟߏߟߕߊ ߘߌ߫ ߥߟߊ߫ ߞߊ߬ ߞߙߊߞߏߘߕߊ ߡߊ߬ߦߟߍ߬ߡߊ߲߬ߟߊ߲ ߠߊߓߊ߯ߙߊ߫߸ ߥߍ߬ߢߍ߲ ߢߐ߲߯ߕߍߞߣߍ ߟߋ߬ ߘߌ߫ "ߊ߬ ߡߊߦߟߍ߬ߡߊ߲߫"/"ߊ߬ ߛߎ߲ ߡߊߦߟߍ߬ߡߊ߲" ߘߐ߫ ߞߙߊߞߏ ߞߐߜߍ ߟߊ߫ ߥߞߌ ߟߎ߬ ߟߊ߫ ߞߙߊߞߏߘߕߊ ߘߐߥߙߊ߬ߟߌ ߟߊߞߎ߲߬ߘߎ߬ߣߍ߲ ߘߌ߫. JSON ߘߐߞߍߣߍ߲߫ ߦߋ߫ ߞߙߊߞߏ ߟߊ߬ߓߍ߲߬ߢߐ߲߰ߡߦߊ߬ߘߊ ߛߙߍߘߍ ߟߎ߬ ߣߌ߫ ߟߊ߬ߓߍ߲߬ߢߐ߲߰ߡߦߊ߬ߘߊ ߞߋ߬ߟߋ߲߬ߞߋ߬ߟߋ߲߬ߠߊ ߓߍ߯ ߞߌ߬ߓߊ߬ߙߏ߬ߦߊ ߟߎ߬ ߟߋ߬ ߟߊ߫߸ ߊ߬ ߣߌ߫ ߞߙߊߞߏ ߡߎ߰ߡߍ. ߏ߬ ߟߎ߬ ߛߓߍߣߍ߲߫ ߦߋ߫ ߘߎ߰ߟߊ ߘߐ߫.

ߣߌ߫ ߞߙߊߞߏ ߞߍ߫ ߘߊ߫ ߞߙߊߞߏߘߕߊ ߘߌ߫߸ ߞߌ߬ߓߊ߬ߙߏ߬ߦߊ ߏ߬ ߘߌ߫ ߦߌ߬ߘߊ߬ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߟߊ߫ ߢߐ߲߯ߕߍߞߣߍ ߘߐ߫ ߣߌ߫ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߞߊ߬ ߞߙߊߞߏ ߝߙߊ߬߸ ߥߊ߯ߕߌ ߘߏ߫ ߟߴߊ߬ ߘߌ߫ ߓߐߛߎ߲ ߞߌ߬ߓߊ߬ߙߏ߬ߦߊ ߟߎ߬ ߦߌ߬ߘߴߊ߬ ߣߌ߫ ߥߊ߯ߕߌ߫ ߜߘߍ߫ ߟߊ߫ ߞߌ߬ߓߊ߬ߙߏ߬ߦߊ߬ ߡߊߞߊ߬ߝߏ߬ߣߍ߲ ߠߎ߬. ߛߋ߲߬ߧߊ ߘߏ߫ ߟߎ߫ ߘߐ߫߸ ߊ߬ ߘߌ߫ ߡߊߝߊ߬ߟߋ߲߬ ߞߊ߬ ߓߍ߲߬ ߡߊ߬ߦߟߍ߬ߡߊ߲߬ߠߊ ߟߊ߫ ߞߏߡߌߘߊߢߊ ߡߵߊ߬ ߡߊߦߟߍ߬ߡߊ߲߫ ߕߎߡߊ ߥߟߊ߫ ߞߙߊߞߏ ߝߙߊ߬ ߕߎߡߊ. ߏ߬ ߟߋ ߞߵߊ߬ ߟߊߣߐ߰ߦߊ߬ ߞߏߖߎ߯ߦߊ߫ ߟߊ߬ߓߊ߰ߙߊ߬ߟߊ ߟߎ߬ ߓߟߏ߫߸ ߊ߬ߟߎ߬ ߓߊ߯ ߞߴߊ߬ ߝߍ߬ ߞߙߊߞߏ ߦߋ߫ ߡߊߟߐ߲߫ ߢߊ ߡߍ߲ ߊ߬ ߝߙߊ߬ ߕߎߡߊ ߟߊ߫.

ߘߐ߬ߝߐ
ߞߙߊߞߏߘߕߊ ߓߐߛߎ߲ ߟߊߛߓߊ߬ߕߌ߫ ߘߊ߫ ߂߀߁߃ ߞߎ߲߬ߝߟߐ ߟߋ߬ ߘߐ߫ ߦߟߌ ߘߌ߫߸ ߏ߬ ߡߍ߲ ߕߘߍ߬ ߦߋ߫ ߡߋߘߌߦߊߥߞߌ ߡߊߝߍߣߍ߲ߠߌ߲߫ ߝߊߘߌ ߘߌ߫ ߥߊ߯ߕߌ ߏ߬ ߟߊ߫. ߦߋߢߊ ߡߊߦߟߍ߬ߡߊ߲߬ߠߌ߲ ߦߋ߫ ߦߋߢߊ߫ ߡߊߦߟߍߡߊ߲ ߓߊߖߎߡߊ ߢߐ߲߯ߕߍߞߣߍ ߟߋ߬ ߘߌ߫ ߥߞߌߡߋߘߌߦߊ ߥߞߌ ߟߎ߬ ߦߋ߫߸ ߊ߬ ߣߌ߫ ߞߙߊߞߏߘߕߊ ߦߴߊ߬ ߟߊߘߌ߬ߢߍ߬ ߟߊ߫ ߞߵߊ߬ ߞߍ߫ ߢߐ߲߯ߕߍߞߣߍ߫ ߟߊߓߊ߯ߙߕߊ ߞߏߟߌߞߏߟߌ ߘߌ߫ ߣߌ߫ ߞߙߊߞߏ ߟߎ߬ ߡߊߦߟߍ߬ߡߊ߲ ߞߍ߫ ߘߴߌ ߘߐ߫. It was officially supported by VisualEditor immediately. 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.

In December 2016, the VisualEditor interface was made available for editing source code as a beta feature. This was termed the 2017 wikitext editor. This brought the features of TemplateData to source editing for the first time.

In March 2018, Sam Wilson developed, a GUI template editor extension for the default Wikimedia source editor, (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from TemplateData. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that TemplateData was now a default part of both the visual editor and the source editor on Wikimedia wikis.

Adding or editing TemplateData
To add or edit TemplateData, first navigate to a template's page, located at "/Template:Templatename".

Prior checks
There are two things you should check before adding or editing TemplateData, in the following order:


 * 1) whether the template has a documentation subpage
 * 2) whether the template already has TemplateData and whether this is located on the template page or the documentation subpage.

Checking for the documentation subpage

The first thing to do is identify whether the template has a subpage for its documentation or not.

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:


 * The vast majority use a documentation subpage. This is a page located at the template's name followed by "/doc". In this case, on the main template page after the template source code, there is only the text " " between  tags. Here, the Documentation template transcludes all the /doc page's content onto the template page. This makes the template's source code look much cleaner.
 * A small minority keep the information on the template's main page, after its source code. In this case, it is contained after " ", which is between  tags.

You can quickly identify whether a template has a /doc page by checking if the " Template documentation" (or similar) heading has links like "[view] [edit] [history] [purge]" after it. This may look slightly different on different wikis. Rarely, the main template page may still have documentation content even if you see these buttons and there is a /doc page. This will happen if a user has added a custom /doc page title between " " and " " then added content after " ".

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.

If a template doesn't have a documentation subpage

If a template doesn't have a documentation subpage, you have two options:


 * You can either create it and move its documentation (if it has any) there. After this, you can then add TemplateData to the documentation subpage. This is the preferred option.
 * Or, you can add or edit TemplateData on the main template page.

Creating the doc subpage and moving the documentation contents

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

To do this, click "Edit"/"Edit source" on the main template page, and look for the  tags and their contents, usually at the bottom.

It should look something like this: It might also have TemplateData already. This will look something like: Select everything after " " and before " ", cut it, then delete " ", so you are just left with: Now, save the page.

Next, add "/doc" to the URL in the address bar after the template name, and press Enter. Then, click "Create source".

If your wiki has a Documentation subpage notice template, add it at the top. You may also want to add some other templates, like a Purge button or Purge link, if your wiki has it. See meta:Help:Template documentation for more info.

Beneath this, paste the contents of the clipboard.

Next, enclose the categories within  tags. This is so that they don't have an effect on the doc subpage, only on the template's main page.

This will look like this: Some wikis (including the English Wikipedia) have a template. Use this if the template can be expected to have a sandbox version, located at "Template:Templatename/sandbox". It will stop the categories from having an effect on the sandbox page.

This will look like this: After this, click "Publish page".

You can now add or edit the TemplateData on the documentation subpage based on the guidance at.

Adding or editing TemplateData on the main template page

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 to do this.

If a template has a documentation subpage

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.

Check both the template page and the /doc subpage for the presence of TemplateData documentation; this looks something like this: {   "description": "", "params": { "1": {           "label": "Example parameter", "description": "Example parameter description", "type": "string" }   } } Alternatively, the TemplateData extension can perform this check for you. Simply click "Edit" or "Edit source" on either page.

If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:


 * "Please note: there is already a TemplateData block on the related page "Template:Templatename/doc"", or
 * "Please note: there is already a TemplateData block on the related page "Template:Templatename""

If the template has TemplateData on its documentation subpage

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, simply clicking "Edit" or "Edit source" at the top. Follow the guidance at to add or edit the TemplateData.

If the template has TemplateData on its main page

If the template has TemplateData on its main page, you once again have two options:


 * You can either move to its documentation subpage. This is the preferred option.
 * Or, you can edit it on the main template page.

Moving TemplateData to the documentation subpage

To do this, simply click "Edit"/"Edit source" on the main template page, and look for the  tags, enclosed within   tags. It should look something like this: Cut only the  tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading " Template documentation" (or similar).

Type a heading, like "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at.

Editing TemplateData on the main template page

If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See for how to edit TemplateData.

If the template does not yet have TemplateData but has a doc subpage

If the template does not yet have TemplateData, you should add it to the documentation subpage.

Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, simply clicking "Edit" or "Edit source" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section explains how to add TemplateData.

TemplateData editor method
This is the simpler way to add or edit TemplateData, possible for inexperienced users.

The TemplateData editor is a graphical user interface for adding and editing TemplateData.

It is part of the TemplateData extension.

It is accessible by going to any template's page (or documentation subpage) and clicking "Edit" or "Edit source".

After clicking "Edit" or "Edit source", you will see a button above the editing area and page title that says "".

Clicking this button will enter the TemplateData editor.

If the page you are on already contains TemplateData, this will automatically show here. Features in the above window:


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


 * 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 here.


 * 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 here.


 * If the user chooses "Custom", they will be able to enter a set of wikitext under "Custom format string", according to rules outlined here, to create a custom layout for the template when the user clicks "Insert".


 * 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  or  . 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".


 * At the bottom is "Add parameter". This allows you to add a parameter manually with a custom name.

The next stage is clicking any one of the parameters in the list. This will allow you to edit that parameter's info.



All of these features and their effects are outlined at #Within a parameter's name.

When you are finished, click "Apply".

This will automatically insert the TemplateData at the bottom of the page before the tag; or, if it already exists, it will update it with the new information without changing its position at all.

The TemplateData text will also be selected when you click "Apply".

The TemplateData editor creates a  parameter at the bottom of the TemplateData or updates it if it already exists.

This contains the current TemplateData parameters in the order they were displayed in the TemplateData editor.

You can change the paramOrder by dragging the parameters in different orders in the TemplateData editor using the three horizontal bars on the left. and its effects are outlined here.

After this, click "Save" to save the revision of the page.

Manual method
The alternative is to add or edit TemplateData manually. You may need or wish to do this in some cases.

TemplateData's structure is based around the JSON standard, but you do not need to learn JSON to learn how to place TemplateData.

It follows a few very simple rules and takes only a few dozen possible predefined parameters and values, almost always in a  format.

Adding TemplateData manually

Preconsiderations:


 * 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.
 * If you're adding TemplateData on a template's main page (which is not preferred; see #Prior checks), you must make sure that it is within the  tags.

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

Many wikis (but not all) have a TemplateData header template, which adds a short notice about the TemplateData. If yours does, add this after the heading.

To start adding the TemplateData, type an opening and closing  tag and a pair of curly brackets on new lines, with an empty line between them: 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. Most are optional, but some are highly recommended.

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:

Also, make sure the parameters within, for example, the #Unexpected property object are kept within that object, or you will receive an "Unexpected property" error when you try to save.

Example Here is some example TemplateData for a hypothetical cleanup template. 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. The notice could also contain a link to a talk page section, if specified. The TemplateData would look something like this: The corresponding TemplateData documentation would display as the following: {	"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": " ", "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 parameters
Each parameter for TemplateData is listed below with a description and example.

They are also listed at Extension:TemplateData#Format.

Within a parameter's name
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

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 feedback page what you were trying to do, and we will be happy to help.

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

Note that each item of information is enclosed in quotation marks (except for  and  ) and separated from the next bit by a comma (unless it's the last one).

Type parameter
The  parameter is meant to signal to a template editor the nature of a parameter's value.

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.

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.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in speech marks.

Example: Effects

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

The currently known effects are listed as follows.

Custom formats
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Syntax error in JSON / Bad JSON format
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).

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

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.


 * Examples of trailing commas:


 * Examples of missing commas:


 * Example of missing quotation marks:

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 JSONLint, and it will highlight the problematic commas and keys that should be removed.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in.

The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in.

Alternatively, you can remove the  object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in.

The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in.

Alternatively, you can remove the  object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks.

To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "Property "format" is expected to be "inline", "block", or a valid format string."

To fix this, make sure the value after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.

Alternatively, you can remove the  parameter to remove this error.

Unexpected property "parametername".
This error occurs if you state a parameter that does not exist in TemplateData.

This is probably due to spelling mistakes.

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.

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

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.

Additionally, make sure you don't state any parameters that don't exist for a TemplateData object.

You can check which parameters exist for an object in the section #TemplateData parameters.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData.

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.

See the section above on how to add the  parameter.

Limitations and feedback

 * Missing features – 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 let us know.
 * Delays in showing in templates – 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.
 * Current issues – A list of current bugs and feature requests is available in the Wikimedia bug tracker.

Other tools

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * TemplateData Wizard: A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator: 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.
 * JSONLint: A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data