Gui Command/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
(7 intermediate revisions by 2 users not shown)
Line 22: Line 22:


Chaque GuiCommand doit avoir une page d'aide. La page d'aide est hébergée sur le wiki de documentation FreeCAD.
Chaque GuiCommand doit avoir une page d'aide. La page d'aide est hébergée sur le wiki de documentation FreeCAD.
L'article porte le même nom que la GuiCommand, par exemple [[Draft ShapeString|Draft ShapeString]].
L'article porte le même nom que la GuiCommand, par exemple [[Draft ShapeString/fr|Draft ShapeString]].


Pour créer vos propres pages d'aide vous pouvez utiliser le modèle de base : [[GuiCommand model/fr|GuiCommand]]
Pour créer vos propres pages d'aide vous pouvez utiliser le [[GuiCommand model/fr|modèle GuiCommand]]


Exemples :
Exemples :
Line 33: Line 33:
[[Image:Tango-Palette.png|400px|right]]
[[Image:Tango-Palette.png|400px|right]]


Chaque GuiCommand doit avoir une icône. Nous utilisons le jeu d'[http://commons.wikimedia.org/wiki/Tango_icons icônes] [http://tango.freedesktop.org/Tango_Desktop_Project Tango], et sa philosophie (guidelines).
Chaque GuiCommand doit avoir une icône. Nous utilisons le [http://tango.freedesktop.org/Tango_Desktop_Project jeu d'icônes Tango], et ses recommandations.
Sur le côté droit, vous voyez la palette de couleurs tango.
Sur le côté droit, vous voyez la palette de couleurs tango.


Il est conseillé de faire toutes les icônes en format [[SVG/fr|SVG]], par exemple avec [http://inkscape.org/?lang=fr&css=css/base.css Inkscape]. Cela rend plus facile l’application des changements et d'en tirer des icônes supplémentaires dans l'espace même de l'application.
Il est conseillé de faire toutes les icônes en format [[SVG/fr|SVG]], par exemple avec [http://inkscape.org/?lang=fr&css=css/base.css Inkscape]. Cela rend plus facile l’application des changements et des icônes dérivés dans l'espace de la même application.


===Code des couleurs des icônes===
===Code des couleurs des icônes===
Line 44: Line 44:
Nous essayons autant que possible de respecter ce tableau, de sorte que la couleur des icônes soit dans la même ligne.
Nous essayons autant que possible de respecter ce tableau, de sorte que la couleur des icônes soit dans la même ligne.


=== Exigences de qualité ===
== Exigences de qualité ==
{{VeryImportantMessage|L'[[Complete Workbench/fr|atelier Complete]] est obsolète, il ne contient plus chacune des commandes de FreeCAD.}}
{{VeryImportantMessage|L'[[Complete Workbench/fr|atelier Complete]] est obsolète, il ne contient plus chacune des commandes de FreeCAD.}}


<s>Il y a beaucoup de fonctions GuiCommands dans FreeCAD, certaines sont expérimentales ou utilisées à des fins provisoires ou en prévision. Ces GuiCommands sont pour la plupart dans les ateliers dédiés comme [[Part_Module/fr|Part]], [[Mesh_Module/fr|Mesh]] ou [[Path_Workbench/fr|Path]].
<s>Il y a beaucoup de fonctions GuiCommands (outils) dans FreeCAD, qui sont expérimentales ou utilisées à des fins de test ou pour des nouveautés. Ces GuiCommands sont pour la plupart dans les ateliers dédiés comme [[Part_Module/fr|Part]], [[Mesh_Module/fr|Mesh]] ou Cam.
Pour assurer à l'utilisateur une utilisation facile, le '''workbench''' complet a été créé. C'est l'atelier de démarrage par défaut de FreeCAD, et, intègre toutes les GuiCommands qui satisfont aux exigences de qualité qui sont décrites ici :
Pour assurer à l'utilisateur une utilisation facile, l'atelier ''Complete'' a été créé. Cet atelier intègre toutes les commandes Gui qui répondent à certaines exigences de qualité décrites ci-après :


* La commande/fonction doit être terminé. Pas un travail en cours !
* La commande ou la fonctionnalité doit être "terminée", c'est-à-dire ne pas être un travail en cours.
* Il doit définir une icône et une position de menu appropriées.
* Doit avoir une page d'aide comme [[Draft ShapeString/fr|celle-ci]]
* Il doit avoir une page d’aide, comme [[Draft ShapeString/fr|Draft ShapeString]].
** Tous les champs de modèle : [[GuiCommand_model/fr|GuiCommand]] doivent remplir,
** Tous les champs du [[Template:GuiCommand/fr|Template:GuiCommand]] doivent être remplis
** Une image des boîtes de dialogue de la commande finalement,
** Donnent une description détaillée de la commande et de tous ses paramètres et réglages
** Il devrait avoir une description détaillée de la commande et de tous ses paramètres et personnalisations.
** Il devrait avoir une image des dialogues que la commande va produire.
** Description des interfaces connexes [[Python/fr|Python]] et des classes avec un exemple de code.
** Il devrait y avoir une description des interfaces et des classes [[Python/fr|Python]] associées avec un exemple de code.


Espérons que cela devienne vrai pour toutes les GuiCommands de la [[List_of_Commands/fr|liste des commandes]].</s>
Espérons que cela devienne vrai pour toutes les GuiCommands de la [[List_of_Commands/fr|liste des commandes]].</s>

Revision as of 08:51, 7 October 2019

Une GuiCommand, est l'une des fonctions les plus importantes du point de vue interaction entre l'utilisateur et FreeCAD. Chaque fois que l'utilisateur sélectionne un élément du menu, ou appuie sur un bouton de la barre d'outils, il active une GuiCommand. Voici quelques-uns des attributs d'une GuiCommand :

  • Définir un nom
  • Contenir une icône
  • Définir l'action annuler/rétablir
  • Aller à une page d'aide
  • Ouvrir et contrôler des boîtes de dialogues
  • Enregistrement de macros
  • et ainsi de suite ...

Nommage

La GuiCommand est appelée selon un certain standard : ModuleName_CommandName, par exemple Base Open est la Gui Command Open dans le système Base. Dans certains modules, la GuiCommand a pour préfixe le nom du module, comme par exemple Part Cylinder.

Si le document n'est pas fini, utilisez le bandeau Template:UnfinishedDocu

Pages d'aide

Chaque GuiCommand doit avoir une page d'aide. La page d'aide est hébergée sur le wiki de documentation FreeCAD. L'article porte le même nom que la GuiCommand, par exemple Draft ShapeString.

Pour créer vos propres pages d'aide vous pouvez utiliser le modèle GuiCommand

Exemples :

Icônes

Chaque GuiCommand doit avoir une icône. Nous utilisons le jeu d'icônes Tango, et ses recommandations. Sur le côté droit, vous voyez la palette de couleurs tango.

Il est conseillé de faire toutes les icônes en format SVG, par exemple avec Inkscape. Cela rend plus facile l’application des changements et des icônes dérivés dans l'espace de la même application.

Code des couleurs des icônes

Nous essayons autant que possible de respecter ce tableau, de sorte que la couleur des icônes soit dans la même ligne.

Exigences de qualité

L'atelier Complete est obsolète, il ne contient plus chacune des commandes de FreeCAD.

Il y a beaucoup de fonctions GuiCommands (outils) dans FreeCAD, qui sont expérimentales ou utilisées à des fins de test ou pour des nouveautés. Ces GuiCommands sont pour la plupart dans les ateliers dédiés comme Part, Mesh ou Cam. Pour assurer à l'utilisateur une utilisation facile, l'atelier Complete a été créé. Cet atelier intègre toutes les commandes Gui qui répondent à certaines exigences de qualité décrites ci-après :

  • La commande ou la fonctionnalité doit être "terminée", c'est-à-dire ne pas être un travail en cours.
  • Il doit définir une icône et une position de menu appropriées.
  • Il doit avoir une page d’aide, comme Draft ShapeString.
    • Tous les champs du Template:GuiCommand doivent être remplis
    • Il devrait avoir une description détaillée de la commande et de tous ses paramètres et personnalisations.
    • Il devrait avoir une image des dialogues que la commande va produire.
    • Il devrait y avoir une description des interfaces et des classes Python associées avec un exemple de code.

Espérons que cela devienne vrai pour toutes les GuiCommands de la liste des commandes.