Template:Format TemplateData/doc: Difference between revisions

Content deleted Content added
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 ==
<!--{{Format TemplateData|1=<templatedata>
{
"params": {
"1": {
"label": "&lt;templadata> template information",
"description": "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.",
"default": "If neither this nor JSON is given, the page's source code is scanned for a &lt;templatedata> tag."
]},
"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>*'''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 &#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.*'''[[HTML entities]]''': you may specify &amp;lt; &amp;gt; &amp;amp; &amp;quot; &amp;nbsp; and any numeric entity.*'''HTML tags''' may be used; they won't appear in VisualEditor.*'''&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.*'''Templates''' may be transcluded. However some templates may output content that makes the JSON invalid.</noexport>",
"type": "string",
"default": "Fetched from the page's source code.",
"aliases": [
"1suggested": true
],
"default": "Fetched from the page's source code."
},
"TOC": {
Line 36 ⟶ 39:
"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}}
 
== Using the template ==