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. These parameters are formatted as Commands.

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

 * You can use  to show all known commands' syntax.
 * 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:  , or place   tags around the problem area.
 * Texts in nowiki or other tags cannot be read by module. So placing spaces, bracket, braces or quotes into nowiki tags maybe makes it unable to separate parameters correctly. Please use self-closing tags, or enclose the whole parameter with nowiki. In a case such as:, use   tags:  , or  , whatever is more readable.
 * However it may be complex if a command contains multiple separate dataTags. In that case, use separate arguments for the parameters.

es:Plantilla:Comando ko:틀:Command nl:Sjabloon:Opdracht pt:Predefinição:Comando ru:Шаблон:Команда zh:模块:Command

es:Plantilla:Comando/doc ko:틀:Command/doc nl:Sjabloon:Opdracht/doc pt:Predefinição:Comando/doc ru:Шаблон:Команда/док