Gui Command/it: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updating to match new version of source page)
Line 1: Line 1:
The GuiCommand is one of the most important functions of FreeCAD
== Comandi dell'interfaccia grafica dell'utente ==
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 ===
I comandi dell'interfaccia grafica dell'utente (GuiCommand) sono una delle funzioni più importanti di FreeCAD e sono il punto principale di interazione dell'utente. Ogni volta che l'utente seleziona una voce del menu o preme un pulsante si attiva un comando Gui. Alcuni degli attributi di un comando grafico sono:
The GuiCommand is named in a certain way: ''ModuleName_CommandName''
* Definisce un nome
e.g "Base_Open" this is the Open Gui Command in the Base system.
* Contiene una icona
The GuiCommand in a certain module is named with the module name
* Definisce la possibilità di annullare/ripetere
in front e.g. "Part_Cylinder".
* Ha una pagina di aiuto
* Apre e controlla le finestre di dialogo
* Registra macro
* etc...


If the docu is not finished use [[Template:UnfinishedDocu]]
___TOC___


=== Nome del comando ===
=== 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:
Il Comando Gui è denominato nel modo: ''ModuleName_CommandName''. Ad esempio, "Base_Open" nell'interfaccia grafica è il comando ''Open'' nel sistema ''Base''. I comandi della Gui specifici di un modulo sono denominati con il nome del modulo come prefissso. Ad esempio: "Part_Cylinder".
[[GuiCommand model]]


Example:
Se la sua documentazione non è completa usare la maschera [[Template:UnfinishedDocu]] (en) - [[Template:UnfinishedDocu/it|Documentazione incompleta]] (it).

=== Pagina di aiuto ===

Ogni GuiCommand deve avere una pagina di aiuto. La pagina di aiuto è ospitata sul wiki della documentazione di FreeCAD. L'articolo ha lo stesso nome del GuiCommand. Per esempio [[Draft ShapeString]] (in inglese) - [[Draft ShapeString/it|Draft ShapeString]] (in it).

Per creare le proprie pagine di aiuto si può utilizzare il modello:
[[GuiCommand model]] (en) - [[GuiCommand model/it|Modello di comando Gui]] (it)

Esempi in italiano:
* [[Draft ShapeString/it|Draft ShapeString]]
* [[Draft Line/it|Draft Linea]]

Esempi in inglese:
* [[Draft ShapeString]]
* [[Draft ShapeString]]
* [[Draft Line]]
* [[Draft Line]]


=== Icone ===
=== Icons ===

[[Image:Tango-Palette.png|400px|right]]
[[Image:Tango-Palette.png|400px|right]]


Ogni comando dell'interfaccia grafica deve avere un'icona. Utilizziamo il [http://tango.freedesktop.org/Tango_Desktop_Project Set di icone Tango] e le sue linee guida. Sul lato destro si vede la tavolozza dei colori 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.


Produrre preferiblemente tutte le icone in formato Grafico Vettoriale Scalabile (SVG) per esempio 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
Questo rende più facile applicare le modifiche e ricavare ulteriori icone nell'ambito della stessa applicazione.
additional Icons in the same application space.


'''icons color coding chart'''

'''tabella del codice colore delle icone'''


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


We try as much as possible to respect this chart, so the color of the icons has a direct meaning.
Cerchiamo di rispettare quanto più possibile questo schema, in modo che il colore delle icone abbia un preciso significato.

=== Requisiti di qualità ===


=== Quality requirements ===
In FreeCAD esistono diversi comandi dell'interfaccia grafica (Funzioni) che sono sperimentali o utilizzati raramente in attesa di implementazione. Questi comandi Gui si trovano per lo più negli ambienti specifici quali Parte, Mesh o Cam.
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!
Per consentire all'utente una sperimentazione efficace si è creato un ambiente di lavoro definito ''Completo''. Questo è l'ambiente di lavoro predefinito all'avvio di FreeCAD e incorpora tutti i comandi Gui che soddisfano determinati '''requisiti di qualità''' che sono descritti qui:
* 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]].
* Il comando o funzione è '''finito'''. Non ci sono lavori in corso!
* Ha una '''pagina di aiuto''' come [[Draft ShapeString/it|Draft ShapeString]]
** Tutti i campi del modello [[Template:GuiCommand]] - [[Template:GuiCommand/it|Maschera di GuiCommand]] sono compilati
** È visualizzata l'eventuale finestra di dialogo del comando
** C'è la descrizione dettagliata del comando, di tutti i suoi parametri e delle impostazioni
** Le interfacce e classi Python correlate sono descritte con codici di esempio
* È definita una icona appropriata e una posizione nel menu


[[Category:User Documentation]]
Si spera che questo sia vero per tutti i comandi Gui della [[List of Commands]] - [[List of Commands/it|Lista dei comandi]].
[[Category:Command_Reference]]


{{clear}}
{{languages/it | {{en|Gui_Command}} {{es|Gui_Command/es}} {{fr|Gui_Command/fr}} {{ru|Gui_Command/ru}} }}
<languages/>

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.