Template:GuiCommand

{{{Name}}}
Menu location
None
Workbench / area
Not specified
Default shortcut
None
Introduced in version
-
See also
None

Usage

This template is the main tool to document GuiCommands. See the sample on the right.

SampleCommand
Menu location
Menu → Command
Workbench / area
Ph1, Ph2
Default shortcut
DefaultShortcut
Introduced in version
0.7
See also
OtherTopic

{{GuiCommand
|Name=SampleCommand
|MenuLocation=Menu → Command
|Phenomena=Ph1, Ph2
|Shortcut=DefaultShortcut
|Version=0.7
|SeeAlso=OtherTopic
}}

Parameters are specified with values after the equals sign: parameter=value.

The required parameters are:

{{GuiCommand
|Name=SampleCommand
|Phenomena=Ph1, Ph2
}}

Other parameters may be omitted or their value left empty.

Required parameters

The following parameters are required.

Name

The properly capitalized name of the command to be documented.

The name is used to retrieve the icon graphic Name.svg or Name.png from the wiki repository.

Phenomena

One or more phenomena in LabRPS that the command and icon can be found in. It should be an internal link to the phenomenon page, used like this:

[[Stochastic_wind_velocity_phenomenon|Stochastic wind velocity]]

The portion to the left of the pipe | is the page name, and the portion to the right is the displayed text. This example will display as Stochastic wind velocity.

Optional Parameters

The following parameters are optional. If they are not included in the template, they will default to None, or a dash (-).

MenuLocation

The location of the command in the LabRPS menu structure. Please use the proper right arrow symbol (→) rather than ->.

Shortcut

The default keyboard shortcut to launch the command in LabRPS, for example, Shortcut={{KEY|A}} {{KEY|B}}.

Version

The Product version number in which the command was first introduced, for example, Version=0.17. There is no need to add the specific revision number, only the major version. Use this parameter for all new commands included in the documentation.

SeeAlso

Optional links to other related commands and Wiki pages, for example, SeeAlso=[[Some Tool|Tool]].

Icon

An image file different from Name.svg or Name.png for the icon. This can be used to include a specific icon that is not named after the command, for example, Icon=Some_other_name.svg

Empty

If Empty=1 no icon is displayed. This is for the rare cases where the Name.svg or Name.png icon needs to be suppressed.

GuiCommand model

For a complete example of how to document a GuiCommand, see GuiCommand model.

---

Migrated from SiteMasterDoc. Original revision history and imported contributor names are retained. See BathAfrica:Template migration for compatibility changes and unresolved image dependencies. Legacy examples do not establish current BathAfrica product capabilities.