Template:Parameters/Doc

Summary

This template can be used to create Parameters tables on template documentation pages. In addition to the normal three-parameter entry, predefined entries can be created as subpages of this template and included wherever they're needed. A list of those can be found here (excluding Parameters/Doc and Parameters/Line).

Parameters

Parameters

Parameter	Scope	Description
template	optional	The template name for the title. Defaults to the title of the base template.
name scope description	optional	Each set of three parameters describes one parameter in the table. The parameters name and scope are required, description may be blank, or omitted entirely for the final parameter. Special formatting: If the first parameter is a hyphen (-) then the text will span all three columns and the second parameter provides the text to display. If the first parameter is an exclamation point (!) then the line text will be displayed as a table header and span all three columns. In both cases the third parameter will be ignored.

Note: Equals signs in parameters must be escaped using {{=}}, = or <nowiki>=</nowiki>.

Examples

{{Parameters
|template|optional|The template name for the title. Defaults to the title of the base template.
|name<br>scope<br>description|optional|Each set of three parameters describes one parameter in the table. The parameters <code>name</code> and <code>scope</code> are required, <code>description</code> may be blank, or omitted entirely for the final parameter.

'''Special formatting:'''<br>
If the first parameter is a hyphen (-) then the text will span all three columns and the second parameter provides the text to display.<br>
If the first parameter is an exclamation point (!) then the line text will be displayed as a table header and span all three columns.<br>
In both cases the third parameter will be ignored.

This generates the Parameters table above.

{{Parameters
|separator|optional|Use this to specify the text to separate entries with.
{{Parameters/Case}}
}}

Parameters

Parameter	Scope	Description
separator	optional	Use this to specify the text to separate entries with.
case	optional	Set to "any" to recognize parameters or variables with any capitalization rather than forcing a specific capitalization.