Template:Command Option/doc: Difference between revisions
From HPC Wiki
Jump to:navigation
Jump to:search
m (Protected "Template:Command Option/doc" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
== Parameters == | == Parameters == | ||
{{Template Parameter Table|1= | {{Template Parameter Table|1= | ||
{{Template Parameter|1|Option description}} | {{Template Parameter|1|default=''(description missing)''|Option description}} | ||
{{Template Parameter|long|Long form option name}} | {{Template Parameter|long|Long form option name}} | ||
{{Template Parameter|short|Short form option name}} | {{Template Parameter|short|Short form option name}} | ||
{{Template Parameter|type|Type of option parameter (e.g., string, integer)}} | {{Template Parameter|type|Type of option parameter (e.g., string, integer)}} | ||
{{Template Parameter|required|Required option (yes/no)}} | {{Template Parameter|required|default=no|Required option (yes/no)}} | ||
}} | }} | ||
| Line 19: | Line 19: | ||
<includeonly> | <includeonly> | ||
[[Category:Formatting templates]] | |||
</includeonly> | </includeonly> | ||
Latest revision as of 13:43, 19 April 2017
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.
As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
Parameters
| Parameter name | Required? | Default value | Description |
|---|---|---|---|
Anonymous parameter 1 |
No | (description missing) |
Option description |
long |
No | (n/a) | Long form option name |
short |
No | (n/a) | Short form option name |
type |
No | (n/a) | Type of option parameter (e.g., string, integer) |
required |
No | no |
Required option (yes/no) |
Usage
See the template's testcases:
| Single option in table | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Wiki code | {{Command Option Table|1=
{{Command Option|long=input|short=i|type-string|input file to read|required=yes}}
}}
| ||||||||||
| Main version |
| ||||||||||
| Sandbox version | Template:Command Option Table/sandbox | ||||||||||
| Two options in table | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Wiki code | {{Command Option Table|1=
{{Command Option|long=input|short=i|type=string|input file to read|required=yes}}
{{Command Option|long=output|type=string|output file to write}}
}}
| |||||||||||||||
| Main version |
| |||||||||||||||
| Sandbox version | Template:Command Option Table/sandbox | |||||||||||||||