Castus: 1 revision imported

2021-05-21T03:13:16Z

1 revision imported

← Older revision	Revision as of 03:13, 21 May 2021
(No difference)

en>Jundie: Created page with "{{Documentationpage}} Template for standardized formatting of template parameters in template documentation. ==Usage..."

2011-12-28T08:39:37Z

Created page with "<noinclude>{{Documentationpage}}</noinclude> Template for standardized formatting of template parameters in template documentation. ==Usage..."

New page

<noinclude>{{Documentationpage}}</noinclude>
Template for standardized formatting of template parameters in [[:Category:Template documentation|template documentation]].

==Usage==
<pre>{{Docparam|name=parameter|req=yes|desc=description}}</pre>

===Parameters===
{{Docparam|name=<unnamed 1> // name|req=yes|default=|desc=
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):
* <code>>></code> is converted to a dash with spaces around it (" - "); used to indicate parameter ranges (e.g. "game1 - game5").
* <code>//</code> is converted to " or "; used for alternative choices (e.g. "<unnamed 1> or title").
* <code>++</code> is converted to a comma with a trailing space (", "); used for listing parameters which are separate but work the same (e.g. "contentA1, contentB1").
}}

{{Docparam|name=default ++ default2|req=no|default=|desc=
The default value(s) of the parameter.
}}

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

{{Docparam|name=req|req=semi|default=yes|desc=
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 <code>up to</code>, this means that at least one of them is required.
*''yes'': Always required.
}}

==Copy/paste==
<pre>
{{Docparam|name=|req=|default=|desc=

}}
</pre>

==Examples==
===Simple===
<pre>
{{Docparam|name=parameter|req=yes|default=|desc=
Description
}}
</pre>
results in:
{{Docparam|name=parameter|req=yes|default=|desc=
Description
}}

===Advanced===
<pre>
{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Description
}}
</pre>
results in:
{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Description
}}

Template:Docparam/doc - Revision history

Castus: 1 revision imported

en>Jundie: Created page with "{{Documentationpage}} Template for standardized formatting of template parameters in template documentation. ==Usage..."