No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation}} | {{Documentation}} | ||
<includeonly><onlyinclude>{{#ifeq:{{#titleparts:{{FULLPAGENAME}}||-1|Documentation|<!-- Do Nothing -->|{{#switch:{{{1|}}} | <includeonly><onlyinclude>{{#ifeq:{{#titleparts:{{FULLPAGENAME}}}}||-1|Documentation|<!-- Do Nothing -->|{{#switch:{{{1|}}} | ||
| mandatory = mandatory {{{2|}}} parameter[[Category:Templates With Mandatory Parameters|Parameter]] | | mandatory = mandatory {{{2|}}} parameter[[Category:Templates With Mandatory Parameters|Parameter]] | ||
| optional = optional {{{2|}}} parameter[[Category:Templates With Optional Parameters|Parameter]] | | optional = optional {{{2|}}} parameter[[Category:Templates With Optional Parameters|Parameter]] | ||
| no | none = no parameters[[Category:Templates Without Parameters|Parameter]] | | no | none = no parameters[[Category:Templates Without Parameters|Parameter]] | ||
| #default = {{Error|{{Code|{{{1|}}}}} is not a valid parameter for {{Template|Parameter}}.}} | | #default = {{Error|{{Code|{{{1|}}}}} is not a valid parameter for {{Template|Parameter}}.}} | ||
}}}}</onlyinclude></includeonly> | |||
Revision as of 13:54, 22 October 2022
Template:Parameter is used with in the template namespace to identify and categorize templates based on their usage of parameters.
Usage
It accepts one Documentation, one of mandatory, optional, no, or none.
It also accepts one Documentation, arbitrary text describing the parameter, typically something like string or integer.
Return
It's invoked twice above, but for clarity sake...
{{Parameter|mandatory}} adds the template to the Templates with Mandatory Parameters category and returns: Documentation
{{Parameter|optional}} adds the template to the Templates with Optional Parameters category and returns: Documentation
{{Parameter|no}} or {{Parameter|none}} adds the template to the Templates without Parameters category and returns: no parameters
The optional parameter is inserted between the two words. For instance, {{Parameter|optional|magenta}} returns: Documentation
The documentation above was transcluded from Template:Parameter/Documentation. [edit]