Template:Format TemplateData/doc - Revision history

CleanupBot: clean up

2023-12-05T04:54:55Z

clean up

← Older revision		Revision as of 10:24, 5 December 2023
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\|<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 <>. <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 [https://en.~~wikipedia~~.org ~~Wikipedia~~], this will appear as [https://en.~~wikipedia~~.org ~~Wikipedia~~] in the table and https://en.~~wikipedia~~.org in VisualEditor.\n'''[[HTML entities]]''': you may specify &lt; &gt; &amp; &quot; &nbsp; and any numeric entity.'''HTML tags''' may be used; they won't appear in VisualEditor.\n'''<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.\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\|<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 <>. <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 [https://en.bharatpedia.org Bharatpedia], this will appear as [https://en.bharatpedia.org Bharatpedia] in the table and https://en.bharatpedia.org in VisualEditor.\n'''[[HTML entities]]''': you may specify &lt; &gt; &amp; &quot; &nbsp; and any numeric entity.'''HTML tags''' may be used; they won't appear in VisualEditor.\n'''<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.\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>

Muskit Gergous: 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= { "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..."

2023-08-06T04:40:44Z

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

New page

{{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.",
"format": "block",
"params": {
"1": {
"label": "<templatedata> template information",
"description": "If the JSON and TNT parameters are 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"
},
"JSON": {
"label": "JSON template information",
"description": "The code that would normally be wrapped in [[WP:TemplateData|<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 <>. <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 [https://en.wikipedia.org Wikipedia], this will appear as [https://en.wikipedia.org Wikipedia] in the table and https://en.wikipedia.org in VisualEditor.\n*'''[[HTML entities]]''': you may specify &lt; &gt; &amp; &quot; &nbsp; and any numeric entity.*'''HTML tags''' may be used; they won't appear in VisualEditor.\n*'''<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.\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 {{{TNT}}} 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": {
"label": "Show table of contents",
"description": "If set to 1, inserts a table of contents for the whole page just after the description and before any parameter table.",
"type": "boolean",
"default": "0",
"suggested": true
},
"header": {
"label": "Show TemplateDataHeader",
"description": "If set to 0, hides the {{[[Template:TemplateData header|TemplateData header]]}} 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"
}
}
}
</templatedata>
}}

== Using the template ==
Add the <code><templatedata></code> as usual, and then enclose it in a template call like <code><nowiki>{{Format TemplateData|1=<templatedata>...</templatedata>}}</nowiki></code>.

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

<includeonly>{{sandbox other||

[[Category:TemplateData]]
}}</includeonly>

== See also ==
* [[JSON]]