Template:Docparam/doc
For use on template documentation pages. Adds header and category.
Based on {{directionbox}}.
Contents
Usage
Place the following at the top of the documentation page:
<noinclude>{{Documentationpage}}</noinclude>
Parameters
Name of the page the documentation page belongs to.
Allows to specify the type of documentation page and alters display text accordingly.
Available options:
- default: This page is a normal documentation page.
- standard: This page is a standard documentation page for all templates based on a specific meta template.
Template for standardized formatting of template parameters in template documentation.
Usage
{{Docparam|name=parameter|req=yes|desc=description}}
Parameters
Name of the parameter(s). Certain strings are automatically translated to allow for specification of alternative choices or parameter ranges.
Translated strings (all of these need to be enclosed by spaces):
-
>>
is converted to a dash with spaces around it (" - "); used to indicate parameter ranges (e.g. "game1 - game5"). -
//
is converted to " or "; used for alternative choices (e.g. "<unnamed 1> or title"). -
++
is converted to a comma with a trailing space (", "); used for listing parameters which are separate but work the same (e.g. "contentA1, contentB1").
The default value(s) of the parameter.
Description of the parameter.
Specifies whether this parameter is required for the template to function.
Available options:
- no: Completely optional.
- semi: Parameter is required in certain circumstances but optional in others. For a range of parameters (set via
up to
, this means that at least one of them is required. - yes: Always required.
Copy/paste
{{Docparam|name=|req=|default=|desc= }}
Examples
Simple
{{Docparam|name=parameter|req=yes|default=|desc= Description }}
results in:
Description
Advanced
{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc= Description }}
results in:
Description