Template:CommandReference: Difference between revisions
Jump to navigation
Jump to search
imported>Felice Enellen (seeing how it looks if I indent shortdesc) |
imported>Felice Enellen (I think that's preferable, but the args need an indent too now) |
||
| Line 47: | Line 47: | ||
{{ | {{ | ||
#if:{{{1|}}}| | #if:{{{1|}}}| | ||
; <var>{{{1}}}</var> | ;: <var>{{{1}}}</var> | ||
: {{{3}}} | :: {{{3}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{4|}}}| | #if:{{{4|}}}| | ||
; <var>{{{4}}}</var> | ;: <var>{{{4}}}</var> | ||
: {{{6}}} | :: {{{6}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{7|}}}| | #if:{{{7|}}}| | ||
; <var>{{{7}}}</var> | ;: <var>{{{7}}}</var> | ||
: {{{9}}} | :: {{{9}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{10|}}}| | #if:{{{10|}}}| | ||
; <var>{{{10}}}</var> | ;: <var>{{{10}}}</var> | ||
: {{{12}}} | :: {{{12}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{13|}}}| | #if:{{{13|}}}| | ||
; <var>{{{13}}}</var> | ;: <var>{{{13}}}</var> | ||
: {{{15}}} | :: {{{15}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{16|}}}| | #if:{{{16|}}}| | ||
; <var>{{{16}}}</var> | ;: <var>{{{16}}}</var> | ||
: {{{18}}} | :: {{{18}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{19|}}}| | #if:{{{19|}}}| | ||
; <var>{{{19}}}</var> | ;: <var>{{{19}}}</var> | ||
: {{{21}}} | :: {{{21}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{22|}}}| | #if:{{{22|}}}| | ||
; <var>{{{22}}}</var> | ; <var>{{{22}}}</var> | ||
: {{{24}}} | :: {{{24}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{25|}}}| | #if:{{{25|}}}| | ||
; <var>{{{25}}}</var> | ; <var>{{{25}}}</var> | ||
: {{{27}}} | :: {{{27}}} | ||
|}}{{ | |}}{{ | ||
#if:{{{28|}}}| | #if:{{{28|}}}| | ||
; <var>{{{28}}}</var> | ;: <var>{{{28}}}</var> | ||
: {{{30}}} | :: {{{30}}} | ||
|}} | |}} | ||
Revision as of 13:25, 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}}}