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)
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>

<div class="mw-translate-fuzzy">
<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.}}
{{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>
</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 8: 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.
While the page is under construction, add the <nowiki>{{UnfinishedDocu}}</nowiki> template at the top of the page.


For example: The feature to utilize {{incode|App::Link}} {{Version|0.19}} allows linking between sub-assemblies etc...
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:
Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics]]. Example taken from [[Part_Sweep|Part Sweep]]:
[[File:Draft_Line_example.jpg|none|400px]]
[[Image:Part_Sweep_simple.png|none]]
{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}
{{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.
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.
Line 44: Line 60:
</div>
</div>


* List the command options here. Check out two examples, [[Draft Line]] and [[PartDesign Pad]].
* Optional. List the command options here. Check out two examples, {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} and {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign_Pad|PartDesign Pad]]}}.

== 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 55: Line 79:
</div>
</div>


===Data===
=== Data ===


{{TitleProperty|Property Group}}
* {{PropertyData|PropertyName1}}: Description of the property


* {{PropertyData|Property Name 1}}: Description of the property
===View===


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


{{TitleProperty|Property Group}}
==Example==
Optional


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

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


{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]].
See also: [[:Category:API]] 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:


The ExampleCommandModel tool can be used in [[macros]] and from the [[Python]] console by using the following function:
{{Code|code=
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
Object = makeExampleCommandModel(Data1, Data2)
}}
}}

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


Ejemplo:
Ejemplo:

{{Code|code=
{{Code|code=
import FreeCAD, Base
import FreeCAD, Base
Line 83: Line 113:
}}
}}


<div class="mw-translate-fuzzy">
==Limitations==
* Optional, use bullet list if multiple items

==Otros (opcional)==
==Otros (opcional)==
!
!
</div>


Optional.
{{clear}}


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


<nowiki>
<nowiki>
<languages/>
{{UnfinishedDocu}}
{{UnfinishedDocu}}
<translate>
&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 this row if not used-->
|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}}'''


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)
While the page is under construction, add the {{UnfinishedDocu}} template at the top of the page.


Remember to use [[Template:Version]], [[Template:VersionMinus]], [[Template:VersionPlus]] and [[Template:Obsolete]] when applicable.
Insert here a short description of what the command does.


For example: The feature to utilize {{incode|App::Link}} {{Version|0.19}} allows linking between sub-assemblies etc...
</translate>
[[File:Draft_Line_example.jpg|none|400px]]
<translate>


Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics]]. Example taken from [[Part_Sweep|Part Sweep]]:
{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}
&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.
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==
== Usage ==


# There are several ways to invoke the command:
# Press the {{Button|[[File:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button. The button must be a link to this 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)
# Detailed steps as needed.
#* 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}}.
# Other commands may need to be referenced/used. Consider linking to their wiki pages along with their icons {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} or {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign_Pad|PartDesign Pad]]}}.
# Set options and press {{Button|OK}}.
# Set options and press {{Button|OK}}.


==Options==
== Options ==


* Optional. List the command options here. Check out two examples, {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} and {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign_Pad|PartDesign Pad]]}}.
* List the command options here.


==Properties==
== Example ==


Optional.
===Data===


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


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


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


==Example==
=== Data ===


{{TitleProperty|Property Group}}
Optional


* {{PropertyData|Property Name 1}}: Description of the property
==Scripting==
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics]].


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


{{TitleProperty|Property Group}}
</translate>

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

== Scripting ==

See also: [[:Category:API]] 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=
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
Object = makeExampleCommandModel(Data1, Data2)
}}
}}
<translate>
&lt;translate&gt;


* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.
* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.
Line 160: Line 217:
Example:
Example:


</translate>
&lt;/translate&gt;
{{Code|code=
{{Code|code=
import FreeCAD, Base
import FreeCAD, Base
Line 166: Line 223:
Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
}}
<translate>
&lt;translate&gt;


==Limitations==
== Other ==


Optional.
* Optional, use bullet list if multiple items


==Other==


{{Docnav
Optional
|[[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>
&lt;/translate&gt;
{{Workbench Tools navi{{#translation:}}}} <!--use the Tools navi belonging to the workbench -->
{{Userdocnavi{{#translation:}}}}</nowiki>


</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 -->
{{Userdocnavi{{#translation:}}}}
[[Category:Wiki:Example]]
[[Category:Wiki:Example]]

Revision as of 09:52, 15 September 2021

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

Add an image if possible, and please follow the guidelines in WikiPages#Graphics. 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

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)

Data

Property Group

  • DatosProperty Name 1: Description of the property

View

Property Group

  • VistaProperty Name 2: Description of the property

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)

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 feature to utilize {{incode|App::Link}} {{Version|0.19}} allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics]]. 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}}.
# Other commands may need to be referenced/used. Consider linking to their wiki pages along with their icons {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} or {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign_Pad|PartDesign Pad]]}}.
# Set options and press {{Button|OK}}.

== Options ==

* Optional. List the command options here. Check out two examples, {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} and {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign_Pad|PartDesign Pad]]}}.

== Example ==

Optional.

== Notes ==

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

== Properties ==

=== Data ===

{{TitleProperty|Property Group}}

* {{PropertyData|Property Name 1}}: Description of the property

=== View ===

{{TitleProperty|Property Group}}

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

== Scripting ==

See also: [[:Category:API]] 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