Template:Docparam/doc

This page contains usage information for Template:Docparam.

This template depends on CSS

MediaWiki:Common.css

Template for standardized formatting of template parameters in template documentation.

Usage

{{Docparam|name=parameter|req=yes|desc=description}}

Parameters

<unnamed 1> or name

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 "up to"; used to indicate parameter ranges (e.g. "game1 up to 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").

default, default2

The default value(s) of the parameter.

desc

Description of the parameter.

(default: "yes")

req

Specifies whether this parameter is required for the template to function.

Available options:

• yes: Always required.
• 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.
• no: Completely optional.

Copy/paste

{{Docparam|name=|req=|default=|desc=
}}

Examples

Simple

{{Docparam|name=parameter|req=yes|default=|desc=
Description
}}

results in:

parameter

Description

Advanced

{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Description
}}

results in:

(default: "default setting")

parameter or alternative, similar1 up to similar3

Description