Template:Command/doc

This template is used to generate auto-formatted commands. Commands can either be pasted directly into the template (with or without a slash), or each parameter specified as a separate argument.

Any parameter that isn't specified or is set to an empty value or  will be replaced with the default parameter for the command, if it is a known command and a valid parameter. Specified optional parameters will be displayed as if required, along with any other parameters in the optional group. Unspecified optional parameters won't be displayed.

These parameters are formatted as follows:
 * Parameters that do not have to be entered to use a command are given in parentheses.
 * If a given parameter can accept one of several different values, the values are listed in square brackets ([]) and separated by pipes, e.g..
 * Parameter names are enclosed in angled brackets and italicized, e.g..
 * Parameter values are given as plaintext and enclosed with square brackets, e.g..
 * These are combined as necessary, e.g.  or

Arguments

 * To output the rest of the command including optional parameters, add  to the template.
 * To remove the forward slash, add  or   to the template.
 * To change the command name's link, add  to the template.
 * To remove the command name's link, add  to the template.
 * To add HTML in the command, add  to the template. It's then your responsibility to   anything that looks like HTML but isn't.
 * If a command is long and may go off the edge of the screen, add  to the template. This allows the code to wrap as well as displaying it on its own line.

Examples




Pitfalls

 * Commands containing equals signs or vertical pipes must be escaped to display correctly. For equals, if using a single argument place  at the start of the command, otherwise replace each equals sign with =. For vertical pipes replace each one with !.
 * Commands containing braces must be careful not to end with a brace or have two or more next to each other. In a case such as:, a space can simply be placed at the end of the command:  . In a case such as:  ,   tags must be placed around the problem area:   or  , whatever is more readable.
 * In order to count dataTags and sub-commands as a single parameter, spaces inside are ignored. However this won't work if a command contains multiple separate dataTags or multiple separate sub-commands. In that case, use separate arguments for the parameters.

nl:Sjabloon:Command/doc