Template:CommandReference: Difference between revisions
Jump to navigation
Jump to search
imported>Felice Enellen (format the args as well) |
imported>Felice Enellen (seeing how it looks if I indent shortdesc) |
||
| Line 44: | Line 44: | ||
| {{#if:{{{29|}}}|<var>[</var>|}}{{{28}}}{{#if:{{{29|}}}|<var>]</var>|}} | | {{#if:{{{29|}}}|<var>[</var>|}}{{{28}}}{{#if:{{{29|}}}|<var>]</var>|}} | ||
|}}</div> | |}}</div> | ||
{{{shortdesc}}} | : {{{shortdesc}}} | ||
{{ | {{ | ||
#if:{{{1|}}}| | #if:{{{1|}}}| | ||
Revision as of 13:23, 26 March 2020
Use this template at the top of every system command reference page:
{{CommandReference
|name=load
|shortdesc=Loads a cartridge file.
|filename||The name of the cartridge file.
}}
name=... is the name of the command.
shortdesc=... is a short description, where the first sentence is a verb phrase with an implied noun (e.g. "Loads a cartridge file."), followed by an optional second (full) sentence.
The subsequent template parameters describe the command arguments. Each argument has three template parameters: the argument name, "optional" if the argument is optional, and a short description.
As a matter of style, command and argument short descriptions begin with a capital letter and end with a period.
This template supports up to 10 command arguments. Extend the template if more are needed.
{{{name}}}
- {{{shortdesc}}}