WikiPages/it: Difference between revisions

From FreeCAD Documentation
(Created page with "Per utilizzare un'immagine come collegamento:")
No edit summary
 
(126 intermediate revisions by 2 users not shown)
Line 126: Line 126:
Per utilizzare un'immagine come collegamento:
Per utilizzare un'immagine come collegamento:


<code><nowiki>[[Image:Draft_Wire.svg|24px|Optional text that is shown when you hover the image|link=Draft_Wire]]</nowiki></code>
<code><nowiki>[[Image:Draft_Wire.svg|24px|Testo facoltativo che viene mostrato quando passi il mouse sull'immagine|link=Draft_Wire]]</nowiki></code>


; Immagine del Collegamento + testo del collegamento
; Image link + text link
: [[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]
: [[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]


Se si tralascia il testo facoltativo, il collegamento stesso verrà mostrato quando si passa sull'immagine, il che è preferibile, e si dovrebbe anche aggiungere un collegamento testuale dopo il collegamento dell'immagine:
If you leave out the optional text the link itself will be shown when the image is hovered, which is preferable, and you should also add a text link after the image link:


<code><nowiki>[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]</nowiki></code>
<code><nowiki>[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]</nowiki></code>
Line 138: Line 138:
=== Pagine degli Ambienti di lavoro ===
=== Pagine degli Ambienti di lavoro ===


Una pagina dell'ambiente di livello superiore dovrebbe iniziare con:
A top level workbench page should start with:
* Una descrizione dello scopo per cui viene utilizzato l'ambiente.
* A description of what the workbench is used for.
* Un'immagine per illustrarne la descrizione.
* An image to illustrate the description.


See [[#Screen_capture|#Screen capture]] for conventions on including images.
Vedere [[#Screen_capture|#Istantanee dello schermo]] per le convenzioni su come inserire le immagini.


<span id="Command_pages"></span>
<span id="Command_pages"></span>
=== Pagine dei comandi ===
=== Pagine dei comandi ===


Le pagine dei comandi che descrivono gli strumenti dell'ambiente di lavoro non dovrebbero essere troppo lunghe, dovrebbero solo spiegare cosa può fare un comando e cosa no, e come usarlo. Si dovrebbe ridurre al minimo le immagini e gli esempi. I tutorial si possono espandere riguardo l'utilizzo dello strumento e fornire dettagli passo passo.
Command pages describing workbench tools should not be too long, they should only explain what a command can do and what it can't, and how to use it. You should keep pictures and examples to a minimum. Tutorials can expand on how to use the tool and provide step-by-step details.


Please refer to the [[GuiCommand_model|GuiCommand model]] page for more details.
Per ulteriori dettagli, fare riferimento alla pagina dei [[GuiCommand_model/it|Modelli per la descrizione dei comandi]].


<span id="Tutorials"></span>
<span id="Tutorials"></span>
=== Tutorial ===
=== Tutorial ===


Un tutorial ben scritto dovrebbe insegnare come ottenere rapidamente determinati risultati pratici. Non dovrebbe essere troppo lungo, ma dovrebbe includere immagini e istruzioni passo passo sufficienti per guidare l'utente. Man mano che FreeCAD si evolve, i tutorial potrebbero diventare obsoleti, quindi è importante menzionare la versione di FreeCAD utilizzata o richiesta per un tutorial.
A well written tutorial should teach how to achieve certain practical results quickly. It shouldn't be too long, but should include sufficient step-by-step instructions and images to guide the user. As FreeCAD evolves, tutorials may become obsolete, so it is important to mention the FreeCAD version used in, or required for, a tutorial.


For examples visit the [[Tutorials|Tutorials]] page.
Per esempi visitare la pagina dei [[Tutorials/it|Tutorial]].
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
Line 164: Line 164:
== Templates ==
== Templates ==
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
Styling of the FreeCAD wiki pages is achieved through the use of templates ([[Help:Editing#Templates_and_transcluding_pages]]). They ensure a standardized look and feel across all pages, and also make it possible to re-style the wiki. You can see the complete list of defined templates by accessing [[Special:PrefixIndex/Template:]]. But please only use the templates listed in the tables below. Only in very special cases should you use HTML tags directly.
Lo stile delle pagine wiki di FreeCAD si ottiene attraverso l'uso di modelli ([[Help:Editing#Templates_and_transcluding_pages]]). Garantiscono un aspetto standardizzato in tutte le pagine e consentono anche di rimodellare il wiki. È possibile visualizzare l'elenco completo dei modelli definiti accedendo a [[Special:PrefixIndex/Template:]]. Si prega tuttavia di utilizzare solo i modelli elencati nelle tabelle seguenti. Solo in casi molto particolari si possono utilizzare direttamente i tag HTML.


Click on the template link to see the usage instructions for a template, and to see its implementation. Templates are a powerful feature of the MediaWiki software. You should be an experienced wiki user if you wish to propose additions and modifications to existing templates. If implemented incorrectly, templates make it difficult to translate pages into other languages, so their use should be limited to text formatting, page transclusion should be avoided. See [https://www.mediawiki.org/wiki/Help:Templates MediaWiki Help:Templates] to learn more.
Fare clic sul collegamento del modello per visualizzare le istruzioni di utilizzo di un modello e per visualizzarne l'implementazione. I modelli sono una potente funzionalità del software MediaWiki. Si dovrebbe essere un utente wiki esperto per proporre aggiunte e modifiche ai modelli esistenti. Se implementati in modo errato, i template rendono difficile la traduzione delle pagine in altre lingue, quindi il loro utilizzo dovrebbe essere limitato alla formattazione del testo e la transclusione delle pagine dovrebbe essere evitata. Vedere [https://www.mediawiki.org/wiki/Help:Templates MediaWiki Help:Templates] per ulteriori informazioni.


<span id="Simple_templates"></span>
=== Simple templates ===
=== Template semplici ===

Questi template accettano un parametro semplice di testo e lo formattano con uno stile particolare.


These templates accept a simple text parameter, and format it with a particular style.
{|{{Prettytable}}
{|{{Prettytable}}
!style="width:10%;"|Template
!style="width:10%;"|Template
!style="width:20%;"|Appearance
!style="width:20%;"|Aspetto
!style="width:70%;"|Description
!style="width:70%;"|Descrizione


|--
|--
Line 181: Line 182:
|
|
{{Top}}
{{Top}}
|Use it to add a link to the top of the page.
| Utilizzato per aggiungere un link che porta all'inizio della pagina.


|--
|--
|[[Template:Emphasis|Emphasis]]
|[[Template:Emphasis|Emphasis]]
|{{Emphasis|emphasis}}
|{{Emphasis|emphasis}}
|Utilizzato per enfatizzare una parte di testo.
|Use it to emphasize a piece of text.


|--
|--
|[[Template:KEY|KEY]]
|[[Template:KEY|KEY]]
|{{KEY|Alt}}
|{{KEY|Alt}}
|Utilizzato per indicare un tasto della tastiera che deve essere premuto.
|Use it to indicate a keyboard key that needs to be pressed.


|--
|--
|[[Template:ASCII|ASCII]]
|[[Template:ASCII|ASCII]]
|{{ASCII|A}}
|{{ASCII|A}}
|Use it to indicate a ascii key in a image (.svg) that needs to be pressed. You must give the character desired or the number of the code ascii of the character.
|Utilizzato per indicare un tasto ascii in un'immagine (.svg) che deve essere premuto. E' necessario fornire il carattere desiderato oppure il numero del codice ascii del carattere.


|--
|--
|[[Template:Button|Button]]
|[[Template:Button|Button]]
|{{Button|Cancel}}
|{{Button|Cancel}}
|Utilizzato per indicare un pulsante nell'interfaccia utente grafica che deve essere premuto.
|Use it to indicate a button in the graphical user interface that needs to be pressed.


|--
|--
|[[Template:RadioButton|RadioButton]]
|[[Template:RadioButton|RadioButton]]
|{{RadioButton|Option}}
|{{RadioButton|Option}}
|Use it to indicate a radio button in the graphical user interface that needs to be {{RadioButton|TRUE|Selected}} or {{RadioButton|FALSE|Not}}.
|Utilizzato per indicare un pulsante di un'opzione nell'interfaccia utente grafica che deve essere {{RadioButton|TRUE|Selezionato}} o {{RadioButton|FALSE|No}}.


|--
|--
|[[Template:CheckBox|CheckBox]]
|[[Template:CheckBox|CheckBox]]
|{{CheckBox|Option}}
|{{CheckBox|Option}}
|Use it to indicate a checkbox in the graphical user interface that needs to be {{CheckBox|TRUE|Checked}} or {{CheckBox|FALSE|Not}}.
|Utilizzato per indicare una casella di controllo nell'interfaccia utente grafica che deve essere {{CheckBox|TRUE|Selezionata}} o {{CheckBox|FALSE|No}}.


|--
|--
|[[Template:SpinBox|SpinBox]]
|[[Template:SpinBox|SpinBox]]
|{{SpinBox|1.50}}
|{{SpinBox|1.50}}
|Utilizzato per indicare una casella numerica nell'interfaccia utente grafica che può essere modificata.
|Use it to indicate a spinbox in the graphical user interface that needs to be modified.


|--
|--
|[[Template:ComboBox|ComboBox]]
|[[Template:ComboBox|ComboBox]]
|{{ComboBox|Menu 1}}
|{{ComboBox|Menu 1}}
|Utilizzato per indicare una casella combinata nell'interfaccia utente grafica che può essere modificata.
|Use it to indicate a combobox in the graphical user interface that needs to be modified.


|--
|--
|[[Template:LineEdit|LineEdit]]
|[[Template:LineEdit|LineEdit]]
|{{LineEdit|Metal Nickel (Ni)}}
|{{LineEdit|Metal Nickel (Ni)}}
|Utilizzato per indicare un LineEdit nell'interfaccia utente grafica che può essere modificato.
|Use it to indicate a LineEdit in the graphical user interface that needs to be modified.


|--
|--
|[[Template:FALSE|FALSE]], [[Template:false|false]]
|[[Template:FALSE|FALSE]], [[Template:false|false]]
|{{FALSE}}, {{false}}
|{{FALSE}}, {{false}}
|Use it to indicate a False Boolean value, for example, as a property in the [[Property_editor|property editor]]. This is a shortcut. Since it is a value, prefer Template [[Template:Value|Value]] {{Value|false}}
|Utilizzato per indicare un valore booleano falso, ad esempio, come proprietà nell'[[Property_editor/it|editor delle proprietà]]. Questa è una scorciatoia. Poiché si tratta di un valore, preferire il Template [[Template:Value|Value]] {{Value|false}}


|--
|--
|[[Template:TRUE|TRUE]], [[Template:true|true]]
|[[Template:TRUE|TRUE]], [[Template:true|true]]
|{{TRUE}}, {{true}}
|{{TRUE}}, {{true}}
|Use it to indicate a True Boolean value, for example, as a property in the [[Property_editor|property editor]]. This is a shortcut. Since it is a value, prefer Template [[Template:Value|Value]] {{Value|true}}
|Utilizzato per indicare un valore booleano vero, ad esempio, come proprietà nell'[[Property_editor/it|editor delle proprietà]]. Questa è una scorciatoia. Poiché si tratta di un valore, preferire Template [[Template:Value|Value]] {{Value|true}}


|--
|--
|[[Template:MenuCommand|MenuCommand]]
|[[Template:MenuCommand|MenuCommand]]
|{{MenuCommand|File → Save}}
|{{MenuCommand|File → Save}}
|Utilizzato per indicare la posizione di un comando all'interno di un particolare menu.
|Use it to indicate the location of a command inside a particular menu.


|--
|--
|[[Template:FileName|FileName]]
|[[Template:FileName|FileName]]
|{{FileName|File name}}
|{{FileName|File name}}
|Use it to indicate a name of a file or directory.
|Utilizzato per indicare il nome di un file o di una cartella.


|--
|--
|[[Template:SystemInput|SystemInput]]
|[[Template:SystemInput|SystemInput]]
|{{SystemInput|Type this text}}
|{{SystemInput|Type this text}}
|Utilizzato per indicare il testo di input digitato dall'utente.
|Use it to indicate user typed input text.


|--
|--
|[[Template:SystemOutput|SystemOutput]]
|[[Template:SystemOutput|SystemOutput]]
|{{SystemOutput|Output text}}
|{{SystemOutput|Output text}}
|Utilizzato per indicare l'output di testo dal sistema.
|Use it to indicate text output from the system.


|--
|--
|[[Template:Incode|Incode]]
|[[Template:Incode|Incode]]
|{{incode|import FreeCAD}}
|{{incode|import FreeCAD}}
|Utilizzato per includere il codice sorgente in linea con un carattere a spaziatura fissa. Dovrebbe stare in una riga.
|Use it to include in-line source code with a monospace font. It should fit in one line.


|--
|--
|[[Template:PropertyView|PropertyView]]
|[[Template:PropertyView|PropertyView]]
|{{PropertyView|Color}}
|{{PropertyView|Color}}
|Use it to indicate a View property in the [[Property_editor|property editor]]. Examples of View properties include {{emphasis|Line Color}}, {{emphasis|Line Width}}, {{emphasis|Point Color}}, {{emphasis|Point Size}}, etc.
|Utilizzato per indicare una proprietà View nell'[[Property_editor/it|editor delle proprietà]]. Esempi di proprietà di visualizzazione includono {{emphasis|Line Color}}, {{emphasis|Line Width}}, {{emphasis|Point Color}}, {{emphasis|Point Size}}, ecc..


|--
|--
|[[Template:PropertyData|PropertyData]]
|[[Template:PropertyData|PropertyData]]
|{{PropertyData|Position}}
|{{PropertyData|Position}}
|Use it to indicate a Data property in the [[Property_editor|property editor]]. Data properties are different for different types of objects.
|Utilizzato per indicare una proprietà Data nell'[[Property_editor/it|editor delle proprietà]]. Le proprietà dei dati sono diverse per i diversi tipi di oggetti.


|--
|--
|[[Template:Properties Title|Properties Title]] / [[Template:TitleProperty|TitleProperty]]
|[[Template:Properties Title|Properties Title]] / [[Template:TitleProperty|TitleProperty]]
|{{Properties_Title|Base}}
|{{Properties_Title|Base}}
|Utilizzato per indicare il titolo di un gruppo di proprietà nell'[[Property_editor/it|editor delle proprietà]]. Il titolo non verrà incluso nel sommario automatico.
|Use it to indicate the title of a property group in the [[Property_editor|property editor]]. The title will not be included in the automatic table of contents.


|--
|--
|[[Template:Obsolete|Obsolete]]
|[[Template:Obsolete|Obsolete]]
|{{Obsolete|0.19}}
|{{Obsolete|0.19}}
|Utilizzato per indicare che una funzionalità è diventata obsoleta nella versione di FreeCAD specificata.
|Use it to indicate that a feature became obsolete in the specified FreeCAD version.


|--
|--
|[[Template:Version|Version]]
|[[Template:Version|Version]]
|{{Version|0.18}}
|{{Version|0.18}}
|Utilizzato per indicare che una funzionalità è stata introdotta nella versione di FreeCAD specificata.
|Use it to indicate that a feature was introduces in the specified FreeCAD version.


|--
|--
|[[Template:VersionMinus|VersionMinus]]
|[[Template:VersionMinus|VersionMinus]]
|{{VersionMinus|0.16}}
|{{VersionMinus|0.16}}
|Utilizzato per indicare che una funzionalità è disponibile nella versione di FreeCAD specificata e nelle versioni precedenti.
|Use it to indicate that a feature is available in the specified FreeCAD version and earlier versions.


|--
|--
|[[Template:VersionPlus|VersionPlus]]
|[[Template:VersionPlus|VersionPlus]]
|{{VersionPlus|0.17}}
|{{VersionPlus|0.17}}
|Utilizzato per indicare che una funzionalità è disponibile nella versione di FreeCAD specificata e nelle versioni successive.
|Use it to indicate that a feature is available in the specified FreeCAD version and later versions.


|--
|--
|[[Template:ColoredText|ColoredText]]
|[[Template:ColoredText|ColoredText]]
|{{ColoredText|Colored Text}}
|{{ColoredText|Colored Text}}
|Use this template to color the background, text, or background and text. ([[Template:ColoredText|ColoredText]] page for more examples)
|Questo modello è utilizzato per colorare lo sfondo, il testo o lo sfondo e il testo. (Pagina [[Template:ColoredText|ColoredText]] per ulteriori esempi)


|--
|--
|[[Template:ColoredParagraph|ColoredParagraph]]
|[[Template:ColoredParagraph|ColoredParagraph]]
|{{ColoredParagraph|Colored Paragraph}}
|{{ColoredParagraph|Colored Paragraph}}
|Use this template to color the background, text, or background and text of an entire paragraph. [[Template:ColoredParagraph|ColoredParagraph]] page for more examples)
|Questo modello è utilizzato per colorare lo sfondo, il testo o lo sfondo e il testo di un intero paragrafo. (Pagina [[Template:ColoredParagraph|ColoredParagraph]] per ulteriori esempi)
|}
|}


<span id="Complex_templates"></span>
=== Complex templates ===
=== Template complessi ===


Questi template richiedono più parametri di input o producono un blocco di testo con un formato particolare.
These templates require more input parameters, or produce a block of text with a particular format.


{|{{Prettytable}}
{|{{Prettytable}}
!style="width:10%;"|Template
!style="width:10%;"|Template
!style="width:45%;"|Appearance
!style="width:45%;"|Aspetto
!style="width:45%;"|Description
!style="width:45%;"|Descrizione


|--
|--
|[[Template:Prettytable|Prettytable]]
|[[Template:Prettytable|Prettytable]]
|This table
|This table
|Utilizzato per formattare tabelle come questa. È possibile aggiungere ulteriori proprietà alla tabella.
|Use it to format tables such as this one. Additional table properties can be added.


|--
|--
|[[Template:Caption|Caption]]
|[[Template:Caption|Caption]]
|<div style="width:400px;">{{Caption|Some caption for an image}}</div>
|<div style="width:400px;">{{Caption|Some caption for an image}}</div>
|Utilizzato per aggiungere una didascalia sotto un'immagine. Può essere allineato a sinistra o al centro.
|Use it to add an explanation below an image. It can be left aligned or center aligned.


|--
|--
|[[Template:Clear|Clear]]
|[[Template:Clear|Clear]]
|
|
|Utilizato per cancellare le colonne. Seguire la definizione del modello per una spiegazione dettagliata. Viene spesso utilizzato per impedire al testo di scorrere accanto a immagini non correlate.
|Use it to clear columns. Follow the definition of the template for a detailed explanation. It is often used to stop text from flowing next to unrelated images.


|--
|--
|[[Template:Code|Code]]
|[[Template:Code|Code]]
|{{Code|code=import FreeCAD}}
|{{Code|code=import FreeCAD}}
|Utilizzato per includere esempi di codice su più righe con un carattere a spaziatura fissa. Il linguaggio predefinito è Python, ma è possibile specificare altri linguaggi.
|Use it to include multi-line code examples with a monospace font. The default language is Python, but other languages can be specified.


[[Python|Python]] code should adhere to the general recommendations established by [https://www.python.org/dev/peps/pep-0008/ PEP8: Style Guide for Python Code]. In particular, parentheses should immediately follow the function name, and a space should follow a comma. This makes the code more readable.
Il codice [[Python/it|Python]] deve aderire alle raccomandazioni generali stabilite da [https://www.python.org/dev/peps/pep-0008/ PEP8: Style Guide for Python Code]. In particolare, le parentesi dovrebbero seguire immediatamente il nome della funzione e uno spazio dovrebbe seguire una virgola. Ciò rende il codice più leggibile.


|--
|--
|[[Template:CodeDownload|CodeDownload]]
|[[Template:CodeDownload|CodeDownload]]
|{{CodeDownload|https://wiki.freecad.org/Main_Page|Some label}}
|{{CodeDownload|https://wiki.freecad.org/Main_Page|Some label}}
|Use it to create a link on a [[Macros|macro]] page.
|Utilizzato per creare un collegamento su una pagina di una [[Macros/it|macro]].


|--
|--
|[[Template:Codeextralink|Codeextralink]]
|[[Template:Codeextralink|Codeextralink]]
|{{Codeextralink|https://wiki.freecad.org/Main_Page}}
|{{Codeextralink|https://wiki.freecad.org/Main_Page}}
|Use it if the code of a [[Macros|macro]] is too large to be hosted on the Wiki. The code can then be hosted somewhere else, and the raw link to it specified with this template. The [[Std_AddonMgr|Addon Manager]] will use this link.
|Utilizzato se il codice di una [[Macro/it|macro]] è troppo grande per essere ospitato sul Wiki. Il codice può quindi essere ospitato da qualche altra parte e il collegamento non elaborato ad esso può essere specificato con questo modello. [[Std_AddonMgr/it|Addon Manager]] utilizzerà questo collegamento.


|--
|--
|[[Template:Fake heading|Fake heading]]
|[[Template:Fake heading|Fake heading]]
|{{Fake heading|Heading|2}}
|{{Fake heading|Heading|2}}
|Utilizzato per creare un'intestazione che non verrà inclusa automaticamente nel sommario.
|Use it to create a heading that will not be automatically included in the table of contents.


|--
|--
|[[Template:GuiCommand|GuiCommand]]
|[[Template:GuiCommand|GuiCommand]]
|See [[GuiCommand model|GuiCommand model]]
|See [[GuiCommand model|GuiCommand model]]
|Utilizzato per creare un riquadro con informazioni utili per documentare i comandi dell'ambiente di lavoro (strumenti).
|Use it to create a box with useful information to document workbench commands (tools).


|--
|--
|[[Template:TutorialInfo|TutorialInfo]]
|[[Template:TutorialInfo|TutorialInfo]]
|See for example [[Basic_modeling_tutorial|Basic modeling tutorial]]
|See for example [[Basic_modeling_tutorial|Basic modeling tutorial]]
|Use it to create a box with useful information to document [[Tutorials|tutorials]].
|Utilizzato per creare un box con informazioni utili per documentare i [[Tutorials/it|tutorial]].


|--
|--
|[[Template:Macro|Macro]]
|[[Template:Macro|Macro]]
|See for example [[Macro_FlattenWire|Macro FlattenWire]]
|See for example [[Macro_FlattenWire|Macro FlattenWire]]
|Utilizzato per creare un box con informazioni utili per documentare le [[Macros/it|macro]].
|Use it to create a box with useful information to document [[macros|macros]].


|--
|--
|[[Template:Docnav|Docnav]]
|[[Template:Docnav|Docnav]]
|{{Docnav|Online Help Startpage|Feature list}}
|{{Docnav|Online Help Startpage|Feature list}}
|Utilizzato per creare una barra con frecce e collegamenti appropriati, adatto a disporre le pagine in una sequenza particolare.
|Use it to create a bar with arrows and appropriate links, which is useful for putting pages in a particular sequence.


|--
|--
|[[Template:VeryImportantMessage|VeryImportantMessage]]
|[[Template:VeryImportantMessage|VeryImportantMessage]]
|{{VeryImportantMessage|Important Message}}
|{{VeryImportantMessage|Important Message}}
|Utilizzato per creare una casella evidenziata con un messaggio molto importante. Utilizzare con parsimonia, solo per indicare gravi problemi nella funzionalità del software, interruzione degli strumenti e cose simili.
|Use it to create a highlighted box with a very important message. Use sparingly, only to indicate major problems in the functionality of the software, discontinuation of tools, and similar.


|--
|--
|[[Template:Page in progress|Page in progress]]
|[[Template:Page in progress|Page in progress]]
|{{Page in progress|Page in progress}}
|{{Page in progress|Page in progress}}
|Utilizzato per le pagine che sono ancora in elaborazione o che sono attualmente in fase di rielaborazione. Non dimenticarsi di rimuoverlo quando la pagina è completata.
|Use this for pages that are still in progress or that are currently being reworked. Don't forget to remove this when the page is ready.


|--
|--
|[[Template:UnfinishedDocu|UnfinishedDocu]]
|[[Template:UnfinishedDocu|UnfinishedDocu]]
|{{UnfinishedDocu}}
|{{UnfinishedDocu}}
|Utilizzato per creare una casella evidenziata che indica una pagina di documentazione incompleta.
|Use it to create a highlighted box indicating an unfinished documentation page.


|--
|--
|[[Template:Softredirect|Softredirect]]
|[[Template:Softredirect|Softredirect]]
|
|
|Utilizzato al posto del reindirizzamento normale, quando si sta reindirizzando a una pagina speciale (come Media: o Categoria:), nei quali casi il reindirizzamento normale è disabilitato.
|Use it instead of the normal redirect, when you are redirecting to a special page (such as Media: or Category:), in which cases the normal redirect is disabled.


|--
|--
|[[Template:Quote|Quote]]
|[[Template:Quote|Quote]]
|{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=William Shakespeare|source=''Julius Caesar'', act III, scene I}}
|{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=William Shakespeare|source=''Julius Caesar'', act III, scene I}}
|Utilizzato per creare una casella di testo con una citazione letterale e un riferimento.
|Use it to create a box of text with a literal quote and reference.


|--
|--
|[[Template:Userdocnavi|Userdocnavi]], [[Template:Powerdocnavi|Powerdocnavi]]
|[[Template:Userdocnavi|Userdocnavi]], [[Template:Powerdocnavi|Powerdocnavi]]
|
|
|Utilizzati per creare caselle di navigazione per la documentazione per l'utente, la documentazione per utenti esperti e la documentazione per sviluppatori. Ciò consente di saltare rapidamente tra le diverse sezioni della documentazione. Inoltre inseriscono la pagina corrispondente nella categoria corretta.
|Use them to create navigation boxes for the user documentation, the power user documentation, and the developer documentation. This allows quickly jumping between different sections of the documentation. They also place the corresponding page in the proper category.


|}
|}
Line 411: Line 413:
<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">


== Graphics ==
<span id="Graphics"></span>
== Grafica ==
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
Immagini e screenshot sono necessari per produrre una documentazione completa di FreeCAD. Sono particolarmente utili per illustrare esempi e tutorial. Le immagini devono essere mostrate nella loro dimensione originale, in modo che presentino dettagli sufficienti e siano leggibili se includono testo. Le immagini [[bitmap/it|Bitmap]] non devono essere ridimensionate.
Images and screenshots are necessary to produce a complete documentation of FreeCAD. They are particularly useful to illustrate examples and tutorials. Images should be shown in their original size, so they present sufficient detail and are readable if they include text. [[bitmap|Bitmap]] images should not be resized.


Evitare le immagini animate (GIF) nelle pagine generiche di aiuto. Le animazioni e i video devono essere riservati ai tutorial non destinati a essere utilizzati come documentazione PDF offline.
Avoid animated pictures (GIF) in the general help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation.


Images can be uploaded through the [[Special:Upload|Special:Upload]] page.
Le immagini possono essere caricate tramite la pagina [[Special:Upload/it|Special:Upload]].


<span id="Name"></span>
=== Name ===
=== Nome ===


Give meaningful names to your images. If you have an image that showcases the characteristics of a particular command, you should use the name of that command with {{incode|_example}} at the end. For example for the command [[Draft_Offset|Draft Offset]] the image should be called {{incode|Draft_Offset_example.png}}.
Dare nomi significativi alle proprie immagini. Se si ha un'immagine che mostra le caratteristiche di un particolare comando, si dovrebbe usare il nome di quel comando con {{incode|_example}} alla fine. Ad esempio per il comando [[Draft_Offset/it|Draft Offset]] l'immagine dovrebbe essere chiamata {{incode|Draft_Offset_example.png}}.


<span id="Screen_capture"></span>
=== Screen capture ===
=== Istantanee dello schermo ===


Le dimensioni consigliate per le istantanee dello schermo sono:
Recommended sizes for screen captures are:
* Native 400x200 (or width=400 and height<=200), for [[GuiCommand_model|command reference]] pages, to allow the picture to fit in the left part of the page, and for other standard snapshots.
* Nativo 400x200 (o larghezza=400 e altezza<=200), per le pagine di [[GuiCommand_model/it|riferimento dei comandi]], per consentire all'immagine di adattarsi alla parte sinistra della pagina e per altre istantanee standard.
* Native 600x400 (or width=600 and height<=400), for [[GuiCommand_model|command reference]] pages, when you really need a bigger picture, and still allow the picture to fit in the left part of the page, and for other standard snapshots.
* Nativo 600x400 (o larghezza=600 e altezza<=400), per le pagine di [[GuiCommand_model|riferimento dei comandi]], quando si ha davvero bisogno di un'immagine più grande e si consente comunque all'immagine di adattarsi alla parte sinistra della pagina e per altre istantanee standard.
* Native 1024x768 (or width=1024 and height<=768), only for full screen images.
* 1024x768 nativo (o larghezza=1024 e altezza<=768), solo per immagini a schermo intero.
*Sono possibili taglie più piccole quando si mostrano i dettagli.
* Smaller sizes are possible when showing details.
* Evitare immagini con risoluzioni maggiori, poiché non saranno molto trasferibili su altri tipi di display o sulla documentazione PDF stampata.
* Avoid images with larger resolutions, as they won't be very portable to other kinds of displays or the printed PDF documentation.


Non si dovrebbe dipendere da una configurazione personalizzata del proprio desktop o sistema operativo quando si creano schermate e si dovrebbero utilizzare le impostazioni visive predefinite dell'interfaccia di FreeCAD quando possibile.
You shouldn't depend on a custom configuration of your desktop or operating system when you create screenshots and you should use the visual defaults of the FreeCAD interface whenever possible.


To create a screenshots you can use the options provided by your operating system, or one of these macros: [[Image:Snip.png|24px]] [[Macro_Snip|Macro Snip]] and [[Image:Macro_Screen_Wiki.png|24px]] [[Macro_Screen_Wiki|Macro Screen Wiki]].
Per creare uno screenshot si possono utilizzare le opzioni fornite dal proprio sistema operativo, oppure una di queste macro: [[Image:Snip.png|24px]] [[Macro_Snip/it|Macro Snip]] e [[Image:Macro_Screen_Wiki.png|24px ]] [[Macro_Screen_Wiki/it|Macro Screen Wiki]].


<span id="Text"></span>
=== Text ===
=== Testo ===


Per facilitare le traduzioni della documentazione, cercare di evitare screenshot che contengono testo. Se non lo si può evitare, prendere in considerazione l'idea di acquisire screenshot separati dell'interfaccia e della [[3D_view/it|Vista 3D]]. L'immagine della vista 3D può essere riutilizzata in ogni traduzione, mentre un traduttore può, se necessario, acquisire uno screenshot dell'interfaccia localizzata.
To ease documentation translations, try to avoid screenshots that contain texts. If you cannot avoid this, consider taking separate screenshots of the interface and the [[3D_view|3D view]]. The image of the 3D view can be reused in every translation, while a translator can take a screenshot of the localized interface if necessary.


<span id="Icons_and_graphics"></span>
=== Icons and graphics ===
=== Icone e grafica ===


Refer to the [[Artwork|Artwork]] page for all artwork and icons that have been created for FreeCAD, and which can also be used in documentation pages. If you would like to contribute icons, please read the [[Artwork_Guidelines|Artwork Guidelines]].
Fare riferimento alla pagina [[Artwork/it|Artwork]] per tutti gli elementi grafici e le icone che sono state create per FreeCAD e che possono essere utilizzate anche nelle pagine di documentazione. Se si desidera contribuire alle icone, leggere le [[Artwork_Guidelines/it|Linee guida per le Artwork]].
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->
Line 448: Line 455:
<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">


== Translations ==
<span id="Translations"></span>
== Traduzioni ==
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
Per consenso generale, la pagina di riferimento nel wiki è la pagina in inglese, che dovrebbe venire creata per prima. Se si desidera modificare o aggiungere contenuto a una pagina, si dovrebbe farlo prima sulla pagina inglese e, solo una volta completato l'aggiornamento, trasferire la modifica sulla pagina tradotta.
As per general consensus, the reference page in the wiki is the English page, which should be created first. If you want to change or add content to a page, you should do it to the English page first, and only once the update is completed, port the modification to the translated page.


The FreeCAD wiki supports a translation extension that allows managing translations between pages easier; for details, see [[Localisation#Translating the wiki|Localisation Translating the wiki]].
Il wiki di FreeCAD supporta un'estensione di traduzione che consente di gestire più facilmente le traduzioni tra le pagine; per i dettagli, vedere [[Localisation/it#Tradurre_il_wiki|Tradurre il wiki]].


Altre risorse utili sono:
Other useful resources are:
* [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO language codes] to identify the two-letter code for a particular language that you want to translate to.
* [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO language codes] per identificare il codice di due lettere per una particolare lingua in cui si desidera tradurre.
* [http://translate.google.com/ Google Translate] for help with translations.
* [http://translate.google.com/ Google Translate] per l'aiuto con le traduzioni.
* [https://www.deepl.com/translator Deepl translator] for help with translations.
* [https://www.deepl.com/translator Deepl translator] per l'aiuto con le traduzioni.


<span id="Some_tips_for_translators"></span>
== Some tips for translators ==
== Alcuni consigli per i traduttori ==


<span id="Translate_GuiCommand"></span>
=== Translate GuiCommand ===
=== Tradurre GuiCommand ===


<pre>
<pre>
Line 474: Line 484:
</pre>
</pre>


Tradotto:
Translated:


<pre>
<pre>
Line 488: Line 498:
</pre>
</pre>


<span id="Translate_navi"></span>
=== Translate navi ===
=== Tradurre navi ===


<pre>
<pre>
Line 494: Line 505:
</pre>
</pre>


Tradotto:
Translated:


<pre>
<pre>
Line 500: Line 511:
</pre>
</pre>


<span id="Translate_link"></span>
=== Translate link ===
=== Tradurre link ===


<pre>
<pre>
Line 506: Line 518:
</pre>
</pre>


Tradotto:
Translated:


<pre>
<pre>
Line 512: Line 524:
</pre>
</pre>


<span id="Translate_Docnav"></span>
=== Translate Docnav ===
=== Tradurre Docnav ===


<pre>
<pre>
Line 521: Line 534:
</pre>
</pre>


Tradotto:
Translated:


<pre>
<pre>
Line 530: Line 543:
</pre>
</pre>


Esempio con le icone:
Example with icons:


<pre>
<pre>
Line 543: Line 556:
</pre>
</pre>


Tradotto:
Translated:


<pre>
<pre>
Line 559: Line 572:
</div> <!-- END of Translation section collapsible element. Do not remove! -->
</div> <!-- END of Translation section collapsible element. Do not remove! -->


<span id="Create,_rename_and_delete_pages"></span>
== Create, rename and delete pages ==
== Creare, rinominare ed eliminare le pagine ==


<span id="Create_pages"></span>
=== Create pages ===
=== Creare pagine ===


Before creating a new page you should first check if a similar page already exists. If that is the case it is usually better to edit that existing page instead. When in doubt please open a topic in the [https://forum.freecadweb.org/viewforum.php?f=21 Wiki forum] first.
Prima di creare una nuova pagina si dovrebbe prima verificare se esiste già una pagina simile. In questo caso, di solito è meglio prima modificare la pagina esistente. In caso di dubbi, aprire prima un topic nel [https://forum.freecadweb.org/viewforum.php?f=21 forum delle Wiki].


Per creare una nuova pagina, effettuare una delle seguenti operazioni:
To create a new page do one of the following:
* Visit the URL with the desired page name, for example: <code><nowiki>https://wiki.freecadweb.org/My_New_Page</nowiki></code>, and click on 'create this page'.
* Visitare l'URL con il nome della pagina desiderata, ad esempio: <code><nowiki>https://wiki.freecadweb.org/My_New_Page</nowiki></code>, e fare clic su 'create this page'.
* Do a wiki search for the page name, and click on the red text in 'Create the page "My New Page" on this wiki!'.
* Effettuare una ricerca nel wiki per il nome della pagina e fare clic sul testo in rosso in 'Create the page "My New Page" on this wiki!'.


<span id="Rename_pages"></span>
=== Rename pages ===
=== Rinominare le pagine ===


Since FreeCAD is a project under permanent development, it is sometimes necessary to revise the content of the wiki. If the names of commands are changed in the source code, the wiki pages documenting them have to be renamed as well. This can only be done by wiki administrators. To inform them, open a topic in the [https://forum.freecadweb.org/viewforum.php?f=21 Wiki forum] and list the necessary renaming operation in this form:
Poiché FreeCAD è un progetto in costante sviluppo, a volte è necessario rivedere il contenuto del wiki. Se i nomi dei comandi vengono modificati nel codice sorgente, anche le pagine wiki che li documentano dovranno essere rinominate. Questo può essere fatto solo dagli amministratori del wiki. Per informarli, aprire un argomento nel [https://forum.freecadweb.org/viewforum.php?f=21 Forum delle Wiki] ed elencare l'operazione di ridenominazione necessaria in questo modulo:


<pre>
<pre>
Line 580: Line 596:
</pre>
</pre>


<span id="Delete_files_and_pages"></span>
=== Delete files and pages ===
=== Eliminare file e pagine ===


In case you need to delete a file, go to its page (<code><nowiki>https://www.freecadweb.org/wiki/File:***.***</nowiki></code>) and edit it. No matter if the page is blank or not, add this as the first element: <code><nowiki>{{Delete}}</nowiki></code> and directly below it describe why the page should be deleted. Additionally, open a topic in the [https://forum.freecadweb.org/viewforum.php?f=21 Wiki forum].
Nel caso in cui sia necessario eliminare un file, andare alla relativa pagina (<code><nowiki>https://www.freecadweb.org/wiki/File:***.***</nowiki></code>) e modificarlo. Non importa se la pagina è vuota o meno, aggiungere quanto segue come primo elemento: <code><nowiki>{{Delete}}</nowiki></code> e direttamente sotto descrivere il motivo per cui la pagina dovrebbe essere eliminata. Inoltre, aprire un topic nel [https://forum.freecadweb.org/viewforum.php?f=21 Forum delle Wiki].


Per le pagine la procedura è la stessa.
For pages the procedure is the same.


== Discussion ==
<span id="Discussion"></span>
== Discussioni ==


The [http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki subforum] in the [https://forum.freecadweb.org FreeCAD forum] provides a dedicated space for discussing wiki topics, the wiki appearance and anything else related to the wiki. Direct your questions and suggestions there.
Il [http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki subforum] nel [https://forum.freecadweb.org Forum di FreeCAD] fornisce uno spazio dedicato per discutere argomenti wiki, l'aspetto delle wiki e qualsiasi altra cosa relativa al wiki. Indirizzare lì le proprie domande e i suggerimenti.


<span id="Terminology_-_naming_policy"></span>
== Terminology - naming policy ==
== Terminologia - politica di denominazione ==


=== English ===
<span id="English"></span>
=== Inglese ===


See [[Glossary|Glossary]].
Vedere il [[Glossary/it|Glossario]].


<span id="Other_languages"></span>
=== Other languages ===
=== Altre lingue ===


* [[Italian_Translation|Italiano]]
* [[Italian_Translation|Italiano]]

Latest revision as of 07:50, 12 May 2024

Questa pagina è un'estensione della pagina Help:Editing e fornisce linee guida comuni per scrivere e aggiornare la documentazione wiki di FreeCAD. Riassume diverse discussioni e sessioni di brainstorming

Prima di iniziare

  • Questa documentazione wiki è basata su MediaWiki, lo stesso software con cui è realizzata Wikipedia. Se si ha contribuito a Wikipedia, modificare le pagine wiki di FreeCAD dovrebbe essere facile.
  • Contrariamente a Wikipedia, la wiki di FreeCAD è protetta da scrittura per evitare spam. È necessario richiedere un account sul forum.
  • Se non si ha mai utilizzato il software wiki prima, leggere Help:Editing per acquisire familiarità con il markup utilizzato.
  • Per un utilizzo avanzato del software wiki, vedere MediaWiki Help:Contents. Non tutte le funzionalità di MediaWiki sono disponibili in questo wiki di FreeCAD, ma molte lo sono.
  • Si è intenzionati a mantenere la documentazione facile da leggere, quindi si dovrebbe evitare di utilizzare funzionalità complesse. Mantenerlo semplice.
  • Utilizzare una sandbox per testare il codice, ad esempio, FreeCADDocu:Sandbox o una pagina personale con il proprio nome Sandbox:Yourname. Le pagine Sandbox devono essere inserite nella categoria Sandbox. Questo viene fatto aggiungendo [[Category:Sandbox]] in fondo al codice wiki.
  • Si prega di fare attenzione alle traduzioni. Il wiki di FreeCAD utilizza il supporto della traduzione automatizzata per fornire pagine in molte lingue. Per ogni pagina possono esistere versioni in più lingue. In molte pagine ci saranno tag come <translate>...</translate> e molti tag singoli come <!--T:8-->. Questi ultimi contrassegnano le cosiddette unità di traduzione e vengono creati dal sistema di traduzione, non andrebbero mai creati manualmente. Collegano i titoli e i paragrafi alle loro versioni tradotte. Non vanno cambiati perché ciò distruggerebbe i collegamenti. È comunque possibile spostare paragrafi o modificare il testo purché i tag rimangano con essi. Se si rimuove un'intestazione o un paragrafo andrebbe rimosso anche il tag che gli appartiene. Tenere presente che le modifiche ai titoli e ai paragrafi esistenti influiscono sulle traduzioni esistenti. Le modifiche dovrebbero valerne la pena. Non preoccuparsi di aggiungere nuovo materiale perché il sistema aggiungerà automaticamente i nuovi tag dopo le modifiche. Per ulteriori informazioni vedere Localizzazione e la Mediawiki:Extension:Translate pagina originale.

Linee guida generali

Descrizioni concise

Quando si descrive FreeCAD si deve cercare di essere concisi e diretti ed evitare ripetizioni. Descrivere cosa fa FreeCAD, non cosa non fa FreeCAD. Evitare anche espressioni colloquiali come "una coppia". Utilizzare "alcuni" quando si ha a che fare con un numero indeterminato o specificare la quantità corretta.

Descrizione errata
Ambiente PartDesign: PartDesign è un ambiente di lavoro per la progettazione di parti che mira a fornire strumenti per la modellazione di parti solide complesse.
Descrizione corretta
Ambiente PartDesign: mira a fornire strumenti per la modellazione di parti solide complesse.

Informazioni centralizzate

Evitare di duplicare le stesse informazioni in luoghi diversi. Inserire le informazioni in una nuova pagina e collegarsi a questa pagina da altre pagine che richiedono queste informazioni.

Non utilizzare la transclusione delle pagine (Help:Editing#Templates and transclosure pagine), poiché ciò rende difficile la traduzione del wiki. Utilizzare solo i modelli descritti di seguito in #Templates.

Stile

I modelli vengono utilizzati per definire lo stile delle pagine della guida. Conferiscono alla documentazione un aspetto coerente. C'è un modello per i comandi di menu, File → Salva, un modello per definire lo stile dei tasti da premere, Shift, per mostrare un valore booleano, true, ecc. Per favore acquisire familiarità con la sezione #Templates prima di scrivere pagine di aiuto.

Flag temporanei

Se si sta lavorando su una pagina di grandi dimensioni è consigliabile contrassegnare la pagina come work in progress o come incompiuta. Ciò garantisce che gli amministratori wiki non contrassegnino la tua pagina come pronta per la traduzione mentre la si sta ancora modificando.

Per contrassegnare una pagina, aggiungere come prima linea {{Page in progress}} o {{UnfinishedDocu}}. Con {{UnfinishedDocu}} si invitano gli altri a collaborare per finire la pagina, mentre {{Page in progress}} indica che si svolgerà il lavoro da solo e che gli altri dovrebbero lasciarti un po' di tempo.

Una volta terminato il lavoro, non dimenticare di rimuovere i flag!

Esempi

Per acquisire rapidamente familiarità con la struttura e lo stile del wiki di FreeCAD, guardare la pagina del modello: modello di base.

Struttura

L'Hub degli utenti fornisce un Sommario. Viene utilizzato come riferimento principale per creare automaticamente la guida offline raggiungibile da FreeCAD, nonché la documentazione PDF offline.

Il Template:Docnav viene utilizzato per collegare in sequenza le pagine, seguendo la struttura del Sommario. Vedere #Templates per un elenco di tutti i modelli.

Nomi delle pagine

I nomi delle pagine dovrebbero essere brevi e dovrebbero usare le maiuscole: ogni parola dovrebbe iniziare con una lettera maiuscola, a meno che non si tratti di articoli, preposizioni, congiunzioni o altre particelle grammaticali (ad esempio 'di', 'su', 'in', 'a ', 'uno', 'e').

Nome della pagina errato
Construction of AeroCompany airplanes
Nome della pagina corretto
Construction of AeroCompany Airplanes

I nomi delle pagine dell'ambiente di lavoro del livello superiore devono avere questo formato: XYZ Workbench, dove XYZ è il nome del workbench, ad esempio PartDesign Workbench. E i nomi delle pagine che descrivono i comandi (o strumenti) appartenenti a un ambiente devono avere questo formato: Comando XYZ, ad esempio PartDesign Pad. Tenere presente che si dovrebbe utilizzare il nome del comando così come appare nel codice sorgente.

Intestazioni

I titoli dei paragrafi dovrebbero essere brevi e utilizzare maiuscole e minuscole: tutte le parole, tranne la prima e i nomi propri, dovrebbero essere in minuscolo. Non si dovrebbero utilizzare le intestazioni H1 (= Heading =) nel markup della wiki, in quanto nel titolo della pagina viene aggiunto automaticamente come intestazione principale H1.

Link

Si dovrebbe utilizzare il nome del collegamento originale per i collegamenti quando possibile. Questo rende più evidente la pagina di riferimento nella documentazione stampata oppure offline. Si prega di evitare parole prive di significato per il collegamento.

Collegamento errato
Per ulteriori informazioni sul disegno di oggetti 2D, fare clic qui.
Collegamento corretto
Per ulteriori informazioni sul disegno di oggetti 2D fare riferimento a Draft.

Il formato preferito per un collegamento è:

[[Name_of_Page/it|Name of Page]]

Tradotto

[[Name_of_Page/fr|Nom de la Page]]

Tenere presente che per la parte prima del carattere |, ovvero il link effettivo, è rilevante la distinzione tra maiuscole e minuscole. Se il nome della pagina è Name_of_page il collegamento non funzionerà se si digita Name_of_Page (P maiuscola). Prima del carattere | tutti gli spazi devono essere sostituiti da trattini bassi (_). Questo serve per aiutare i traduttori che utilizzano software di traduzione, senza i caratteri di sottolineatura il collegamento verrebbe tradotto dal software, il che è indesiderabile.

Per collegarsi a un determinato paragrafo aggiungere un segno # e le sue intestazioni al nome della pagina. Esempio:

[[WikiPages#Links|WikiPages]]

Tradotto

[[WikiPages/fr#Liens|WikiPages]]

All'interno della stessa pagina si può omettere il nome della pagina. Esempio:

[[#Links|Links]]

Per collegarsi alla parte superiore della pagina è possibile utilizzare:

</translate>{{Top}}<translate>

Questo template dovrebbe visualizzare automaticamente il testo corretto a seconda della lingua della pagina. Un collegamento alla parte superiore della pagina è particolarmente utile per le pagine lunghe poiché consente all'utente di tornare rapidamente al sommario. Lo si può mettere alla fine di ogni paragrafo. Assicurarsi che ci sia una riga vuota prima e dopo il template.

Collegamento a una immagine
Testo facoltativo che viene mostrato quando passi il mouse sull'immagine

Per utilizzare un'immagine come collegamento:

[[Image:Draft_Wire.svg|24px|Testo facoltativo che viene mostrato quando passi il mouse sull'immagine|link=Draft_Wire]]

Immagine del Collegamento + testo del collegamento
Draft Wire

Se si tralascia il testo facoltativo, il collegamento stesso verrà mostrato quando si passa sull'immagine, il che è preferibile, e si dovrebbe anche aggiungere un collegamento testuale dopo il collegamento dell'immagine:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]

Pagine degli Ambienti di lavoro

Una pagina dell'ambiente di livello superiore dovrebbe iniziare con:

  • Una descrizione dello scopo per cui viene utilizzato l'ambiente.
  • Un'immagine per illustrarne la descrizione.

Vedere #Istantanee dello schermo per le convenzioni su come inserire le immagini.

Pagine dei comandi

Le pagine dei comandi che descrivono gli strumenti dell'ambiente di lavoro non dovrebbero essere troppo lunghe, dovrebbero solo spiegare cosa può fare un comando e cosa no, e come usarlo. Si dovrebbe ridurre al minimo le immagini e gli esempi. I tutorial si possono espandere riguardo l'utilizzo dello strumento e fornire dettagli passo passo.

Per ulteriori dettagli, fare riferimento alla pagina dei Modelli per la descrizione dei comandi.

Tutorial

Un tutorial ben scritto dovrebbe insegnare come ottenere rapidamente determinati risultati pratici. Non dovrebbe essere troppo lungo, ma dovrebbe includere immagini e istruzioni passo passo sufficienti per guidare l'utente. Man mano che FreeCAD si evolve, i tutorial potrebbero diventare obsoleti, quindi è importante menzionare la versione di FreeCAD utilizzata o richiesta per un tutorial.

Per esempi visitare la pagina dei Tutorial.

Templates

Lo stile delle pagine wiki di FreeCAD si ottiene attraverso l'uso di modelli (Help:Editing#Templates_and_transcluding_pages). Garantiscono un aspetto standardizzato in tutte le pagine e consentono anche di rimodellare il wiki. È possibile visualizzare l'elenco completo dei modelli definiti accedendo a Special:PrefixIndex/Template:. Si prega tuttavia di utilizzare solo i modelli elencati nelle tabelle seguenti. Solo in casi molto particolari si possono utilizzare direttamente i tag HTML.

Fare clic sul collegamento del modello per visualizzare le istruzioni di utilizzo di un modello e per visualizzarne l'implementazione. I modelli sono una potente funzionalità del software MediaWiki. Si dovrebbe essere un utente wiki esperto per proporre aggiunte e modifiche ai modelli esistenti. Se implementati in modo errato, i template rendono difficile la traduzione delle pagine in altre lingue, quindi il loro utilizzo dovrebbe essere limitato alla formattazione del testo e la transclusione delle pagine dovrebbe essere evitata. Vedere MediaWiki Help:Templates per ulteriori informazioni.

Template semplici

Questi template accettano un parametro semplice di testo e lo formattano con uno stile particolare.

Template Aspetto Descrizione
Top

Inizio

Utilizzato per aggiungere un link che porta all'inizio della pagina.
Emphasis emphasis Utilizzato per enfatizzare una parte di testo.
KEY Alt Utilizzato per indicare un tasto della tastiera che deve essere premuto.
ASCII Utilizzato per indicare un tasto ascii in un'immagine (.svg) che deve essere premuto. E' necessario fornire il carattere desiderato oppure il numero del codice ascii del carattere.
Button Cancel Utilizzato per indicare un pulsante nell'interfaccia utente grafica che deve essere premuto.
RadioButton Option Utilizzato per indicare un pulsante di un'opzione nell'interfaccia utente grafica che deve essere Selezionato o No.
CheckBox Option Utilizzato per indicare una casella di controllo nell'interfaccia utente grafica che deve essere Selezionata o No.
SpinBox 1.50 Utilizzato per indicare una casella numerica nell'interfaccia utente grafica che può essere modificata.
ComboBox Menu 1 Utilizzato per indicare una casella combinata nell'interfaccia utente grafica che può essere modificata.
LineEdit Metal Nickel (Ni) Utilizzato per indicare un LineEdit nell'interfaccia utente grafica che può essere modificato.
FALSE, false false, false Utilizzato per indicare un valore booleano falso, ad esempio, come proprietà nell'editor delle proprietà. Questa è una scorciatoia. Poiché si tratta di un valore, preferire il Template Value false
TRUE, true true, true Utilizzato per indicare un valore booleano vero, ad esempio, come proprietà nell'editor delle proprietà. Questa è una scorciatoia. Poiché si tratta di un valore, preferire Template Value true
MenuCommand File → Save Utilizzato per indicare la posizione di un comando all'interno di un particolare menu.
FileName File name Utilizzato per indicare il nome di un file o di una cartella.
SystemInput Type this text Utilizzato per indicare il testo di input digitato dall'utente.
SystemOutput Output text Utilizzato per indicare l'output di testo dal sistema.
Incode import FreeCAD Utilizzato per includere il codice sorgente in linea con un carattere a spaziatura fissa. Dovrebbe stare in una riga.
PropertyView VistaColor Utilizzato per indicare una proprietà View nell'editor delle proprietà. Esempi di proprietà di visualizzazione includono Line Color, Line Width, Point Color, Point Size, ecc..
PropertyData DatiPosition Utilizzato per indicare una proprietà Data nell'editor delle proprietà. Le proprietà dei dati sono diverse per i diversi tipi di oggetti.
Properties Title / TitleProperty Base Utilizzato per indicare il titolo di un gruppo di proprietà nell'editor delle proprietà. Il titolo non verrà incluso nel sommario automatico.
Obsolete obsolete in version 0.19 Utilizzato per indicare che una funzionalità è diventata obsoleta nella versione di FreeCAD specificata.
Version introduced in version 0.18 Utilizzato per indicare che una funzionalità è stata introdotta nella versione di FreeCAD specificata.
VersionMinus version 0.16 and below Utilizzato per indicare che una funzionalità è disponibile nella versione di FreeCAD specificata e nelle versioni precedenti.
VersionPlus version 0.17 and above Utilizzato per indicare che una funzionalità è disponibile nella versione di FreeCAD specificata e nelle versioni successive.
ColoredText Colored Text Questo modello è utilizzato per colorare lo sfondo, il testo o lo sfondo e il testo. (Pagina ColoredText per ulteriori esempi)
ColoredParagraph
Colored Paragraph
Questo modello è utilizzato per colorare lo sfondo, il testo o lo sfondo e il testo di un intero paragrafo. (Pagina ColoredParagraph per ulteriori esempi)

Template complessi

Questi template richiedono più parametri di input o producono un blocco di testo con un formato particolare.

Template Aspetto Descrizione
Prettytable This table Utilizzato per formattare tabelle come questa. È possibile aggiungere ulteriori proprietà alla tabella.
Caption

Some caption for an image

Utilizzato per aggiungere una didascalia sotto un'immagine. Può essere allineato a sinistra o al centro.
Clear Utilizato per cancellare le colonne. Seguire la definizione del modello per una spiegazione dettagliata. Viene spesso utilizzato per impedire al testo di scorrere accanto a immagini non correlate.
Code
import FreeCAD
Utilizzato per includere esempi di codice su più righe con un carattere a spaziatura fissa. Il linguaggio predefinito è Python, ma è possibile specificare altri linguaggi.

Il codice Python deve aderire alle raccomandazioni generali stabilite da PEP8: Style Guide for Python Code. In particolare, le parentesi dovrebbero seguire immediatamente il nome della funzione e uno spazio dovrebbe seguire una virgola. Ciò rende il codice più leggibile.

CodeDownload Utilizzato per creare un collegamento su una pagina di una macro.
Codeextralink

Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro


# This code is copied instead of the original macro code
# to guide the user to the online download page.
# Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki
# or if the RAW code URL is somewhere else in the wiki.

from PySide import QtGui, QtCore

diag = QtGui.QMessageBox(QtGui.QMessageBox.Information,
    "Information",
    "This macro must be downloaded from this link\n"
    "\n"
    "https://wiki.freecad.org/Main_Page" + "\n"
    "\n"
    "Quit this window to access the download page")

diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint)
diag.setWindowModality(QtCore.Qt.ApplicationModal)
diag.exec_()

import webbrowser 
webbrowser.open("https://wiki.freecad.org/Main_Page")
<class="rawcodeurl"><a href="https://wiki.freecad.org/Main_Page">raw code</a>
Utilizzato se il codice di una macro è troppo grande per essere ospitato sul Wiki. Il codice può quindi essere ospitato da qualche altra parte e il collegamento non elaborato ad esso può essere specificato con questo modello. Addon Manager utilizzerà questo collegamento.
Fake heading
Heading
Utilizzato per creare un'intestazione che non verrà inclusa automaticamente nel sommario.
GuiCommand See GuiCommand model Utilizzato per creare un riquadro con informazioni utili per documentare i comandi dell'ambiente di lavoro (strumenti).
TutorialInfo See for example Basic modeling tutorial Utilizzato per creare un box con informazioni utili per documentare i tutorial.
Macro See for example Macro FlattenWire Utilizzato per creare un box con informazioni utili per documentare le macro.
Docnav
Online Help Startpage
Feature list
Utilizzato per creare una barra con frecce e collegamenti appropriati, adatto a disporre le pagine in una sequenza particolare.
VeryImportantMessage
Important Message
Utilizzato per creare una casella evidenziata con un messaggio molto importante. Utilizzare con parsimonia, solo per indicare gravi problemi nella funzionalità del software, interruzione degli strumenti e cose simili.
Page in progress
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.
Utilizzato per le pagine che sono ancora in elaborazione o che sono attualmente in fase di rielaborazione. Non dimenticarsi di rimuoverlo quando la pagina è completata.
UnfinishedDocu

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Utilizzato per creare una casella evidenziata che indica una pagina di documentazione incompleta.
Softredirect Utilizzato al posto del reindirizzamento normale, quando si sta reindirizzando a una pagina speciale (come Media: o Categoria:), nei quali casi il reindirizzamento normale è disabilitato.
Quote

Cry "Havoc" and let slip the dogs of war.

—William Shakespeare, Julius Caesar, act III, scene I
Utilizzato per creare una casella di testo con una citazione letterale e un riferimento.
Userdocnavi, Powerdocnavi Utilizzati per creare caselle di navigazione per la documentazione per l'utente, la documentazione per utenti esperti e la documentazione per sviluppatori. Ciò consente di saltare rapidamente tra le diverse sezioni della documentazione. Inoltre inseriscono la pagina corrispondente nella categoria corretta.

Grafica

Immagini e screenshot sono necessari per produrre una documentazione completa di FreeCAD. Sono particolarmente utili per illustrare esempi e tutorial. Le immagini devono essere mostrate nella loro dimensione originale, in modo che presentino dettagli sufficienti e siano leggibili se includono testo. Le immagini Bitmap non devono essere ridimensionate.

Evitare le immagini animate (GIF) nelle pagine generiche di aiuto. Le animazioni e i video devono essere riservati ai tutorial non destinati a essere utilizzati come documentazione PDF offline.

Le immagini possono essere caricate tramite la pagina Special:Upload.

Nome

Dare nomi significativi alle proprie immagini. Se si ha un'immagine che mostra le caratteristiche di un particolare comando, si dovrebbe usare il nome di quel comando con _example alla fine. Ad esempio per il comando Draft Offset l'immagine dovrebbe essere chiamata Draft_Offset_example.png.

Istantanee dello schermo

Le dimensioni consigliate per le istantanee dello schermo sono:

  • Nativo 400x200 (o larghezza=400 e altezza<=200), per le pagine di riferimento dei comandi, per consentire all'immagine di adattarsi alla parte sinistra della pagina e per altre istantanee standard.
  • Nativo 600x400 (o larghezza=600 e altezza<=400), per le pagine di riferimento dei comandi, quando si ha davvero bisogno di un'immagine più grande e si consente comunque all'immagine di adattarsi alla parte sinistra della pagina e per altre istantanee standard.
  • 1024x768 nativo (o larghezza=1024 e altezza<=768), solo per immagini a schermo intero.
  • Sono possibili taglie più piccole quando si mostrano i dettagli.
  • Evitare immagini con risoluzioni maggiori, poiché non saranno molto trasferibili su altri tipi di display o sulla documentazione PDF stampata.

Non si dovrebbe dipendere da una configurazione personalizzata del proprio desktop o sistema operativo quando si creano schermate e si dovrebbero utilizzare le impostazioni visive predefinite dell'interfaccia di FreeCAD quando possibile.

Per creare uno screenshot si possono utilizzare le opzioni fornite dal proprio sistema operativo, oppure una di queste macro: Macro Snip e Macro Screen Wiki.

Testo

Per facilitare le traduzioni della documentazione, cercare di evitare screenshot che contengono testo. Se non lo si può evitare, prendere in considerazione l'idea di acquisire screenshot separati dell'interfaccia e della Vista 3D. L'immagine della vista 3D può essere riutilizzata in ogni traduzione, mentre un traduttore può, se necessario, acquisire uno screenshot dell'interfaccia localizzata.

Icone e grafica

Fare riferimento alla pagina Artwork per tutti gli elementi grafici e le icone che sono state create per FreeCAD e che possono essere utilizzate anche nelle pagine di documentazione. Se si desidera contribuire alle icone, leggere le Linee guida per le Artwork.

Traduzioni

Per consenso generale, la pagina di riferimento nel wiki è la pagina in inglese, che dovrebbe venire creata per prima. Se si desidera modificare o aggiungere contenuto a una pagina, si dovrebbe farlo prima sulla pagina inglese e, solo una volta completato l'aggiornamento, trasferire la modifica sulla pagina tradotta.

Il wiki di FreeCAD supporta un'estensione di traduzione che consente di gestire più facilmente le traduzioni tra le pagine; per i dettagli, vedere Tradurre il wiki.

Altre risorse utili sono:

Alcuni consigli per i traduttori

Tradurre GuiCommand

{{GuiCommand
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

Tradotto:

{{GuiCommand/fr
|Name=FEM EquationFlux
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}

Tradurre navi

{{FEM_Tools_navi}}

Tradotto:

{{FEM_Tools_navi/fr}}

Tradurre link

[[Part_Module|Part Module]]

Tradotto:

[[Part_Module/fr|Atelier Part]]

Tradurre Docnav

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

Tradotto:

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Esempio con le icone:

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Tradotto:

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Creare, rinominare ed eliminare le pagine

Creare pagine

Prima di creare una nuova pagina si dovrebbe prima verificare se esiste già una pagina simile. In questo caso, di solito è meglio prima modificare la pagina esistente. In caso di dubbi, aprire prima un topic nel forum delle Wiki.

Per creare una nuova pagina, effettuare una delle seguenti operazioni:

  • Visitare l'URL con il nome della pagina desiderata, ad esempio: https://wiki.freecadweb.org/My_New_Page, e fare clic su 'create this page'.
  • Effettuare una ricerca nel wiki per il nome della pagina e fare clic sul testo in rosso in 'Create the page "My New Page" on this wiki!'.

Rinominare le pagine

Poiché FreeCAD è un progetto in costante sviluppo, a volte è necessario rivedere il contenuto del wiki. Se i nomi dei comandi vengono modificati nel codice sorgente, anche le pagine wiki che li documentano dovranno essere rinominate. Questo può essere fatto solo dagli amministratori del wiki. Per informarli, aprire un argomento nel Forum delle Wiki ed elencare l'operazione di ridenominazione necessaria in questo modulo:

old name         new name
Old_page_name_1  New_page_name_1
Old_page_name_2  New_page_name_2
...

Eliminare file e pagine

Nel caso in cui sia necessario eliminare un file, andare alla relativa pagina (https://www.freecadweb.org/wiki/File:***.***) e modificarlo. Non importa se la pagina è vuota o meno, aggiungere quanto segue come primo elemento: {{Delete}} e direttamente sotto descrivere il motivo per cui la pagina dovrebbe essere eliminata. Inoltre, aprire un topic nel Forum delle Wiki.

Per le pagine la procedura è la stessa.

Discussioni

Il Development/Wiki subforum nel Forum di FreeCAD fornisce uno spazio dedicato per discutere argomenti wiki, l'aspetto delle wiki e qualsiasi altra cosa relativa al wiki. Indirizzare lì le proprie domande e i suggerimenti.

Terminologia - politica di denominazione

Inglese

Vedere il Glossario.

Altre lingue