Gui Command/de: Difference between revisions
(Created page with "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 Sc...") |
No edit summary |
||
(20 intermediate revisions by 2 users not shown) | |||
Line 11: | Line 11: | ||
* und andere. |
* und andere. |
||
== |
== Benennung == |
||
Der Gui Befehl wird standardmäßig benannt: ''ModuleName_CommandName''. |
|||
z.B. "[[Base_Open/de|Base_Open]]" Dies ist der Open Gui Befehl im Basissystem. |
|||
Der Gui Befehl in einem bestimmten Modul wird mit dem Modulnamen benannt. |
|||
The GuiCommand in a certain module is named with the module name |
|||
davor z.B. "[[Part_Cylinder/de|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 |
|||
Every GuiCommand has to have a help page. The help page is hosted on the |
|||
FreeCAD |
FreeCAD Dokumentations Wiki. Der Artikel hat den gleichen Namen wie der Gui Befehl, z.B. [[Draft ShapeString|Draft ShapeString]]. |
||
Um Deine eigenen Hilfeseiten zu erstellen, kannst Du die Vorlage [[GuiCommand model|GuiCommand model]] verwenden. |
|||
Beispiel: |
|||
Example: |
|||
* [[Draft ShapeString| |
* [[Draft ShapeString/de|Entwurf FormString]] |
||
* [[Draft Line| |
* [[Draft Line/de|Entwurfslinie]] |
||
== |
== Symbole == |
||
[[Image:Tango-Palette.png|400px|right]] |
[[Image:Tango-Palette.png|400px|right]] |
||
Jeder GuiBefehl muss ein Symbol haben. Wir verwenden das [http://tango-project.org/Tango_Desktop_Project/ Tango Symbolsatz] und seine Richtlinien. |
|||
Auf der rechten Seite siehst du die Tango Farbpalette. |
|||
On the right side you see the tango color palette. |
|||
Alle Symbole sollten im Format [[SVG|SVG]] mit einer Vektorbildanwendung, wie beispielsweise [http://inkscape.org Inkscape], erstellt werden. |
|||
Dies erleichtert die Übernahme von Änderungen und die Ableitung von Änderungen. |
|||
This makes it easier to apply changes and derive |
|||
zusätzliche Symbole im gleichen Anwendungsbereich. |
|||
additional icons in the same application space. |
|||
=== Symbol Farbkodierungstabelle=== |
|||
===Icons color coding chart=== |
|||
[[Image:Colorchart.png|200px]] |
[[Image:Colorchart.png|200px]] |
||
Wir versuchen so weit wie möglich, dieses Diagramm zu respektieren, so dass die Farbe der Symbole eine direkte Bedeutung hat. |
|||
We try as much as possible to respect this chart, so the color of the icons has a direct meaning. |
|||
== |
== Qualitätsanforderungen == |
||
{{VeryImportantMessage| |
{{VeryImportantMessage|Die [[Complete Workbench/de|Complete Workbench]] ist veraltet, sie enthält nicht mehr jeden der Befehle in FreeCAD.}} |
||
<s> |
<s>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. |
|||
or used for a short time to test implementation of new features. These GuiCommands are mostly in |
|||
Um ein gutes Benutzererlebnis zu gewährleisten, wurde der Arbeitsbereich ''Complete'' erstellt. Dieser |
|||
the dedicated workbenches like Part, Mesh or Cam. |
|||
Arbeitsbereich enthält alle Gui Befehle die bestimmte Qualitätsanforderungen erfüllen, die hier beschrieben werden: |
|||
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: |
|||
* Der Befehl oder die Funktion muss "fertig" sein, d.h. es handelt sich nicht um eine laufende Arbeit. |
|||
* The command or feature has to be "finished", that is, not be a work in progress. |
|||
* Es muss ein geeignetes Symbol und eine korrekte Menüposition eingerichtet werden. |
|||
* It has to set up a proper icon and menu position. |
|||
* |
* Es muss eine Hilfeseite haben, wie [[Draft ShapeString/de|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. |
|||
** It should have a detailed description of the command and all its parameters and settings. |
|||
** Es sollte ein Bild der Dialoge haben, die der Befehl erzeugen wird. |
|||
** It should have a picture of the dialogs that the command will produce. |
|||
** |
** Es sollte eine Beschreibung der zugehörigen [[Python|Python]] Schnittstellen und Klassen mit Beispielcode enthalten. |
||
Hoffentlich wird dies für alle Gui Befehle in der [[List of Commands/de|List of Commands]].</s> wahr. |
|||
{{Userdocnavi}} |
|||
[[Category:User Documentation]] |
|||
[[Category:Command Reference]] |
|||
{{Powerdocnavi{{#translation:}}}} |
|||
{{clear}} |
{{clear}} |
Revision as of 22:39, 21 May 2020
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
Jeder GuiBefehl muss ein Symbol haben. Wir verwenden das Tango Symbolsatz 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
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.
- FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics
- Modules: Builtin modules, Units, Quantity
- Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
- Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC
- Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
- Scenegraph: Coin (Inventor) scenegraph, Pivy
- Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
- Macros: Macros, How to install macros
- Embedding: Embedding FreeCAD, Embedding FreeCADGui
- Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)
- Hubs: User hub, Power users hub, Developer hub