 | This is the template sandbox page for Template:Format TemplateData (diff). |
 | 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
editTemplateData 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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| <templatedata> template information | 1 | If the JSON parameter is 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 [[WP:TemplateData|<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 <>. <noexport><h3>Formatting options</h3>
| 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 {{[[Template:TemplateData header|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
editAdd the <templatedata> as usual, and then enclose it in a template call like {{Format TemplateData|1=<templatedata>...</templatedata>}}.
Maintenance categories
edit- Category:Templates with TemplateData errors (0) – the template adds this category to template documentation pages with malformed TemplateData code.
See also
edit- {{Template data}}
- {{TemplateData header}}
- {{Crude TemplateData}}
- {{Format TemplateData}}
- {{Template parameter usage}}
- {{TemplateData}}