Jump to content

Template:TemplateData header/doc

From Wikipedia, the free encyclopedia

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

Usage

[edit]
==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

[edit]
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

ParameterDescriptionTypeStatus
User name1 user

The user name that you want to create links to and notify.

Stringrequired
Sister projectproject

Used to link to a sister project instead of the English Wikipedia. Use the standard interwiki prefix.

Stringoptional
Other language projectlang

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.

Stringoptional
Separatorseparator

Used to change the separator between the links. If unused, defaults to a dot.

Unknownoptional

Parameters

[edit]
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

ParameterDescriptionTypeStatus
Template name1

Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.

Stringoptional
No linknolink

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.

Stringoptional
No headernoheader

Assigning any value to this parameter will cause the template to omit the first sentence of the header text.

Stringoptional

Tracking categories

[edit]

See also

[edit]