टेम्पलेट:Format TemplateData
 | This template uses Lua: |
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 for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Format TemplateData in articles based on its TemplateData.
TemplateData for Format TemplateData
This template formats 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, {{TemplateData header}} is automatically inserted before the table.
| 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.
| String | optional |
| JSON template information | JSON | The code that would normally be wrapped in <templatedata> tags (not including the <templatedata> 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 <>. Formatting options
| 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 TemplateData file on Wikimedia Commons in the Data: namespace as a subpage of Data:Templatedata. This relies on Module:TNT.
| 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.
| Boolean | suggested |
| Show TemplateDataHeader | header | If set to 0, hides the {{TemplateData header}} template. This is not generally recommended.
| 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.
| 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
[संपादन करीं]- श्रेणी:Templates with TemplateData errors (0) – the template adds this category to template documentation pages with malformed TemplateData code.