Template:Format TemplateData/doc: Difference between revisions

m
clean up
(Created page with "{{Documentation subpage}} {{Lua|Module:Format TemplateData}} 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> { "description": "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 Visu...")
 
m (clean up)
 
Line 6: Line 6:
<templatedata>
<templatedata>
{
{
"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, {{[[Template:TemplateData header|TemplateData header]]}} is automatically inserted before the table.",
"description": "This template formats [[BP: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.",
"format": "block",
"format": "block",
"params": {
"params": {
Line 17: Line 17:
"JSON": {
"JSON": {
"label": "JSON template information",
"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.*'''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>",
"description": "The code that would normally be wrapped in [[BP: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.bharatpedia.org Bharatpedia&#93;, this will appear as [https://en.bharatpedia.org Bharatpedia] in the table and https:&#47;&#47;en.bharatpedia.org in VisualEditor.\n*'''[[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.\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",
"type": "string",
"default": "If neither {{{1}}}, {{{JSON}}}, nor {{{TNT}}} is given, the page's source code is scanned for a <templatedata> tag.",
"default": "If neither {{{1}}}, {{{JSON}}}, nor {{{TNT}}} is given, the page's source code is scanned for a <templatedata> tag.",
Line 60: Line 60:


<includeonly>{{sandbox other||
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- Categories below this line, please; interwikis at Bharatdata -->
[[Category:TemplateData]]
[[Category:TemplateData]]
}}</includeonly>
}}</includeonly>
16,952

edits