Template:Format TemplateData/doc: Difference between revisions

Revision as of 00:53, 4 May 2019

Revision as of 03:31, 25 May 2020

Line 2:

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 ==

<!--<templatedata>

{{Format TemplateData|JSON={

{

"params": {

"JSON": {

"label": "JSON template information",

"description": "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>\n*'''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.\n*'''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.\n*'''[[HTML entities]]''': you may specify &amp;lt; &amp;gt; &amp;amp; &amp;quot; &amp;nbsp; and any numeric entity.\n*'''HTML tags''' may be used; they won't appear in VisualEditor.\n*'''&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.\n*'''Templates''' may be transcluded. However some templates may output content that makes the JSON invalid.</noexport>",

"type": "string",

"required": true,

"aliases": ["1"]

"type": "string",

"1"

"aliases": ["1"]

],

},

"default": "Fetched from the page's source code."

"TOC": {

},

"label": "Show table of contents",

"TOC": {

"description": "If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.",

"label": "Show table of contents",

"type": "boolean",

"description": "If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.",

"default": "0",

"type": "boolean",

"suggested": true

"default": "0",

},

"suggested": true

},

"header": {

"label": "Show TemplateDataHeader",

"description": "If set to 0, hides the TemplateDataHeader template. This is not generally recommended.",

"type": "boolean",

"default": "1"

},

"lazy": {

"label": "Prevent TemplateData output",

"description": "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.",

"type": "boolean",

"default": "0"

}

}

},

"description": "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, {{tl|TemplateData header}} is automatically inserted before the table."

} }}

</templatedata>-->

{{Format TemplateData|JSON={}}

==Maintenance categories==