Template:Command/doc

This is the documentation page. It should be transcluded into Template:Command. See Template:Documentation for more information.

This template uses Module:Command, a script written in Lua.

Shortcut

This template is used to generate auto-formatted commands.

Arguments

To remove the forward slash, add |/=0 or |slash=0 to the template.
To change the command name's link, add |link=<link> to the template.
To remove the command name's link, add |link=none to the template.
To add HTML in the command, add |escape=0 to the template. It's then your responsibility to <nowiki> anything that looks like HTML but isn't.
If a command is long and may go off the edge of the screen, add |long=1 to the template. This allows the code to wrap as well as displaying it on its own line.

Commands containing equals signs or vertical pipes must be escaped to display correctly. For equals, if using a single argument place 1= 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: {{cmd|data {some:"data"}}}, a space can simply be placed at the end of the command: {{cmd|data {some:"data"} }}, or place <nowiki> tags around the problem area.