Template:Command Option/doc: Difference between revisions

Latest revision as of 12:43, 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`	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

¹Long form options are prefixed with `--`; ²Short form options are prefixed with `-`.
Long form¹	Short form²	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

¹Long form options are prefixed with `--`; ²Short form options are prefixed with `-`.
Long form¹	Short form²	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

@@ Line 4: / Line 4: @@
 == Parameters ==
 {{Template Parameter Table|1=
-{{Template Parameter|1|Parameter name|required=yes}}
+{{Template Parameter|1|default=''(description missing)''|Option description}}
-{{Template Parameter|2|Parameter name}}
+{{Template Parameter|long|Long form option name}}
-…
+{{Template Parameter|short|Short form option name}}
+{{Template Parameter|type|Type of option parameter (e.g., string, integer)}}
+{{Template Parameter|required|default=no|Required option (yes/no)}}
 }}
@@ Line 14: / Line 16: @@
 == See also ==
-*
+* {{Tl|Command Option Table}}
 <includeonly>
-<!-- Categories go here: -->
+[[Category:Formatting templates]]
 </includeonly>