Maschera del modello di base per la descrizione dei comandi

From FreeCAD Documentation
Revision as of 13:58, 4 February 2020 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
Questa pagina mostra un modello di una pagina per documentare un Comando GUI. Sotto il Selectable block nella sezione sottostante si trova lo stesso contenuto facilmente selezionabile per incollarlo in una nuova pagina.

Esempio di comando

Posizione nel menu
Menu → Sottomenu → Comando
Ambiente
Ambiente
Avvio veloce
Nessuno
Introdotto nella versione
0.17
Vedere anche
Nessuno

Descrizione

Mentre la pagina è in costruzione, aggiungere la template {{UnfinishedDocu}} a inizio pagina.

Inserire qui una breve descrizione di cosa fa il comando.

Remember to use Template:Version, Template:VersionMinus, Template:VersionPlus and Template:Obsolete when applicable.

For example: The feature to utilize App::Link introduced in version 0.19 allows linking between sub-assemblies etc...

Aggiungere un'immagine se possibile, e per favore seguire le linee guida di WikiPages#Graphics. Esempio tratto da Draft Linea:

Facoltativo: aggiungere una didascalia sotto l'immagine per spiegare cosa sta facendo lo strumento.

Chiudere e riaprire i tag di traduzione prima e dopo le immagini e gli altri elementi fissi, se non c'è bisogno di tradurli. La didascalia dovrebbe sempre essere tradotta.

Utilizzo

  1. Premere il pulsante File:Std Close.png Nome del comando. Il pulsante deve essere un collegamento a questo comando.
  2. Descrivere i passaggi necessari.
  3. Impostare le opzioni e premere OK.

Opzioni

Proprietà

Dati

  • DatiNome della proprietà 1: descrizione della proprietà

Vista

  • VistaNome della proprietà 2: descrizione della proprietà

Esempio

Optionale

Script

Lo strumento ExampleCommandModel può essere utilizzato nelle macro e dalla console Python tramite la seguente funzione:

Object = makeExampleCommandModel(Data1, Data2)
  • Crea un Object usando Data1 e Data2.

Esempio:

import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)

Limitazioni

  • Facoltativo, utilizzare l'elenco puntato se ci sono più elementi

Ulteriori informazioni

Optionale

Selectable block

{{UnfinishedDocu}}
<translate>

{{GuiCommand
|Name=Base ExampleCommandModel
|Icon=<!--filename of icon with extension (e.g. svg, png) if not the same name as command; delete this row if not used-->
|MenuLocation=Menu → Submenu → Command
|Workbenches=[[Workbench Name|Workbench]]
|Shortcut={{KEY|F}} {{KEY|C}} <!--delete this row if not used-->
|SeeAlso=<!--add links to similar commands; delete this row if not used-->
|Version=0.17
}}

==Description==

While the page is under construction, add the {{UnfinishedDocu}} template at the top of the page.

Insert here a short description of what the command does.

</translate>
[[Image:Draft_Line_example.jpg|none|400px]]
<translate>

{{Caption|Optional: add a caption below the image to explain what the tool is doing.}}

Closing and opening translate tags should surround images, and other fixed elements, if they don't need to be translated. The caption should always be translated.

==Usage==

# There are several ways to invoke the command: 
#* The {{Button|[[Image:Std Close.png|16px]] [[GuiCommand model|Command name]]}} button from the toolbar (''Editor note:'' Using the [[Template:Button]] template, it is necessary to link to command as shown in this example)
#* Using the {{MenuCommand|Menu → Submenu → Command}} from the top menu. (''Editor note:'' This uses the [[Template:MenuCommand]] wiki template)
#* Use the keyboard shortcut {{KEY|F}} then {{KEY|C}} or {{KEY|Ctrl}} + {{KEY|Z}} (''Editor note:'' This uses the [[Template:KEY]] wiki template)
#* (Optional) RMB (Right Mouse Button) context menu: {{MenuCommand|RMB → {{Button|[[Image:Std Close.png|16px]] [[GuiCommand model|Command name]]}}}}
# Detailed steps as needed. Some steps may need {{KEY|Keyboard}} presses while others may require using the mouse to click on a {{Button|Button}} 
# Other commands may need to be referenced/used. Consider linking to their wiki pages along with their icons {{Button|[[Image:Draft_Line.svg|16px]] [[Draft Line|Draft Line]]}} or {{Button|[[Image:PartDesign_Pad.png|16px]] [[PartDesign Pad|PartDesign Pad]]}}
# Set options and press {{Button|OK}}.

==Options==

* List the command options here.

==Properties==

===Data===

* {{PropertyData|PropertyName1}}: Description of the property

===View===

* {{PropertyView|PropertyName2}}: Description of the property

==Example==

Optional

==Scripting==
{{Emphasis|See also:}} [[:Category:API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].

The ExampleCommandModel tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:

</translate>
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
}}
<translate>

* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.

Example:

</translate>
{{Code|code=
import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
<translate>

==Limitations==

* Optional, use bullet list if multiple items

==Other==

Optional

</translate>