LabRPS: Created page with "{|class="fcinfobox wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" | | class="ctTitle" style="font-weight: bold; font-size: 125%;" | {{#if:{{{Empty|}}} | |{{#if:{{{Icon|}}} |link= |{{#ifexist: Image:{{{Name}}}.svg |link= |{{#ifexist: Image:{{{Name}}}.png |Image:{{{Name}}}.png|x3..."

2022-08-26T08:44:21Z

Created page with "{|class="fcinfobox wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" | | class="ctTitle" style="font-weight: bold; font-size: 125%;" | {{#if:{{{Empty|}}} | |{{#if:{{{Icon|}}} |[[Image:{{{Icon}}}|x32px|link=]] |{{#ifexist: Image:{{{Name}}}.svg |[[Image:{{{Name}}}.svg|x32px|link=]] |{{#ifexist: Image:{{{Name}}}.png |Image:{{{Name}}}.png|x3..."

New page

{|class="fcinfobox wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" |
| class="ctTitle" style="font-weight: bold; font-size: 125%;" |
{{#if:{{{Empty|}}}
|
|{{#if:{{{Icon|}}}
|[[Image:{{{Icon}}}|x32px|link=]] 
|{{#ifexist: Image:{{{Name}}}.svg
|[[Image:{{{Name}}}.svg|x32px|link=]] 
|{{#ifexist: Image:{{{Name}}}.png
|[[Image:{{{Name}}}.png|x32px|link=]] 
|}}}}}}}}{{{Name}}}
|-
! class="ctOdd"|Menu location
|-
| class="ctEven"|{{#if:{{{MenuLocation|}}}|{{{MenuLocation}}}|''None''}}
|-
! class="ctOdd"|Phenomena
|-
| class="ctEven"|{{{Phenomena}}}
|-
! class="ctOdd"|Default shortcut
|-
| class="ctEven"|{{#if:{{{Shortcut|}}}|{{{Shortcut}}}|''None''}}
|-
! class="ctOdd"|Introduced in version
|-
| class="ctEven"|{{#if:{{{Version|}}}|{{{Version}}}|-}}
|-
! class="ctOdd"|See also
|-
| class="ctEven"|{{#if:{{{SeeAlso|}}}|{{{SeeAlso}}}|''None''}}
|-
| class="ctToc"| __TOC__
|}
[[Category:User Documentation]]
[[Category:Command Reference]]<noinclude>

==Usage==

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

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

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

Parameters are specified with values after the equals sign: <code>parameter=value</code>.

The required parameters are:

<pre>
{{GuiCommand
|Name=SampleCommand
|Phenomena=Ph1, Ph2
}}
</pre>

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 <code>Name.svg</code> or <code>Name.png</code> 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:

<pre>
[[Stochastic_wind_velocity_phenomenon|Stochastic wind velocity]]
</pre>

The portion to the left of the pipe <code>|</code> is the page name, and the portion to the right is the displayed text. This example will display as [[Stochastic_wind_velocity_phenomenon|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, <code><nowiki>Shortcut={{KEY|A}} {{KEY|B}}</nowiki></code>.
;Version
: The LabRPS version number in which the command was first introduced, for example, <code>Version=0.17</code>. 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, <code><nowiki>SeeAlso=[[Some Tool|Tool]]</nowiki></code>.
;Icon
: An image file different from <code>Name.svg</code> or <code>Name.png</code> for the icon. This can be used to include a specific icon that is not named after the command, for example, <code>Icon=Some_other_name.svg</code>
;Empty
: If <code>Empty=1</code> no icon is displayed. This is for the rare cases where the <code>Name.svg</code> or <code>Name.png</code> icon needs to be suppressed.

==GuiCommand model==

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

[[Category:Template:Doc]]
[[Category:Template]]
</noinclude>

Template:GuiCommand - Revision history