GuiCommand model: Difference between revisions

From FreeCAD Documentation
(Use the {{VeryImportantTemplate}} instead of the {{Message}} template)
(Link to Gui Command on the important message; add {{Caption}} template below the image; add {{Button}} template, with 16px for the image, instead of {{KEY}}, for buttons; {{Code}} is more explicit that using an initial space; indicate return value)
Line 2: Line 2:
<translate>
<translate>
<!--T:15-->
<!--T:15-->
{{VeryImportantMessage|This page shows a model of a recommended GuiCommand page. Under the [[#Selectable block|Selectable block]] section below you will find the same content easily selectable for pasting in a new page.}}
{{VeryImportantMessage|This page shows a model to document a [[Gui Command]]. Under the [[#Selectable block|Selectable block]] section below you will find the same content easily selectable for pasting in a new page.}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Base ExampleCommandModel
|Name=Base ExampleCommandModel
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command / delete row if unused-->
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command; delete this row if not used-->
|MenuLocation=Menu → Submenu → Command
|MenuLocation=Menu → Submenu → Command
|Workbenches=[[Workbench Name|Workbench]]
|Workbenches=[[Workbench Name|Workbench]]
|Shortcut=<!--delete this row if not used-->
|Shortcut=<!--delete this row if not used-->
|SeeAlso=<!--add links to similar commands, delete this row if not used-->
|SeeAlso=<!--add links to similar commands; delete this row if not used-->
|Version=0.17
|Version=0.17
}}
}}
Line 26: Line 26:
<translate>
<translate>
<!--T:17-->
<!--T:17-->
''Optional: add a caption in italics below the image.''
{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}

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.


==How to use== <!--T:3-->
==How to use== <!--T:3-->


<!--T:4-->
<!--T:4-->
# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# Press the {{Button|[[File:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button. The button must be a link to this command.
# Detailed steps as needed.
# Detailed steps as needed.
# Set options and press {{KEY|OK}}.
# Set options and press {{Button|OK}}.


==Options== <!--T:5-->
==Options== <!--T:5-->
Line 56: Line 58:


==Scripting== <!--T:8-->
==Scripting== <!--T:8-->
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]].


<!--T:9-->
<!--T:9-->
The ExampleCommandModel tool can be used in [[macros]] and from the python console by using the following function:
The ExampleCommandModel tool can be used in [[macros]] and from the [[Python]] console by using the following function:
</translate>
</translate>
{{Code|code=
'''makeExampleCommandModel(Data, Data)'''
Object = makeExampleCommandModel(Data1, Data2)
}}
<translate>
<translate>
<!--T:10-->
<!--T:10-->
* Creates a CommandModel using Data.
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.
* Returns the newly created object.


<!--T:11-->
<!--T:11-->
Example:
Example:
</translate>
</translate>
{{Code|code=
import FreeCAD, Base
import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
<translate>
<translate>


Line 87: Line 94:
{{GuiCommand
{{GuiCommand
|Name=Base ExampleCommandModel
|Name=Base ExampleCommandModel
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command / delete row if unused-->
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command; delete this row if not used-->
|MenuLocation=Menu → Submenu → Command
|MenuLocation=Menu → Submenu → Command
|Workbenches=[[Workbench Name|Workbench]]
|Workbenches=[[Workbench Name|Workbench]]
|Shortcut=<!--delete this row if not used-->
|Shortcut=<!--delete this row if not used-->
|SeeAlso=<!--add links to similar commands, delete this row if not used-->
|SeeAlso=<!--add links to similar commands; delete this row if not used-->
|Version=0.17
|Version=0.17
}}
}}
Line 102: Line 109:
[[File:Draft_Line_example.jpg|none|400px]]
[[File:Draft_Line_example.jpg|none|400px]]
<translate>
<translate>

''Optional: add a caption in italics.''
{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}

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.


==How to use==
==How to use==


# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# Press the {{Button|[[File:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button. The button must be a link to this command.
# Detailed steps as needed.
# Detailed steps as needed.
# Set options and press {{KEY|OK}}.
# Set options and press {{Button|OK}}.


==Options==
==Options==
Line 129: Line 139:


==Scripting==
==Scripting==
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]].


The ExampleCommandModel tool can be used in [[macros]] and from the python console by using the following function:
The ExampleCommandModel tool can be used in [[macros]] and from the [[Python]] console by using the following function:
</translate>
</translate>
{{Code|code=
'''makeExampleCommandModel(Data, Data)'''
Object = makeExampleCommandModel(Data1, Data2)
}}
<translate>
<translate>
* Creates a CommandModel using Data.
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.
* Returns the newly created object.


Example:
Example:
</translate>
</translate>
{{Code|code=
import FreeCAD, Base
import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
<translate>
<translate>



Revision as of 17:28, 4 December 2018

This page shows a model to document a Gui Command. Under the Selectable block section below you will find the same content easily selectable for pasting in a new page.

Base ExampleCommandModel

Menu location
Menu → Submenu → Command
Workbenches
Workbench
Default shortcut
None
Introduced in version
0.17
See also
None

Description

Insert here a short description of what the command does.

Add an image if possible, and please follow the guidelines in WikiPages#Graphics. Example taken from Draft Line:

Optional: add a caption below the image to explain what the tool is doing.

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.

How to use

  1. Press the File:Std Close.png Command name button. The button must be a link to this command.
  2. Detailed steps as needed.
  3. Set options and press OK.

Options

Properties

Data

  • DataPropertyName1: Description of the property

View

  • ViewPropertyName2: Description of the property

Example

Optional

Scripting

See also: Category:API and FreeCAD Scripting Basics.

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

Object = makeExampleCommandModel(Data1, Data2)
  • Creates an Object using Data1 and Data2.

Example:

import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)

Limitations

  • Optional, use bullet list if multiple items

Other

Optional

Selectable block

{{GuiCommand
|Name=Base ExampleCommandModel
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command; delete this row if not used-->
|MenuLocation=Menu → Submenu → Command
|Workbenches=[[Workbench Name|Workbench]]
|Shortcut=<!--delete this row if not used-->
|SeeAlso=<!--add links to similar commands; delete this row if not used-->
|Version=0.17
}}

==Description==

Insert here a short description of what the command does.

</translate>
[[File:Draft_Line_example.jpg|none|400px]]
<translate>

{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}

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.

==How to use==

# Press the {{Button|[[File:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button. The button must be a link to this command.
# Detailed steps as needed.
# Set options and press {{Button|OK}}.

==Options==

* List the command options here.

==Properties==

===Data===

* {{PropertyData|PropertyName1}}: Description of the property

===View===

* {{PropertyView|PropertyName2}}: Description of the property

==Example==

Optional

==Scripting==
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]].

The ExampleCommandModel tool can be used in [[macros]] and from the [[Python]] console by using the following function:
</translate>
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
}}
<translate>
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.

Example:
</translate>
{{Code|code=
import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
<translate>

==Limitations==

* Optional, use bullet list if multiple items

==Other==

Optional