Template:Command Option/doc

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	(n/a)	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	(n/a)	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	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

• {{Command Option Table}}