Gui Command/es: Difference between revisions

From FreeCAD Documentation
(Created page with "Preferiblemente todos los iconos serán dibujados en formato de Gráficos Vectoriales Escalables (SVG) por ejemplo con [http://inkscape.org Inkscape]. Esto hace que sea más ...")
(Created page with "=== Requerimientos de Calidad === Existen muchos comandos de la interfaz gráfica de usuario (operaciones) en FreeCAD que son experimentales o utilizados brevemente con propó...")
Line 39: Line 39:
We try as much as possible to respect this chart, so the color of the icons has a direct meaning.
We try as much as possible to respect this chart, so the color of the icons has a direct meaning.


=== Quality requirements ===
=== 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).
There are a lot of GuiCommands (Features) in FreeCAD which are experimental
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í:
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!
* The Command/Feature has to be '''finished'''. No work in progress!

Revision as of 09:53, 30 March 2014

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:

  • Define un nombre
  • Contiene un icono
  • Define el alcance para deshacer/rehacer
  • Tiene una página de ayuda
  • Abre y controla letreros de diálogo
  • Grabación de macros
  • etc...

Denominación

Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ModuleName_CommandName Por ejemplo "Base_Open" este es el comando Abrir de la interfaz gráfica de usuario en el sistema base. 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".

Si la documentación no está terminada utiliza la plantilla Template:UnfinishedDocu

Página de ayuda

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 Draft ShapeString.

Para crear tus propias páginas de ayuda puedes utilizar la plantilla: GuiCommand model

Ejemplo:

Iconos

Todos los comandos de la interfaz gráfica de usuario deben tener un icono. Utilizamos la Colección de iconos Tango y sus recomendaciones. A la derecha puedes ver la paleta de colores del proyecto Tango.

Preferiblemente todos los iconos serán dibujados en formato de Gráficos Vectoriales Escalables (SVG) por ejemplo con Inkscape. Esto hace que sea más sencillo aplicar cambios y crear iconos adicionales similares en el mismo espacio de la aplicación.

icons color coding chart

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

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í:

  • 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.