GuiCommand model/es: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 95: Line 95:
<nowiki>
<nowiki>
{{UnfinishedDocu}}
{{UnfinishedDocu}}
<translate>

{{GuiCommand
{{GuiCommand
|Name=Base ExampleCommandModel
|Name=Base ExampleCommandModel

Revision as of 17:48, 6 February 2019

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

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.

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

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.

Ejemplo:

import FreeCAD, Base

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

Limitations

  • Optional, use bullet list if multiple items

Otros (opcional)

!

Selectable block

{{UnfinishedDocu}}
<translate>

{{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