Gui Command/ro: Difference between revisions

From FreeCAD Documentation
No edit summary
(Created page with "=== Pagina Help === Fiecare GuiCommand trebuie să aibă o pagină de ajutor. Pagina de ajutor este găzduită pe FreeCAD docu wiki. Articolul are același nume ca și GuiComm...")
Line 20: Line 20:
If the docu is not finished use [[Template:UnfinishedDocu]]
If the docu is not finished use [[Template:UnfinishedDocu]]


=== Help page ===
=== Pagina Help ===
Every GuiCommand has to have a help page. The help page is hosted on the
Fiecare GuiCommand trebuie aibă o pagină de ajutor. Pagina de ajutor este găzduită pe
FreeCAD docu wiki. The article has the same name as the GuiCommand, e.g. [[Draft ShapeString]].
FreeCAD docu wiki. Articolul are același nume ca și GuiCommand, de ex. [[Draft ShapeString]].


To create your own help pages you can use the template:
To create your own help pages you can use the template:

Revision as of 08:33, 9 November 2018

GuiCommand este una dintre cele mai importante funcții ale FreeCAD în principalul punct de interacțiune al utilizatorului. De fiecare dată când utilizatorul selectează un element de meniu sau apasă butonul unei bare de instrumente pe care îl activează a GuiCommand. Unele dintre atributele unui GuiCommand sunt:

  • Definește un nume
  • Conține o pictogramă
  • Definește domeniul de aplicare pentru o anulare / refacere
  • Are o pagină de ajutor
  • Deschide și controlează dialogurile
  • Înregistrare macro
  • si asa mai departe...

Nominalizare

The GuiCommand is named in a certain way: ModuleName_CommandName e.g "Base_Open" this is the Open Gui Command in the Base system. The GuiCommand in a certain module is named with the module name in front e.g. "Part_Cylinder".

If the docu is not finished use Template:UnfinishedDocu

Pagina Help

Fiecare GuiCommand trebuie să aibă o pagină de ajutor. Pagina de ajutor este găzduită pe FreeCAD docu wiki. Articolul are același nume ca și GuiCommand, de ex. Draft ShapeString.

To create your own help pages you can use the template: GuiCommand model

Example:

Icons

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.

Preferable all Icons are drafted with SVG with e.g. Inkscape. This makes it easier to apply changes and derive additional Icons in the same application space.

icons color coding chart

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

Quality requirements

There are a lot of GuiCommands (Features) in FreeCAD which are experimental or used shortly for implementation purposes. 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/Feature has to be finished. No work in progress!
  • Has to have a help page like Draft ShapeString
    • All the fields in Template:GuiCommand have to filled in
    • A picture of the dialogs the command eventually yield
    • detailed description of the command and all its parameters and settings
    • Description of the related python interfaces and classes with example code
  • Set up a proper Icon and menu position

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