User:Sardanaphalus/Template:Parameter descriptions/old/doc

Parameter descriptions may be used to add a list of parameters and their descriptions – and, if one of its variants, or  is used, with examples and/or defaults – to template documentation. An example of the kind of output it can produce appears in the "Customization" section below, where is used to list these templates' own named parameters.


 *  Note: Vertical-bar characters ("pipes", "|") and equals-sign characters (equalities, "=") within parameter values need to be represented by, respectively, the magic word and template =, or placed between  tags (e.g. &lt;nowiki&gt;).

Syntax
[By default,] those values given as parameter names – i.e. those appearing in the list's first column – are displayed in monospace and without line/word-wrapping ... (i.e. should more than one line be required, formatting such as   [will need] to be used) ... [alternatively, col1style]

For descriptions accompanied by examples, use the lefthand syntax below; if accompanied by default settings, use the righthand syntax:

For descriptions accompanied by both examples and defaults, use:

Customization
[By default,] the following customization parameters are not set.