requiredrequired
Name?
Beschreibung?
Vorlagen-Dokumentation (Für die oben gezeigte Vorlage, manchmal unsichtbar oder versteckt.)

Template for standardized formatting of template parameters in template documentation.

Usage

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

Parameters

requiredrequired
<unnamed 1> oder 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 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").
optionaloptional
default, default2
The default value(s) of the parameter.
requiredrequired
desc
Description of the parameter.
semi-requiredsemi-required
(default: "yes")
req
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:

requiredrequired
parameter
Description

Advanced

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

results in:

optionaloptional
(default: "default setting")
parameter oder alternative, similar1 bis similar3
Description
Dokumentation transkludiert aus Vorlage:Docparam/doc.
Nutzung von Community-Inhalten gemäß CC-BY-SA, sofern nicht anders angegeben.