GuiCommand model

Description
While the page is under construction, add the Template:UnfinishedDocu template at the top of the page by simply typing:  

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the Sketcher Workbench. (Editor note: The image is 24px, not 16px)

Remember to use Template:Version, Template:VersionMinus, Template:VersionPlus and Template:Obsolete when applicable.

For example: The feature  allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in WikiPages. Example taken from Part Sweep:

Closing and opening translate tags should surround images, and other fixed elements, if they don't need to be translated. The caption should always be translated.

Usage

 * 1) There are several ways to invoke the command:
 * 2) * Press the button. (Editor note: This uses the Template:Button template, it is necessary to link to the command as shown in this example)
 * 3) * Select the option from the menu. (Editor note: This uses the Template:MenuCommand template)
 * 4) * Select the option from the Tree view context menu or 3D view context menu. (Editor note: This also uses the Template:MenuCommand template, not all commands can be accessed from a context menu)
 * 5) * Use the keyboard shortcut then  or +. (Editor note: This uses the Template:KEY template, not all commands have a keyboard shortcut)
 * 6) Detailed steps as needed. Some steps may need  presses while others may require using the mouse to click on a.
 * 7) Set options and press.

Options

 * Optional. List the command options here. See for example Draft Wire.

Example
Optional.

Properties
See also: Property editor.

An object is usually derived from a base object. You should not list the properties that are inherited from that base object. See for example Draft Wire.

Data

 * : Description of the property. (Editor note: to find the select  in the context menu of the Property editor. The tooltip of each property will then include this information. But the  can also be found in the source code.)

View

 * : Description of the property.

Scripting
See also: Autogenerated API documentation and FreeCAD Scripting Basics.

The ExampleCommandModel tool can be used in macros and from the Python console by using the following function:


 * Creates an using  and.

Example:

Other
Optional.

Selectable block
&lt;translate&gt;

Description
While the page is under construction, add the Template:UnfinishedDocu template at the top of the page by simply typing: 

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the Sketcher Workbench. (Editor note: The image is 24px, not 16px)

Remember to use Template:Version, Template:VersionMinus, Template:VersionPlus and Template:Obsolete when applicable.

For example: The feature  allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in WikiPages. Example taken from Part Sweep: &lt;/translate&gt; &lt;translate&gt;

Closing and opening translate tags should surround images, and other fixed elements, if they don't need to be translated. The caption should always be translated.

Usage

 * 1) There are several ways to invoke the command:
 * 2) * Press the button. (Editor note: This uses the Template:Button template, it is necessary to link to the command as shown in this example)
 * 3) * Select the option from the menu. (Editor note: This uses the Template:MenuCommand template)
 * 4) * Select the option from the Tree view context menu or 3D view context menu. (Editor note: This also uses the Template:MenuCommand template, not all commands can be accessed from a context menu)
 * 5) * Use the keyboard shortcut then  or +. (Editor note: This uses the Template:KEY template, not all commands have a keyboard shortcut)
 * 6) Detailed steps as needed. Some steps may need  presses while others may require using the mouse to click on a.
 * 7) Set options and press.

Options

 * Optional. List the command options here. See for example Draft Wire.

Example
Optional.

Properties
See also: Property editor.

An object is usually derived from a base object. You should not list the properties that are inherited from that base object. See for example Draft Wire.

Data

 * : Description of the property. (Editor note: to find the select  in the context menu of the Property editor. The tooltip of each property will then include this information. But the  can also be found in the source code.)

View

 * : Description of the property.

Scripting
See also: Autogenerated API documentation and FreeCAD Scripting Basics.

The ExampleCommandModel tool can be used in macros and from the Python console by using the following function:

&lt;/translate&gt;

&lt;translate&gt;


 * Creates an using  and.

Example:

&lt;/translate&gt;

&lt;translate&gt;

Other
Optional.

&lt;/translate&gt;