Difference between revisions of "Template:Docparam"

From Lorekeeper Wiki
Jump to navigation Jump to search
m (1 revision imported: Docparam template)
Tag: 2017 source edit
Line 2: Line 2:
  
 
--><div class="va-docparam"><!--
 
--><div class="va-docparam"><!--
  --><div class="va-docparam-icon">{{#switch:{{{req}}}|no={{icon|optional}}|semi={{icon|semi-required}}|yes|#default={{icon|required}}}}</div><!--
+
  --><div class="va-docparam-icon">{{#switch:{{{req}}}|no=Optional|semi=Semi-required|yes|#default=Required}}</div><!--
 
  -->{{#if:{{{default|}}}|<div class="va-docparam-default">(default: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}|&#032;or {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!--
 
  -->{{#if:{{{default|}}}|<div class="va-docparam-default">(default: {{#switch:{{lc:{{{default}}}}}|none|-=none|#default="{{{default}}}"}}{{#if:{{{default2|}}}|&#032;or {{#switch:{{lc:{{{default2}}}}}|none|-=none|#default="{{{default2}}}"}}}})</div>}}<!--
 
  --><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}||&#032;}}|&#032;>>&#032;|''' up to '''}}|&#032;//&#032;|''' or '''}}|&#032;++&#032;|''', '''}}|Name?}}</span>'''<!--
 
  --><span class="va-docparam-params">'''{{#if:{{{name|{{{1|}}}}}}|{{#replace:{{#replace:{{#replace:{{#replace:{{{name|{{{1|}}}}}}||&#032;}}|&#032;>>&#032;|''' up to '''}}|&#032;//&#032;|''' or '''}}|&#032;++&#032;|''', '''}}|Name?}}</span>'''<!--

Revision as of 10:41, 11 June 2020

Required
Name?
Description?
50px Template documentation[view] [edit] [history] [purge]

Usage

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

Parameters

Required
{{#replace:{{#replace:{{#replace:{{#replace:<unnamed 1> // name|| }}| >> | up to }}| // | or }}| ++ |, }}
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").
Optional
{{#replace:{{#replace:{{#replace:{{#replace:default ++ default2|| }}| >> | up to }}| // | or }}| ++ |, }}
The default value(s) of the parameter.
Required
{{#replace:{{#replace:{{#replace:{{#replace:desc|| }}| >> | up to }}| // | or }}| ++ |, }}
Description of the parameter.
Semi-required
(default: "yes")
{{#replace:{{#replace:{{#replace:{{#replace:req|| }}| >> | up to }}| // | or }}| ++ |, }}
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:

Required
{{#replace:{{#replace:{{#replace:{{#replace:parameter|| }}| >> | up to }}| // | or }}| ++ |, }}
Description

Advanced

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

results in:

Optional
(default: "default setting")
{{#replace:{{#replace:{{#replace:{{#replace:parameter // alternative ++ similar1 >> similar3|| }}| >> | up to }}| // | or }}| ++ |, }}
Description