Template:TemplateData header/sandbox

{{#if:|See a monthly parameter usage report for [[Template:]] in articles.

TemplateData for TemplateData header

This is the template sandbox page for Template:TemplateData header (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 16,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Check for unknown parameters (sandbox)

The {{TemplateData header}} template inserts a brief header for the template data section, and adds the page to Category:Templates using TemplateData.

Usage

==TemplateData==
{{TemplateData header}}
<templatedata>{
...
}</templatedata>

Note: Section headers of ==Parameters== or ==Usage== may also be used.

Use {{TemplateData header|Template name}} to display a name for the template other than the default, which is {{BASEPAGENAME}}. Do not add Template:.

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Template name in articles based on its TemplateData.

TemplateData for Template name

Use {{TemplateData header|nolink=1}} to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:TemplateData header in articles based on its TemplateData.

TemplateData for TemplateData header

Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.

See a monthly parameter usage report for Template:TemplateData header in articles based on its TemplateData.

TemplateData for TemplateData header

Example

Using a collapse box for [[Template:User]]:

{{collapse top|title=TemplateData}}
{{TemplateData header|User}}
<templatedata>
{
	"description": "This template is used to create a link to a user's user page (unless using {{Useranon}}), talk page, and contributions, and generates a special notification (aka 'ping').",
	"params": {
		"1": {
			"label": "User name",
			"type": "string",
			"required": true,
			"description": "The user name that you want to create links to and notify.",
			"aliases":["user"]
		},
		"project": {
			"label": "Sister project",
			"type": "string",
			"description": "Used to link to a sister project instead of the English Wikipedia. Use the standard interwiki prefix."
		},
		"lang": {
			"label": "Other language project",
			"type": "string",
			"description": "Used to link to another language project. If used with the \"sister project\" parameter, links to another language of a sister project. Otherwise links to another language Wikipedia. Use the standard language code."
		},
		"separator": {
			"label": "Separator",
			"description": "Used to change the separator between the links. If unused, defaults to a dot."
		}
	}
}
</templatedata>
{{collapse bottom}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:User in articles based on its TemplateData.

TemplateData for User

This template is used to create a link to a user's user page (unless using {{Useranon}}), talk page, and contributions, and generates a special notification (aka 'ping').

Template parameters[Edit template data]
Parameter		Description	Type	Status
User name	`1` `user`	The user name that you want to create links to and notify.	String	required
Sister project	`project`	Used to link to a sister project instead of the English Wikipedia. Use the standard interwiki prefix.	String	optional
Other language project	`lang`	Used to link to another language project. If used with the "sister project" parameter, links to another language of a sister project. Otherwise links to another language Wikipedia. Use the standard language code.	String	optional
Separator	`separator`	Used to change the separator between the links. If unused, defaults to a dot.	Unknown	optional

Parameters

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:TemplateData header in articles based on its TemplateData.

TemplateData for TemplateData header

Inserts a brief header for the TemplateData section. Adds the page to [[:Category:Templates using TemplateData]]

Template parameters[Edit template data]
Parameter		Description	Type	Status
Template name	`1`	Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.	String	optional
No link	`nolink`	Assigning any value to this parameter will omit cause the template to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.	String	optional
No header	`noheader`	Assigning any value to this parameter will cause the template to omit the first sentence of the header text.	String	optional

Usage

Example

Parameters

Tracking categories

See also