Stiles Wiki:TemplateData: Difference between revisions
Jump to navigation
Jump to search
(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...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{for|a 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 | {{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| | {{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 [[ | 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 [[ | 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 '''[[ | 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| | {{Main|Stiles.casa Wiki:TemplateData/Used templates}} | ||
==See also== | ==See also== | ||
*[[ | *[[Stiles.casa Wiki:VisualEditor/TemplateData/List]] A list of all pages with TemplateData | ||
[[Category:TemplateData| ]] | [[Category:TemplateData| ]] | ||
[[Category:VisualEditor]] | [[Category:VisualEditor]] | ||
[[Category: | [[Category:Stiles.casa Wiki template help]] | ||
Latest revision as of 13:04, 11 June 2022
 | This Stiles.casa Wiki page needs to be updated. Please help update this Stiles.casa Wiki page to reflect recent events or newly available information. |
- Main page
- Feedback at MediaWiki or local feedback
- Sandbox (no account required)
About
- Why are the developers building this?
- Documentation:
- Development:
Help out
Research
Other
- Customization
- Known problems
- Requests for Comments (RfCs): Jul 2013 a, Jul 2013 b, Jul 2015, Sep 2015
What is TemplateData?
TemplateData is the standardized description of a template, used by the default VisualEditor, the optional 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.
No information is provided about what the value of the parameter should be.
Editing with TemplateData
With TemplateData, a list of supported parameters (and their description) is provided for the template.
TemplateData provides context for each parameter, and makes it much easier for users to modify templates.
Adding TemplateData
Anyone can help by adding TemplateData to templates (particularly high-profile ones, such as infoboxes) so that they are easier to edit in VisualEditor. The following is a minimal example, placed on a template's documentation page:
<templatedata>{
"description": "insert description here",
"params": {
"first parameter": {
"label": "x",
"description": "x",
"type": "string",
"default": "default value",
"required": false
}
}
}</templatedata>
You can also add or edit TemplateData using a GUI, by pressing the following button which appears at the top of the edit page:
The TemplateData tutorial explains in detail how to add TemplateData information to a template.
Used templates
See also
- Stiles.casa Wiki:VisualEditor/TemplateData/List A list of all pages with TemplateData