Template:Parameters/doc: Difference between revisions
Jump to navigation
Jump to search
Create: Minecraft Mod Wiki>Joker876 No edit summary |
BoxWithout (talk | contribs) m 9 revisions imported |
||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Ts|for=ParametersHead|PsHead}}{{Ts|for=Parameters|Ps}}{{Ts|for=ParametersFoot|PsFoot}} | |||
This template is used to display the parameters of a certain template. | This template is used to display the parameters of a certain template. | ||
| Line 6: | Line 7: | ||
==Definition== | ==Definition== | ||
{{ParametersHead}} | {{ParametersHead}} | ||
{{Parameters|1|string|The name/names of the parameter.}} | {{Parameters|1|yes|string|The name/names of the parameter.}} | ||
{{Parameters|2|string|The type of the parameter that should be used.}} | {{Parameters|2|yes|bool|Whether or not the parameter is required.}} | ||
{{Parameters| | {{Parameters|reqtext|no|any|Additional text displayed after the Yes/No in the "R?" column.}} | ||
{{Parameters| | {{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}} | {{ParametersFoot}} | ||
| Line 15: | Line 18: | ||
<pre style="width: 700px"> | <pre style="width: 700px"> | ||
{{ParametersHead}} | {{ParametersHead}} | ||
{{Parameters|1|string|The name/names of the parameter.}} | {{Parameters|1|yes|string|The name/names of the parameter.}} | ||
{{Parameters|2|string|The type of the parameter that should be used.}} | {{Parameters|2|yes|bool|Whether or not the parameter is required.}} | ||
{{Parameters| | {{Parameters|3|yes|string|The type of the parameter that should be used.}} | ||
{{Parameters| | {{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}} | {{ParametersFoot}} | ||
</pre> | </pre> | ||
;produces | ;produces | ||
{{ParametersHead}} | {{ParametersHead}} | ||
{{Parameters|1|string|The name/names of the parameter.}} | {{Parameters|1|yes|string|The name/names of the parameter.}} | ||
{{Parameters|2|string|The type of the parameter that should be used.}} | {{Parameters|2|yes|bool|Whether or not the parameter is required.}} | ||
{{Parameters| | {{Parameters|3|yes|string|The type of the parameter that should be used.}} | ||
{{Parameters| | {{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}} | {{ParametersFoot}} | ||
Latest revision as of 21:59, 14 February 2025
 |
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:
For template:
{{ParametersHead}}{{PsHead}}
Template shortcut
For template:
For template:
{{Parameters}}{{Ps}}
Template shortcut
For template:
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[edit source]
| 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[edit source]
{{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}} |