Template:Template parameter usage/doc

The Template Parameters tool is available for viewing template parameter usage in articles. It works with TemplateData to show the frequency of parameter name usage in a template's mainspace transclusions, along with whether or not each parameter is listed in that template's TemplateData code as a supported parameter. For a required parameter, it can display a list of pages where the template is missing that parameter. The tool also shows commonly used values for each parameter. Each report is updated monthly and does not reflect changes made to articles or to the TemplateData code after the report's generation.

Usage

Example:

• {{Infobox lighthouse}}/documentation: Template:Slink → "Click here to see a monthly parameter usage report ..." → [1].

Parameters

All parameters are optional, and have a default

By default, the template links for the template page:

{{Template parameter usage}} → Click here to see a monthly parameter usage report for this template in articles. [for this page]

One can enter a template name:

{{Template parameter usage|Infobox film}} → Click here to see a monthly parameter usage report for Template:Infobox film in articles.

Optional:

• |lc=yes for lowercase "click": click here to see a monthly parameter usage report for Template:Infobox film in articles.
• Entering |1=Template:Infobox film is accepted (namespace is removed). Editor friendly, using a positional parameter.

When |1= is used, "this template" text changes: → Click here to see a monthly parameter usage report for Template:Infobox film in articles.

• |label= sets the visible text; it does not change the target link:

|label= default → Click here to see a monthly parameter usage report for Template:Infobox film in articles.

|label=none → Parameter usage report

|label=for → Parameter usage report for Template:Infobox film.

|label=FooBar → FooBar

• |based=yes adds the text "based on this TemplateData" to the end of the template (or "based on its TemplateData" if |1= is also used).

The template is included in transclusions of {{TemplateData header}}.

Error reports

{{Template parameter usage}}

By default, it links a report for the template-page being viewed. To link a report for a different template-page, pass it as the first parameter:

{{Template parameter usage|Example}} makes a link to the error report for Template:Example:

→ Click here to see a monthly parameter usage report for Template:Example in articles.

The first character can be made lowercase to follow on at the end of a sentence:

Blah, Template:Tlp → Blah, click here to see a monthly parameter usage report for this template in articles.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Template parameter usage

Short line of text providing a link to a monthly parameter usage report for a template based on its TemplateData

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Lowercase	lc	Enter "y", "yes", "true", "on" or "1" here to make the text begin with a lowercase character. Example y Auto value y	Line	optional
Custom template	1	Enter any template here to change the usage report link to that of that template Example Anchor	Template	optional
Custom text	label	Enter any text here to make the template just the usage report link with the given custom text. Alternatively, enter "none" to include only the usage report link, or enter "for" to include only the usage report link followed by "for <template name>".	String	optional
Append "based on this[/its] TemplateData"	based	Enter "y", "yes", "true", "on" or "1" here to append the text "based on this TemplateData" (or "based on its TemplateData" if "Custom template" is also used). Example y Auto value y	Line	optional

See also

• {{TemplateData header}} -- major user of this template
• User:Bamyers99/TemplateParametersTool - the tool