Gui Command/de: Difference between revisions

From FreeCAD Documentation
(Created page with "== Namengebung == Der Gui Befehl wird standardmäßig benannt: ''ModuleName_CommandName''. z.B. "Base_Open]" Dies ist der Open Gui Befehl im Basissystem. Der...")
No edit summary
 
(42 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
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
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:
Gui Befehl aktiviert. Einige der Attribute eines Gui Befehls sind:
* Definiert einen Namen
* Definiert einen Namen
* Enthält ein Symbol
* Enthält ein Symbol
* Definiert den Umfang für ein Rückgängigmachen/Wiederherstellen.
* Definiert den Umfang für ein Rückgängigmachen/Wiederherstellen.
* Hat eine Hilfeseite
* Besitzt eine Hilfeseite
* Öffnet und kontrolliert Dialoge
* Öffnet und steuert Dialoge
* Makroaufnahme
* Makro Aufnahme
* und andere.
* und andere.


==Benennung==
<div class="mw-translate-fuzzy">
== Namengebung ==
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.
davor z.B. "[[Part_Cylinder/de|Teil Zylinder]]"
</div>


Der GUI-Befehl wird nach einem Standardmuster benannt: ''Modulname_Befehlsname'', z.B. "[[Base_Open/de|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_Cylinder/de|Part Zylinder]]"
If the documentation is not finished use [[Template:UnfinishedDocu]].


Wenn die Dokumentation noch nicht fertig ist, verwendet man die Vorlage [[Template:UnfinishedDocu|UnfinishedDocu]].
== Help page ==
Every GuiCommand has to have a help page. The help page is hosted on the
FreeCAD documentation wiki. The article has the same name as the GuiCommand, e.g. [[Draft ShapeString|Draft ShapeString]].


==Hilfe-Seite==
To create your own help pages you can use the template [[GuiCommand model|GuiCommand model]]


Jeder GUI-Befehl muss eine Hilfeseite haben. Die Hilfeseite wird im Wiki der
Example:
FreeCAD-Dokumentation gehostet. Der Artikel hat den gleichen Namen wie der GUI-Befehl, z.B. [[Draft_ShapeString|Draft ShapeString]].
* [[Draft ShapeString|Draft ShapeString]]
* [[Draft Line|Draft Line]]


Um eigene Hilfeseiten zu erstellen, kann man die Vorlage [[GuiCommand_model|GuiCommand model]] verwenden.
== Icons ==
[[Image:Tango-Palette.png|400px|right]]


Beispiel:
Every GuiCommand has to have an icon. We use the [http://tango.freedesktop.org/Tango_Desktop_Project Tango icon set] and its guidelines.
* [[Draft_ShapeString|Draft ShapeString]]
On the right side you see the tango color palette.
* [[Draft_Line|Draft Line]]


==Symbole==
All icons should be created in [[SVG|SVG]] format with a vector image application, such as [http://inkscape.org Inkscape].
This makes it easier to apply changes and derive
additional icons in the same application space.


[[Image:Tango-Palette.png|400px|right]]
===Icons color coding chart===


Jeder GUI-Befehl muss ein Symbol haben. Wir verwenden den [http://tango-project.org/Tango_Desktop_Project/ Tango Symbolsatz] und seine Richtlinien. Auf der rechten Seite ist die Tango-Farbpalette dargestellt.
[[Image:Colorchart.png|200px]]


Alle Symbole sollten im Format [[SVG/de|SVG]] mit einer Vektorgrafikanwendung, wie beispielsweise [http://inkscape.org Inkscape], erstellt werden.
We try as much as possible to respect this chart, so the color of the icons has a direct meaning.
Dies erleichtert die Anwendung von Änderungen und die Ableitung von zusätzlichen Symbolen im gleichen Anwendungsbereich.


===Symbol-Farbkodierungstabelle===
== Quality requirements ==
{{VeryImportantMessage|The [[Complete Workbench|Complete Workbench]] is deprecated, it no longer holds each of the commands in FreeCAD.}}

<s>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|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|Python]] interfaces and classes with example code.

Hopefully this becomes true for all GuiCommands in the [[List of Commands|List of Commands]].</s>


[[Image:Colorchart.png|200px]]


Wir versuchen so weit wie möglich, dieses Diagramm zu berücksichtigen, und so hat die Farbe der Symbole eine direkte Bedeutung.
{{Userdocnavi}}


[[Category:User Documentation]]
[[Category:Command Reference]]


{{Powerdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 13:34, 27 September 2022

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.

Hilfe-Seite

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:

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 berücksichtigen, und so hat die Farbe der Symbole eine direkte Bedeutung.