Template:Command Option Table: Difference between revisions
From HPC Wiki
No edit summary |
(Table caption describing long and short form usage.) |
||
| Line 1: | Line 1: | ||
<includeonly>{| class="table table-striped" | <includeonly>{| class="table table-striped" | ||
|+<span style="font-size:88%; line-height: 1.3em;"><sup>1</sup>Long form options are prefixed with <code>--</code>; <sup>2</sup>Short form options are prefixed with <code>-</code>.</span> | |||
|- | |- | ||
! Long form | ! Long form<sup>1</sup>!! Short form<sup>2</sup> !! Option type !! Required? !! Description | ||
|- | |- | ||
{{{1|}}} | {{{1|}}} | ||
|} | |}</includeonly><noinclude>{{Documentation}}</noinclude> | ||
Revision as of 12:39, 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 |
Yes | (n/a) | List of commands options |
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 Table/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 Table/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.