WikiPages/fr

Cette page est une extension de la page Help:Editing et donne des directives communes sur les meilleures pratiques à suivre lors de la rédaction ou de la mise à jour de la documentation FreeCAD. Il résume les discussions et les réflexions en ce qui concerne la documentation FreeCAD.

Pour l'image, vous pouvez utiliser la Macro Snip pour saisir l'image dans la fenêtre sélectionnée ou Macro Screen Wiki  et créez une image au format standard, une image de rotation ou un écran enregistré en série et vous devez l'assembler avec Gimp ou autre pour créer un fichier Gif animé.

Avant de commencer

 * Cette documentation wiki est basée sur le MediaWiki, le même logiciel qui alimente Wikipedia. Si vous avez déjà contribué à Wikipédia, la modification des pages du wiki FreeCAD devrait être facile.
 * Contrairement à Wikipedia, le wiki FreeCAD est protégé en écriture pour éviter les spams. Vous devez demander qu'un compte soit créé pour vous sur le forum.
 * Si vous n'avez jamais utilisé de logiciel wiki auparavant, dirigez-vous vers Help:Editing pour vous familiariser avec le balisage utilisé pour éditer les pages.
 * Pour une utilisation avancée du logiciel wiki, voir MediaWiki Help:Contents. Toutes les fonctionnalités de MediaWiki ne sont pas disponibles dans ce wiki FreeCAD, mais beaucoup d'entre elles le sont.
 * Nous aimons garder la documentation simple à lire, évitez donc d'utiliser des fonctionnalités complexes. Rester simple.
 * Utilisez un bac à sable pour tester votre code, par exemple, FreeCADDocu:Sandbox ou une page particulière avec votre nom Sandbox:Yourname.
 * Veuillez prendre connaissance des traductions. Le wiki FreeCAD utilise la prise en charge de la traduction automatisée pour fournir des pages dans de nombreuses langues. C'est comme une 3ème dimension: chaque page pourrait exister dans plusieurs versions linguistiques.
 * On many pages you will see tags like  and many single tags like this   in many sections. The former enable translation support. Do not change them. The latter are created by the system. They link the headlines/paragraphs with their translated versions. If you change the numbering obviously you will destroy those links. However, it is fine to move paragraphs or change wording as long as the tags stay with them. If you remove a paragraph you should remove the tag with it. Please be aware that changes to existing headlines and paragraphs potentially affect 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.

Descriptions concises
Lorsque vous décrivez les fonctionnalités de FreeCAD, essayez d'être concis et précis. Décrivez ce que FreeCAD fait pas ce que FreeCAD ne fait pas. Il peut y avoir des exceptions pour justifier pourquoi FreeCAD ne prend pas en charge une certaine fonctionnalité, par exemple, pour expliquer en quoi FreeCAD est différent des autres systèmes de CAO.

Informations centralisées
Évitez de dupliquer les mêmes informations à différents endroits. Insérez les informations dans une nouvelle page et créez un lien vers cette page à partir d'autres pages qui nécessitent ces informations.

N'utilisez pas la transclusion de pages (Help:Editing#Templates and transcluding pages) car cela rend le wiki difficile à traduire. Utilisez uniquement les modèles décrits ci-dessous dans #Modèles.

Mettre des styles
Les modèles sont utilisés pour styliser le texte utilisé dans les pages d'aide.

Il existe un modèle pour styliser les commandes de menu, comme, un autre modèle pour styliser les touches sur lesquelles appuyer, comme , un autre modèle pour afficher une valeur booléenne etc... Cela permet à la documentation d'avoir une apparence cohérente et de pouvoir être traduite sans trop d'effort. Veuillez vous familiariser avec la section #Modèles avant d'écrire des pages d'aide.

Travail en cours
Si vous travaillez sur une grande page, il est conseillé de marquer la page comme travail en cours ou comme inachevée. Cela garantit que les administrateurs Wiki ne marquent pas votre page comme prête pour la traduction alors que vous la modifiez encore fréquemment.

Pour marquer une page, ajoutez simplement soit   or    comme première ligne à une page. Avec  , vous invitez tout le monde à rejoindre et terminer la page avec    vous ferez le travail et les autres devraient vous donner du temps.

Une fois le travail terminé, n'oubliez pas de retirer les avertissements!

Exemples
Vous pouvez rapidement vous familiariser avec la structure et le style du wiki FreeCAD en consultant les pages suivantes qui peuvent être considérées comme des pages de référence pour le reste de la documentation FreeCAD.
 * Draft ShapeString
 * Draft Line

Général
Vous ne devriez normalement pas utiliser une section =header= pour une page car le titre de la page est automatiquement ajouté.

Le Documentation pour utilisateurs fournit une Table des matières. Ceci est utilisé comme référence principale pour créer automatiquement l'aide hors ligne que vous pouvez atteindre à partir de FreeCAD ainsi que la documentation PDF hors ligne.

Le Template:Docnav est utilisé pour créer un lien vers la page avant et la page après selon la structure de la Table des matières. Voir #Modèles pour une liste de tous les modèles.

Noms de page
Les noms de page doivent être courts et utiliser "casse de la phrase", par opposition à "casse du titre". Il s'agit du style utilisé par Wikipedia pour leurs articles.

Essentiellement, tous les mots, sauf le premier et les noms propres, doivent être en minuscules.


 * Tutoriel sur la construction d'avions AeroCompany
 * Tutoriel Sur La Construction d'Avions AeroCompany

une convention précédente était d'utiliser la casse du titre. Chaque mot doit commencer par une majuscule à moins qu'il ne s'agisse d'articles, de prépositions, de conjonctions ou d'autres particules grammaticales, "de, sur, dans, a, un, et etc..." Il existe de nombreuses pages utilisant ce style, mais cela est déconseillé pour les nouvelles pages. Ceci est discuté dans le fil de discussion du forum (Lowercase links) Use a lower case title for a wiki page.

Noms de page pour l'atelier et les outils
La page de l'atelier de niveau supérieur doit avoir le format XYZ Workbench où XYZ est le nom de l'atelier. Voir Pages d'atelier pour le contenu.

Les pages décrivant les outils (Gui Command) de l'atelier doivent avoir le format XYZ Tool où Tool est le nom de l'outil spécifique. Voir Pages de commande (outil) pour le contenu.


 * Mauvais nom
 * Working with architectural objects
 * Working with architectural walls
 * Drafting 2D objects
 * Tool: building a line between two points


 * Nom correct
 * Atelier Arch
 * Arch Mur
 * Atelier Draft
 * Draft Ligne

Liens
Vous devez utiliser le nom du lien d'origine pour les liens dans la mesure du possible. Cela clarifie la page référencée dans la documentation imprimée ou hors ligne. Vous devez éviter l'utilisation de mots non significatifs pour le lien.


 * Mauvais lien
 * Pour plus d'informations sur ce sujet, cliquez sur ici.


 * Lien acceptable
 * Pour plus d'informations sur ce sujet, reportez-vous à Dessin d'objets 2D.


 * Bon lien
 * Pour plus d'informations sur ce sujet, voir comment créer des objets 2D dans l'Atelier Draft.

Navigation dans les pages
Les liens de navigation aident l'utilisateur à parcourir les informations de ce wiki. Envisagez l'utilisation des éléments suivants pour rendre la navigation plus agréable pour le lecteur:


 * Liens "top", en français deviendra "En haut". Pour les longues pages, vous pouvez revenir à la table des matières.
 * liens "retour". Cela permet de revenir sur un certain problème. Un lien retour est beaucoup plus utile que le bouton "retour" du navigateur car il contient des informations structurelles. Un backlink peut vous conduire à une étape sur la hiérarchie des informations. Par exemple, voir Ateliers externes: d'où que vous arriviez une page sur un atelier externe, vous voudrez peut-être voir quels autres ateliers sont disponibles.

Consultez la section suivante pour savoir comment créer ces liens.

Liens vers le haut de la page
Tapez simplement ce qui suit à l'endroit où vous voulez le lien supérieur.

top en français en haut

Vous pouvez le mettre à la fin de chaque chapitre. Assurez-vous d'avoir une ligne vide avant afin qu'il reste libre du dernier paragraphe.


 * Remarque 1: Si vous connaissez la plate-forme MediaWiki, vous remarquerez peut-être que cela fonctionne même sans définir "top" ("en haut") comme cible de lien en utilisant  . Cela ne fonctionne bien sûr que si le "haut" n'est pas utilisé pour d'autres choses.
 * Remarque 2: Si vous pensez que c'est utile, vous pouvez simplement commencer à vous entraîner un peu en mettant un lien "top" ("en haut") à la fin de chaque section de cette très longue page.

En haut

Liens arrière
Pour un lien retour, vous avez 2 choix:
 * retourner en haut d'une autre page
 * revenir à une certaine section d'une autre page

Pour l'utilisateur, il peut être plus pratique d'accéder directement à la section appropriée d'une page, par ex. une liste d'articles similaires.

Le format général d'un lien est

pagename

Pour traduire cette ligne:

nom de la page

Pour cette page, il s'agirait de. Remarquez le point de détail. Si le nom de votre page est "WikiPages", le lien échouera si vous tapez "Wikipages" ('p' en minuscule). La meilleure pratique consiste à ouvrir la page dans un autre onglet et à copier et coller le nom de la page.

Pour utiliser une certaine section comme cible de lien, il vous suffit d'ajouter le nom de la section (c'est-à-dire le texte du titre) après le signe '#' derrière le nom de la page. Exemple:

WikiPages

Le résultat est un peu moche, à cause du '#' dans WikiPages. Cela peut être évité en utilisant le '|' syntaxe pour entrer un intitulé. Voir cet exemple:

WikiPages

Pour traduire cette ligne:

WikiPages début

Au lieu de "WikiPages", vous pouvez insérer le texte de votre choix. Le résultat est bien meilleur: WikiPages ou WikiPages/Top Page Links ou tout ce que vous voulez. C'est un peu plus à taper dans la source mais c'est un petit prix à payer pour une excellente convivialité. Dans la même page, vous faites la même chose mais vous pouvez omettre le nom de la page, par exemple  donne Top Page Links.

En haut

Pages d'atelier
Chaque page d'un atelier doit commencer par:
 * le nom de l'atelier,
 * une image de l'aspect de l'atelier (menu et barre d'outils dans leur position par défaut), et
 * une description de l'utilisation de l'atelier

Voir pour les conventions sur l'inclusion d'images.

Pages de commande (outil)
Les pages de commandes décrivant les outils d'atelier ne doivent pas être trop longues, elles doivent uniquement expliquer ce qu'une commande peut faire et ce qu'elle ne peut pas faire et comment l'utiliser. Vous devez réduire au minimum les images et les exemples. Les tutoriels peuvent expliquer comment utiliser l'outil et fournir des détails étape par étape.

Les limitations et lacunes doivent être documentées directement dans la page de commande, éventuellement sous une section "restrictions" ou "limitations".

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. Use Boiler NonCommand to fill in information that is not related to a command.

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

A series of tutorials in which each increases in complexity could be helpful to explore basic, intermediate, and expert tools in one or more workbenches.

See the tutorial guidelines for a basic idea on how to set up a tutorial.

See some examples
 * Tutorials, already written and accessible from the sidebar
 * FreeCAD tutorial - Unofficial tutorial blog, for other example tutorials

As FreeCAD evolves, some tutorials may become too old for modern versions of the program, so it is important to mention the version or limitations of the tools used in that specific version of the tutorial.

Expressions
You should avoid colloquial generic expressions as "a couple". Please re-phrase as "some" if an indeterminate number, or use the correct quantity.

Conciseness
Try to avoid repetitions to keep descriptions short.

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.

Modèles
Styling of FreeCAD wiki pages is achieved through the usage of templates (Help:Editing). 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.

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.

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; page transclusion should be avoided. See MediaWiki Help:Templates to learn more.

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

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

Deprecated templates
To have a global view on the chromatic aspect, see Basic Graphic Template.

Code
Code must be styled using the 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.

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.

Example of good code description

 * Creates an angular dimension from the given point, the  containing  and, and passing through point.
 * Returns the newly created object.

Graphics
Images and screenshots are necessary to produce a complete documentation of FreeCAD. Images are particularly useful to illustrate examples and tutorials.

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.

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.

Pictures must be uploaded through the Special:Upload page.

Name
Give a meaningful name to your image. If you have a picture that showcases the characteristics of a particular command, you should use the same name as the command with at the end.
 * For the command Draft Offset the image should be called Draft Offset example.jpg.
 * For the command Arch Space the image should be called Arch Space example.jpg.

Capture d'écran
Les tailles recommandées pour les captures d'écran sont:
 * Natif 400x200 (ou largeur=400 et hauteur<= 200), pour les pages Commande Gui, pour permettre à l'image de tenir dans la partie gauche de la page, et pour d'autres instantanés standard.
 * Natif 600x400 (ou largeur=600 et hauteur<= 400), pour les pages Commande Gui, lorsque vous avez vraiment besoin d'une image plus grande, tout en permettant à l'image de tenir dans la partie gauche de la page, et pour d'autres instantanés standard.
 * Natif 1024x768 (ou largeur=1024 et hauteur<= 768), uniquement pour les images plein écran.
 * Des tailles plus petites sont possibles lors de l'affichage des détails, mais utilisez la résolution native, pas le redimensionnement ou les miniatures, sauf si vous avez une très bonne raison de le faire.
 * Évitez les résolutions plus importantes, car elles ne seront pas très portables avec d'autres types d'affichage ou dans la documentation PDF imprimée.

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.

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.

If your screen capture contains text use the same resolution of the original interface in FreeCAD so that text is readable.

Bad sizing for reading text


In the second picture the text is less clear and there are visual artifacts due to rescaling the original width from 307px to 190px.

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. If you would like to contribute with 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:
 * ISO language codes to identify the two-letter code for a particular language that you want to translate to
 * Country flags to identify a country's flag for use in relevant localized pages
 * Google Translate for help with translating languages

Setting GuiCommand
translated:

Setting template
translated:

Setting link
translated:

or:

translated:

Setting Docnav
To localize the Template:Docnav navigation bar, see this thread in the forum Docnav previous/next.

Essentially, a new translated template needs to be created, Template:Docnav/it.

The translated template should include the appropriate localized links as the "previous" and "next" parameters, together with the translated text:

The translated template should include the appropriate localized links as the "previous" and "next" parameters with icon, together with the translated text:

Also include the appropriate language category

If the localized category is not included in the translated template, the translated template will remain in the default English category.

Using special pages

 * Special:LonelyPages lists those pages that are not linked from other pages in the FreeCAD wiki, therefore nobody can access these pages. If you find any in your native language, try to create the connection that exists in the English version of the page, otherwise no one can read them.
 * Special:UncategorizedPages lists pages without an assigned category, therefore they do not appear when you browse the wiki by categories. Assign a category.
 * Special:WantedPages lists pages that are called in a page, but that do not exist. These are shown as red links in the text. Deprecated and very annoying.
 * Others Wanted (files and templates)
 * Special:WantedCategories lists categories that are used in a page, but that do not exist. They can be created immediately by clicking on the red link. Skip.
 * Special:Categories lists all categories in the wiki. They allow you to compare the number of pages inside a translated category, which should preferably match then number of pages inside the English language category.
 * Special:ListRedirects lists all redirected pages. If there is any red links, something does not work well. Investigate which link is missing. Light blue links lead to pages outside the site, no problem.
 * Special:RecentChanges lists the most recent changes done to the wiki, including the pages changed, the number of changes to a particular page, whether these were additions or subtractions, and the user responsible.
 * Special:LanguageStats shows translation statistics for all message groups for a single 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 statistics. It also contains the link to see what has been recently translated into that language. Note: if entering the English code en shows pages, it is likely that the original page contains markup errors, with the exception of the sidebar.
 * Special:PageTranslation lists all pages marked for translation, and those unmarked but that have translation tags. Only administrators can mark pages for translation.
 * Category:Pages to delete: lists all pages that should be deleted because they were created by mistake, are obsolete, or no longer necessary.

Rename pages
Since FreeCAD is a project under permanent development, it is necessary to revise the Wiki pages. One task is hereby to check if the file and page names are still following the conventions. If a workbench changed for example a component name, the Wiki page describing it must be renamed. Thi can only be done by Wiki administrators. To inform them, open a topic in the Wiki forum and list the necessary renaming in this form:

old name                    new name OLD_PAGE_NAME   NEW_PAGE_NAME ...

Move files
To rename files it is in many cases to move them. That means they will become a new file under a new name while its content remains.

To move a file, go to its page ( https://www.freecadweb.org/wiki/File:***.*** ) and click at the upper right on the menu More and select there the appearing menu Move. This opens a page with all info on how to perform a movement.

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 command as first element to the page:   and describe below why this should be deleted. Additonally, open a topic in the Wiki forum.

For pages the procedure is the same.

Robots
Head to WikiRobots to find instructions on how to set up and use robots to automate repetitive tasks on the FreeCAD Wiki.

Discussion
The Development/Wiki subforum in the FreeCAD forum provides a dedicated space for discussing improvements on the wiki topics and appearance. Direct your questions and suggestions there.

Brainstorming
See Wiki brainstorming. The information here was moved there to avoid cluttering this page.---Vocx (talk) 00:38, 2 November 2018 (UTC)

English
See Glossary

Other languages

 * Italiano
 * Français

Start Center
proposal to create the page:

See Sandbox:Start center. The information here was moved there to avoid cluttering this page.---Vocx (talk) 00:28, 2 November 2018 (UTC)

= Sandbox for Macro Dimensions = See Sandbox:Macro dimensions. The information here was moved there to avoid cluttering this page.---Vocx (talk) 23:43, 1 November 2018 (UTC)

= Sandbox for PartDesign Fillet =

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