Maxwells at 20:04, 11 June 2022

2022-06-11T20:04:17Z

← Older revision		Revision as of 14:04, 11 June 2022
Line 1:		Line 1:
	{{for\|a tutorial\|~~Wikipedia~~:TemplateData/Tutorial}}		{{for\|a tutorial\|Stiles.casa Wiki:TemplateData/Tutorial}}
	{{hatnote\|For additional technical information, see [[mw:Help:TemplateData]] and [[mw:Extension:TemplateData]].}}		{{hatnote\|For additional technical information, see [[mw:Help:TemplateData]] and [[mw:Extension:TemplateData]].}}
	{{Short description\|Information page on the use of TemplateData on ~~Wikipedia~~}}		{{Short description\|Information page on the use of TemplateData on Stiles.casa Wiki}}
	{{out of date}}		{{out of date}}
	{{VisualEditor navbox}}		{{VisualEditor navbox}}
	{{stack\|{{Shortcuts\|WP:VE/TD\|WP:TDATA}}}}		{{stack\|{{Shortcuts\|SW:VE/TD\|SW:TDATA}}}}
	__TOC__		__TOC__

	== What is TemplateData? ==		== What is TemplateData? ==
	TemplateData is the standardized description of a template, used by the default [[~~Wikipedia~~:VisualEditor\|VisualEditor]], the optional [[mw:2017 wikitext editor\|2017 wikitext editor]] and other tools to improve the template-editing experience for the user. Both VisualEditor and the 2017 wikitext editor include a wizard to edit templates, but for the wizard to be most useful, it needs to present specific information to the user about each template, such as a short description of the template's purpose and its parameters. This information is codified formally (by any wiki editor) using TemplateData.		TemplateData is the standardized description of a template, used by the default [[Stiles.casa Wiki:VisualEditor\|VisualEditor]], the optional [[mw:2017 wikitext editor\|2017 wikitext editor]] and other tools to improve the template-editing experience for the user. Both VisualEditor and the 2017 wikitext editor include a wizard to edit templates, but for the wizard to be most useful, it needs to present specific information to the user about each template, such as a short description of the template's purpose and its parameters. This information is codified formally (by any wiki editor) using TemplateData.

	=== Editing without TemplateData ===		=== Editing without TemplateData ===
Line 29:		Line 29:

	== Adding TemplateData ==		== Adding TemplateData ==
	Anyone can help by adding TemplateData to templates (particularly high-profile ones, such as [[WP:INFOBOX\|infoboxes]]) so that they are easier to edit in VisualEditor. The following is a minimal example, placed on a template's documentation page:		Anyone can help by adding TemplateData to templates (particularly high-profile ones, such as [[SW:INFOBOX\|infoboxes]]) so that they are easier to edit in VisualEditor. The following is a minimal example, placed on a template's documentation page:

	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
Line 48:		Line 48:
	You can also add or edit TemplateData using a [[GUI]], by pressing the following button which appears at the top of the edit page: <span class="oo-ui-widget oo-ui-widget-enabled oo-ui-buttonElement oo-ui-buttonElement-framed oo-ui-labelElement oo-ui-buttonWidget" style="display:inline-block;vertical-align:middle;margin-right: 0.5em;"><span class="oo-ui-buttonElement-button" style="color: #757575;border: solid 1px #cdcdcd;margin: 0.1em 0;padding: 0.2em 0.8em;border-radius: 2px;transition: background 0.1s ease-in-out,color 0.1s ease-in-out,box-shadow 0.1s ease-in-out;font-weight: bold;display: inline-block;vertical-align: top;text-align: center;cursor: pointer;"><span class="oo-ui-labelElement-label" style="line-height: 1.9em;">Manage TemplateData</span></span></span>		You can also add or edit TemplateData using a [[GUI]], by pressing the following button which appears at the top of the edit page: <span class="oo-ui-widget oo-ui-widget-enabled oo-ui-buttonElement oo-ui-buttonElement-framed oo-ui-labelElement oo-ui-buttonWidget" style="display:inline-block;vertical-align:middle;margin-right: 0.5em;"><span class="oo-ui-buttonElement-button" style="color: #757575;border: solid 1px #cdcdcd;margin: 0.1em 0;padding: 0.2em 0.8em;border-radius: 2px;transition: background 0.1s ease-in-out,color 0.1s ease-in-out,box-shadow 0.1s ease-in-out;font-weight: bold;display: inline-block;vertical-align: top;text-align: center;cursor: pointer;"><span class="oo-ui-labelElement-label" style="line-height: 1.9em;">Manage TemplateData</span></span></span>

	The '''[[~~Wikipedia~~:VisualEditor/TemplateData tutorial\|TemplateData tutorial]]''' explains in detail how to add TemplateData information to a template.		The '''[[Stiles.casa Wiki:VisualEditor/TemplateData tutorial\|TemplateData tutorial]]''' explains in detail how to add TemplateData information to a template.

	==Used templates==		==Used templates==
	{{Main\|~~Wikipedia~~:TemplateData/Used templates}}		{{Main\|Stiles.casa Wiki:TemplateData/Used templates}}

	==See also==		==See also==
	*[[~~Wikipedia~~:VisualEditor/TemplateData/List]] A list of all pages with TemplateData		*[[Stiles.casa Wiki:VisualEditor/TemplateData/List]] A list of all pages with TemplateData


	[[Category:TemplateData\| ]]		[[Category:TemplateData\| ]]
	[[Category:VisualEditor]]		[[Category:VisualEditor]]
	[[Category:~~Wikipedia~~ template help]]		[[Category:Stiles.casa Wiki template help]]

Maxwells: Created page with "{{for|a tutorial|Wikipedia:TemplateData/Tutorial}} {{hatnote|For additional technical information, see mw:Help:TemplateData and mw:Extension:TemplateData.}} {{Short description|Information page on the use of TemplateData on Wikipedia}} {{out of date}} {{VisualEditor navbox}} {{stack|{{Shortcuts|WP:VE/TD|WP:TDATA}}}} TOC == What is TemplateData? == TemplateData is the standardized description of a template, used by the default Wikipedia:VisualEditor|VisualE..."

2022-06-11T19:05:56Z

Created page with "{{for|a tutorial|Wikipedia:TemplateData/Tutorial}} {{hatnote|For additional technical information, see mw:Help:TemplateData and mw:Extension:TemplateData.}} {{Short description|Information page on the use of TemplateData on Wikipedia}} {{out of date}} {{VisualEditor navbox}} {{stack|{{Shortcuts|WP:VE/TD|WP:TDATA}}}} __TOC__ == What is TemplateData? == TemplateData is the standardized description of a template, used by the default Wikipedia:VisualEditor|VisualE..."

New page

{{for|a tutorial|Wikipedia:TemplateData/Tutorial}}
{{hatnote|For additional technical information, see [[mw:Help:TemplateData]] and [[mw:Extension:TemplateData]].}}
{{Short description|Information page on the use of TemplateData on Wikipedia}}
{{out of date}}
{{VisualEditor navbox}}
{{stack|{{Shortcuts|WP:VE/TD|WP:TDATA}}}}
__TOC__

== What is TemplateData? ==
TemplateData is the standardized description of a template, used by the default [[Wikipedia:VisualEditor|VisualEditor]], the optional [[mw:2017 wikitext editor|2017 wikitext editor]] and other tools to improve the template-editing experience for the user. Both VisualEditor and the 2017 wikitext editor include a wizard to edit templates, but for the wizard to be most useful, it needs to present specific information to the user about each template, such as a short description of the template's purpose and its parameters. This information is codified formally (by any wiki editor) using TemplateData.

=== Editing without TemplateData ===
Without TemplateData, each parameter needs to be added manually when inserting a new template.

[[File:VisualEditor - Template without TemplateData.png|frameless|500px]]

No information is provided about what the value of the parameter should be.

[[File:VisualEditor - Template without TemplateData2.png|frameless|500px]]

=== Editing with TemplateData ===
With TemplateData, a list of supported parameters (and their description) is provided for the template.

[[File:VisualEditor - Template with TemplateData1.png|frameless|500px]]

TemplateData provides context for each parameter, and makes it much easier for users to modify templates.

[[File:VisualEditor - Template with TemplateData2.png|frameless|500px]]

== Adding TemplateData ==
Anyone can help by adding TemplateData to templates (particularly high-profile ones, such as [[WP:INFOBOX|infoboxes]]) so that they are easier to edit in VisualEditor. The following is a minimal example, placed on a template's documentation page:

<syntaxhighlight lang="javascript">
<templatedata>{
"description": "insert description here",
"params": {
"first parameter": {
"label": "x",
"description": "x",
"type": "string",
"default": "default value",
"required": false
}
}
}</templatedata>
</syntaxhighlight>

You can also add or edit TemplateData using a [[GUI]], by pressing the following button which appears at the top of the edit page: <span class="oo-ui-buttonElement-button" style="color: #757575;border: solid 1px #cdcdcd;margin: 0.1em 0;padding: 0.2em 0.8em;border-radius: 2px;transition: background 0.1s ease-in-out,color 0.1s ease-in-out,box-shadow 0.1s ease-in-out;font-weight: bold;display: inline-block;vertical-align: top;text-align: center;cursor: pointer;">Manage TemplateData

The '''[[Wikipedia:VisualEditor/TemplateData tutorial|TemplateData tutorial]]''' explains in detail how to add TemplateData information to a template.

==Used templates==
{{Main|Wikipedia:TemplateData/Used templates}}

==See also==
*[[Wikipedia:VisualEditor/TemplateData/List]] A list of all pages with TemplateData

[[Category:TemplateData| ]]
[[Category:VisualEditor]]
[[Category:Wikipedia template help]]

Stiles Wiki:TemplateData - Revision history

Maxwells at 20:04, 11 June 2022