No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
It accepts two {{Parameter|mandatory|string}}: | It accepts two {{Parameter|mandatory|string}}: | ||
* {{Code|1}} is the name of the parameter. | * {{Code|1}} is the name of the parameter or the number of parameters. | ||
* {{Code|2}} is the name of the template. | * {{Code|2}} is the name of the template. | ||
It should generally be included as the default for named parameters. For example, if a template called "bar" has a required parameter called "foo", it should be used like so: {{Code|<nowiki>{{{foo|{{Required|foo|bar}}}}}</nowiki>}} | It should generally be included as the default for named parameters. For example, if a template called "bar" has a required parameter called "foo", it should be used like so: {{Code|<nowiki>{{{foo|{{Required|foo|bar}}}}}</nowiki>}} | ||
==Return== | ==Return== | ||
{{Code|<nowiki>{{Required| | {{Code|<nowiki>{{Required|foo|bar}}</nowiki>}} returns: {{Return|{{Required|foo|bar}}}} | ||
{{Code|<nowiki>{{Required|7|bar}}</nowiki>}} returns: {{Return|{{Required|7|bar}}}} | |||
Revision as of 15:47, 24 October 2022
Template:Required is a helper template for Template:Error, used to call out missing mandatory parameters.
Usage
It accepts two mandatory string parameter:
1is the name of the parameter or the number of parameters.2is the name of the template.
It should generally be included as the default for named parameters. For example, if a template called "bar" has a required parameter called "foo", it should be used like so: {{{foo|{{Required|foo|bar}}}}}
Return
{{Required|foo|bar}} returns:
Error!
foo is required by Template:bar!{{Required|7|bar}} returns:
Error!
Template:bar has 7 mandatory parameters!