We've Moved! Just as Gamepedia has joined forces with Fandom, this wiki had joined forces with our Fandom equivalent. The wiki has been archived and we ask that readers and editors move to the now combined wiki on Fandom. Click to go to the new wiki.

Template:Docparam

From The Vault - Fallout Wiki
Jump to: navigation, search
RequiredIcon required.png
Name?

Description?

Template documentation (for the template shown above, sometimes hidden or invisible)

Template for standardized formatting of template parameters in template documentation.

Usage

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

Parameters

RequiredIcon required.png
<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 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").
OptionalIcon optional.png
default, default2

The default value(s) of the parameter.

RequiredIcon required.png
desc

Description of the parameter.

Sometimes required or at least one requiredIcon semi-required.png
(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:

RequiredIcon required.png
parameter

Description

Advanced

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

results in:

OptionalIcon optional.png
(default: "default setting")
parameter or alternative, similar1 up to similar3

Description

Documentation transcluded from Template:Docparam/doc.