WikiPages/fr

Cette page est une prolongation de la page Help:Editing et donne des directives communes pour la rédaction et la mise à jour de la documentation du wiki FreeCAD. Elle résume plusieurs discussions et séances de réflexion.

Avant de commencer

 * Cette documentation wiki est basée sur MediaWiki, le même logiciel qui alimente Wikipedia. Si vous avez contribué à Wikipédia, la modification des pages du wiki FreeCAD devrait être facile.
 * Contrairement à Wikipédia, le wiki FreeCAD est protégé en écriture pour éviter les spams. Vous devez demander un compte sur le forum.
 * Si vous n'avez jamais utilisé de logiciel wiki auparavant, veuillez lire Help:Editing pour vous familiariser avec le balisage utilisé.
 * Pour une utilisation avancée du logiciel wiki, voir MediaWiki Aide:Sommaire. Toutes les fonctionnalités de MediaWiki ne sont pas disponibles dans ce wiki FreeCAD, mais beaucoup le sont.
 * Nous aimons garder la documentation facile à lire, évitez donc d'utiliser des fonctionnalités complexes. Rester simple.
 * Utilisez un sandbox 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. Pour chaque page, plusieurs versions linguistiques peuvent exister. Sur de nombreuses pages, vous verrez des balises telles que  et de nombreuses balises simples telles que  . Ces dernières sont créées par le système de traduction. Elles lient les titres et les paragraphes à leurs versions traduites. Vous ne devriez pas les changer car cela détruirait ces liens. Il est cependant bien de déplacer des paragraphes ou de modifier le libellé tant que les balises restent avec eux. Si vous supprimez un titre ou un paragraphe, vous devez également supprimer la balise qui lui appartient. Veuillez noter que les modifications apportées aux en-têtes et aux paragraphes existants affectent les traductions actuelles. Vos changements devraient en valoir la peine. Ne vous inquiétez pas lors de l'ajout de nouveau matériel car le système ajoutera automatiquement de nouvelles balises après vos modifications. Pour plus d'informations, consultez Localisation et la page d'origine Aide:Extension:Translate/Exemple de traduction de page.

Descriptions concises
Lorsque vous décrivez FreeCAD, essayez d'être concis et précis et évitez les répétitions. Décrivez ce que FreeCAD fait, et non ce que FreeCAD ne fait pas. Évitez également les expressions familières telles que "un petit nombre". Utilisez "quelques" lorsqu'il s'agit d'un nombre indéterminé, ou précisez la quantité exacte.


 * Mauvaise description
 * Atelier PartDesign : l'atelier PartDesign est un atelier de conception de pièces qui vise à fournir des outils pour la modélisation de pièces solides complexes.


 * Bonne description
 * Atelier PartDesign : vise à fournir des outils pour la modélisation de pièces solides complexes.

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.

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

Indicateurs temporaires
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 du wiki ne marquent pas votre page comme prête pour la traduction pendant que vous la modifiez encore.

Pour signaler une page, ajoutez soit  ou   en première ligne. Avec, vous invitez les autres à se joindre à vous pour terminer la page, tandis que   indique que vous ferez le travail vous-même et que les autres doivent vous laisser du temps.

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

Exemples
Pour vous familiariser rapidement avec la structure et le style du wiki FreeCAD, consultez la page du modèle : Modèle GuiCommand.

Structure
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 lier séquentiellement des pages, en suivant la structure de la Table des matières de l'aide en ligne. Voir #Modèles pour une liste de tous les modèles.

Noms de page
Les noms de page doivent être courts et utiliser la casse des phrases: tous les mots sauf le premier et les noms propres doivent être en minuscules. Il s'agit du style utilisé par Wikipedia pour leurs articles.


 * Nom de page incorrect:
 * Construction Of AeroCompany Airplanes


 * Bon nom de page:
 * Construction of AeroCompany airplanes

Les noms des pages d'atelier de premier niveau doivent avoir le format suivant :, où   est le nom de l'atelier, par exemple PartDesign Workbench. Et les noms des pages décrivant les commandes (ou outils) appartenant à un atelier doivent avoir ce format :, par exemple PartDesign Pad. Notez que vous devez utiliser le nom de la commande tel qu'il apparaît dans le code source.

Une ancienne convention consistait à utiliser la casse : chaque mot devait commencer par une majuscule, sauf s'il s'agissait d'articles, de prépositions, de conjonctions ou d'autres particules grammaticales (par exemple, 'de', 'sur', 'dans', 'a', 'an', 'et'). De nombreuses pages existantes utilisent ce style, mais il est déconseillé de l'utiliser pour les nouvelles pages. Ce point a été discuté dans le fil de discussion du forum (Liens en minuscules) Utiliser un titre en minuscules pour une page wiki.

En-têtes
Comme les noms de pages, les titres de paragraphes doivent être courts et utiliser la casse des phrases. Vous ne devez pas utiliser les titres   dans votre balisage wiki puisque le titre de la page est automatiquement ajouté comme titre principal.

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. Veuillez éviter les mots non significatifs pour le lien.


 * Mauvais lien
 * Pour plus d'informations sur le dessin d'objets 2D, cliquez sur ici.


 * Bon lien
 * Pour plus d'informations sur le dessin d'objets 2D, consultez l'Atelier Draft.

Le format préféré pour un lien est:

Traduit en:

Notez que pour la partie avant le caractère, le lien réel, la casse est pertinente. Si le nom de votre page est, le lien échouera si vous tapez   (P majuscule). Avant le caractère, tous les espaces doivent être remplacés par des tirets bas. Ceci a pour but d'aider les traducteurs qui utilisent un logiciel de traduction. Sans les traits de soulignement, le lien serait traduit par le logiciel, ce qui n'est pas souhaitable.

Pour créer un lien vers un certain paragraphe, ajoutez un signe  et ses intitulés au nom de la page. Exemple :

Traduit en:

Dans la même page, vous pouvez omettre le nom de la page. Exemple:

Pour créer un lien vers le haut de la page, vous pouvez utiliser:

en français

Ce lien fonctionnera même s'il n'y a pas de paragraphe 'Top' sur la page. Il est particulièrement utile pour les longues pages car il permet à l'utilisateur de revenir rapidement à la table des matières. Vous pouvez le mettre à la fin de chaque paragraphe. Assurez-vous qu'il y a une ligne vide avant et après le lien.

Les pages atelier
Une page d'atelier de haut niveau devrait commencer par :
 * Une description de l'utilisation de l'atelier.
 * Une image pour illustrer la description.

Voir Capture d'écran pour les conventions sur l'inclusion d'images.

Pages de commande
Les pages de commandes décrivant les outils de l'atelier ne doivent pas être trop longues, elles doivent seulement expliquer ce qu'une commande peut faire et ce qu'elle ne peut pas faire, et comment l'utiliser. Les images et les exemples doivent être réduits au minimum. Les tutoriels peuvent développer la manière d'utiliser l'outil et fournir des détails étape par étape.

Veuillez vous référer à la page Modèle GuiCommand pour plus de détails

Tutoriels
Un tutoriel bien rédigé doit permettre d'apprendre comment obtenir rapidement certains résultats pratiques. Il ne doit pas être trop long, mais doit inclure suffisamment d'instructions étape par étape et d'images pour guider l'utilisateur. Au fur et à mesure de l'évolution de FreeCAD, les tutoriels peuvent devenir obsolètes, il est donc important de mentionner la version de FreeCAD utilisée dans, ou requise pour, un tutoriel.

Pour des exemples, consultez la page Tutoriels.

Modèles
Le style des pages du wiki FreeCAD est réalisé grâce à l'utilisation de modèles (Help:Editing). Ils garantissent une apparence standardisée pour toutes les pages et permettent également de modifier le style du wiki. Vous pouvez voir la liste complète des modèles définis en accédant à Special:PrefixIndex/Template:. Mais veuillez n'utiliser que les modèles figurant dans les tableaux ci-dessous. Vous ne devez utiliser directement les balises HTML que dans des cas très particuliers.

Cliquez sur le lien du modèle pour voir les instructions d'utilisation d'un modèle et voir son implémentation. Les modèles sont une fonctionnalité puissante du logiciel MediaWiki. Vous devez être un utilisateur expérimenté de wiki si vous souhaitez proposer des ajouts et des modifications aux modèles existants. S'ils ne sont pas correctement mis en œuvre, les modèles rendent difficile la traduction des pages dans d'autres langues. Leur utilisation doit donc être limitée au formatage du texte et la transclusion des pages doit être évitée. Voir MediaWiki Help:Templates pour en savoir plus.

Modèles plus complexes
Ces modèles nécessitent plus de paramètres d'entrée ou produisent un bloc de texte avec un format particulier.

{| !style="width:10%;"|Template !style="width:45%;"|Appearance !style="width:45%;"|Description


 * Prettytable
 * This table
 * Use it to format tables such as this one. Additional table properties can be added.
 * Use it to format tables such as this one. Additional table properties can be added.


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

Le code Python doit adhérer aux recommandations générales établies par PEP8: Style Guide for Python Code. En particulier, les parenthèses doivent immédiatement suivre le nom de la fonction et un espace doit suivre une virgule. Cela rend le code plus lisible.


 * Fake heading
 * Use it to create a heading that will not be automatically included in the table of contents.
 * Use it to create a heading that will not be automatically included in the table of contents.
 * 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).
 * 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.
 * 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.
 * Use it to create a box with useful information to document macros.


 * Docnav
 * Use it to create a bar with the words 'next', 'previous', and 'index', and the appropriate links, which is useful for putting pages in a particular sequence.
 * Use it to create a bar with the words 'next', 'previous', and 'index', and the appropriate links, which is useful for putting pages in a particular sequence.
 * Use it to create a bar with the words 'next', 'previous', and 'index', and the appropriate links, which is useful for putting pages in a particular sequence.


 * VeryImportantMessage
 * 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.
 * 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.
 * 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
 * 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.
 * 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.
 * 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
 * Use it to create a highlighted box indicating an unfinished documentation page.
 * Use it to create a highlighted box indicating an unfinished documentation page.
 * 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.
 * 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.
 * 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."
 * "Cry "Havoc" and let slip the dogs of war."


 * Use it to create a box of text with a literal quote and reference.


 * Userdocnavi, Powerdocnavi, Devdocnavi
 * 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.
 * 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.
 * 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.

Illustrations
Des images et des captures d'écran sont nécessaires pour produire une documentation complète de FreeCAD. Les images sont particulièrement utiles pour illustrer des exemples et des tutoriels.

Généralités
Évitez les vignettes et le redimensionnement des images bitmap (réduction de taille ou mise à l'échelle). Les images doivent être présentées dans leur taille d'origine afin qu'elles présentent suffisamment de détails et soient lisibles si elles contiennent du texte. Les images SVG font exception à cette règle. Elles peuvent être redimensionnées à n'importe quelle taille souhaitée sans perdre de détails.

Évitez les images animées (GIF) dans les pages d'aide générales Gui Command. Les animations et vidéos doivent être réservées aux tutoriels non destinés à être utilisés comme documentation PDF hors ligne.

Les iamges doivent être téléchargées via la page Special:Upload.

Nom
Donnez un nom significatif à votre image. Si vous avez une image qui présente les caractéristiques d'une commande particulière, vous devez utiliser le même nom que la commande avec à la fin.
 * Pour la commande Draft Décalage, l'image doit s'appeler Draft Offset example.jpg.
 * Pour la commande Arch Espace, l'image doit être appelée Arch Space example.jpg.

Capture d'écran
Les tailles recommandées pour les captures d'écran sont :
 * Native 400x200 (ou width=400 et height<=200), pour les pages Modèle GuiCommand, pour permettre à l'image de tenir dans la partie gauche de la page, et pour les autres captures d'écran standard.
 * Native 600x400 (ou width=600 et height<=400), pour les pages Modèle GuiCommand, 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.
 * Native 1024x768 (ou largeur=1024 et hauteur<=768), uniquement pour les images en plein écran.
 * Des tailles plus petites sont possibles pour l'affichage des détails.
 * Évitez les images de plus grande résolution, car elles ne seront pas très portables sur d'autres types d'écrans ou sur la documentation PDF imprimée.

Vous ne devez dépendre d'aucune configuration particulière de votre bureau ou de votre système d'exploitation lorsque vous affichez des captures d'écran. Vous devez utiliser les valeurs visuelles par défaut de l'interface FreeCAD dans la mesure du possible.

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

Texte
Pour faciliter les traductions de la documentation, prenez des photos séparées de l'interface et de la fenêtre du modèle 3D. L'image du modèle 3D peut être réutilisée dans chaque traduction, tandis qu'un traducteur peut prendre une photo de son interface si nécessaire.

Icônes et illustrations
Reportez-vous à la page Graphisme pour toutes les illustrations et icônes qui ont été créées pour FreeCAD et qui peuvent être immédiatement réutilisées dans les pages de documentation. Si vous souhaitez contribuer avec des icônes, veuillez lire les Recommandations pour la charte graphique.

Traductions
D'avis général, la page de référence dans le wiki est la page anglaise, qui doit être créée en premier. Si vous souhaitez modifier ou ajouter du contenu à une page, vous devez d'abord le faire sur la page en anglais et une fois la mise à jour terminée, portez la modification sur la page traduite.

Le wiki FreeCAD prend en charge une extension de traduction qui permet de gérer plus facilement les traductions entre les pages; pour plus de détails, voir Localisation Traduire le wiki.

D'autres ressources utiles sont:
 * codes de langue ISO pour identifier le code à deux lettres d'une langue particulière vers laquelle vous souhaitez traduire
 * Drapeaux des pays pour identifier le drapeau d'un pays à utiliser dans les pages localisées pertinentes
 * Google Translate pour obtenir de l'aide sur la traduction des langues.
 * Deepl translator pour obtenir de l'aide sur la traduction des langues.

Paramétrage de GuiCommand
traduit en:

Définition du modèle
traduit en:

Définition du lien
Part Module

traduit en:

Atelier Pièces /

Définition de Docnav
Translated:

Example with icons:

Translated:

Renommer les pages
FreeCAD étant un projet en développement permanent, il est nécessaire de réviser les pages Wiki. Une tâche consiste ici à vérifier si les noms de fichier et de page respectent toujours les conventions. Si un atelier a changé par exemple le nom d'un composant, la page Wiki le décrivant doit être renommée. Cela ne peut être fait que par les administrateurs du Wiki. Pour les informer, ouvrez un sujet dans le Forum Wiki et listez les changements de nom nécessaires dans ce formulaire:

old name        new name Old_page_name_1 New_page_name_1 Old_page_name_2 New_page_name_2 ...

Supprimer les fichiers et les pages
Au cas où vous auriez besoin de supprimer un fichier, allez sur sa page ( https://www.freecadweb.org/wiki/File:***.*** ) et éditez-le. Peu importe si la page est vierge ou non, ajoutez cette commande comme premier élément de la page:   et décrivez ci-dessous pourquoi cela devrait être supprimé. De plus, ouvrez un sujet dans le Forum Wiki.

Pour les pages, la procédure est la même.

Discussion
Le sous forum Development/Wiki du FreeCAD forum fournit un espace dédié pour discuter des améliorations sur les sujets et l'apparence du wiki. Posez-y vos questions et suggestions.

Anglais
Voir Glossary

Autres langues

 * Italiano
 * Français
 * Deutsch