GuiCommand model/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(42 intermediate revisions by 2 users not shown)
Line 15: Line 15:
|Name=Base ExampleCommandModel
|Name=Base ExampleCommandModel
|Name/fr=Modèle GuiCommand
|Name/fr=Modèle GuiCommand
|Icon=<!--nom de fichier de l'icône avec l'extension (par exemple, svg, png) s'il ne s'agit pas du même nom que la commande effacez cette ligne si elle n'est pas utilisée-->
|Icon=<!--nom de fichier de l'icône avec l'extension (par exemple, svg, png) s'il ne s'agit pas du même nom que la commande-->
|MenuLocation=Menu → Submenu → Texte de menu pour la commande
|MenuLocation=Menu → Sousmenu → Texte de menu pour la commande
|Workbenches=[[Workbench_Name/fr|Nom de l'atelier]]
|Workbenches=[[Workbench_Name/fr|Nom de l'atelier]]
|Shortcut={{KEY|F}} {{KEY|C}} <!--effacez cette ligne si elle n'est pas utilisée-->
|Shortcut={{KEY|F}} {{KEY|C}}
|SeeAlso=<!--ajouter des liens vers des commandes similaires, effacez cette ligne si elle n'est pas utilisée-->
|Version=0.19
|Version=0.19
|SeeAlso=<!--ajouter des liens vers des commandes similaires et les pages en relation-->
}}
}}


== Description ==
== Description ==


tant que la page est en construction, ajouter le template [[Template:UnfinishedDocu]] en haut de la page le modèle en mettant le code '''<nowiki>{{UnfinishedDocu}}</nowiki>'''.
Tant que la page est en construction, ajoutez le modèle [[Template:UnfinishedDocu]] en haut de la page en tapant simplement : '''<nowiki>{{UnfinishedDocu}}</nowiki>'''.


Dans ce premier paragraphe, donnez une brève description de ce que fait la commande. La description peut faire référence à d'autres ateliers tels que [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench/fr|Atelier Sketcher ]]. (''Note de l'éditeur:'' L'image fait 24px, pas 16px)
Dans ce premier paragraphe, donnez une brève description de ce que fait la commande. La description peut faire référence à d'autres ateliers tels que l'[[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench/fr|Atelier Sketcher]]. (''Note de l'éditeur:'' L'image fait 24px, pas 16px)


N'oubliez pas d'utiliser [[Template:Version/fr]], [[Template:VersionMinus/fr]], [[Template:VersionPlus/fr]] et [[Template:Obsolete/fr]] le cas échéant.
N'oubliez pas d'utiliser [[Template:Version]], [[Template:VersionMinus]], [[Template:VersionPlus]] et [[Template:Obsolete]] le cas échéant.


Par exemple: La fonctionnalité pour utiliser {{incode|App::Link}} {{Version/fr|0.19}} permet la liaison entre les sous-ensembles, etc....
Par exemple : La fonction {{incode|App::Link}} ({{Version/fr|0.19}}) permet de créer des liens entre les sous-ensembles, etc...


Ajoutez une image si possible et suivez les instructions dans [[WikiPages#Graphics]] (page en Anglais). Exemple tiré de [[Part_Sweep/fr|Part Balayage]] :
Ajoutez une image si possible et suivez les instructions de [[WikiPages/fr#Illustrations|Ecrire une page Wiki]]. Exemple tiré de [[Part_Sweep/fr|Part Balayage]] :
[[Image:Part_Sweep_simple.png|none]]
[[Image:Part_Sweep_simple.png|none]]
{{Caption|Facultatif : ajoutez une légende sous l'image pour expliquer le fonctionnement de l'outil.}}
{{Caption|Facultatif : ajoutez une légende sous l'image pour expliquer le fonctionnement de l'outil.}}
Line 44: Line 44:
#* Appuyez sur le bouton {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand_model/fr|Base ExampleCommandModel]]}}. (''Note de l'éditeur:'' Ceci utilise le modèle [[Template:Button]], il est nécessaire de créer un lien vers la commande comme indiqué dans cet exemple)
#* Appuyez sur le bouton {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand_model/fr|Base ExampleCommandModel]]}}. (''Note de l'éditeur:'' Ceci utilise le modèle [[Template:Button]], il est nécessaire de créer un lien vers la commande comme indiqué dans cet exemple)
#* Sélectionnez l'option {{MenuCommand|Menu → Sous-menu → [[Image:Std_Open.svg|16px]] Texte du menu de la commande}} dans le menu. (''Note de l'éditeur:'' Ceci utilise le modèle [[Template: MenuCommand]])
#* Sélectionnez l'option {{MenuCommand|Menu → Sous-menu → [[Image:Std_Open.svg|16px]] Texte du menu de la commande}} dans le menu. (''Note de l'éditeur:'' Ceci utilise le modèle [[Template: MenuCommand]])
#* Sélectionnez l'option {{MenuCommand|Submenu → [[Image:Std_Open.svg|16px]] Texte du menu de la commande}} dans le menu contextuel [[Tree_view|Tree view]] ou [[3D_view|3D view]] menu contextuel. (''Note de l'éditeur:'' Ceci utilise également le modèle [[Template:MenuCommand]], toutes les commandes ne sont pas accessibles à partir d'un menu contextuel)
#* Sélectionnez l'option {{MenuCommand|Submenu → [[Image:Std_Open.svg|16px]] Texte du menu de la commande}} dans le menu contextuel [[Tree_view/fr|Vue en arborescence]] ou [[3D_view/fr|Vue 3D]]. (''Note de l'éditeur:'' Ceci utilise également le modèle [[Template:MenuCommand]], toutes les commandes ne sont pas accessibles à partir d'un menu contextuel)
#* Utilisez le raccourci clavier {{KEY|F}} puis {{KEY|C}} ou {{KEY|Ctrl}} + {{KEY|Z}}. (''Note de l'éditeur:'' Ceci utilise le modèle [[Template:KEY]], toutes les commandes n'ont pas de raccourci clavier)
#* Utilisez le raccourci clavier {{KEY|F}} puis {{KEY|C}} ou {{KEY|Ctrl}} + {{KEY|Z}}. (''Note de l'éditeur:'' Ceci utilise le modèle [[Template:KEY]], toutes les commandes n'ont pas de raccourci clavier)
# Étapes détaillées au besoin. Certaines étapes peuvent nécessiter {{KEY|Keyboard}} pressions tandis que d'autres peuvent nécessiter l'utilisation de la souris pour cliquer sur un {{Button|Button}}.
# Étapes détaillées au besoin. Certaines étapes peuvent nécessiter {{KEY|Keyboard}} pressions tandis que d'autres peuvent nécessiter l'utilisation de la souris pour cliquer sur un {{Button|Button}}.
# D'autres commandes peuvent devoir être référencées / utilisées. Pensez à créer un lien vers leurs pages wiki avec leurs icônes {{Button|[[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]]}} ou {{Button|[[Image:PartDesign_Pad.svg|16px] ] [[PartDesign_Pad/fr|PartDesign Protusion]]}}.
# Définissez les options et appuyez sur {{Button|OK}}.
# Définissez les options et appuyez sur {{Button|OK}}.


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


* Optionnel. Énumérez les options de commande ici. Voir par exemple [[Draft_Wire/fr|Draft Polyligne]].
<div class="mw-translate-fuzzy">
* Énumérez les options de commande ici. Découvrez deux exemples, {{Button|[[Image:Draft_Line.svg|16px]] [[Draft Line/fr|Draft Ligne]]}} et {{Button|[[Image:PartDesign_Pad.svg|16px]] [[PartDesign Pad/fr|PartDesign Protrusion]]}}.
</div>


== Exemple ==
<div class="mw-translate-fuzzy">
==Exemple==
Optionnel
</div>


Optionnel.
Optional.


== Remarques ==
<div class="mw-translate-fuzzy">
==Limitations==
* Facultativement, utilisez une liste à puces si plusieurs éléments
</div>


* Optional. Use a bullet list if there are multiple items. You can also mention limitations here.
* Optionnel. Utilisez une liste à puces s'il y a plusieurs éléments. Vous pouvez également mentionner les limitations ici.

== Propriétés ==

Voir aussi : [[Property_editor/fr|Éditeur de propriétés]]


Un objet est généralement dérivé d'un objet de base. Vous ne devez pas énumérer les propriétés qui sont héritées de cet objet de base. Voir par exemple [[Draft_Wire/fr#Propri.C3.A9t.C3.A9s|Draft Polyligne]].
<div class="mw-translate-fuzzy">
==Propriétés==
</div>


<div class="mw-translate-fuzzy">
=== Données ===
=== Données ===
</div>


{{TitleProperty|Property Group}}
{{TitleProperty|Property Group}}


* {{PropertyData|Nom de la propriété 1|PropertyType}} : Description de la propriété. (''Note de l'éditeur:'' pour trouver {{Value|PropertyType}}, sélectionnez {{MenuCommand|Show all}} dans le menu contextuel de l'[[Property_editor/fr|Éditeur de propriétés]]. L'infobulle de chaque propriété comprendra alors cette information. Mais {{Value|PropertyType}} peut également être trouvé dans le code source).
<div class="mw-translate-fuzzy">
* {{PropertyData/fr|PropertyName1}} : Description de la propriété
</div>


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


{{TitleProperty|Property Group}}
{{TitleProperty|Property Group}}


* {{PropertyView|Property Name 2|PropertyType}} : Description de la propriété
<div class="mw-translate-fuzzy">
* {{PropertyView/fr|PropertyName2}} : Description de la propriété
</div>


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


Voir aussi: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] et [[FreeCAD_Scripting_Basics/fr|Débuter avec les scripts FreeCAD]].
<div class="mw-translate-fuzzy">
{{Emphasis|Voir aussi :}} [[:Category:API/fr]] et [[FreeCAD Scripting Basics/fr|Débuter avec les scripts]].
</div>


L'outil ExampleCommandModel peut être utilisé dans une [[Macros/fr|macro]] et depuis la console [[Python/fr|Python]] en utilisant la fonction suivante :
<div class="mw-translate-fuzzy">
L'outil ExampleCommandModel peut être utilisé dans une [[macros/fr|macro]] et depuis la console [[Python/fr|Python]] en utilisant la fonction suivante :
</div>


{{Code|code=
{{Code|code=
Line 122: Line 99:
}}
}}


== Autre ==
<div class="mw-translate-fuzzy">
==Autre==
Optionnel
</div>


Optionnel.
Optional.


== Bloc sélectionnable ==
<div class="mw-translate-fuzzy">
==Bloc sélectionnable==
</div>


<nowiki>
<nowiki>
Line 149: Line 121:
{{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 → Menu text for the 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}}
|SeeAlso= <!--add links to similar commands; delete this row if not used-->
|Version=0.19
|Version=0.19
|SeeAlso= <!--add links to similar commands and related pages-->
}}
}}


Line 165: Line 137:
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...


Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics]]. Example taken from [[Part_Sweep|Part Sweep]]:
Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics|WikiPages]]. Example taken from [[Part_Sweep|Part Sweep]]:
&lt;/translate&gt;
&lt;/translate&gt;
[[Image:Part_Sweep_simple.png|none]]
[[Image:Part_Sweep_simple.png|none]]
Line 177: Line 149:
== Usage ==
== Usage ==


# There are several ways to invoke the command:
# 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)
#* 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|Menu → Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the menu. (''Editor note:'' This uses the [[Template:MenuCommand]] template)
Line 183: Line 155:
#* 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)
#* 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}}.
# 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]]}}.
* Optional. List the command options here. See for example [[Draft_Wire|Draft Wire]].


== Example ==
== Example ==
Line 199: Line 170:


== Properties ==
== 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 ===
=== Data ===
Line 204: Line 179:
{{TitleProperty|Property Group}}
{{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.)
* {{PropertyData|Property Name 1}}: Description of the property


=== View ===
=== View ===
Line 210: Line 185:
{{TitleProperty|Property Group}}
{{TitleProperty|Property Group}}


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


== Scripting ==
== Scripting ==


See also: [[:Category:API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
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:
The ExampleCommandModel tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following function:
Line 251: Line 226:


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




{{Docnav
{{Docnav/fr
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_PreviousCommand/fr|Commande avant]]
|[[Base_NextCommand|NextCommand]]
|[[Base_NextCommand/fr|Commande après]]
|[[Workbench_Name|Workbench]]
|[[Workbench_Name/fr|Atelier]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
Line 264: Line 239:
}}
}}


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

Latest revision as of 21:58, 22 February 2022

Cette page montre un modèle de page Gui Command. Sous la section Bloc sélectionnable ci-dessous, vous trouverez le même contenu que vous pouvez facilement sélectionner pour le coller dans une nouvelle page.

Modèle GuiCommand

Emplacement du menu
Menu → Sousmenu → Texte de menu pour la commande
Ateliers
Nom de l'atelier
Raccourci par défaut
F C
Introduit dans la version
0.19
Voir aussi
Aucun

Description

Tant que la page est en construction, ajoutez le modèle Template:UnfinishedDocu en haut de la page en tapant simplement : {{UnfinishedDocu}}.

Dans ce premier paragraphe, donnez une brève description de ce que fait la commande. La description peut faire référence à d'autres ateliers tels que l' Atelier Sketcher. (Note de l'éditeur: L'image fait 24px, pas 16px)

N'oubliez pas d'utiliser Template:Version, Template:VersionMinus, Template:VersionPlus et Template:Obsolete le cas échéant.

Par exemple : La fonction App::Link (introduit dans la version 0.19) permet de créer des liens entre les sous-ensembles, etc...

Ajoutez une image si possible et suivez les instructions de Ecrire une page Wiki. Exemple tiré de Part Balayage :

Facultatif : ajoutez une légende sous l'image pour expliquer le fonctionnement de l'outil.

La fermeture et l’ouverture des balises de traduction doivent entourer les images et d’autres éléments fixes, s’ils ne nécessitent pas de traduction. La légende doit toujours être traduite.

Utilisation

  1. Il existe plusieurs façons de lancer la commande:
    • Appuyez sur le bouton Base ExampleCommandModel. (Note de l'éditeur: Ceci utilise le modèle Template:Button, il est nécessaire de créer un lien vers la commande comme indiqué dans cet exemple)
    • Sélectionnez l'option Menu → Sous-menu → Texte du menu de la commande dans le menu. (Note de l'éditeur: Ceci utilise le modèle Template: MenuCommand)
    • Sélectionnez l'option Submenu → Texte du menu de la commande dans le menu contextuel Vue en arborescence ou Vue 3D. (Note de l'éditeur: Ceci utilise également le modèle Template:MenuCommand, toutes les commandes ne sont pas accessibles à partir d'un menu contextuel)
    • Utilisez le raccourci clavier F puis C ou Ctrl + Z. (Note de l'éditeur: Ceci utilise le modèle Template:KEY, toutes les commandes n'ont pas de raccourci clavier)
  2. Étapes détaillées au besoin. Certaines étapes peuvent nécessiter Keyboard pressions tandis que d'autres peuvent nécessiter l'utilisation de la souris pour cliquer sur un Button.
  3. Définissez les options et appuyez sur OK.

Options

  • Optionnel. Énumérez les options de commande ici. Voir par exemple Draft Polyligne.

Exemple

Optionnel.

Remarques

  • Optionnel. Utilisez une liste à puces s'il y a plusieurs éléments. Vous pouvez également mentionner les limitations ici.

Propriétés

Voir aussi : Éditeur de propriétés

Un objet est généralement dérivé d'un objet de base. Vous ne devez pas énumérer les propriétés qui sont héritées de cet objet de base. Voir par exemple Draft Polyligne.

Données

Property Group

  • DonnéesNom de la propriété 1 (PropertyType) : Description de la propriété. (Note de l'éditeur: pour trouver PropertyType, sélectionnez Show all dans le menu contextuel de l'Éditeur de propriétés. L'infobulle de chaque propriété comprendra alors cette information. Mais PropertyType peut également être trouvé dans le code source).

Vue

Property Group

  • VueProperty Name 2 (PropertyType) : Description de la propriété

Script

Voir aussi: Autogenerated API documentation et Débuter avec les scripts FreeCAD.

L'outil ExampleCommandModel peut être utilisé dans une macro et depuis la console Python en utilisant la fonction suivante :

Object = makeExampleCommandModel(Data1, Data2)
  • Créer un Object utilisant Data1 et Data2.

Exemple :

import FreeCAD, Base

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

Autre

Optionnel.

Bloc sélectionnable

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