Gui Command/de

Der GUI-Befehl (Befehl der grafischen Benutzerschnittstelle) ist eine der wichtigsten Funktionen von FreeCAD im Hauptinteraktionsbereich des Benutzers. Jedes Mal, wenn der Benutzer einen Menüeintrag auswählt oder eine Schaltfläche in der Werkzeugleiste drückt, wird ein GUI-Befehl aktiviert. Einige der Merkmale eines GUI-Befehls sind:
 * Definiert einen Namen
 * Enthält ein Symbol
 * Definiert den Umfang für ein Rückgängigmachen/Wiederherstellen.
 * Besitzt eine Hilfeseite
 * Öffnet und steuert Dialoge
 * Makroaufnahme
 * und andere.

Benennung
Der GUI-Befehl wird nach einem Standardmuster benannt: Modulname_Befehlsname, z.B. "Base_Öffnen" Dies wäre der GUI-Befehl Öffnen in einem Basissystem. Der GUI-Befehl in einem bestimmten Modul wird mit dem Modulnamen an erster Stelle benannt z.B. "Part Zylinder"

Wenn die Dokumentation noch nicht fertig ist, verwendet man die Vorlage UnfinishedDocu.

Hilfeseite
Jeder GUI-Befehl muss eine Hilfeseite haben. Die Hilfeseite wird im Wiki der FreeCAD-Dokumentation gehostet. Der Artikel hat den gleichen Namen wie der GUI-Befehl, z.B. Draft ShapeString.

Um eigene Hilfeseiten zu erstellen, kann man die Vorlage GuiCommand model verwenden.

Beispiel:
 * Draft ShapeString
 * Draft Line

Symbole


Jeder GUI-Befehl muss ein Symbol haben. Wir verwenden den Tango Symbolsatz und seine Richtlinien. Auf der rechten Seite ist die Tango-Farbpalette dargestellt.

Alle Symbole sollten im Format SVG mit einer Vektorgrafikanwendung, wie beispielsweise Inkscape, erstellt werden. Dies erleichtert die Anwendung von Änderungen und die Ableitung von zusätzlichen Symbolen im gleichen Anwendungsbereich.

Symbol Farbkodierungstabelle


Wir versuchen so weit wie möglich, dieses Diagramm zu respektieren, so dass die Farbe der Symbole eine direkte Bedeutung hat.

Qualitätsanforderungen
Es gibt viele Gui Befehle (Werkzeuge) in FreeCAD, die experimentell sind. oder für kurze Zeit genutzt werden, um die Implementierung neuer Funktionen zu testen. Diese Gui Befehle befinden sich meist in den zugeordneten Arbeitsbereichen wie Part, Mesh oder Cam. Um ein gutes Benutzererlebnis zu gewährleisten, wurde der Arbeitsbereich Complete erstellt. Dieser Arbeitsbereich enthält alle Gui Befehle die bestimmte Qualitätsanforderungen erfüllen, die hier beschrieben werden:


 * Der Befehl oder die Funktion muss "fertig" sein, d.h. es handelt sich nicht um eine laufende Arbeit.
 * Es muss ein geeignetes Symbol und eine korrekte Menüposition eingerichtet werden.
 * Es muss eine Hilfeseite haben, wie Draft ShapeString.
 * Alle Felder in Template:GuiCommand müssen ausgefüllt werden.
 * Es sollte eine detaillierte Beschreibung des Befehls und aller Parameter und Einstellungen enthalten.
 * Es sollte ein Bild der Dialoge haben, die der Befehl erzeugen wird.
 * Es sollte eine Beschreibung der zugehörigen Python Schnittstellen und Klassen mit Beispielcode enthalten.

Hoffentlich wird dies für alle Gui Befehle in der List of Commands. wahr.