GuiCommand model/en: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{VeryImportantMessage|This page shows a model |
{{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.}} |
||
{{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 |
|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 |
|SeeAlso=<!--add links to similar commands; delete this row if not used--> |
||
|Version=0.17 |
|Version=0.17 |
||
}} |
}} |
||
==Description== |
==Description== |
||
While the page is under construction, add the <nowiki>{{UnfinishedDocu}}</nowiki> template at the top of the page. |
|||
Insert here a short description of what the command does. |
Insert here a short description of what the command does. |
||
Line 18: | Line 20: | ||
Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics]]. Example taken from Draft Line: |
Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics]]. Example taken from Draft Line: |
||
[[File:Draft_Line_example.jpg|none|400px]] |
[[File:Draft_Line_example.jpg|none|400px]] |
||
{{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 {{ |
# 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 {{ |
# Set options and press {{Button|OK}}. |
||
==Options== |
==Options== |
||
Line 45: | Line 49: | ||
==Scripting== |
==Scripting== |
||
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]]. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
* Creates a CommandModel using Data. |
|||
{{Code|code= |
|||
* Returns the newly created object. |
|||
⚫ | |||
}} |
|||
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}. |
|||
Example: |
Example: |
||
{{Code|code= |
|||
import FreeCAD, Base |
|||
⚫ | |||
⚫ | |||
}} |
|||
==Limitations== |
==Limitations== |
||
Line 65: | Line 75: | ||
<nowiki> |
<nowiki> |
||
{{UnfinishedDocu}} |
|||
{{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 |
|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 |
|SeeAlso=<!--add links to similar commands; delete this row if not used--> |
||
|Version=0.17 |
|Version=0.17 |
||
}} |
}} |
||
==Description== |
==Description== |
||
While the page is under construction, add the {{UnfinishedDocu}} template at the top of the page. |
|||
Insert here a short description of what the command does. |
Insert here a short description of what the command does. |
||
Line 82: | Line 95: | ||
[[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 {{ |
# 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 {{ |
# Set options and press {{Button|OK}}. |
||
==Options== |
==Options== |
||
Line 109: | Line 125: | ||
==Scripting== |
==Scripting== |
||
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]]. |
|||
The ExampleCommandModel tool can be used in [[macros]] and from the |
The ExampleCommandModel tool can be used in [[macros]] and from the [[Python]] console by using the following function: |
||
</translate> |
</translate> |
||
{{Code|code= |
|||
Object = makeExampleCommandModel(Data1, Data2) |
|||
}} |
|||
<translate> |
<translate> |
||
* Creates |
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}. |
||
* Returns the newly created object. |
|||
Example: |
Example: |
||
</translate> |
</translate> |
||
{{Code|code= |
|||
import FreeCAD, Base |
|||
⚫ | |||
⚫ | |||
}} |
|||
<translate> |
<translate> |
||
Line 131: | Line 152: | ||
Optional |
Optional |
||
</nowiki> |
</nowiki> |
||
[[Category:Wiki:Example]] |
Revision as of 22:58, 15 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
While the page is under construction, add the {{UnfinishedDocu}} template at the top of the page.
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
- Press the File:Std Close.png Command name button. The button must be a link to this command.
- Detailed steps as needed.
- Set options and press OK.
Options
- List the command options here. Check out two examples, Draft Line and PartDesign Pad.
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
usingData1
andData2
.
Example:
import FreeCAD, Base
Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
Limitations
- Optional, use bullet list if multiple items
Other
Optional
Selectable block
{{UnfinishedDocu}} {{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== While the page is under construction, add the {{UnfinishedDocu}} template at the top of the page. 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