Template:GuiCommand

{{{Name}}}
Menu location
{{{MenuLocation}}}
Workbenches
{{{Workbenches}}}
Default shortcut
None
Introduced in version
-
See also
None

Usage

This Template is the main anchor on documenting GuiCommands. It should be inserted as the first line in new documents.

The minimum code required for this template usage is: (sample result to right)

{{GuiCommand|Name=SampleCommand|MenuLocation=Menu → Command...|Workbenches=Wb1, Wb2}}

Also note that each parameter can be placed on a separate line, which may make it easier for editors and translators to understand its use:

{{GuiCommand
|Name=SampleCommand
|MenuLocation=Menu → Command...
|Workbenches=Wb1, Wb2
}}

Minimum Parameters

The following parameters are used in the format [parameter]=[value], with each parameter in the list separated by a pipe symbol (|):

Name

The properly capitalized name of the command to be documented.

The name is also used to retrieve the Icon graphic in .PNG format from the WIKI repository. The template works properly, if the Icon graphic does not exist. In this case a generic icon is displayed.

MenuLocation

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

Workbenches

One or more workbenches in FreeCAD that the command and icon can be found on. It should be an internal link to the workbench(es) page(s), used like this:

[[Part Workbench|Part]]

Where the portion left to the pipe (|) symbol is the page name, and the portion right to it is the text displayed. This example will display as Part.

Optional Parameters

The following parameters are optional. If they are not included in the template code, they will default to a value of "None", or for the Version parameter, a dash sign.

Shortcut

The default Keyboard shortcut as found in FreeCAD.

SeeAlso

Optional links to other related commands.

Icon

an icon with a different name as pagename.png can be used by defining the variable Icon (other format can be used eg: myIcon.svg)

Empty

if Empty=1 no icon is displayed

Version

inserts the FreeCAD version number in which the command was first introduced. No need to add the revision number. Please consider adding this parameter for all new commands.

Localization

The code required for this template is different if you are using a localized version. For more information see the Localization page.

• First, a localized version of this template must exist or be created.
• The localized template must be named:

  Template:GuiCommand/AA

  where /AA is the 2 letter code for the desired language, for example /fr = French localization.
• The method for calling the localized GuiCommand template in a GuiCommand document is:

{{GuiCommand/AA
|Name=SampleCommand
|Name/AA=SampleCommand (translated)
|MenuLocation=Menu → Commande...
|Workbenches=Wb1, Wb2
}}

where /AA is the 2 letter code for the desired language, for example /fr = French localization.

• In the sample code above, the Name parameter format is critical. The Name=SampleCommand allows the correct icon file to be displayed, which is not normally localized. The Name/AA=SampleCommand (translated) displays the correct localized version of the GUI command documentation.

GuiCommand Model

For a complete model of a GuiCommand, see GuiCommand model.