Template:Parameters/doc

This is a documentation subpage for Template:Parameters. It contains usage information, categories and other content that is not part of the original template page.

Template shortcut
For template: {{ParametersHead}}

• {{PsHead}}

Template shortcut
For template: {{Parameters}}

• {{Ps}}

Template shortcut
For template: {{ParametersFoot}}

• {{PsFoot}}

This template is used to display the parameters of a certain template.

It should only be used on documentation pages.

Definition

Parameter	R?	Type	Description	Default
1	Yes	/	The name/names of the parameter.
2	Yes	/	Whether or not the parameter is required.
reqtext	No	/	Additional text displayed after the Yes/No in the "R?" column.
3	Yes	/	The type of the parameter that should be used.
4	No	/	The description of the parameter.	–
5	No	/	The default value for the parameter.	{{Blank cell}}

Examples

{{ParametersHead}}
{{Parameters|1|yes|string|The name/names of the parameter.}}
{{Parameters|2|yes|bool|Whether or not the parameter is required.}}
{{Parameters|3|yes|string|The type of the parameter that should be used.}}
{{Parameters|4|no|any|The description of the parameter.|<center>–</center>}}
{{Parameters|5|no|any|The default value for the parameter.|{{T|Blank cell}}}}
{{ParametersFoot}}

produces

Parameter	R?	Type	Description	Default
1	Yes	/	The name/names of the parameter.
2	Yes	/	Whether or not the parameter is required.
3	Yes	/	The type of the parameter that should be used.
4	No	/	The description of the parameter.	–
5	No	/	The default value for the parameter.	{{Blank cell}}