Gui Befehl

From FreeCAD Documentation
Revision as of 21:54, 19 November 2019 by Maker (talk | contribs) (Created page with "* 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 eingeric...")
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

Jeder Gui Befehl muss ein Symbol haben. Wir verwenden das Tango-Icon-Set und seine Richtlinien. Auf der rechten Seite siehst du die Tango-Farbpalette.

Alle Symbole sollten im Format SVG mit einer Vektorbildanwendung, wie beispielsweise Inkscape, erstellt werden. Dies erleichtert die Übernahme von Änderungen und die Ableitung von Änderungen. zusätzliche Symbole im gleichen Anwendungsbereich.

Symbol Farbkodierungstabelle

Colorchart.png

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

Qualitätsanforderungen

Die Complete Workbench ist veraltet, sie enthält nicht mehr jeden der Befehle in FreeCAD.


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.

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