Template:Command Option Table/doc: Difference between revisions

From HPC Wiki
Jump to:navigation Jump to:search
(Created page with "{{Template}} <!-- Categories go at the bottom of this page. --> == Parameters == {{Template Parameter Table|1= {{Template Parameter|1|Parameter name|required=yes}} {{Template...")
 
m (Protected "Template:Command Option Table/doc" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading])
 
(3 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|Parameter name|required=yes}}
{{Template Parameter|1|List of commands options|required=yes}}
{{Template Parameter|2|Parameter name}}
 
…
}}
}}


== Usage ==
== Usage ==
See the template's [[Template:XYZ/testcases|testcases]]:
See the template's [[Template:Command Option Table/testcases|testcases]]:
{{Template:XYZ/testcases}}
{{Template:Command Option Table/testcases}}


== See also ==
== See also ==
*  
* {{Tl|Command Option}}


<includeonly>
<includeonly>
<!-- Categories go here: -->
[[Category:Formatting templates]]


</includeonly>
</includeonly>

Latest revision as of 12:42, 19 April 2017

Note
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
1Long form options are prefixed with --; 2Short form options are prefixed with -.
Long form1 Short form2 Option type Required? Description
input i string Yes input file to read
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
1Long form options are prefixed with --; 2Short form options are prefixed with -.
Long form1 Short form2 Option type Required? Description
input i string Yes input file to read
output string No output file to write
Sandbox version Template:Command Option Table/sandbox

See also

Retrieved from "http://magnolia.usm.edu/index.php?title=Template:Command_Option_Table/doc&oldid=771"