Gui Command/it: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
The GuiCommand is one of the most important functions of FreeCAD
{{TOCright}}
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...


<div class="mw-translate-fuzzy">
=== 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...
</div>


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


<div class="mw-translate-fuzzy">
=== Help page ===
=== Nome del comando ===
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]].


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".
To create your own help pages you can use the template:
</div>
[[GuiCommand model]]


<div class="mw-translate-fuzzy">
Example:
Se la sua documentazione non è completa usare la maschera [[Template:UnfinishedDocu]] (en) - [[Template:UnfinishedDocu/it|Documentazione incompleta]] (it).
</div>

== Help page ==

<div class="mw-translate-fuzzy">
=== 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).
</div>

<div class="mw-translate-fuzzy">
Per creare le proprie pagine di aiuto si può utilizzare il modello:
[[GuiCommand model]] (en) - [[GuiCommand model/it|Modello di comando Gui]] (it)
</div>

<div class="mw-translate-fuzzy">
Esempi in italiano:
* [[Draft ShapeString/it|Draft ShapeString]]
* [[Draft Line/it|Draft Linea]]

Esempi in inglese:
* [[Draft ShapeString]]
* [[Draft ShapeString]]
* [[Draft Line]]
* [[Draft Line]]
</div>

<div class="mw-translate-fuzzy">
=== Icone ===


=== Icons ===
[[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">
Preferable all Icons are drafted with SVG with e.g. [http://inkscape.org Inkscape].
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.
This makes it easier to apply changes and derive
</div>
additional Icons in the same application space.


<div class="mw-translate-fuzzy">
'''icons color coding chart'''
Produrre preferiblemente tutte le icone in formato Grafico Vettoriale Scalabile (SVG) per esempio con [http://inkscape.org Inkscape].
Questo rende più facile applicare le modifiche e ricavare ulteriori icone nell'ambito della stessa applicazione.
</div>

<div class="mw-translate-fuzzy">
'''tabella del codice colore delle icone'''
</div>


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


Cerchiamo di rispettare quanto più possibile questo schema, in modo che il colore delle icone abbia un preciso significato.
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

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:

  • Definisce un nome
  • Contiene una icona
  • Definisce la possibilità di annullare/ripetere
  • Ha una pagina di aiuto
  • Apre e controlla le finestre di dialogo
  • Registra macro
  • etc...

Naming

Nome del comando

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

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

Help page

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 (in it).

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

Esempi in italiano:

Esempi in inglese:

Icone

Ogni comando dell'interfaccia grafica deve avere un'icona. Utilizziamo il Set di icone Tango e le sue linee guida. Sul lato destro si vede la tavolozza dei colori Tango.

Produrre preferiblemente tutte le icone in formato Grafico Vettoriale Scalabile (SVG) per esempio con Inkscape. Questo rende più facile applicare le modifiche e ricavare ulteriori icone nell'ambito della stessa applicazione.

tabella del codice colore delle icone

Cerchiamo di rispettare quanto più possibile questo schema, in modo che il colore delle icone abbia un preciso significato.