Maschera del modello di base per la descrizione dei comandi

From FreeCAD Documentation
Revision as of 10:29, 24 November 2018 by Renatorivo (talk | contribs) (Replaced content with "== Opzioni ==")
This page shows a model of a recommended GuiCommand page. Under the Selectable block section below you will find the same content easily selectable for pasting in a new page.


Esempio di comando

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

Descrizione

Inserire qui una breve descrizione di cosa fa il comando.

Add an image if possible, and please follow the guidelines in WikiPages#Graphics. Example taken from Draft Line:

Optional: add a caption in italics below the image.

Utilizzo

  1. Spiegare come si utilizza il comando.
  2. xxxx.
  3. Aggiungere eventuali collegamenti per la navigazione del manuale.

Opzioni

Proprietà

Base

{{TitleProperty|Base}}  (Codice principale delle Proprietà)
  • DatiProprietà: Proprietà parametri dell'oggetto, lunghezza, raggio, ecc.
{{ProprietaDati|Proprietà}} (Codice della proprietà Dati, come appare nella scheda)

o

{{PropertyData/it|Proprietà}}
  • VistaProprietà: Proprietà di visualizzazione dell'oggetto, tipo di linea, colore, ecc.
{{ProprietaVista|Proprietà}} (Codice della proprietà Vista, come appare nella scheda)

o

{{PropertyView/it|Proprietà}}

Data

  • DatiPropertyName1: Description of the property

View

  • VistaPropertyName2: Description of the property

Esempio

Optional

Script

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

makeExampleCommandModel(Data, Data)
  • Crea un CommandModel utilizzando i dati.
  • Restituisce l'oggetto appena creato.

Esempio:

import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)

Limitations

  • Optional, use bullet list if multiple items

Ulteriori informazioni

Eventuali informazioni aggiuntive

Descrizione del codice della finestra principale

Non è indispensabile inserire tutti i codici della finestra.

Comando Test

Posizione nel menu
Schizzo → Vincoli → Coincidenza
Ambiente
Schizzo, PartDesign
Avvio veloce
C
Introdotto nella versione
-
Vedere anche
Blocca, Punto su oggetto

Esempio casuale:

{{ = Apertura del codice della finestra GuiCommand.
GuiCommand/it = Senza "/it" il menu è in inglese, aggiungendo "/it" si converte il menu in italiano.
| = Separatore dei codici.
|Name= FreeCAD04 = Assegna il titolo alla finestra. Non deve essere modificato nè tradotto. E' anche il nome dell'icona del comando. Se esiste una immagine (.png) con quel nome, essa viene visualizzata (non utilizzare l'estensione del nome). Quando non esiste nessuna immagine (.png) con quel nome, viene visulizzato in rosso un link a un file mancante.
|Name/it= Comando Test = Titolo in italiano che sostituisce il titolo precedente.
|Workbenches= [[Sketcher Workbench/it|Schizzo]], [[PartDesign Workbench/it|PartDesign]] = Ambienti che utilizzano il comando ... e a cui si possono creare dei collegamenti.
|MenuLocation= Schizzo → Vincoli → Coincidenza = Posizione del comando nel menu di FreeCAD.
|Shortcut= C = Scorciatoia da tastiera.
|SeeAlso= [[Sketcher_ConstrainBlock/it|Blocca]], [[Sketcher ConstrainPointOnObject/it|Punto su oggetto]] = Altri comandi simili che possono fornire ulteriori informazioni... e a cui si possono creare dei collegamenti.
}} = Chiusura del codice della finestra GuiCommand.

Selectable block

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

==Description==

Insert here a short description of what the command does.

</translate>
[[File:Draft_Line_example.jpg|none|400px]]
<translate>
''Optional: add a caption in italics.''

==How to use==

# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# Detailed steps as needed.
# Set options and press {{KEY|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==

The ExampleCommandModel tool can be used in [[macros]] and from the python console by using the following function:
</translate>
 '''makeExampleCommandModel(Data, Data)'''
<translate>
* Creates a CommandModel using Data.
* Returns the newly created object.

Example:
</translate>
 import FreeCAD, Base
 Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)
<translate>

==Limitations==

* Optional, use bullet list if multiple items

==Other==

Optional