Modèle GuiCommand

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page GuiCommand model and the translation is 33% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎română • ‎русский
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.


Arrow-left.svg Page précédente : Commande avant
Page suivante : Commande après Arrow-right.svg

Base ExampleCommandModel.png Modèle GuiCommand

Emplacement du menu
Menu → Submenu → 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

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 {{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 Workbench Sketcher.svg 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.

Par exemple: La fonctionnalité pour utiliser App::Link Introduit dans la version 0.19 permet la liaison entre les sous-ensembles, etc....

Ajoutez une image si possible et suivez les instructions dans WikiPages#Graphics (page en Anglais). Exemple tiré de Draft Line :

Part Sweep simple.png

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 d'appeler la commande:
  2. * Le bouton Std Open.svg Nom de la commande dans la barre d'outils (Note de l'éditeur: L'utilisation du modèle Template:Button, est nécessaire de lier la commande comme indiqué dans cet exemple)
  3. * Utilisation de Menu → Sous-menu → Commande dans le menu supérieur. (Note de l'éditeur: Ceci utilise le modèle wiki Template:MenuCommand)
  4. * Utilisez le raccourci clavier F puis C ou Ctrl + Z (Note de l'éditeur: Ceci utilise le Template:KEY modèle wiki)
  5. * (Facultatif) Menu contextuel RMB (bouton droit de la souris): RMB → Std Open.svg Nom de la commande
  6. Étapes détaillées selon les besoins. Certaines étapes peuvent nécessiter des pressions sur le clavier tandis que d'autres peuvent nécessiter l'utilisation de la souris pour cliquer sur un bouton
  7. 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 Draft Line.svg Draft Ligne ou PartDesign Pad.svg PartDesign Protrusion
  8. Définissez les options et appuyez sur OK.

Options

Exemple

Optionnel

Optional.

Limitations

  • Facultativement, utilisez une liste à puces si plusieurs éléments
  • Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

Propriétés

Données

Property Group

  • DonnéesPropertyName1 : Description de la propriété

Vue

Property Group

  • VuePropertyName2 : Description de la propriété

Script

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

Optional.

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

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