User:Banri/TemplateData - Revision history

Banri at 22:24, 9 October 2020

2020-10-09T22:24:24Z

← Older revision		Revision as of 22:24, 9 October 2020
Line 90:		Line 90:
	</pre>		</pre>

	This is how a template with TemplateData displays in VisualEditor:		This is how a template with TemplateData displays in VisualEditor

	~~(Image goes here)~~

	===Further help===		===Further help===
	* [https://en.wikipedia.org/wiki/Wikipedia:TemplateData/Tutorial Wikipedia's tutorial on TemplateData]		* [https://en.wikipedia.org/wiki/Wikipedia:TemplateData/Tutorial Wikipedia's tutorial on TemplateData]
	* [https://www.mediawiki.org/wiki/Help:TemplateData MediaWiki help page for TemplateData]		* [https://www.mediawiki.org/wiki/Help:TemplateData MediaWiki help page for TemplateData]

Banri at 22:23, 9 October 2020

2020-10-09T22:23:34Z

← Older revision		Revision as of 22:23, 9 October 2020
Line 39:		Line 39:
	\|}		\|}

	~~(Image goes here)~~		https://i.imgur.com/47fEaDE.png

	4. For each parameter an editor can give to a template, press the '''Add parameter''' button at the bottom, enter its name (e.g 'param1'). Click on it when its added to the list and fill out the information:		4. For each parameter an editor can give to a template, press the '''Add parameter''' button at the bottom, enter its name (e.g 'param1'). Click on it when its added to the list and fill out the information:

Banri at 22:11, 9 October 2020

2020-10-09T22:11:14Z

← Older revision		Revision as of 22:11, 9 October 2020
Line 9:		Line 9:
	1. Go on the template '''documentation''' page (for consistency, don't add TemplateData to the template itself) and click '''Edit source'''		1. Go on the template '''documentation''' page (for consistency, don't add TemplateData to the template itself) and click '''Edit source'''

	~~(Image goes here)~~		https://i.imgur.com/HQmUSin.png

	2. Click '''Manage TemplateData'''		2. Click '''Manage TemplateData'''

	~~(Image goes here)~~		https://i.imgur.com/nUzds3U.png

	3. Set the language (should be '''English'''), add a description of the template, and then change the wikitext formatting.		3. Set the language (should be '''English'''), add a description of the template, and then change the wikitext formatting.
Line 70:		Line 70:
	\|}		\|}

	~~(Image goes here)~~		https://i.imgur.com/v9aOkjO.png

	5. When done with adding parameters, press '''Apply''' at the top right of the interface. The TemplateData will be added to your cursor position on the page between the <code><nowiki><TemplateData></nowiki></code> tags. Move this to somewhere more convenient if necessary.		5. When done with adding parameters, press '''Apply''' at the top right of the interface. The TemplateData will be added to your cursor position on the page between the <code><nowiki><TemplateData></nowiki></code> tags. Move this to somewhere more convenient if necessary.

Banri: Created page with "When a template is used or edited in VisualEditor, VisualEditor tries to guess what parameters the template has. You can make this easier by adding "TemplateData" to templates..."

2020-10-09T18:37:51Z

Created page with "When a template is used or edited in VisualEditor, VisualEditor tries to guess what parameters the template has. You can make this easier by adding "TemplateData" to templates..."

New page

When a template is used or edited in VisualEditor, VisualEditor tries to guess what parameters the template has. You can make this easier by adding "TemplateData" to templates, especially more complex ones, so that people using VisualEditor can find it easier to add and edit those templates.

'''This project is dedicated to adding TemplateData to every user-facing template on the wiki.'''

[[User:Banri/MissingTemplateDocs#Missing_template_data|For a list of templates missing template data see this page]]

==How to add TemplateData==

1. Go on the template '''documentation''' page (for consistency, don't add TemplateData to the template itself) and click '''Edit source'''

(Image goes here)

2. Click '''Manage TemplateData'''

(Image goes here)

3. Set the language (should be '''English'''), add a description of the template, and then change the wikitext formatting.

{| class="wikitable"
|-
! Format !! Description
|-
| Unspecified || This is the default formatting. It indicates that there isn't an specific format for the template.
|-
| Inline || This template should be inserted inline. This means that it'll look like <code><nowiki>{{Template|param1=|param2=|param3=}}</nowiki></code> on the page when inserted with VisualEditor.
|-
| Block || This template should be inserted as a block across multiple lines. This means that it'll look like
<pre>
{{Template
|param1=
|param2=
|param3=
}}
</pre>

on the page when inserted with VisualEditor.
|-
| Custom || Allows specification of a custom format for displaying the template in wikitext. Do not use this unless you know what you're doing.
|}

(Image goes here)

4. For each parameter an editor can give to a template, press the '''Add parameter''' button at the bottom, enter its name (e.g 'param1'). Click on it when its added to the list and fill out the information:

{| class="wikitable"
|-
! Field !! Description !! Example
|-
| Name || The name of the parameter || param1
|-
| Aliases || Other names that can be used for this parameter ||
|-
| Label || Human-readable name for the parameter || My parameter 1
|-
| Description || Description of what the parameter is || This gives the target...
|-
| Example || An example of what can be given to the parameter || This Mod
|-
| Type || The type of parameter || String
|-
| Default || The default value of the parameter ||
|-
| Auto value || The value to use when adding the template to VisualEditor, etc || 360
|-
| Deprecated || Tick whether or not the parameter is deprecated/will be removed in the future) || {{NA}}
|-
| Required || Tick whether or not the parameter is required || {{NA}}
|-
| Suggested || Tick whether or not users should be suggested to fill in this parameter (you should always have at least one suggested parameter) || {{NA}}
|}

(Image goes here)

5. When done with adding parameters, press '''Apply''' at the top right of the interface. The TemplateData will be added to your cursor position on the page between the <code><nowiki><TemplateData></nowiki></code> tags. Move this to somewhere more convenient if necessary.

6. Surround the <code><nowiki><TemplateData></nowiki></code> tags with {{t|TemplateData}} to keep consistency across the wiki. Your finished code will look something like:

<pre>
{{TemplateData|<templatedata>
{
"params": {
"param1": {
"type": "unknown"
}
},
"description": "Creates a table listing all of the achievements for the given category",
"format": "block"
}
</templatedata>}}
</pre>

This is how a template with TemplateData displays in VisualEditor:

(Image goes here)

===Further help===
* [https://en.wikipedia.org/wiki/Wikipedia:TemplateData/Tutorial Wikipedia's tutorial on TemplateData]
* [https://www.mediawiki.org/wiki/Help:TemplateData MediaWiki help page for TemplateData]