Template:Format TemplateData

---

The following documentation is located at Template:Format TemplateData/documentation. ^[edit]

Useful links: subpage list • transclusions • redirects • sandbox

Module:Format TemplateData Everything below this line is a demo of Format TemplateData: read the source code, and expand the raw TemplateData section, to see how it all works.

Usage

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Format TemplateData

This template formats [[WP:VE/TD|TemplateData]] nicely on doc pages. It hides irrelevant information such as "Default: empty", and allows the use of formatting. Remember that the users of VisualEditor '''will not see''' this formatting; it is important to test your new TemplateData in VisualEditor to check that it makes sense without. (For all details of formatting available, see the template's page.) By default, {{[[Template:TemplateData header|TemplateData header]]}} is automatically inserted before the table.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
<templatedata> template information	1	If the JSON and TNT parameters are not specified, this will be processed to extract the JSON. This option allows you to use the GUI TemplateData Editor, but it's a bit wonkier than giving the actual JSON object directly. Default See {{{JSON}}}.	String	optional
JSON template information	JSON	The code that would normally be wrapped in [[WP:TemplateData|&lt;templatedata&gt;]] tags (not including the &lt;templatedata&gt; tags themselves. Links and basic text formatting should just work in the displayed table; see this template's page for full details. You should use HTML entities for special characters such as &lt;&gt;. <noexport><h3>Formatting options</h3> '''Wikilinks''' can be specified in the usual way. They will only work in the table; in VisualEditor, the title of the link will be displayed as plain text. '''External links''' can be specified by just inserting the URL; this will be clickable in the table and viewable in VisualEditor. If the URL is specified as &#91;https:&#47;&#47;en.wikipedia.org Wikipedia&#93;, this will appear as [https://en.wikipedia.org Wikipedia] in the table and https:&#47;&#47;en.wikipedia.org in VisualEditor. '''[[HTML entities]]''': you may specify &amp;lt; &amp;gt; &amp;amp; &amp;quot; &amp;nbsp; and any numeric entity.*'''HTML tags''' may be used; they won't appear in VisualEditor. '''&lt;noexport&gt;&lt;/noexport&gt;''' Content wrapped in these tags will appear only in the table. It will not appear in VisualEditor at all; it is useful for detailed explanations of parameters, and for content that is only useful with formatting. Newline characters are respected here. '''Templates''' may be transcluded. However some templates may output content that makes the JSON invalid.</noexport> Default If neither {{{1}}}, {{{JSON}}}, nor {{{TNT}}} is given, the page's source code is scanned for a <templatedata> tag.	String	suggested
Commons “Data:Templatedata” subpage	TNT	If the JSON parameter is not specified, this is the name of the tabular data file storing the [[mw:Special:MyLanguage/Help:TemplateData|TemplateData]] file on [[c:Special:MyLanguage|Wikimedia Commons]] in the '''Data:''' namespace as a subpage of [[c:Special:PrefixIndex/Data:Templatedata/|Data:Templatedata]]. This relies on [[Module:TNT]]. Auto value {{subst:ROOTPAGENAME}}	String	suggested
Show table of contents	TOC	If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table. Default 0	Boolean	suggested
Show TemplateDataHeader	header	If set to 0, hides the {{[[Template:TemplateData header|TemplateData header]]}} template. This is not generally recommended. Default 1	Boolean	optional
Prevent TemplateData output	lazy	If set, other than to 0, prevents any real TemplateData being produced. Potentially useful if there are multiple instances of this template on a page but only one should be active. To clarify, this means that this template will ''not'' be understood by VisualEditor. Default 0	Boolean	optional

Using the template

Add the <templatedata> as usual, and then enclose it in a template call like {{Format TemplateData|1=<templatedata>...</templatedata>}}.

Maintenance categories

• Category:Templates with TemplateData errors (0) – the template adds this category to template documentation pages with malformed TemplateData code.

See also

• JSON