ଛାଞ୍ଚ:Format TemplateData/doc
This is a documentation subpage for ଛାଞ୍ଚ:Format TemplateData. It may contain usage information, categories and other content that is not part of the original ଛାଞ୍ଚ page. |
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, {{tl|TemplateData header}} is automatically inserted before the table.
Parameter | Description | Type | Status | |
---|---|---|---|---|
JSON template information | JSON 1 | 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*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.*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.
| String | optional |
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 |
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[ସମ୍ପାଦନା]
The easiest way to using the template might be enclosing the <templatedata>
tags in a pair of HTML comments like <!--<templatedata> ... </templatedata>-->
. This way, the "Manage TemplateData" editor can still pick up on the data, but the rendering is passed down to this template to do.
Maintenance categories[ସମ୍ପାଦନା]
- Category:Templates with TemplateData errors (୦) – the template adds this category to template documentation pages with malformed TemplateData code.