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)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Message|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.}}
<div class="mw-translate-fuzzy">
{{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.}}
</div>

{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 6: Line 18:
</div>
</div>


<div class="mw-translate-fuzzy">
==Descripción==
==Descripción==
</div>

While the page is under construction, add the [[Template:UnfinishedDocu]] template at the top of the page by simply typing: '''<nowiki>{{UnfinishedDocu}}</nowiki>'''

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|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 {{incode|App::Link}} feature ({{Version|0.19}}) allows linking between sub-assemblies etc...


Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics|WikiPages]]. Example taken from [[Part_Sweep|Part Sweep]]:
Insert here a short description of what the command does.
[[Image:Part_Sweep_simple.png|none]]
{{Caption|Optional: add a caption below the image to explain what the tool does}}


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.
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]]
''Optional: add a caption in italics below the image.''


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 25: Line 47:
</div>
</div>


<div class="mw-translate-fuzzy">
# Cómo se utiliza
# Cómo se utiliza
# Cómo se utiliza
# Cómo se utiliza
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 36: Line 60:
</div>
</div>


* List the command options here. Check out two examples, [[Draft Line]] and [[PartDesign Pad]].
* Optional. List the command options here. See for example [[Draft_Wire|Draft Wire]].

== Example ==

Optional.

== Notes ==

* Optional. Use a bullet list if there are multiple items. You can also mention limitations here.


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 47: Line 79:
</div>
</div>


See also: [[Property_editor|Property editor]].
===Data===


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#Properties|Draft Wire]].
* {{PropertyData|PropertyName1}}: Description of the property


===View===
=== Data ===


{{TitleProperty|Property Group}}
* {{PropertyView|PropertyName2}}: Description of the property


* {{PropertyData|Property Name 1|PropertyType}}: Description of the property. (''Editor note:'' to find the {{Value|PropertyType}} select {{MenuCommand|Show all}} in the context menu of the [[Property_editor|Property editor]]. The tooltip of each property will then include this information. But the {{Value|PropertyType}} can also be found in the source code.)
==Example==
Optional


=== View ===

{{TitleProperty|Property Group}}

* {{PropertyView|Property Name 2|PropertyType}}: Description of the property.

<div class="mw-translate-fuzzy">
==Archivos de guión==
==Archivos de guión==
</div>

See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

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

{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
}}


* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.
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:
Ejemplo:
import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)


{{Code|code=
==Limitations==
import FreeCAD, Base
* Optional, use bullet list if multiple items


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

<div class="mw-translate-fuzzy">
==Otros (opcional)==
==Otros (opcional)==
!
!
</div>


Optional.
{{clear}}


==Selectable block==
== Selectable block ==


<nowiki>
<nowiki>
<languages/>
{{UnfinishedDocu}}
&lt;translate&gt;

{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}

{{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-->
|MenuLocation=Menu → Submenu → Command
|MenuLocation=Menu → Submenu → Menu text for the command
|Workbenches=[[Workbench Name|Workbench]]
|Workbenches=[[Workbench_Name|Workbench]]
|Shortcut=<!--delete this row if not used-->
|Shortcut={{KEY|F}} {{KEY|C}}
|Version=0.19
|SeeAlso=<!--add links to similar commands, delete this row if not used-->
|SeeAlso= <!--add links to similar commands and related pages-->
|Version=0.17
}}
}}


==Description==
== Description ==


While the page is under construction, add the [[Template:UnfinishedDocu]] template at the top of the page by simply typing: '''{{UnfinishedDocu}}'''
Insert here a short description of what the command does.


In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|Sketcher Workbench]]. (''Editor note:'' The image is 24px, not 16px)
</translate>
[[File:Draft_Line_example.jpg|none|400px]]
<translate>
''Optional: add a caption in italics.''


Remember to use [[Template:Version]], [[Template:VersionMinus]], [[Template:VersionPlus]] and [[Template:Obsolete]] when applicable.
==How to use==


For example: The {{incode|App::Link}} feature ({{Version|0.19}}) allows linking between sub-assemblies etc...
# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# Detailed steps as needed.
# Set options and press {{KEY|OK}}.


Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics|WikiPages]]. Example taken from [[Part_Sweep|Part Sweep]]:
==Options==
&lt;/translate&gt;
[[Image:Part_Sweep_simple.png|none]]
&lt;translate&gt;
{{Caption|Optional: add a caption below the image to explain what the tool does}}


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.
* List the command options here.


==Properties==
== Usage ==


# There are several ways to invoke the command:
===Data===
#* Press the {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand_model|Base ExampleCommandModel]]}} button. (''Editor note:'' This uses the [[Template:Button]] template, it is necessary to link to the command as shown in this example)
#* Select the {{MenuCommand|Menu → Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the menu. (''Editor note:'' This uses the [[Template:MenuCommand]] template)
#* Select the {{MenuCommand|Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the [[Tree_view|Tree view]] context menu or [[3D_view|3D view]] context menu. (''Editor note:'' This also uses the [[Template:MenuCommand]] template, not all commands can be accessed from a context menu)
#* Use the keyboard shortcut {{KEY|F}} then {{KEY|C}} or {{KEY|Ctrl}}+{{KEY|Z}}. (''Editor note:'' This uses the [[Template:KEY]] template, not all commands have a keyboard shortcut)
# Detailed steps as needed. Some steps may need {{KEY|Keyboard}} presses while others may require using the mouse to click on a {{Button|Button}}.
# Set options and press {{Button|OK}}.


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


* Optional. List the command options here. See for example [[Draft_Wire|Draft Wire]].
===View===


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


Optional.
==Example==


== Notes ==
Optional


* Optional. Use a bullet list if there are multiple items. You can also mention limitations here.
==Scripting==


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

</translate>
See also: [[Property_editor|Property editor]].
'''makeExampleCommandModel(Data, Data)'''

<translate>
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#Properties|Draft Wire]].
* Creates a CommandModel using Data.

* Returns the newly created object.
=== Data ===

{{TitleProperty|Property Group}}

* {{PropertyData|Property Name 1|PropertyType}}: Description of the property. (''Editor note:'' to find the {{Value|PropertyType}} select {{MenuCommand|Show all}} in the context menu of the [[Property_editor|Property editor]]. The tooltip of each property will then include this information. But the {{Value|PropertyType}} can also be found in the source code.)

=== View ===

{{TitleProperty|Property Group}}

* {{PropertyView|Property Name 2|PropertyType}}: Description of the property.

== Scripting ==

See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

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

&lt;/translate&gt;
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
}}
&lt;translate&gt;

* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.


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


&lt;/translate&gt;
==Limitations==
{{Code|code=
import FreeCAD, Base


Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
* Optional, use bullet list if multiple items
}}
&lt;translate&gt;


==Other==
== Other ==

Optional.


{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}

&lt;/translate&gt;
{{Workbench_Tools_navi{{#translation:}}}} <!--use the Tools navi belonging to the workbench -->
{{Userdocnavi{{#translation:}}}}</nowiki>


{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}


{{Workbench_Tools_navi{{#translation:}}}} <!--use the Tools navi belonging to the workbench -->
Optional
{{Userdocnavi{{#translation:}}}}
</nowiki>
[[Category:Wiki:Example]]

Latest revision as of 12:12, 22 February 2022

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 Template:UnfinishedDocu template at the top of the page by simply typing: {{UnfinishedDocu}}

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 App::Link feature (introduced in version 0.19) allows linking between sub-assemblies etc...

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

Optional: add a caption below the image to explain what the tool does

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
  • Optional. List the command options here. See for example Draft Wire.

Example

Optional.

Notes

  • Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

Propiedades

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

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

Property Group

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

View

Property Group

  • VistaProperty Name 2 (PropertyType): Description of the property.

Archivos de guión

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:

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

Ejemplo:

import FreeCAD, Base

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

Otros (opcional)

!

Optional.

Selectable block

<languages/>
{{UnfinishedDocu}}
<translate>

{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}

{{GuiCommand
|Name=Base ExampleCommandModel
|Icon= <!--filename of icon with extension (e.g. svg, png) if not the same name as command-->
|MenuLocation=Menu → Submenu → Menu text for the command
|Workbenches=[[Workbench_Name|Workbench]]
|Shortcut={{KEY|F}} {{KEY|C}}
|Version=0.19
|SeeAlso= <!--add links to similar commands and related pages-->
}}

== Description ==

While the page is under construction, add the [[Template:UnfinishedDocu]] template at the top of the page by simply typing: '''{{UnfinishedDocu}}'''

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|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 {{incode|App::Link}} feature ({{Version|0.19}}) allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics|WikiPages]]. Example taken from [[Part_Sweep|Part Sweep]]:
</translate>
[[Image:Part_Sweep_simple.png|none]]
<translate>
{{Caption|Optional: add a caption below the image to explain what the tool does}}

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

# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand_model|Base ExampleCommandModel]]}} button. (''Editor note:'' This uses the [[Template:Button]] template, it is necessary to link to the command as shown in this example)
#* Select the {{MenuCommand|Menu → Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the menu. (''Editor note:'' This uses the [[Template:MenuCommand]] template)
#* Select the {{MenuCommand|Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the [[Tree_view|Tree view]] context menu or [[3D_view|3D view]] context menu. (''Editor note:'' This also uses the [[Template:MenuCommand]] template, not all commands can be accessed from a context menu)
#* Use the keyboard shortcut {{KEY|F}} then {{KEY|C}} or {{KEY|Ctrl}}+{{KEY|Z}}. (''Editor note:'' This uses the [[Template:KEY]] template, not all commands have a keyboard shortcut)
# Detailed steps as needed. Some steps may need {{KEY|Keyboard}} presses while others may require using the mouse to click on a {{Button|Button}}.
# Set options and press {{Button|OK}}.

== Options ==

* Optional. List the command options here. See for example [[Draft_Wire|Draft Wire]].

== Example ==

Optional.

== Notes ==

* Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

== Properties ==

See also: [[Property_editor|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#Properties|Draft Wire]].

=== Data ===

{{TitleProperty|Property Group}}

* {{PropertyData|Property Name 1|PropertyType}}: Description of the property. (''Editor note:'' to find the {{Value|PropertyType}} select {{MenuCommand|Show all}} in the context menu of the [[Property_editor|Property editor]]. The tooltip of each property will then include this information. But the {{Value|PropertyType}} can also be found in the source code.)

=== View ===

{{TitleProperty|Property Group}}

* {{PropertyView|Property Name 2|PropertyType}}: Description of the property.

== Scripting ==

See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

The ExampleCommandModel tool can be used in [[Macros|macros]] and from the [[Python|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>

== Other ==

Optional.


{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}

</translate>
{{Workbench_Tools_navi{{#translation:}}}} <!--use the Tools navi belonging to the workbench -->
{{Userdocnavi{{#translation:}}}}


Template:Workbench Tools navi/es