GuiCommand model

From FreeCAD Documentation
Revision as of 09:20, 24 November 2018 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
This page shows a model of a recommended GuiCommand page. Under the Selectable block section below you will find the same content easily selectable for pasting in a new page.


Base_ExampleCommandModel

Ubicación en el Menú
Ninguno
Entornos de trabajo
Wb1,Wb2
Atajo de teclado por defecto
Ninguno
Introducido en versión
-
Ver también
Ninguno

Descripción

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 in italics below the image.

Descripción


image


Utilización

  1. Cómo se utiliza
  2. Cómo se utiliza

Opciones

  • TASK Length:Tareas
{{PropertyTasks|Length}} (Código del título)
  • Opciones

Propiedades

  • DatosProperties:Propiedades
{{PropertyData|Length}} (Código del título)
  • VistaProperties:Propiedades
 {{PropertyView|Properties}} (Código del título)

Data

  • DatosPropertyName1: Description of the property

View

  • VistaPropertyName2: Description of the property

Example

Optional

Archivos de guión

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

makeExampleCommandModel(Data, Data)
  • Creates a CommandModel using Data.
  • Returns the newly created object.

Ejemplo:

import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)

Limitations

  • Optional, use bullet list if multiple items

Otros (opcional)

!

Selectable block

{{GuiCommand
|Name=Base ExampleCommandModel
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command / delete row if unused-->
|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>
''Optional: add a caption in italics.''

==How to use==

# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# Detailed steps as needed.
# Set options and press {{KEY|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==

The ExampleCommandModel tool can be used in [[macros]] and from the python console by using the following function:
</translate>
 '''makeExampleCommandModel(Data, Data)'''
<translate>
* Creates a CommandModel using Data.
* Returns the newly created object.

Example:
</translate>
 import FreeCAD, Base
 Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)
<translate>

==Limitations==

* Optional, use bullet list if multiple items

==Other==

Optional