Gui Command/es: Difference between revisions

From FreeCAD Documentation
(Created page with "=== 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...")
(Updating to match new version of source page)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
{{TOCright}}

<div class="mw-translate-fuzzy">
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:
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
* Define un nombre
Line 7: Line 11:
* Grabación de macros
* Grabación de macros
* etc...
* etc...
</div>


== Naming ==

<div class="mw-translate-fuzzy">
=== Denominación ===
=== Denominación ===
Los comandos de la interfaz gráfica de usuario se denominan de cierta forma: ''ModuleName_CommandName''
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.
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".
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".
</div>


<div class="mw-translate-fuzzy">
Si la documentación no está terminada utiliza la plantilla [[Template:UnfinishedDocu]]
Si la documentación no está terminada utiliza la plantilla [[Template:UnfinishedDocu]]
</div>


== Help page ==

<div class="mw-translate-fuzzy">
=== Página de ayuda ===
=== 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/es|Draft ShapeString]].
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/es|Draft ShapeString]].
</div>


<div class="mw-translate-fuzzy">
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]]
[[GuiCommand model]]
</div>


<div class="mw-translate-fuzzy">
Example:
Ejemplo:
* [[Draft ShapeString]]
* [[Draft Line]]
* [[Draft ShapeString/es|Draft ShapeString]]
* [[Draft Line/es|Draft Line]]
</div>


<div class="mw-translate-fuzzy">
=== Icons ===
=== Iconos ===
[[Image:Tango-Palette.png|400px|right]]
[[Image:Tango-Palette.png|400px|right]]
</div>


[[Image:Tango-Palette.png|400px|right]]
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.
<div class="mw-translate-fuzzy">
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.
</div>


<div class="mw-translate-fuzzy">
Preferable all Icons are drafted with SVG with e.g. [http://inkscape.org Inkscape].
Preferiblemente todos los iconos serán dibujados en formato de Gráficos Vectoriales Escalables (SVG) por ejemplo con [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.
</div>


'''icons color coding chart'''
===Icons color coding chart===


[[Image:Colorchart.png|200px]]
[[Image:Colorchart.png|200px]]
Line 41: Line 66:
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 ===
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:


{{Powerdocnavi{{#translation:}}}}
* 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/>

Latest revision as of 09:06, 16 August 2022

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

Naming

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

Help page

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

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.