Template:Format TemplateData/doc
 | This is a documentation subpage for Template:Format TemplateData. It may contain usage information, categories and other content that is not part of the original template page. |
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| JSON template information | JSON1 | 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. | String | required |
| 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 TemplateDataHeader template. This is not generally recommended.
| Boolean | optional |
Formatting options
- 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 [https://en.wikipedia.org Wikipedia], this will appear as Wikipedia in the table and https://en.wikipedia.org in VisualEditor.
- Bold and italics can be specified with apostrophes in the normal way. The text will be unformatted in VisualEditor.
- HTML entities: you may specify < > & " and any numeric entity.
- HTML tags may be used; they won't appear in VisualEditor.
- <noexport></noexport> 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.