Gui Command/es: Difference between revisions

Revision as of 09:41, 30 March 2014

The GuiCommand is one of the most important functions of FreeCAD in the main interaction point of the user. Every time the user selects a menu item or presses a toolbar button it activates a GuiCommand. Some of the attributes of a GuiCommand are:

Defines a name
Contains an icon
Defines the scope for an undo/redo
Has a help page
Opens and controls dialogs
Macro recording
and so forth...

Naming

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

Help page

Every GuiCommand has to have a help page. The help page is hosted on the FreeCAD docu wiki. The article has the same name as the GuiCommand, e.g. 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 is the default start workbench of FreeCAD and 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.

Other languages:

@@ Line 1: / Line 1: @@
+The GuiCommand is one of the most important functions of FreeCAD
-Los comandos de la interfaz gráfica de usuario (GuiCommand) son una de las funciones más importantes de FreeCAD en el principal punto de interacción del usuario. Cada vez que el usuario selecciona un elemento del menú o presiona un botón de una barra de herramientas se activa un comando de la interfaz gráfica de usuario. Alguno de los atributos de un comandos de la interfaz gráfica de usuario (GuiCommand) son:
+in the main interaction point of the user. Every time the user
-* Define un nombre
+selects a menu item or presses a toolbar button it activates a
-* Contiene un icono
+GuiCommand. Some of the attributes of a GuiCommand are:
-* Define el alcance para deshacer/rehacer
+* Defines a name
-* Tiene una página de ayuda
+* Contains an icon
-* Abre y controla letreros de diálogo
+* Defines the scope for an undo/redo
-* Grabación de macros
+* Has a help page
-* etc...
+* Opens and controls dialogs
+* Macro recording
+* and so forth...
-=== Denominación ===
+=== Naming ===
-Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ''ModuleName_CommandName''
+The GuiCommand is named in a certain way: ''ModuleName_CommandName''
-Por ejemplo "Base_Open" este es el comando Abrir de la interfaz gráfica de usuario en el sistema base.
+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
-Los comandos de la interfaz gráfica de usuario en un módulo determinado se denominan con el nombre del módulo como prefijo. Por ejemplo "Part_Cylinder".
+in front e.g. "Part_Cylinder".
-Si la documentación no está terminada utiliza la plantilla [[Template:UnfinishedDocu]]
+If the docu is not finished use [[Template:UnfinishedDocu]]
-=== Página de ayuda ===
+=== Help page ===
+Every GuiCommand has to have a help page. The help page is hosted on the
-Todos los comandos de la interfaz gráfica de usuario deben tener una página de ayuda. La página de ayuda está alojada en la wiki de documentación de FreeCAD. El artículo tiene el mismo nombre que el comando de la interfaz gráfica de usuario. Por ejemplo [[Std_ViewScreenShot/es|Std_ViewScreenShot]].
+FreeCAD docu wiki. The article has the same name as the GuiCommand, e.g. [[Draft ShapeString]].
+To create your own help pages you can use the template:
-Para crear tus propias páginas de ayuda puedes utilizar la plantilla:
 [[GuiCommand model]]
+Example:
-Ejemplo:
+* [[Draft ShapeString]]
-* [[Std_ViewScreenShot/es|Std_ViewScreenShot]]
+* [[Draft Line]]
-* [[Part_Cylinder/es|Part_Cylinder]]
-* [[Std_Open/es|Std_Open]]
-=== Iconos ===
+=== Icons ===
 [[Image:Tango-Palette.png|400px|right]]
-Todos los comandos de la interfaz gráfica de usuario deben tener un icono. Utilizamos la [http://tango.freedesktop.org/Tango_Desktop_Project Colección de iconos Tango] y sus recomendaciones. A la derecha puedes ver la paleta de colores del proyecto Tango.
+Every GuiCommand has to have an icon. We use the [http://tango.freedesktop.org/Tango_Desktop_Project| Tango icon set] and its guidelines. On the right side you see
+the tango color palette.
-Preferiblemente todos los iconos serán dibujados en formato de Gráficos Vectoriales Escalables (SVG) por ejemplo con [http://inkscape.org Inkscape].
+Preferable all Icons are drafted with SVG with e.g. [http://inkscape.org Inkscape].
+This makes it easier to apply changes and derive
-Esto hace que sea más sencillo aplicar cambios y crear iconos adicionales similares en el mismo espacio de la aplicación.
+additional Icons in the same application space.
+'''icons color coding chart'''
-=== Requerimientos de Calidad ===
-Existen muchos comandos de la interfaz gráfica de usuario (operaciones) en FreeCAD que son experimentales o utilizados brevemente con propósitos de implementación. Estos comandos de la interfaz gráfica de usuario están la mayoría en los entornos de trabajo dedicados como los de Piezas, Mallas o Mecanizado (CAM).
-Para asegurar una buena experiencia al usuario se ha creado el entorno de trabajo ''Completo''. Este es el entorno de trabajo de inicio por defecto de FreeCAD e incorpora todos los comandos de la interfaz gráfica de usuario que cumplan con ciertos '''Requerimientos de Calidad''' los cuales se describen aquí:
+[[Image:Colorchart.png|200px]]
-* El comando/operación debe estar '''terminado'''. No en desarrollo!
-* Debe tener una '''página de ayuda''' como [[Std ViewScreenShot/es|esta]]
-** Todos los campos de la plantilla [[Template:GuiCommand]] deben estar cubiertos
-** Una imagen de los letreros de diálogo que el comando eventualmente muestra
-** Descripción detallada del comando y de todos sus parámetros y configuración
-** Descripción de las interfaces de Python relacionadas y las clases con código de ejemplo
-* Definir un icono apropiado y la posición en los menús
+We try as much as possible to respect this chart, so the color of the icons has a direct meaning.
-Se espera que esto sea cierto para todos los comandos de la interfaz gráfica de usuario en la [[List of Commands|Lista de comandos]].
+=== Quality requirements ===
-{{languages/es | {{en|Gui_Command}} {{fr|Gui_Command/fr}} {{it|Gui_Command/it}} {{ru|Gui_Command/ru}} }}
+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
+is the default start workbench of FreeCAD and 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]].
+[[Category:User Documentation]]
+[[Category:Command_Reference]]
+{{clear}}
+<languages/>