3,554
edits
Template:Parameter: Difference between revisions
Jump to navigation
Jump to search
Want an adless experience? Log in or Create an account.
no edit summary
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{#vardefine:status|{{#switch:{{lc:{{{3|}}}}}|optional=Optional|required=Required|#default=Required}}}}*'''''{{#ifeq:{{#var:status}}|Optional|{{Color|Skyblue|{{{1}}}}}|{{{1}}}}}''''' — {{#if:{{{3|}}}|(<i><small>{{#var:status}}</small></i> {{#if:{{{4|}}}|<small> - {{{4|}}}</small>}})}}{{{2}}}<noinclude> | |||
==Purpose== | ==Purpose== | ||
This is a really basic template used to quickly format descriptions for parameters used in the descriptions of other templates. Most cases it is used in conjunction with [[Template:Desc|Desc]]. | {{lc:This}} is a really basic template used to quickly format descriptions for parameters used in the descriptions of other templates. Most cases it is used in conjunction with [[Template:Desc|Desc]]. | ||
==Usage== | ==Usage== | ||
To use this template, type: {{Desc|Optional|Parameter Name|Parameter Description|Parameter Required/Optional|Default Value}} | To use this template, type: {{Desc|Optional|Parameter Name|Parameter Description|Parameter Required/Optional|Default Value}} | ||
*'''''Parameter Name''''' — This is the name of the parameter in question. | *'''''Parameter Name''''' — This is the name of the parameter in question. | ||
*'''''Parameter Description''''' — The description of the parameter. | *'''''Parameter Description''''' — The description of the parameter. | ||
*'''''Parameter Required/Optional''''' — (<i><small>Optional</small></i>) Whether or not the parameter is optional or required. | |||
*'''''Parameter Required/Optional''''' — | *'''''Default Value''''' — (<i><small>Optional</small></i>) If an optional parameter has a default value, explain it here. | ||
*'''''Default Value''''' — | |||
{{Cat|Formatting Templates}} | {{Cat|Formatting Templates}} | ||
</noinclude> | </noinclude> | ||