WikiPages: Difference between revisions

From FreeCAD Documentation
m (removed obsolete description in relation with 'next' and 'previous')
 
(246 intermediate revisions by 17 users not shown)
Line 1: Line 1:
<languages/>
<noinclude>[[Category:Wiki]]</noinclude>
{{TOCright}}
{{TOCright}}
<translate>
This page gives common guidelines on the best practices to be followed when writing or updating FreeCAD documentation.


<!--T:1-->
It also has the goal to bring together the threads that are dispersed in the forum and try to make order, being a single point of reference for FreeCAD documentation discussion and brainstorming, to better organize the wiki.
This page is an extension of the [[Help:Editing|Help:Editing]] page and gives common guidelines for writing and updating the FreeCAD wiki documentation. It summarizes several discussions and brainstorming sessions


==Before Starting==
== Before starting == <!--T:155-->
This wiki documentation is based on [https://www.mediawiki.org/wiki/MediaWiki MediaWiki], the same software that powers [https://en.wikipedia.org/wiki/Main_Page Wikipedia]. If you have contributed to Wikipedia before, editing FreeCAD wiki pages should be easy.


<!--T:3-->
If you have never used wiki software before, head to [[Help:Editing]] to become familiar with the markup used to edit pages.
* This wiki documentation is based on [https://www.mediawiki.org/wiki/MediaWiki MediaWiki], the same software that powers [https://en.wikipedia.org/wiki/Main_Page Wikipedia]. If you have contributed to Wikipedia, editing FreeCAD wiki pages should be easy.
* Contrary to Wikipedia, the FreeCAD wiki is write-protected to avoid spam. You must request an account [http://forum.freecadweb.org/viewtopic.php?f=21&t=6830 on the forum].
* If you have never used wiki software before, please read [[Help:Editing]] to become familiar with the markup that is used.
* For advanced use of the wiki software, see [https://www.mediawiki.org/wiki/Help:Contents MediaWiki Help:Contents]. Not all features of MediaWiki are available in this FreeCAD wiki, but many are.
* We like to keep the documentation easy to read, so avoid using complex features. Keep it simple.
* Use a sandbox to test your code, for example, [[FreeCADDocu:Sandbox]] or a particular page with your name [[Sandbox:Yourname]]. Sandbox pages must be placed in the Sandbox category. This is done by adding <code><nowiki>[[Category:Sandbox]]</nowiki></code> at the bottom of the wiki code.
* Please be aware of the translations. The FreeCAD wiki uses automated translation support to provide pages in many languages. For every page multiple language versions can exist. On many pages you will see tags like <code>&lt;translate&gt;...&lt;/translate&gt;</code> and many single tags like <code>&lt;!--T:8--&gt;</code>. The latter mark so-called translation units and are created by the translation system, you should never create them manually. They link the headings and paragraphs to their translated versions. You should not change them as that would destroy those links. It is however fine to move paragraphs or change wording as long as the tags stay with them. If you remove a heading or a paragraph you should also remove the tag belonging to it. Please be aware that changes to existing headings and paragraphs affect the current translations. Your changes should be worth it. Do not worry when adding new material because the system will add new tags automatically after your edits. For more information see [[Localisation|Localisation]] and the original [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Mediawiki:Extension:Translate page].


== General guidelines == <!--T:4-->
For advance usage of the wiki software, see [https://www.mediawiki.org/wiki/Help:Contents MediaWiki Help:Contents]. Not all features of MediaWiki are available in this FreeCAD wiki, but many of them are.
We like to keep the documentation simple to read, so avoid using complex features. Keep it simple.


=== Concise descriptions === <!--T:156-->
Use a sandbox to test your code, for example, [[FreeCADDocu:Sandbox]] or a particular page with your name [[Sandbox:Yourname]].


<!--T:5-->
==General Guidelines==
When describing FreeCAD try to be concise and to the point and avoid repetition. Describe what FreeCAD ''does'', not what FreeCAD ''does not do''. Also avoid colloquial expressions such as 'a couple'. Use 'some' when dealing with an indeterminate number, or specify the correct quantity.


<!--T:67-->
===Concise descriptions===
; Bad description
When describing FreeCAD functionality try to be concise and to the point. Describe what FreeCAD ''does'', not what FreeCAD ''does not do''. There might be exceptions for justifying why FreeCAD does not support a certain functionality, for instance, to explain how FreeCAD is different from other CAD systems.
: [[PartDesign_Workbench|PartDesign Workbench]]: the PartDesign Workbench is a workbench for part design that aims to provide tools for modelling complex solid parts.


<!--T:69-->
===Centralized information===
; Good description
: [[PartDesign_Workbench|PartDesign Workbench]]: aims to provide tools for modelling complex solid parts.

=== Centralized information === <!--T:157-->

<!--T:6-->
Avoid duplicating the same information in different places. Insert the information in a new page, and link to this page from other pages that require this information.
Avoid duplicating the same information in different places. Insert the information in a new page, and link to this page from other pages that require this information.


<!--T:7-->
Do not use transclusion of pages ([[Help:Editing#Templates and transcluding pages]]), as this makes the wiki difficult to translate. Use only the templates described below in [[#Templates]].
Do not use transclusion of pages ([[Help:Editing#Templates_and_transcluding_pages|Help:Editing#Templates and transcluding pages]]), as this makes the wiki difficult to translate. Use only the templates described below in [[#Templates|#Templates]].


===Styling===
=== Styling === <!--T:158-->
Templates are used for styling the text used in the help pages.


<!--T:9-->
There is a template for styling menu commands, like {{MenuCommand|File → Save}}, another template to style keys to be pressed, like {{KEY|Shift}}, another template to show a Boolean value {{TRUE}}, etc. This allows the documentation to have a consistent look and feel, as well as being able to be translated without much effort. Please get familiar with the [[#Templates]] section before writing help pages.
Templates are used to style the help pages. They give the documentation a consistent look and feel. There is a template for menu commands, {{MenuCommand|File → Save}}, a template to style keys to be pressed, {{KEY|Shift}}, to show a Boolean value, {{TRUE}}, etc. Please get familiar with the [[#Templates|#Templates]] section before writing help pages.


=== Temporary flags === <!--T:159-->
==Examples==


<!--T:10-->
You can quickly get familiar with the structure and style of the FreeCAD wiki by looking at the following pages, which can be considered reference pages for the rest of the FreeCAD documentation.
If you are working on a large page it is advisable to mark the page either as a work in progress or as unfinished. This assures that wiki admins don't mark your page as ready for translation while you are still changing it.
* [[Draft ShapeString]]
* [[Draft Line]]


<!--T:11-->
==Structure==
To flag a page add either <code><nowiki>{{Page in progress}}</nowiki></code> or <code><nowiki>{{UnfinishedDocu}}</nowiki></code> as the first line. With <code><nowiki>{{UnfinishedDocu}}</nowiki></code> you invite others to join you in finishing the page, while <code><nowiki>{{Page in progress}}</nowiki></code> indicates that you will do the work yourself and others should give you some time.


<!--T:12-->
===General===
Once the work is done, please don't forget to remove the flags!
You should normally not use a '''=header=''' section for a page, since the page title is automatically added.


== Examples == <!--T:13-->
The [[User hub]] provides a [[Online Help Toc|Table of Contents]]; this is used as the main reference for automatically building the offline help you can reach from FreeCAD, as well as the offline PDF documentation.


<!--T:14-->
The [[Template:Docnav]] is used to link to the page before and the page after, according to the structure of the [[Online Help Toc|Table of Contents]].
To quickly get familiar with the structure and style of the FreeCAD wiki look at the model page: [[GuiCommand_model|GuiCommand model]].
See [[#Templates]] for a list of all templates.


</translate>
===Page names===
<div class="mw-collapsible mw-collapsed toccolours">
Page names should be short, and they should use "sentence case", as opposed to "title case". This is the [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Capital_letters#Headings,_headers,_and_captions style used by Wikipedia] for their articles.
<translate>


== Structure == <!--T:15-->
Essentially, all words except the first one and proper names, should be in lowercase.
</translate>
<div class="mw-collapsible-content">
<translate>
<!--T:16-->
The [[User_hub|User hub]] provides a [[Online_Help_Toc|Table of Contents]]. This is used as the main reference for automatically building the offline help you can reach from FreeCAD, as well as the offline PDF documentation.


<!--T:17-->
:{{emphasis|Use:}} Tutorial on the construction of AeroCompany airplanes
The [[Template:Docnav]] is used to sequentially link pages, following the structure of the [[Online_Help_Toc|Table of Contents]]. See [[#Templates|#Templates]] for a list of all templates.
:{{emphasis|Avoid:}} Tutorial On The Construction Of AeroCompany Airplanes


=== Page names === <!--T:160-->
{{emphasis|Note:}} a previous convention was to use title case; every word should begin with a capital letter, unless they are articles, prepositions, conjunctions, or other grammatical particles, that is, "of, on, in, a, an, and", etc. There are many pages using this style, but this is discouraged for new pages. This is discussed in the forum thread [https://forum.freecadweb.org/viewtopic.php?p=266029#p266029 (Lowercase links) Use a lower case title for a wiki page].


<!--T:18-->
===Page names for tools===
Page names should be short and they should use title case: every word should begin with a capital letter, unless they are articles, prepositions, conjunctions, or other grammatical particles (f.e. 'of', 'on', 'in', 'a', 'an', 'and').
The top level workbench page must have the format '''XYZ Workbench''', where '''XYZ''' is the name of the workbench.


<!--T:20-->
Pages describing the tools ([[Gui Command]]s) of the workbench must have the format '''XYZ Tool''', where '''Tool''' is the name of the specific tool.
; Bad page name:
: Construction of AeroCompany airplanes


<!--T:161-->
====Bad name====
; Good page name:
*[[Working with architectural objects]]
: Construction of AeroCompany Airplanes
*[[Working with architectural walls]]
*[[Drafting 2D objects]]
*[[Tool: building a line between two points]]


<!--T:22-->
====Good name====
The names of top level workbench pages must have this format: <code>XYZ Workbench</code>, where <code>XYZ</code> is the name of the workbench, for example [[PartDesign_Workbench|PartDesign Workbench]]. And the names of pages describing the commands (or tools) belonging to a workbench must have this format: <code>XYZ Command</code>, for example [[PartDesign_Pad|PartDesign Pad]]. Note that you should use the command name as it occurs in the source code.
*[[Arch Workbench]]
*[[Arch Wall]]


=== Headings === <!--T:162-->
*[[Draft Workbench]]
*[[Draft Line]]


<!--T:163-->
===Links===
Paragraph headings should be short and use sentence case: all words except the first one and proper names, should be in lowercase. You should not use <code><nowiki>H1</nowiki></code> headings (<code><nowiki>=&nbsp;Heading&nbsp;=</nowiki></code>) in your wiki markup since the page title is automatically added as the main <code><nowiki>H1</nowiki></code> heading.
You should use the original link name for the links whenever possible. This clarifies the referenced page in printed or offline documentation. You must avoid the usage of non-meaningful words for the link.


====Bad link====
=== Links === <!--T:164-->
*For more information on this topic, click [[Draft Workbench|here]].


<!--T:26-->
====So-so link====
You should use the original link name for links whenever possible. This clarifies the referenced page in printed or offline documentation. Please avoid non-meaningful words for the link.
*For more information on this topic, refer to [[Draft Workbench|drafting 2D objects]].


<!--T:27-->
====Good link====
; Bad link
*For more information on this topic, see how to draft 2D objects in the [[Draft Workbench]].
: For more information on drafting 2D objects click [[Draft_Workbench|here]].


<!--T:29-->
===Workbench pages===
; Good link
Every page of a workbench should start with:
: For more information on drafting 2D objects refer to the [[Draft_Workbench|Draft Workbench]].
* the name of the workbench,
* an image of the look of the workbench (menu and toolbar in their default position), and
* a description of what the workbench is used for


<!--T:39-->
See [[#Screen capture]] for conventions on including images.
The preferred format for a link is:


<!--T:40-->
===Command (tool) pages===
<code><nowiki>[[Name_of_Page|Name of Page]]</nowiki></code>
The 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.


<!--T:41-->
Limitations and shortcomings should be documented right in the command page, possibly under a "restrictions" or "limitations" section.
Translated:


<!--T:42-->
Please refer to the [[Gui Command]] page for specific indications on how these commands should be presented, and use the [[GuiCommand model]] to start filling the information where appropriate.
<code><nowiki>[[Name_of_Page/fr|Nom de la Page]]</nowiki></code>
Use [[Boiler NonCommand]] to fill in information that is not related to a command.


<!--T:43-->
===Tutorials===
Note that for the part before the <code><nowiki>|</nowiki></code> character, the actual link, case is relevant. If your page name is <code><nowiki>Name_of_page</nowiki></code> the link will fail if you type <code><nowiki>Name_of_Page</nowiki></code> (upper case P). Before the <code><nowiki>|</nowiki></code> character all spaces should be replaced by underscores (<code><nowiki>_</nowiki></code>). This is to assist translators using translation software, without the underscores the link would be translated by the software which is undesirable.
A well written tutorial should teach the user how to achieve certain practical results quickly.
It shouldn't be extremely long, but it should include a sufficient amount
of step-by-step instructions and pictures to guide the user on using different tools.


<!--T:44-->
A series of tutorials in which each increases in complexity could be helpful to explore basic,
To link to a certain paragraph add a <code><nowiki>#</nowiki></code> sign and its headings to the page name. Example:
intermediate, and expert tools in one or more workbenches.


<!--T:45-->
See the [[tutorial guidelines]] for a basic idea on how to set up a tutorial.
<code><nowiki>[[WikiPages#Links|WikiPages]]</nowiki></code>


<!--T:48-->
See some examples
Translated:
* [[Tutorials]], already written and accessible from the sidebar
* [http://freecad-tutorial.blogspot.it FreeCAD tutorial - Unofficial tutorial blog], for other example tutorials


<!--T:49-->
As FreeCAD evolves, some tutorials may become too old for modern versions of the program,
<code><nowiki>[[WikiPages/fr#Liens|WikiPages]]</nowiki></code>
so it is important to mention the version or limitations of the tools used in that specific version of the tutorial.


<!--T:50-->
== Language ==
Within the same page you can omit the page name. Example:


<!--T:165-->
===Expressions===
<code><nowiki>[[#Links|Links]]</nowiki></code>
You should avoid colloquial generic expressions as "a couple". Please re-phrase as "some" if an indeterminate number, or use the correct quantity.


<!--T:33-->
===Conciseness===
To link to the top of the page you can use:
Try to avoid repetitions to keep descriptions short.


</translate>
====Bad description====
<code><nowiki>&lt;/translate&gt;{{Top}}&lt;translate&gt;</nowiki></code>
<translate>


<!--T:35-->
[[PartDesign Workbench]]: the PartDesign Workbench is a workbench for part design that aims to provide tools for modelling complex solid parts.
This template should automatically display the correct text depending on the language of the page. A link to the top of the page is especially useful for long pages as it allows the user to quickly jump back to the table of content. You can put it at the end of each paragraph. Make sure there is an empty line before and after the template.


<!--T:226-->
====Good description====
; Image link
: [[Image:Draft_Wire.svg|24px|Optional text that is shown when you hover the image|link=Draft_Wire]]


<!--T:227-->
[[PartDesign Workbench]]: aims to provide tools for modelling complex solid parts.
To use an image as a link:


<!--T:228-->
==Style==
<code><nowiki>[[Image:Draft_Wire.svg|24px|Optional text that is shown when you hover the image|link=Draft_Wire]]</nowiki></code>


<!--T:229-->
===Templates===
; Image link + text link
Styling of FreeCAD wiki pages is achieved through the usage of templates ([[Help:Editing#Templates_and_transcluding_pages]]). Please only use the templates listed in the tables below; doing this will allow re-styling the entire wiki by updating the template, and help achieve a standardized look and feel across all pages. Only for special cases should you use HTML tags directly.
: [[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]


<!--T:230-->
You can see the complete list of defined templates by accessing [[Special:PrefixIndex/Template:]]. However, not all templates listed there are used for styling the text, and others are deprecated; please use only the ones in the tables below.
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:


<!--T:231-->
Click on the template link to see the usage instructions for the 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, and page transclusion should be avoided. See [https://www.mediawiki.org/wiki/Help:Templates MediaWiki Help:Templates] to learn more.
<code><nowiki>[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]</nowiki></code>


=== Workbench pages === <!--T:166-->
====Simple styling templates ====

<!--T:52-->
A top level workbench page should start with:
* A description of what the workbench is used for.
* An image to illustrate the description.

<!--T:53-->
See [[#Screen_capture|#Screen capture]] for conventions on including images.

=== Command pages === <!--T:167-->

<!--T:54-->
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.

<!--T:56-->
Please refer to the [[GuiCommand_model|GuiCommand model]] page for more details.

=== Tutorials === <!--T:168-->

<!--T:57-->
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.

<!--T:60-->
For examples visit the [[Tutorials|Tutorials]] page.
</translate>
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
</div> <!-- End of collapsible element for Structure section. Do not remove! -->

<div class="mw-collapsible mw-collapsed toccolours">
<translate>

== Templates == <!--T:70-->
</translate>
<div class="mw-collapsible-content">
<translate>
<!--T:71-->
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.

<!--T:73-->
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.

=== Simple templates === <!--T:170-->

<!--T:74-->
These templates accept a simple text parameter, and format it with a particular style.
These templates accept a simple text parameter, and format it with a particular style.
{|{{Prettytable}}
{|{{Prettytable}}
!Template
!style="width:10%;"|Template
!Appearance
!style="width:20%;"|Appearance
!Description
!style="width:70%;"|Description
|--
|[[Template:Emphasis|Emphasis]]
|{{Emphasis|emphasis}}
|Use it to emphasize a piece of text.
|--
|[[Template:KEY|KEY]]
|{{KEY|Alt}}
|Use it to indicate a keyboard key that needs to be pressed.
|--
|[[Template:FALSE|FALSE]]
|{{FALSE}}
|Use it to indicate a False Boolean value, for example, as a property in the [[property editor]].
|--
|[[Template:TRUE|TRUE]]
|{{TRUE}}
|Use it to indicate a True Boolean value, for example, as a property in the [[property editor]].
|--
|[[Template:MenuCommand|MenuCommand]]
|{{MenuCommand|File → Save}}
|Use it to indicate the location of a command inside a particular menu.
|--
|[[Template:FileName|FileName]]
|{{FileName|File name}}
|Use it to indicate a name of a file or directory.
|--
|[[Template:SystemInput|SystemInput]]
|{{SystemInput|Type this text}}
|Use it to indicate user typed input text.
|--
|[[Template:SystemOutput|SystemOutput]]
|{{SystemOutput|Output text}}
|Use it to indicate text output from the system.
|--
|[[Template:Optional|Optional]]
|{{Optional|Insert or not}}
|Use it in programming descriptions to indicate a text or function argument that is optional.
|--
|[[Template:Choice|Choice]]
|{{Choice|This|That}}
|Use it in programming descriptions to indicate a choice between two values.
|--
|[[Template:Incode|Incode]]
|{{incode|import FreeCAD}}
|Use it to include in-line source code with a monospace font. It should fit in one line.
|--
|[[Template:Variable|Variable]]
|{{Variable|MyAttribute|TYPE}}
|Use it in programming descriptions to indicate a value or a parameter, optionally with a type in front of it.
|--
|[[Template:PropertyView|PropertyView]]
|{{PropertyView|Color}}
|Use it to indicate a View property in the [[property editor]]. View properties are like {{emphasis|Line Color}}, {{emphasis|Line Width}}, {{emphasis|Point Color}}, {{emphasis|Point Size}}, etc.
|--
|[[Template:PropertyData|PropertyData]]
|{{PropertyData|Position}}
|Use it to indicate a Data property in the [[property editor]]. Data properties are different for different types of objects.
|--
|[[Template:Properties Title|Properties Title]] / [[Template:TitleProperty|TitleProperty]]
|{{Properties_Title|Base}}
|Use it to indicate the title of a property group in the [[property editor]]. The title will not be included in the automatic table of contents.
|--
|[[Template:PropertyTasks|PropertyTasks]] / [[Template:TasksTag|TasksTag]]
|{{PropertyTasks|Tasks}}
|Use it to indicate the argument for tasks.
|--
|[[Template:TitleTasks|TitleTasks]]
|{{TitleTasks|Tasks Title}}
|Use it to indicate the title for tasks.
|--
|[[Template:Version|Version]]
|{{Version|0.18}}
|Use it to indicate that a particular feature is available only starting with a specific FreeCAD version.
|}


<!--T:236-->
====More complex templates ====
|--
These templates require more input parameters, or produce a block of text with a particular format.
|[[Template:Top|Top]]
{|{{Prettytable}}
|
!Template
!Appearance
!Description
|--
|[[Template:Prettytable|Prettytable]]
|This table
|Use it to format tables such as this one; additional table properties can be added.
|--
|[[Template:Clear|Clear]]
|
|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]]
|{{Code|code=import FreeCAD}}
|Source code style. Use it to include multi-line code examples with a monospace font. The default language is Python, bur other languages can be specified.
|--
|[[Template:Fake heading|Fake heading]]
|{{Fake heading|Heading|2}}
|Use it to create create a heading that will not be included automatically in the table of contents that is used for the offline documentation.
|--
|[[Template:GuiCommand|GuiCommand]]
|See [[Gui Command]] and [[GuiCommand model]]
|Use it to create a box with useful information to document workbench tools (GuiCommands) of FreeCAD.
|--
|[[Template:Macro|Macro]]
|See example [[Macro FlattenWire]]
|Use it to create a box with useful information to document [[macros]].
|--
|[[Template:Docnav|Docnav]]
|{{Docnav|Online Help Startpage|Feature list}}
|Use it to create a bar with the words "next", "previous", and "index", and links to the appropriate articles, which is useful for navigating certain help pages which go in a particular sequence.
|--
|[[Template:VeryImportantMessage|VeryImportantMessage]]
|{{VeryImportantMessage|Important Message}}
|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:Softredirect|Softredirect]]
|
|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:UnfinishedDocu|UnfinishedDocu]]
|{{UnfinishedDocu}}
|Use it to create a highlighted box indicating an unfinished documentation page.
|--
|[[Template:Quote|Quote]]
|{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=William Shakespeare|source=''Julius Caesar'', act III, scene I}}
|Use it to create a box of text with a literal quote and reference.
|}


</translate>{{Top}}<translate>
===Deprecated templates===
{|{{Prettytable}}
!Template
!Appearance
!Description
|--
|Click
|'''Deprecated'''
|Use it to superimpose an invisible link on an image. You should use the native wiki picture inclusion method instead.
|--
|DASH
|'''Deprecated'''
|Use it to show a multi-line text box for code, with colorful background. You should use the style you obtain starting the source line with a space.
|--
|Disambig
|'''Deprecated'''
|Use it a disambiguation message in a page.
|--
|Information
|'''Deprecated'''
|Use it to create a standardized table providing complete information about the file, including description of what it shows and how it was made, copyright status and source.
|--
|Languages
|'''Deprecated'''
|Use it to show available translations. It's been obsoleted with the new wiki, which handles translations and languages via a dedicated plugin.
|--
|Message
|'''Deprecated'''
|Use it show a block of text with a colorful background, to indicate a message of low importance.
|--
|Powerdocnavi, Devdocnavi, Userdocnavi
|'''Deprecated'''
|Use them to create navigation boxes for the user documentation, the power user documentation, and the developer documentation.
|--
|Screenshot
|'''Deprecated'''
|Use it to insert screenshots of the software. See [[#Screen capture]] instead.
|}


<!--T:238-->
To have a global view on the chromatic aspect, see [[WikiPagesBasicColors|Basic Graphic Template]].
|Use it to add a link to the top of the page.


<!--T:171-->
===Code===
|--
Code must be styled using the [[Template:Code|Code]] template. The description of such code should follow afterwards. Accentuation should be strictly used ''only'' on the word or lines that must be accentuated.
|[[Template:Emphasis|Emphasis]]
|{{Emphasis|emphasis}}
|Use it to emphasize a piece of text.


<!--T:172-->
[[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.
|[[Template:KEY|KEY]]
|{{KEY|Alt}}
|Use it to indicate a keyboard key that needs to be pressed.


<!--T:173-->
====Example of bad code description====
|--
|[[Template:ASCII|ASCII]]
|{{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.


<!--T:174-->
{{Code|code=
|--
makeAngularDimension (center,[angle1,angle2],p3): creates an angular Dimension from the given center,
|[[Template:Button|Button]]
with the given list of angles, passing through p3. Returns the newly created object.
|{{Button|Cancel}}
}}
|Use it to indicate a button in the graphical user interface that needs to be pressed.


<!--T:175-->
====Example of good code description====
|--
|[[Template:RadioButton|RadioButton]]
|{{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}}.


<!--T:176-->
{{Code|code=
|--
Dimension = makeAngularDimension(center, anglelist, p3)
|[[Template:CheckBox|CheckBox]]
Dimension = makeAngularDimension(center, [angle1, angle2], p3)
|{{CheckBox|Option}}
}}
|Use it to indicate a checkbox in the graphical user interface that needs to be {{CheckBox|TRUE|Checked}} or {{CheckBox|FALSE|Not}}.


<!--T:177-->
* Creates an angular dimension from the given {{incode|center}} point, the {{incode|anglelist}} containing {{incode|angle1}} and {{incode|angle2}}, and passing through point {{incode|p3}}.
|--
* Returns the newly created {{incode|Dimension}} object.
|[[Template:SpinBox|SpinBox]]
|{{SpinBox|1.50}}
|Use it to indicate a spinbox in the graphical user interface that needs to be modified.


<!--T:178-->
==Graphics==
|--
|[[Template:ComboBox|ComboBox]]
|{{ComboBox|Menu 1}}
|Use it to indicate a combobox in the graphical user interface that needs to be modified.


<!--T:239-->
Images and screenshots are necessary to produce a complete documentation of FreeCAD. Images are particularly useful to illustrate examples and tutorials.
|--
|[[Template:LineEdit|LineEdit]]
|{{LineEdit|Metal Nickel (Ni)}}
|Use it to indicate a LineEdit in the graphical user interface that needs to be modified.


<!--T:179-->
===General===
|--
Avoid thumbnails and resizing [[bitmap]] pictures (downsizing or upscaling). Pictures should be shown in their original size, so they present sufficient detail and are readable if they include text. The exception to this are [[SVG]] images, which can be scaled to any desired size without losing detail.
|[[Template:FALSE|FALSE]], [[Template: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}}


<!--T:180-->
Avoid animated pictures (GIF) in the general [[Gui Command]] help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation.
|--
|[[Template:TRUE|TRUE]], [[Template: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}}


<!--T:181-->
Pictures must be uploaded through the [[Special:Upload]] page.
|--
|[[Template:MenuCommand|MenuCommand]]
|{{MenuCommand|File → Save}}
|Use it to indicate the location of a command inside a particular menu.


<!--T:182-->
===Screen capture===
|--
Recommended sizes for screen captures are:
|[[Template:FileName|FileName]]
* Native 400x200 (or width=400 and height<=200), for [[Gui Command]] pages, to allow the picture to fit in the left part of the page, and for other standard snapshots.
|{{FileName|File name}}
* Native 600x400 (or width=600 and height<=400), for [[Gui Command]] 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.
|Use it to indicate a name of a file or directory.
* Native 1024x768 (or width=1024 and height<=768), only for full screen images.
* Smaller sizes are possible when showing details, however use native resolution, not resizing or thumbnails, unless you have a very good reason to do so.
* Avoid larger resolutions, as they won't be very portable to other kinds of display or in the printed PDF documentation.


<!--T:183-->
You shouldn't depend on any particular configuration of your desktop or operating system when you show screenshots. You should use visual defaults of the FreeCAD interface whenever possible.
|--
|[[Template:SystemInput|SystemInput]]
|{{SystemInput|Type this text}}
|Use it to indicate user typed input text.


<!--T:184-->
===Text===
|--
To ease documentation translations, take separate pictures of the interface and the 3D model viewport. The picture of the 3D model can be reused in every translation, while a translator can take a picture of the localized interface if necessary.
|[[Template:SystemOutput|SystemOutput]]
|{{SystemOutput|Output text}}
|Use it to indicate text output from the system.


<!--T:185-->
If your screen capture contains text use the same resolution of the original interface in FreeCAD so that text is readable.
|--
|[[Template:Incode|Incode]]
|{{incode|import FreeCAD}}
|Use it to include in-line source code with a monospace font. It should fit in one line.


<!--T:186-->
====Good sizing for reading text====
|--
[[Image:partdesign_revolution_parameters.png|PartDesign revolution parameters (original size, 307px)]]
|[[Template:PropertyView|PropertyView]]
|{{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.


<!--T:187-->
====Bad sizing for reading text====
|--
[[Image:partdesign_revolution_parameters.png|190px|PartDesign revolution parameters (scaled to 190px)]]
|[[Template:PropertyData|PropertyData]]
|{{PropertyData|Position}}
|Use it to indicate a Data property in the [[Property_editor|property editor]]. Data properties are different for different types of objects.


<!--T:188-->
In the second picture the text is less clear and there are visual artifacts due to rescaling the original width from 307px to 190px.
|--
|[[Template:Properties Title|Properties Title]] / [[Template:TitleProperty|TitleProperty]]
|{{Properties_Title|Base}}
|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.


<!--T:189-->
===Icons and graphics===
|--
Refer to the [[Artwork]] page for all artwork and icons that have been created for FreeCAD, which can be immediately reused in documentation pages.
|[[Template:Obsolete|Obsolete]]
If you would like to contribute with icons, please read the [[Artwork Guidelines]].
|{{Obsolete|0.19}}
|Use it to indicate that a feature became obsolete in the specified FreeCAD version.


<!--T:190-->
==Translations==
|--
|[[Template:Version|Version]]
|{{Version|0.18}}
|Use it to indicate that a feature was introduces in the specified FreeCAD version.


<!--T:191-->
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.
|--
|[[Template:VersionMinus|VersionMinus]]
|{{VersionMinus|0.16}}
|Use it to indicate that a feature is available in the specified FreeCAD version and earlier versions.


<!--T:192-->
The FreeCAD wiki supports a translation extension that allows managing translations between pages easier; for details, see [[Localisation#Translating the wiki]].
|--
|[[Template:VersionPlus|VersionPlus]]
|{{VersionPlus|0.17}}
|Use it to indicate that a feature is available in the specified FreeCAD version and later versions.


<!--T:193-->
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
|[[Template:ColoredText|ColoredText]]
* [http://en.wikipedia.org/wiki/Gallery_of_sovereign_state_flags Country flags] to identify a country's flag for use in relevant localized pages
|{{ColoredText|Colored Text}}
* [http://translate.google.com/ Google Translate] for help with translating languages
|Use this template to color the background, text, or background and text. ([[Template:ColoredText|ColoredText]] page for more examples)


<!--T:194-->
== Some tips for translators ==
|--
|[[Template:ColoredParagraph|ColoredParagraph]]
|{{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)
|}


=== Complex templates === <!--T:195-->
===Setting Docnav===


<!--T:75-->
To localize the [[Template:Docnav]] navigation bar, see this thread in the forum [http://forum.freecadweb.org/viewtopic.php?f=21&t=6716 Docnav previous/next].
These templates require more input parameters, or produce a block of text with a particular format.


<!--T:196-->
Essentially, a new translated template needs to be created, [[Template:Docnav/it]].
{|{{Prettytable}}
!style="width:10%;"|Template
!style="width:45%;"|Appearance
!style="width:45%;"|Description


<!--T:197-->
The translated template should include the appropriate localized links as the "previous" and "next" parameters, together with the translated text:
|--
<nowiki>{{docnav/it|[[Installing/it|Installazione]]|[[Mouse Model/it|Navigazione 3D - Tipo di mouse]]}}</nowiki>
|[[Template:Prettytable|Prettytable]]
|This table
|Use it to format tables such as this one. Additional table properties can be added.


<!--T:198-->
Also include the appropriate language category
|--
<nowiki>[[Category:Template/it]]</nowiki>
|[[Template:Caption|Caption]]
|<div style="width:400px;">{{Caption|Some caption for an image}}</div>
|Use it to add an explanation below an image. It can be left aligned or center aligned.


<!--T:199-->
If the localized category is not included in the translated template, the translated template will remain in the default English category.
|--
|[[Template:Clear|Clear]]
|
|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.


<!--T:200-->
===Using special pages===
|--
|[[Template:Code|Code]]
|{{Code|code=import FreeCAD}}
|Use it to include multi-line code examples with a monospace font. The default language is Python, but other languages can be specified.


<!--T:79-->
*[[Special:LonelyPages|Orphaned pages]] list those pages that are not linked from or transcluded into other pages in the FreeCAD Documentation. These pages are not accessible via links (no one sees them). If you find any in your native language, try to create the connection that exists in the English page, otherwise no one can read them.
[[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.
*[[Special:UncategorizedPages|Uncategorized pages]] pages without category. They do not appear when you browse the categories. Assign a category.
*[[Special:WantedPages|Wanted pages]] pages that are called, but that do not exist. Red link in the text. Deprecated and very annoying.
*Others Wanted (files and templates)
*[[Special:WantedCategories|Wanted categories]] they exist always, not only has been edited text. Skip.
*[[Special:Categories|Categories]] allow you to compare the number of pages of a given type of the original version with those translated into the specified language.
*[[Special:ListRedirects|List of redirects]] allows you to control the correct redirection pages. If there are any red links, something does not work well. Investigate. Light blue links lead to pages outside the site, no problem.
*[[Special:RecentChanges|Recent changes]] track the most recent changes to the wiki.
*[[Special:LanguageStats|Language statistics]] shows translation statistics for all message groups for a language. Shows the parts not translated in a given language, only for those pages marked for translation. To see what has not been translated, set the language code and press Show statistic. It also contains the link to see what has been recently translated into that language. Note: If entering code en pages appear, it is likely that the original page contains markup errors (Sidebar apart).
*[[Special:PageTranslation|Page translation]] allows you to see all the pages marked for translation, but also the updated and unmarked pages. Only administrators can mark pages for translation.
*Category:Pages to delete: list of pages to be deleted, created by mistake or unnecessary.


<!--T:241-->
==Robots==
|--
|[[Template:CodeDownload|CodeDownload]]
|{{CodeDownload|https://wiki.freecad.org/Main_Page|Some label}}
|Use it to create a link on a [[Macros|macro]] page.


<!--T:240-->
At the page [[WikiRobots]] you can find instructions on how to set-up and use robots to automate repetitive tasks on the FreeCAD Wiki.
|--
|[[Template:Codeextralink|Codeextralink]]
|{{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.


<!--T:201-->
==Discussion==
|--
The [http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki subforum] in the [https://forum.freecadweb.org FreeCAD forum] provides a dedicated space
|[[Template:Fake heading|Fake heading]]
for discussing improvements on the wiki topics and appearance. Direct your questions and suggestions there.
|{{Fake heading|Heading|2}}
|Use it to create a heading that will not be automatically included in the table of contents.


<!--T:202-->
==Brainstorming==
|--
|[[Template:GuiCommand|GuiCommand]]
|See [[GuiCommand model|GuiCommand model]]
|Use it to create a box with useful information to document workbench commands (tools).


<!--T:203-->
{{VeryImportantMessage|All that follows is open to discussion. You can stop reading here if you don't intend to suggest modifications to the FreeCAD WikiPages style rules. You should discuss any wiki-related topic on the [[http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki subforum]]. Contributions are welcome.}}
|--
|[[Template:TutorialInfo|TutorialInfo]]
|See for example [[Basic_modeling_tutorial|Basic modeling tutorial]]
|Use it to create a box with useful information to document [[Tutorials|tutorials]].


<!--T:204-->
===Workflow, Roadmap===
|--
|[[Template:Macro|Macro]]
|See for example [[Macro_FlattenWire|Macro FlattenWire]]
|Use it to create a box with useful information to document [[macros|macros]].


<!--T:205-->
Organize pages in the wiki
|--
|[[Template:Docnav|Docnav]]
|{{Docnav|Online Help Startpage|Feature list}}
|Use it to create a bar with arrows and appropriate links, which is useful for putting pages in a particular sequence.


<!--T:206-->
====Content and Appearance:====
|--
** Renato: ''width of the page, now much space is unused (only for monitor 16:10)''
|[[Template:VeryImportantMessage|VeryImportantMessage]]
** Renato: ''white background, text more readable''
|{{VeryImportantMessage|Important Message}}
** Renato: '' links to similar commands, similar tools, scripts, examples, discussions, insights, forum, other... On all pages or only on some pages?''
|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.


<!--T:207-->
====Templates====
|--
I think the things like this are also templates? <nowiki>{{PartDesign Tools}}</nowiki>
|[[Template:Page in progress|Page in progress]]
This template contains headlines, icons, short textual description, long textual description, list elements. May be easier to handle when splitted in pieces (at least: icon list, description list, "full featured": array of someWorkbenchTools[icon|description,{2-4}]...) ?
|{{Page in progress|Page in progress}}
|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.


<!--T:208-->
* Basic Template that would be useful
|--
{|{{Prettytable}}
|[[Template:UnfinishedDocu|UnfinishedDocu]]
!Template
|{{UnfinishedDocu}}
!Note
|Use it to create a highlighted box indicating an unfinished documentation page.
!Note
|--
|suggestion
caution
|useful?
|as Message?
|--
|alert
|useful?
|as VeryImportantMessage?
|--
|idea
|useful?
|
|--
|shortcut
|
|as KEY?
|}


<!--T:209-->
|--
|[[Template:Softredirect|Softredirect]]
|
|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.


<!--T:210-->
|--
|[[Template:Quote|Quote]]
|{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=William Shakespeare|source=''Julius Caesar'', act III, scene I}}
|Use it to create a box of text with a literal quote and reference.


<!--T:211-->
{|{{Prettytable}}
|--
!Template
|[[Template:Userdocnavi|Userdocnavi]], [[Template:Powerdocnavi|Powerdocnavi]]
!Appearance
|
!Description
|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.
|--
|Clear
|ok
|Template for clearing columns
|--
|Click
|rarely used
|superimpose an invisible link on an image
|--
|DASH
|rarely used
|text box type code, colorful background
|--
|Disambig
|not used
|
|--
|Docnav
|ok
|
|--
|FALSE
|color or black and gray?
|<span style="color: #990000; background-color: #f1cece;">'''FALSE'''</span> <span style="color: #990000; background-color: #DDDDDD;">'''FALSE'''</span> <span style="color: #990000; background-color: #DDDDDD;">FALSE</span> <span style="color: #990000; background-color: #DDDDDD;">'''False'''</span> <span style="color: #990000; background-color: #DDDDDD;">False</span> <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">False</span> <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">'''False'''</span> <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">'''False'''</span> <span style="background: #FFFFFF; border: 1px solid #888888; padding: 0px 5px 1px 5px;">'''False'''</span>
|--
|[[Gui Command]]
|ok
|the main anchor on documenting GuiCommands
|--
|[[MenuCommand]]
|{{MenuCommand|File->Save}}
|Text that is displayed in a GUI command menu
|--
|Information
|not used
|A standardized table providing complete information about the file, including description of what it shows and how it was made, copyright status and source.
|--
|[[KEY]]
|{{KEY|ALT}}
|Show a keyboard key
|--
|Languages
|ok
|obsolete with the new wiki
|--
|Macro
|ok, used
|the main anchor on documenting macros
|--
|Message
|rarely used
|for message not very important
|--
|VeryImportantMessage
|ok, used
|for message very important
|--
|Prettytable
|used for this table
|could have different colors
|--
|PropertyView
|background green or gray?
|<span style="background: #C2EEAA; border: 1px solid #bbbbbb; padding: 0px 5px 1px 5px;"><small>VIEW</small> '''Property'''</span> <span style="background: #DDDDDD; border: 1px solid #bbbbbb; padding: 0px 5px 1px 5px;"><small>View</small> '''Property'''</span>
|--
|Properties Title
|spelling. color or black and gray?
|{{Properties_Title|Base}}
|--
|PropertyTasks
|color or black and gray?
|{{PropertyTasks|Length}} Renato: ''serve but too many disturbing reading''
|--
|Screenshot
|link
|<small>{{{2}}} - see more [[screenshots]]</small>
|--
|Softredirect
|
|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.
|--
|TasksTag
|color or black and gray?
|{{TasksTag|Text}}
|--
|TRUE
|color or black and gray?
|{{TRUE}}
|--
|UnfinishedDocu
|ok
|mark not finished documentation.
|--
|Version
|FreeCAD version, small text
|
|--
|
|
|
|}


<!--T:235-->
|}
</translate>
</div> <!-- end of collapsible div. Do not remove! -->
</div> <!-- end of collapsible div. Do not remove! -->


<div class="mw-collapsible mw-collapsed toccolours">
* Other Template
<translate>
* PartDesignTools
* _______________


== Graphics == <!--T:86-->
===Forum===
</translate>
* Reflect on requests for help made ​​in the forum and use the given examples (if aid is required, it often means that the manual is not exhaustive, in the forum there are good examples, but hard to find)
<div class="mw-collapsible-content">
** Renato: ''Insert a link on the document page or insert the example or insert nothing?''
<translate>
***Ralf: insert link(s) always in a field/area which is always there on every page. If there is nothing to link, there should be a text in this area as "There is currently no link to forum examples."
<!--T:87-->
***Ralf #2 examples: no examples at pages which are describing more than exactly the use of (probably mostly) a tool. If there would be examples (at different pages) which differ in various ways and are not comparable are confusing.
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.
*** Ralf #3 examples: But beside of existing examples: defining a "standard model" (or some of them if needed for fairly different tasks as p.e. Part-Design vs. Arch) for really every example would promise a lot of advantages. The first one: if one like to try an example the related model file is available right there with the next click. Whatever the "standard model" could be - the most important condition it have to be usable for all examples/task from to simplest up to the most complex (FEM,assembly?!)
*** May be such an ''standard model'' and his incarnations could be also a kind of a "figurehead" for FC.<br>
*** [[User:Ediloren|Ediloren]] ([[User talk:Ediloren|talk]]) 18:01, 3 September 2013 (CEST) : looks like a good idea but not too practical; I expect that the burden of adding examples for everything would be very high. I would prefer to resort on tutorials, videos, and forum unless somebody has really the time and commitment to follow this part (me not, sorry :) )
[[WikiPagesFromForum|Some useful examples taken from the forum]]


<!--T:88-->
===Documentation structure:===
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.
* Links between pages (tree and hierarchy linear, orderly, full)
** Renato: ''If there is an index the docnav does not serves.''
* Page titles descriptive
** Renato: ''Translated or not translated? With the new translator seems outdated''
* Structure of the documentation (depending on the type of user and the type of documentation). ''Group some things? - If possible in any way: group everything to maximal seven (7) entrys (per group)(Ralf).'':
** Reference (needs indicate precise criteria) (Ralf: for me for advanced users/using, #3)
** How to (Ralf: additional, #4)
** Tutorial (Ralf: additional, #5)
*** External links
** Themed (Ralf: 1st thing / start point while using the documentation? - for me #1)
** examples - in relevant cases - the most basic example for using the tool / workbench /feature (is that possible with complex tools?) ; may be one "standard" example case for the most examples, if possible (so the fcstd file can be supplied and re-used for a lot of uses) for me #2 or to #1<br>
** linear (all, as now)
** structured with sub-structures (very clear if there are no more than 5..7 entrys per structure layer)
** task - specific (features is other than transform than handle mouse etc.)
** FAQ
** Books
** Plugins
** Macro


<!--T:89-->
===Documentation schemes===
Images can be uploaded through the [[Special:Upload|Special:Upload]] page.


=== Name === <!--T:213-->
See [[WikiPagesDocSchemes|Documentation schemes]]


<!--T:90-->
===Repository===
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}}.
* fcstd file
* pics, images
* icons (there are almost all)
* "Show your FreeCAD projects here!" archives


===Who are the users:===
=== Screen capture === <!--T:214-->
* New users FreeCAD:
** Users without CAD experience -> not the job of the FreeCAD doc to teach them CAD - the job to teach them how to use FreeCAD? ''Renato: I think that FreeCAD is currently the only free CAD program with a professional approach. Many people exactly look for this to begin.''
** Users with CAD experience (2D/3D/parametric); users with 3D experience - no CAD
** Users who know how to program (version?)


<!--T:91-->
* Users who know FreeCAD:
Recommended sizes for screen captures are:
** Users
* 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.
** Advanced users
* 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.
** Developers
* Native 1024x768 (or width=1024 and height<=768), only for full screen images.
* Smaller sizes are possible when showing details.
* Avoid images with larger resolutions, as they won't be very portable to other kinds of displays or the printed PDF documentation.


<!--T:92-->
===What the users needs:===
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.
* According to the category of the previous point they need different things (to be determined).
* Renato: ''In my opinion the beginners to FreeCAD (or to CAD?) needs:''
** ''find the information immediately'' + Ralf: in the expected, consistent way
** ''know what are the workbenches, when and how to use them,'' + Ralf: is this one workbench all I need or do I need more than one?
** ''the commands that are available,'' + Ralf: in the workbench - for the task - all
** ''the workflow to use,'' - Ralf: workflow sounds specific - may be the most basic way to use this - may be especially for tools there could be more than page per tool (as above: basic for beginners, extended use for advanced users)
** ....


<!--T:2-->
===Translations===
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]].


=== Text === <!--T:215-->
* Consistent (the reference page is the English page, see the various discussions regarding the rules in the forum)
* Updated (how?) + Ralf: 1st: Version, 2nd: frozen state of doc page - "this is the actual version of the documentation of ... for FC version xxx"; 3rd linked archiv pages of other versions (and maybe other frozen states), all with corresponding "tags" / marks
** ''Use a document type that including at least one complete section of the manual (not just one page at a time). Comparable off line with an previous version. With "Recent changes" is difficult to follow all the changes, when they are frequent.''
* FCSTD files for Documentation ''(wandererfan wrote: It would be nice to have a repository for the fcstd files +Ralf and it would be very helpful - used to generate screenshots, etc. Then the 2nd author/translator could just open the fcstd with a different locale to generate the new screenshot. This would also for standardization of background colours, font sizes, etc. )''
* Renato. My personal:
''- The wiki, is the best way to create documentation FreeCAD? Would not it be better to reserve it for some issues and create a comprehensive manual for each version?''<br>
''- About updates, this is a crucial point, I've seen that you do not like docboock, and I do not intend to return to this theme, but docboock allows translators to easily work on documents. Allows you to download the entire document and compare it with the previous one. With this way changes are made always and only in the original document. Then the translators periodically (even daily if they want) downloading the document and compares with an earlier version and update it indicating the upgrade version. I've experienced that this procedure is very good. Can I do a similar thing with the wiki? In this way there is no need to continuously monitor Recent Changes and updates are easier to control.''


<!--T:93-->
===Some notes taken from the forum===
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.


=== Icons and graphics === <!--T:216-->
yorikvanhavre wrote: ''Actually we could do a little brainstorming, see things that should be changed on the wiki...''
''I already thought of a couple of things: - a new wiki homepage with a clear view of the contents - better formatting of the 3 principal sections, for user (basically the command pages), for power users (everything about python) and the higher-level stuff (compiling, etc) - more professional aspect of the wiki pages - build a better and more strict model for command pages - find a good system to handle translations''


<!--T:98-->
gdo wrote: ''But maybe a survey to freecad users could help to understand precisely what is the beginners needs.''
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]].
</translate>
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->


<div class="mw-collapsible mw-collapsed toccolours">
Ralf wrote: ''Even for the ones who are trying FreeCAD the first times, it's essential to find a consistent documentation otherwise they weren't motivated to give even some first tries.''
<translate>


== Translations == <!--T:99-->
</translate>
<div class="mw-collapsible-content">
<translate>
<!--T:225-->
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.


<!--T:100-->
And many more ... dispersed and mixed in:
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]].
*[http://forum.freecadweb.org/viewtopic.php?f=8&t=3167 SF hosted app retairement & call for help]
*[http://forum.freecadweb.org/viewtopic.php?f=10&t=3899 doc - some detail questions about changing, display, structure]: Misalignment of ToC (left menu vs. ToC and page titles), links should be called as the pages
*[http://forum.freecadweb.org/viewtopic.php?f=8&t=3988 wiki pages]: Best pages examples (long) discussion, propose to establish clear rules, minimize screenshots, don't use thumbnails, English pages are master, Navigation bar at the bottom like in Sketcher_Point (my view: no; use ToC), image dimensions, misalignment of ToC (Each information is linked to an index directly from the main page. The main menu expands into sub-menu. You can clearly see the hierarchy of the entire document. The documentation must be so.), how to manage docs for different FC versions, (OT: is there a timeout for editing a post? On-again some of my posts are lost in space)
* [http://forum.freecadweb.org/viewtopic.php?f=21&t=1805 Online Help (Wiki) TODO List]: Misalignment and importance of ToC (it is what gets in FreeCAD Help), grouping of workbenches (alphabetically says normandc) topic left in April 10
*[http://forum.freecadweb.org/viewtopic.php?f=21&t=3818 Wiki for New Functions?]: How to mark versions in the Wiki
*[http://forum.freecadweb.org/viewtopic.php?f=12&t=3959 Règles a suivre pour le nouveau wiki]
*[http://forum.freecadweb.org/viewtopic.php?f=13&t=4025 Tutorials auf Deutsch für FreeCAD]


<!--T:101-->
===Examples of CAD documentation===
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://translate.google.com/ Google Translate] for help with translations.
* [https://www.deepl.com/translator Deepl translator] for help with translations.


== Some tips for translators == <!--T:102-->
http://help.solidworks.com/2013/English/SolidWorks/sldworks/c_Sketch_Fillets.htm?id=cb1f4dfbe23245aeb58d17af808ee10c#Pg0 <br>


=== Translate GuiCommand === <!--T:103-->
Ralf: good: you can see where you are ; bad: a huge lot of entrys in the navigation / summary at left - the opposite of structured; sorry: pieces of the forum at the documentation page: what is the documentation page good for than? (but the link to the forum / forum search - ok.)<br>
http://www.gcad3d.org/ <br>
Ralf: thumbs up. clear, well structured. sometimes long but I don't know how to avoid that at some themes. Maybe the tree structure layers could be separated in two directions at the page for more place for the content. They have "last updates" I prefer "this version of the documentation is xxx and depend the program version xxy"


</translate>
Reported by wandererfan<br>
<pre>
guidelines for wiki authors:<br>
{{GuiCommand
http://wiki.blender.org/index.php/Meta:Guides/Writer_Guide<br>
|Name=FEM EquationFlux
http://wiki.blender.org/index.php/Meta:Guides/Style_Guide<br>
|MenuLocation=Solve → Flux equation
Manual TOC:<br>
|Workbenches=[[FEM_Workbench|FEM]]
http://docs.gimp.org/2.8/en/<br>
|Shortcut={{KEY|F}} {{KEY|S}}
http://wiki.blender.org/index.php/Doc:2.6/Manual<br>
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}
</pre>
<translate>


<!--T:105-->
Reported by Ralf:<br>
Translated:
http://opensourceecology.org/wiki/FreeCAD<br>


</translate>
For the Italian translation also:<br>
<pre>
http://tp.linux.it/
{{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]]
}}
</pre>
<translate>


===Next actions ===
=== Translate navi === <!--T:107-->
# gather ideas
# build Table of Contents
# build good models (in the template created by Wandererfan)
# edit the master page in English (updated until a new FreeCAD version is released then freeze the document in pdf or doc or other)
# translate (updated until a new FreeCAD version is released then freeze)
# continue to develop the documentation for the new version of FreeCAD (repeats 4)
# continue to develop the translation for the new version of FreeCAD (repeats 5)


</translate>
== Terminology - Naming policy==
<pre>
{{FEM_Tools_navi}}
</pre>
<translate>


<!--T:109-->
===English===
Translated:
See [[Glossary]]

</translate>
<pre>
{{FEM_Tools_navi/fr}}
</pre>
<translate>

=== Translate link === <!--T:111-->

</translate>
<pre>
[[Part_Module|Part Module]]
</pre>
<translate>

<!--T:113-->
Translated:

</translate>
<pre>
[[Part_Module/fr|Atelier Part]]
</pre>
<translate>

=== Translate Docnav === <!--T:119-->

</translate>
<pre>
{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}
</pre>
<translate>

<!--T:218-->
Translated:

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

<!--T:219-->
Example with icons:

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

<!--T:220-->
Translated:

</translate>
<pre>
{{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
}}
</pre>


</div> <!-- END of Translation section collapsible element. Do not remove! -->
===Other languages===
</div> <!-- END of Translation section collapsible element. Do not remove! -->
*[[Italian_Translation|Italiano]]
*


<translate>
== Create, rename and delete pages == <!--T:128-->


=== Create pages === <!--T:232-->


<!--T:233-->
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.


<!--T:234-->
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'.
* Do a wiki search for the page name, and click on the red text in 'Create the page "My New Page" on this wiki!'.


=== Rename pages === <!--T:129-->
'''proposal to create the page:'''


<!--T:130-->
==[[Start Workbench|Start Center]] ==
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:


</translate>
See [[Sandbox:Start center]].
<pre>
The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 00:18, 2 November 2018 (UTC)
old name new name
Old_page_name_1 New_page_name_1
Old_page_name_2 New_page_name_2
...
</pre>
<translate>


=== Delete files and pages === <!--T:135-->
When you start FreeCAD for the first time, you are presented with the start center:


<!--T:136-->
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].


<!--T:137-->
For pages the procedure is the same.


== Discussion == <!--T:222-->
[[Image:Startcenter.jpg|1024px|center]]


<!--T:140-->
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.


== Terminology - naming policy == <!--T:144-->


=== English === <!--T:223-->
The Start Center allows you to quickly jump to one of the most common workbenches, open one of the recent files, or see the latest news from the FreeCAD world. You can change the default workbench in the [[Preferences Editor|preferences]].


<!--T:145-->
'''Use this part of [[Getting started]] then add more information'''
See [[Glossary|Glossary]].


=== Other languages === <!--T:224-->
= Sandbox for Macro Dimensions =
See [[Sandbox:Macro dimensions]]. The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 23:43, 1 November 2018 (UTC)


<!--T:146-->
= Sandbox for PartDesign Fillet =
* [[Italian_Translation|Italiano]]
* [[French_Translation|Français]]
* [[German_Translation|Deutsch]]
* [[Polish_Translation|Polish]]
* [[Spanish_Translation|Spanish]]


See [[Sandbox:PartDesign fillet]]. The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 23:36, 1 November 2018 (UTC)


</translate>
[[Category:Documentation]]
[[Category:Documentation{{#translation:}}]]
[[Category:Wiki{{#translation:}}]]
[[Category:Wiki Documentation{{#translation:}}]]
[[Category:Administration{{#translation:}}]]

Latest revision as of 11:37, 16 April 2024

This page is an extension of the Help:Editing page and gives common guidelines for writing and updating the FreeCAD wiki documentation. It summarizes several discussions and brainstorming sessions

Before starting

  • This wiki documentation is based on MediaWiki, the same software that powers Wikipedia. If you have contributed to Wikipedia, editing FreeCAD wiki pages should be easy.
  • Contrary to Wikipedia, the FreeCAD wiki is write-protected to avoid spam. You must request an account on the forum.
  • If you have never used wiki software before, please read Help:Editing to become familiar with the markup that is used.
  • For advanced use of the wiki software, see MediaWiki Help:Contents. Not all features of MediaWiki are available in this FreeCAD wiki, but many are.
  • We like to keep the documentation easy to read, so avoid using complex features. Keep it simple.
  • Use a sandbox to test your code, for example, FreeCADDocu:Sandbox or a particular page with your name Sandbox:Yourname. Sandbox pages must be placed in the Sandbox category. This is done by adding [[Category:Sandbox]] at the bottom of the wiki code.
  • Please be aware of the translations. The FreeCAD wiki uses automated translation support to provide pages in many languages. For every page multiple language versions can exist. On many pages you will see tags like <translate>...</translate> and many single tags like <!--T:8-->. The latter mark so-called translation units and are created by the translation system, you should never create them manually. They link the headings and paragraphs to their translated versions. You should not change them as that would destroy those links. It is however fine to move paragraphs or change wording as long as the tags stay with them. If you remove a heading or a paragraph you should also remove the tag belonging to it. Please be aware that changes to existing headings and paragraphs affect the current translations. Your changes should be worth it. Do not worry when adding new material because the system will add new tags automatically after your edits. For more information see Localisation and the original Mediawiki:Extension:Translate page.

General guidelines

Concise descriptions

When describing FreeCAD try to be concise and to the point and avoid repetition. Describe what FreeCAD does, not what FreeCAD does not do. Also avoid colloquial expressions such as 'a couple'. Use 'some' when dealing with an indeterminate number, or specify the correct quantity.

Bad description
PartDesign Workbench: the PartDesign Workbench is a workbench for part design that aims to provide tools for modelling complex solid parts.
Good description
PartDesign Workbench: aims to provide tools for modelling complex solid parts.

Centralized information

Avoid duplicating the same information in different places. Insert the information in a new page, and link to this page from other pages that require this information.

Do not use transclusion of pages (Help:Editing#Templates and transcluding pages), as this makes the wiki difficult to translate. Use only the templates described below in #Templates.

Styling

Templates are used to style the help pages. They give the documentation a consistent look and feel. There is a template for menu commands, File → Save, a template to style keys to be pressed, Shift, to show a Boolean value, true, etc. Please get familiar with the #Templates section before writing help pages.

Temporary flags

If you are working on a large page it is advisable to mark the page either as a work in progress or as unfinished. This assures that wiki admins don't mark your page as ready for translation while you are still changing it.

To flag a page add either {{Page in progress}} or {{UnfinishedDocu}} as the first line. With {{UnfinishedDocu}} you invite others to join you in finishing the page, while {{Page in progress}} indicates that you will do the work yourself and others should give you some time.

Once the work is done, please don't forget to remove the flags!

Examples

To quickly get familiar with the structure and style of the FreeCAD wiki look at the model page: GuiCommand model.

Structure

The User hub provides a Table of Contents. This is used as the main reference for automatically building the offline help you can reach from FreeCAD, as well as the offline PDF documentation.

The Template:Docnav is used to sequentially link pages, following the structure of the Table of Contents. See #Templates for a list of all templates.

Page names

Page names should be short and they should use title case: every word should begin with a capital letter, unless they are articles, prepositions, conjunctions, or other grammatical particles (f.e. 'of', 'on', 'in', 'a', 'an', 'and').

Bad page name
Construction of AeroCompany airplanes
Good page name
Construction of AeroCompany Airplanes

The names of top level workbench pages must have this format: XYZ Workbench, where XYZ is the name of the workbench, for example PartDesign Workbench. And the names of pages describing the commands (or tools) belonging to a workbench must have this format: XYZ Command, for example PartDesign Pad. Note that you should use the command name as it occurs in the source code.

Headings

Paragraph headings should be short and use sentence case: all words except the first one and proper names, should be in lowercase. You should not use H1 headings (= Heading =) in your wiki markup since the page title is automatically added as the main H1 heading.

Links

You should use the original link name for links whenever possible. This clarifies the referenced page in printed or offline documentation. Please avoid non-meaningful words for the link.

Bad link
For more information on drafting 2D objects click here.
Good link
For more information on drafting 2D objects refer to the Draft Workbench.

The preferred format for a link is:

[[Name_of_Page|Name of Page]]

Translated:

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

Note that for the part before the | character, the actual link, case is relevant. If your page name is Name_of_page the link will fail if you type Name_of_Page (upper case P). Before the | character all spaces should be replaced by underscores (_). This is to assist translators using translation software, without the underscores the link would be translated by the software which is undesirable.

To link to a certain paragraph add a # sign and its headings to the page name. Example:

[[WikiPages#Links|WikiPages]]

Translated:

[[WikiPages/fr#Liens|WikiPages]]

Within the same page you can omit the page name. Example:

[[#Links|Links]]

To link to the top of the page you can use:

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

This template should automatically display the correct text depending on the language of the page. A link to the top of the page is especially useful for long pages as it allows the user to quickly jump back to the table of content. You can put it at the end of each paragraph. Make sure there is an empty line before and after the template.

Image link
Optional text that is shown when you hover the image

To use an image as a link:

[[Image:Draft_Wire.svg|24px|Optional text that is shown when you hover the image|link=Draft_Wire]]

Image link + text link
Draft Wire

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:

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

Workbench pages

A top level workbench page should start with:

  • A description of what the workbench is used for.
  • An image to illustrate the description.

See #Screen capture for conventions on including images.

Command pages

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 page for more details.

Tutorials

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

Templates

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.

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 MediaWiki Help:Templates to learn more.

Simple templates

These templates accept a simple text parameter, and format it with a particular style.

Template Appearance Description
Top

Top

Use it to add a link to the top of the page.
Emphasis emphasis Use it to emphasize a piece of text.
KEY Alt Use it to indicate a keyboard key that needs to be pressed.
ASCII 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.
Button Cancel Use it to indicate a button in the graphical user interface that needs to be pressed.
RadioButton Option Use it to indicate a radio button in the graphical user interface that needs to be Selected or Not.
CheckBox Option Use it to indicate a checkbox in the graphical user interface that needs to be Checked or Not.
SpinBox 1.50 Use it to indicate a spinbox in the graphical user interface that needs to be modified.
ComboBox Menu 1 Use it to indicate a combobox in the graphical user interface that needs to be modified.
LineEdit Metal Nickel (Ni) Use it to indicate a LineEdit in the graphical user interface that needs to be modified.
FALSE, false false, false Use it to indicate a False Boolean value, for example, as a property in the property editor. This is a shortcut. Since it is a value, prefer Template Value false
TRUE, true true, true Use it to indicate a True Boolean value, for example, as a property in the property editor. This is a shortcut. Since it is a value, prefer Template Value true
MenuCommand File → Save Use it to indicate the location of a command inside a particular menu.
FileName File name Use it to indicate a name of a file or directory.
SystemInput Type this text Use it to indicate user typed input text.
SystemOutput Output text Use it to indicate text output from the system.
Incode import FreeCAD Use it to include in-line source code with a monospace font. It should fit in one line.
PropertyView ViewColor Use it to indicate a View property in the property editor. Examples of View properties include Line Color, Line Width, Point Color, Point Size, etc.
PropertyData DataPosition Use it to indicate a Data property in the property editor. Data properties are different for different types of objects.
Properties Title / TitleProperty Base Use it to indicate the title of a property group in the property editor. The title will not be included in the automatic table of contents.
Obsolete obsolete in version 0.19 Use it to indicate that a feature became obsolete in the specified FreeCAD version.
Version introduced in version 0.18 Use it to indicate that a feature was introduces in the specified FreeCAD version.
VersionMinus version 0.16 and below Use it to indicate that a feature is available in the specified FreeCAD version and earlier versions.
VersionPlus version 0.17 and above Use it to indicate that a feature is available in the specified FreeCAD version and later versions.
ColoredText Colored Text Use this template to color the background, text, or background and text. (ColoredText page for more examples)
ColoredParagraph
Colored Paragraph
Use this template to color the background, text, or background and text of an entire paragraph. ColoredParagraph page for more examples)

Complex templates

These templates require more input parameters, or produce a block of text with a particular format.

Template Appearance Description
Prettytable This table Use it to format tables such as this one. Additional table properties can be added.
Caption

Some caption for an image

Use it to add an explanation below an image. It can be left aligned or center aligned.
Clear 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.
Code
import FreeCAD
Use it to include multi-line code examples with a monospace font. The default language is Python, but other languages can be specified.

Python code should adhere to the general recommendations established by 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.

CodeDownload Use it to create a link on a macro page.
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>
Use it if the code of a 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 Addon Manager will use this link.
Fake heading
Heading
Use it to create a heading that will not be automatically included in the table of contents.
GuiCommand See GuiCommand model Use it to create a box with useful information to document workbench commands (tools).
TutorialInfo See for example Basic modeling tutorial Use it to create a box with useful information to document tutorials.
Macro See for example Macro FlattenWire Use it to create a box with useful information to document macros.
Docnav
Online Help Startpage
Feature list
Use it to create a bar with arrows and appropriate links, which is useful for putting pages in a particular sequence.
VeryImportantMessage
Important Message
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.
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.
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.
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.

Use it to create a highlighted box indicating an unfinished documentation page.
Softredirect 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.
Quote

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

—William Shakespeare, Julius Caesar, act III, scene I
Use it to create a box of text with a literal quote and reference.
Userdocnavi, Powerdocnavi 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.

Graphics

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 images should not be resized.

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

Name

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 _example at the end. For example for the command Draft Offset the image should be called Draft_Offset_example.png.

Screen capture

Recommended sizes for screen captures are:

  • Native 400x200 (or width=400 and height<=200), for command reference pages, to allow the picture to fit in the left part of the page, and for other standard snapshots.
  • Native 600x400 (or width=600 and height<=400), for 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.
  • Native 1024x768 (or width=1024 and height<=768), only for full screen images.
  • Smaller sizes are possible when showing details.
  • Avoid images with larger resolutions, as they won't be very portable to other kinds of displays or the printed PDF documentation.

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: Macro Snip and Macro Screen Wiki.

Text

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

Icons and graphics

Refer to the 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.

Translations

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.

Other useful resources are:

Some tips for translators

Translate 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]]
}}

Translated:

{{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]]
}}

Translate navi

{{FEM_Tools_navi}}

Translated:

{{FEM_Tools_navi/fr}}

Translate link

[[Part_Module|Part Module]]

Translated:

[[Part_Module/fr|Atelier Part]]

Translate Docnav

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

Translated:

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

Example with icons:

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

Translated:

{{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
}}

Create, rename and delete pages

Create pages

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 Wiki forum first.

To create a new page do one of the following:

  • Visit the URL with the desired page name, for example: https://wiki.freecadweb.org/My_New_Page, and click on '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!'.

Rename pages

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 Wiki forum and list the necessary renaming operation in this form:

old name         new name
Old_page_name_1  New_page_name_1
Old_page_name_2  New_page_name_2
...

Delete files and pages

In case you need to delete a file, go to its page (https://www.freecadweb.org/wiki/File:***.***) and edit it. No matter if the page is blank or not, add this as the first element: {{Delete}} and directly below it describe why the page should be deleted. Additionally, open a topic in the Wiki forum.

For pages the procedure is the same.

Discussion

The Development/Wiki subforum in the 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.

Terminology - naming policy

English

See Glossary.

Other languages