User:Sardanaphalus/Template:Parameter descriptions/sandbox

This is the sandbox page for User:Sardanaphalus/Template:Parameter descriptions (diff).

Documentation[view] [edit] [history] [purge]

{{tl|Parameter descriptions}} may be used to add a list of parameters and their descriptions – and, if one of its variants {{tla|Parameter descriptions/with examples|.../with examples}}, {{tla|Parameter descriptions/with defaults|.../with defaults}} or {{tla|Parameter descriptions/full|.../full}} 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 {{Parameter descriptions/with examples}} 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 <nowiki>...</nowiki> tags (e.g. <nowiki>|one |two=value</nowiki>).

Syntax

{{Parameter descriptions
| (parameter name) | (description)
| (parameter name) | (description)
......
}}

[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 <br/> [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:

{{Parameter descriptions/with examples
| (parameter name) | (description) | (example/s)
| (parameter name) | (description) | (example/s)
......
}}

...... or ......

{{Parameter descriptions/with defaults
| (parameter name) | (description) | (default/s)
| (parameter name) | (description) | (default/s)
......

}}

For descriptions accompanied by both examples and defaults, use:

{{Parameter descriptions/full
| (parameter name) | (description) | (example/s) | (default/s)
| (parameter name) | (description) | (example/s) | (default/s)
......
}}

Customization

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


{{Parameter descriptions/with examples
 |colheadings=on

 | tableclass (class) <br/> tablestyle (style)
 | Set to apply, respectively, [[Cascading Style Sheets|CSS classes and/or styling]] to the table presenting the descriptions.
 | |class=wikitable   |tableclass=nowrap <br/> |style= 

 | colheadings (headings)
 | Set (as e.g. "{{mono|on}}", "{{mono|include}}", etc) to include a heading above each column to identify it ("Parameter", "Description", "Examples", "Defaults").<br/>If set as CSS styling, that styling will be applied to each heading.
 | |headings=on   |colheadings=font-style:italic;

 | [col[N]style]
 | 
 | 

 | ......
 | 
 | 
}}

Syntax

Customization

See also