Gui Befehl

From FreeCAD Documentation
Revision as of 21:47, 19 November 2019 by Maker (talk | contribs) (Created page with "== Symbole == 400px|right")
Jump to: navigation, search
Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎português • ‎română • ‎русский • ‎svenska

Der Gui Befehl ist eine der wichtigsten Funktionen von FreeCAD. im Hauptinteraktionspunkt des Benutzers. Jedes Mal, wenn der Benutzer einen Menüpunkt auswählt oder eine Schaltfläche in der Werkzeugleiste drückt , die einen Gui Befehl aktiviert. Einige der Attribute eines Gui Befehls sind:

  • Definiert einen Namen
  • Enthält ein Symbol
  • Definiert den Umfang für ein Rückgängigmachen/Wiederherstellen.
  • Hat eine Hilfeseite
  • Öffnet und kontrolliert Dialoge
  • Makro Aufnahme
  • und andere.

Benennung

Der Gui Befehl wird standardmäßig benannt: ModuleName_CommandName. z.B. "Base_Open" Dies ist der Open Gui Befehl im Basissystem. Der Gui Befehl in einem bestimmten Modul wird mit dem Modulnamen benannt. davor z.B. "Teil Zylinder"

Wenn die Dokumentation noch nicht fertig ist, verwende Template:UnfinishedDocu.

Hilfeseite

Jeder Gui Befehl muss eine Hilfeseite haben. Die Hilfeseite wird auf der Seite FreeCAD Dokumentations Wiki. Der Artikel hat den gleichen Namen wie der Gui Befehl, z.B. Draft ShapeString.

Um Deine eigenen Hilfeseiten zu erstellen, kannst Du die Vorlage GuiCommand model verwenden.

Beispiel:

Symbole

Tango-Palette.png

Every GuiCommand has to have an icon. We use the Tango icon set and its guidelines. On the right side you see the tango color palette.

All icons should be created in SVG format with a vector image application, such as Inkscape. This makes it easier to apply changes and derive additional icons in the same application space.

Icons color coding chart

Colorchart.png

We try as much as possible to respect this chart, so the color of the icons has a direct meaning.

Quality requirements

The Complete Workbench is deprecated, it no longer holds each of the commands in FreeCAD.


There are a lot of GuiCommands (tools) in FreeCAD which are experimental or used for a short time to test implementation of new features. These GuiCommands are mostly in the dedicated workbenches like Part, Mesh or Cam. To ensure a good user experience the workbench Complete was created. This workbench incorporates all GuiCommands which meet certain quality requirements which are described here:

  • The command or feature has to be "finished", that is, not be a work in progress.
  • It has to set up a proper icon and menu position.
  • It has to have a help page, like Draft ShapeString.
    • All the fields in Template:GuiCommand have to be filled in
    • It should have a detailed description of the command and all its parameters and settings.
    • It should have a picture of the dialogs that the command will produce.
    • It should have a description of the related Python interfaces and classes with example code.

Hopefully this becomes true for all GuiCommands in the List of Commands.