Template:Command Option: Difference between revisions
From HPC Wiki
No edit summary |
m (Protected "Template:Command Option" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>| {{# | <includeonly>| {{#if: {{{long|}}} |<code>{{{long|}}}</code>}} || {{#if: {{{short|}}} | <code>{{{short}}}</code>}} || {{{type|}}} || {{#ifeq: {{{required|no}}} | yes | {{Yes}} | {{No}}}} || {{{1|''(description missing)''}}} | ||
|-</includeonly><noinclude>{{Documentation}}</noinclude> | |-</includeonly><noinclude>{{Documentation}}</noinclude> | ||
Latest revision as of 12:43, 19 April 2017
[edit]
Documentation
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 | |||||||||||||||
See also
Note
The above documentation is transcluded from Template:Command Option/doc. (edit | history)
Editors can experiment in this template's sandbox (create) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.
The above documentation is transcluded from Template:Command Option/doc. (edit | history)
Editors can experiment in this template's sandbox (create) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.