Template:CommandReference

From Pico-8 Wiki
Revision as of 13:19, 26 March 2020 by imported>Felice Enellen (format the args as well)
Jump to navigation Jump to search

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}}}