Template:GuiCommand

{|class="wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" | | class="ctTitle"|

[[Image:.png|32px]]
|- ! class="ctOdd"|Menu location |- | class="ctEven"| |- ! class="ctOdd"|Workbenches |- | class="ctEven"| |- ! class="ctOdd"|Default shortcut |- | class="ctEven"| |- ! class="ctOdd"|See also |- | class="ctEven"| |- | class="ctToc"|
 * }

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)

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.


 * MenuLocation : The location of the command in the FreeCAD menu structure.
 * Workbenches : One or more workbenches in FreeCAD that the command and icon can be found on.

Optional Parameters
The following parameters are optional. If they are not included in the template code, they will default to a value of "None".
 * Shortcut : The default Keyboard shortcut as found in FreeCAD.
 * SeeAlso : Optional link to other related topics.

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: 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/AA displays the correct localized version of the GUI command documentation.
 * Make sure you add the localized version of this template to the Languages list below.

Description
Description image

How to use

 * 1) How to use
 * 2) How to use

Options
(Code of title Tasks)
 * : Tasks
 * Options

Properties
(Code of title Data) (Code of title View)
 * : Properties
 * : Properties

Scripting
Scripting

code

Example

code

other (optional)
!