Template:Parameters

The UESPWiki – Your source for The Elder Scrolls since 1995
Jump to: navigation, search

Summary

Used to create Parameters tables on template /Doc pages.

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 {{=}}, &#61; or <nowiki>=</nowiki>.

Examples

{{Parameters
|template|optional|The template name for the title. Defaults to base namespace and title of /Doc page.
|(others)<br>  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:'''

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.