Template:Format TemplateData/doc: Difference between revisions

Revision as of 05:46, 28 August 2021

Latest revision as of 05:53, 2 June 2025

(12 intermediate revisions by 8 users not shown)

Line 1:

{{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 [[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.",

Line 9 ⟶ 11:

"1": {

"label": "<templatedata> template information",

"description": "If the JSON andparameter TNT parameters areis not specified, this will be processed to extract the JSON. This option allows you to use the GUI TemplateData Editor, but it's a bit wonkier than giving the actual JSON object directly.",

"default": "See {{{JSON}}}.",

"type": "string"

Line 17 ⟶ 19:

"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>",

"type": "string",

"default": "If neither {{{1}}}, {{{JSON}}}, nor {{{TNTJSON}}} is given, the page's source code is scanned for a <templatedata> tag.",

"suggested": true

},

"TNT": {

"label": "Commons “Data:Templatedata” subpage",

"description": "If the JSON parameter is not specified, this is the name of the tabular data file storing the [[mw:Special:MyLanguage/Help:TemplateData|TemplateData]] file on [[c:Special:MyLanguage|Wikimedia Commons]] in the '''Data:''' namespace as a subpage of [[c:Special:PrefixIndex/Data:Templatedata/|Data:Templatedata]]. This relies on [[Module:TNT]].",

"autovalue": "{{subst:ROOTPAGENAME}}",

"suggested": true,

"type": "string"

},

"TOC": {

Line 48 ⟶ 43:

}

}

</templatedata>
}}

== Using the template ==

Line 55 ⟶ 51:

==Maintenance categories==

* {{clc|Templates with TemplateData errors}} – the template adds this category to template documentation pages with malformed TemplateData code.

==See also==

* {{tl|Template data}}

* {{tl|TemplateData header}}

* {{tl|Crude TemplateData}}

* {{tl|Format TemplateData}}

* {{tl|Template parameter usage}}

* {{tl|TemplateData}}

<includeonly>{{sandbox other||

<!-- Categories below this line, please; interwikis at Wikidata -->

[[Category:TemplateData]]

}}</includeonly>