GuiCommand model/it: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
No edit summary
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
{{VeryImportantMessage|Questa pagina mostra un modello di una pagina per documentare un [[Gui Command/it|Comando GUI]]. Sotto il [[#Selectable block|Selectable block]] nella sezione sottostante si trova lo stesso contenuto facilmente selezionabile per incollarlo in una nuova pagina.}}
{{VeryImportantMessage|Questa pagina mostra un modello di una pagina per documentare un [[Gui Command/it|Comando GUI]]. Sotto il [[#Selectable block|Selectable block]] nella sezione sottostante si trova lo stesso contenuto facilmente selezionabile per incollarlo in una nuova pagina.}}
</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 17: Line 27:
</div>
</div>


<div class="mw-translate-fuzzy">
==Descrizione==
==Descrizione==
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 23: Line 35:
</div>
</div>


<div class="mw-translate-fuzzy">
Inserire qui una breve descrizione di cosa fa il comando.
Inserire qui una breve descrizione di cosa fa il comando.
</div>


Remember to use [[Template:Version]], [[Template:VersionMinus]], [[Template:VersionPlus]] and [[Template:Obsolete]] when applicable.
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...
For example: The {{incode|App::Link}} feature ({{Version|0.19}}) allows linking between sub-assemblies etc...


<div class="mw-translate-fuzzy">
Aggiungere un'immagine se possibile, e per favore seguire le linee guida di [[WikiPages#Graphics]]. Esempio tratto da Draft Linea:
Aggiungere un'immagine se possibile, e per favore seguire le linee guida di [[WikiPages#Graphics]]. Esempio tratto da Draft Linea:
</div>
[[File:Draft_Line_example.jpg|none|400px]]
[[Image:Part_Sweep_simple.png|none]]
<div class="mw-translate-fuzzy">
{{Caption|Facoltativo: aggiungere una didascalia sotto l'immagine per spiegare cosa sta facendo lo strumento.}}
{{Caption|Facoltativo: aggiungere una didascalia sotto l'immagine per spiegare cosa sta facendo lo strumento.}}
</div>


Chiudere e riaprire i tag di traduzione prima e dopo le immagini e gli altri elementi fissi, se non c'è bisogno di tradurli. La didascalia dovrebbe sempre essere tradotta.
Chiudere e riaprire i tag di traduzione prima e dopo le immagini e gli altri elementi fissi, se non c'è bisogno di tradurli. La didascalia dovrebbe sempre essere tradotta.
Line 38: Line 56:
==Utilizzo==
==Utilizzo==
</div>
</div>

# 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}}.


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
== Opzioni ==
# Premere il pulsante {{Button|[[File:Std Close.png|16px]] [[GuiCommand model/it|Nome del comando]]}}. Il pulsante deve essere un collegamento a questo comando.
# Descrivere i passaggi necessari.
# Impostare le opzioni e premere {{Button|OK}}.
</div>
</div>

== Opzioni ==


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 51: Line 73:
</div>
</div>


<div class="mw-translate-fuzzy">
==Esempio==
Optionale
</div>

Optional.

<div class="mw-translate-fuzzy">
==Limitazioni==
* Facoltativo, utilizzare l'elenco puntato se ci sono più elementi
</div>

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

<div class="mw-translate-fuzzy">
== Proprietà ==
== Proprietà ==
</div>


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]].

<div class="mw-translate-fuzzy">
===Dati===
===Dati===
</div>


{{TitleProperty|Property Group}}

<div class="mw-translate-fuzzy">
* {{PropertyData/it|Nome della proprietà 1}}: descrizione della proprietà
* {{PropertyData/it|Nome della proprietà 1}}: descrizione della proprietà
</div>


<div class="mw-translate-fuzzy">
===Vista===
===Vista===
</div>


{{TitleProperty|Property Group}}

<div class="mw-translate-fuzzy">
* {{PropertyView/it|Nome della proprietà 2}}: descrizione della proprietà
* {{PropertyView/it|Nome della proprietà 2}}: descrizione della proprietà
</div>


<div class="mw-translate-fuzzy">
==Esempio==
Optionale

== Script ==
== Script ==
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 88: Line 141:
}}
}}


<div class="mw-translate-fuzzy">
==Limitazioni==
* Facoltativo, utilizzare l'elenco puntato se ci sono più elementi

==Ulteriori informazioni==
==Ulteriori informazioni==
Optionale
Optionale
</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={{KEY|F}} {{KEY|C}} <!--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 {{UnfinishedDocu}} template at the top of the page.
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)
Insert here a short description of what the command does.

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...
</translate>
[[Image:Draft_Line_example.jpg|none|400px]]
<translate>


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


==Usage==
== Usage ==


# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* The {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand model|Command name]]}} button from the toolbar (''Editor note:'' Using the [[Template:Button]] template, it is necessary to link to command as shown in this example)
#* 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)
#* Using the {{MenuCommand|Menu → Submenu → Command}} from the top menu. (''Editor note:'' This uses the [[Template:MenuCommand]] wiki template)
#* 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)
#* Use the keyboard shortcut {{KEY|F}} then {{KEY|C}} or {{KEY|Ctrl}} + {{KEY|Z}} (''Editor note:'' This uses the [[Template:KEY]] wiki 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)
#* (Optional) RMB (Right Mouse Button) context menu: {{MenuCommand|RMB → {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand model|Command name]]}}}}
# Detailed steps as needed. Some steps may need {{KEY|Keyboard}} presses while others may require using the mouse to click on a {{Button|Button}}
# 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 ==


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


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


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


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]].
Optional


==Scripting==
=== Data ===
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


{{TitleProperty|Property Group}}
The ExampleCommandModel tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:


* {{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.)
</translate>

=== 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=
{{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 170: Line 248:
Example:
Example:


</translate>
&lt;/translate&gt;
{{Code|code=
{{Code|code=
import FreeCAD, Base
import FreeCAD, Base
Line 176: Line 254:
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
[[Category:Wiki:Example/it]]
|[[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]]

Revision as of 20:52, 6 March 2022

Questa pagina mostra un modello di una pagina per documentare un Comando GUI. Sotto il Selectable block nella sezione sottostante si trova lo stesso contenuto facilmente selezionabile per incollarlo in una nuova pagina.

Esempio di comando

Posizione nel menu
Menu → Sottomenu → Comando
Ambiente
Ambiente
Avvio veloce
Nessuno
Introdotto nella versione
0.17
Vedere anche
Nessuno

Descrizione

Mentre la pagina è in costruzione, aggiungere la template {{UnfinishedDocu}} a inizio pagina.

Inserire qui una breve descrizione di cosa fa il comando.

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

Aggiungere un'immagine se possibile, e per favore seguire le linee guida di WikiPages#Graphics. Esempio tratto da Draft Linea:

Facoltativo: aggiungere una didascalia sotto l'immagine per spiegare cosa sta facendo lo strumento.

Chiudere e riaprire i tag di traduzione prima e dopo le immagini e gli altri elementi fissi, se non c'è bisogno di tradurli. La didascalia dovrebbe sempre essere tradotta.

Utilizzo

  1. There are several ways to invoke the command:
    • Press the 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 Menu → Submenu → Menu text for the command option from the menu. (Editor note: This uses the Template:MenuCommand template)
    • Select the Submenu → Menu text for the command option from the Tree view context menu or 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 F then C or Ctrl+Z. (Editor note: This uses the Template:KEY template, not all commands have a keyboard shortcut)
  2. Detailed steps as needed. Some steps may need Keyboard presses while others may require using the mouse to click on a Button.
  3. Set options and press OK.

Opzioni

Esempio

Optionale

Optional.

Limitazioni

  • Facoltativo, utilizzare l'elenco puntato se ci sono più elementi
  • Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

Proprietà

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.

Dati

Property Group

  • DatiNome della proprietà 1: descrizione della proprietà

Vista

Property Group

  • VistaNome della proprietà 2: descrizione della proprietà

Script

Lo strumento ExampleCommandModel può essere utilizzato nelle macro e dalla console Python tramite la seguente funzione:

Object = makeExampleCommandModel(Data1, Data2)
  • Crea un Object usando Data1 e Data2.

Esempio:

import FreeCAD, Base

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

Ulteriori informazioni

Optionale

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/it