WikiPages/fr

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 : chaque mot doit commencer par une majuscule, sauf s'il s'agit d'articles, de prépositions, de conjonctions ou d'autres particules grammaticales (par exemple, "of", "on", "in", "a", "an", "and").

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 : XYZ Workbench, où XYZ 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 : Commande XYZ, par exemple PartDesign Pad. Notez que vous devez utiliser le nom de la commande tel qu'il apparaît dans le code source.

En-têtes

Les titres des paragraphes doivent être courts et utiliser la casse : tous les mots, sauf le premier et les noms propres, doivent être en minuscules. Vous ne devriez pas utiliser les titres H1 (= Heading =) dans votre balisage wiki puisque le titre de la page est automatiquement ajouté comme titre principal H1.

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 :

[[Name_of_Page|Name of Page]]

Traduit en :

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

Notez que pour la partie avant le caractère |, le lien réel, la casse est pertinente. Si le nom de votre page est Nom_de_page, le lien échouera si vous tapez Nom_de_page (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 :

[[WikiPages#Links|WikiPages]]

Traduit en :

[[WikiPages/fr#Liens|WikiPages]]

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

[[#Links|Links]]

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

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

Ce modèle doit automatiquement afficher le texte correct en fonction de la langue de la page. Un lien vers le haut de la page est particulièrement utile pour les pages longues, car il permet à l'utilisateur de revenir rapidement à la table des matières. Vous pouvez le placer à la fin de chaque paragraphe. Assurez-vous qu'il y a une ligne vide avant et après le modèle.

Lien image

.

Pour utiliser une image comme lien :

[[Image:Draft_Wire.svg|24px|Texte facultatif qui s'affiche lorsque vous survolez l'image|link=Draft_Wire]]

Lien image + lien texte

Draft Polyligne

Si vous ne tenez pas compte du texte facultatif, le lien lui-même s'affichera au survol de l'image, ce qui est préférable et vous devez également ajouter un lien texte après le lien image :

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire/fr|Draft Polyligne]]

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.

Le style des pages du wiki FreeCAD est réalisé grâce à l'utilisation de modèles (Help:Editing#Templates_and_transcluding_pages). 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 simples

Ces modèles acceptent un simple paramètre de texte et le mettent en forme avec un style particulier.

Modèle	Apparence	Description
Top	En haut	Utilisez-le pour ajouter un lien en haut de la page.
Emphasis	emphasis	Utilisez-le pour mettre en valeur un élément de texte.
KEY	Alt	Utilisez-le pour indiquer une touche du clavier qui doit être enfoncée.
ASCII		Utilisez-le pour indiquer une touche ascii dans une image (.svg) qui doit être utilisée. Vous devez donner le caractère souhaité ou le numéro du code ascii du caractère.
Button	Cancel	Utilisez-le pour indiquer un bouton de l'interface utilisateur graphique sur lequel il faut appuyer.
RadioButton	Option	Utilisez-le pour indiquer un bouton radio dans l'interface utilisateur graphique qui doit être Selected ou Not.
CheckBox	Option	Utilisez-le pour indiquer une case à cocher dans l'interface utilisateur graphique qui doit être Checked ou Not.
SpinBox	1.50	Utilisez-le pour indiquer une spinbox dans l'interface utilisateur graphique qui doit être modifiée.
ComboBox	Menu 1	Utilisez-le pour indiquer une combobox dans l'interface utilisateur graphique qui doit être modifiée.
LineEdit	Metal Nickel (Ni)	Utilisez-le pour indiquer un LineEdit dans l'interface utilisateur graphique qui doit être modifié.
FALSE, false	false, false	Utilisez-le pour indiquer une valeur booléenne fausse, par exemple, en tant que propriété dans l'Éditeur de propriétés. Il s'agit d'un raccourci. Comme il s'agit d'une valeur, préférez Template Value false
TRUE, true	true, true	Utilisez-le pour indiquer une valeur booléenne vraie, par exemple, en tant que propriété dans l'Éditeur de propriétés. Il s'agit d'un raccourci. Comme il s'agit d'une valeur, préférez Template Value true
MenuCommand	File → Save	Utilisez-le pour indiquer l'emplacement d'une commande dans un menu particulier.
FileName	File name	Utilisez-le pour indiquer le nom d'un fichier ou d'un répertoire.
SystemInput	Type this text	Utilisez-le pour indiquer le texte d'entrée tapé par l'utilisateur.
SystemOutput	Output text	Utilisez-le pour indiquer la sortie de texte du système.
Incode	import FreeCAD	Utilisez-le pour inclure du code source en ligne avec une police monospace. Il doit tenir sur une seule ligne.
PropertyView	VueColor	Utilisez-le pour indiquer une propriété de vue dans l'Éditeur de propriétés. Des exemples de propriétés de vue incluent Line Color, Line Width, Point Color, Point Size, etc.
PropertyData	DonnéesPosition	Utilisez-le pour indiquer une propriété Data dans l'Éditeur de propriétés. Les propriétés de données sont différentes selon les types d'objets.
Properties Title / TitleProperty	Base	Utilisez-le pour indiquer le titre d'un groupe de propriétés dans l'Éditeur de propriétés. Le titre ne sera pas inclus dans la table des matières automatique.
Obsolete	obsolete in 0.19	Utilisez-le pour indiquer qu'une fonctionnalité est devenue obsolète dans la version de FreeCAD spécifiée.
VersionNoteObsolete	obsolete in 0.19	Idem (variante de l'exposant).
Version	introduced in 0.18	Utilisez-le pour indiquer qu'une fonctionnalité a été introduite dans la version de FreeCAD spécifiée.
VersionNote	introduced in 0.18	Idem (variante de l'exposant).
VersionMinus	0.16 and below	Utilisez-le pour indiquer qu'une fonctionnalité est disponible dans la version de FreeCAD spécifiée et les versions antérieures.
VersionNoteMinus	0.16 and below	Idem (variante en exposant).
VersionPlus	0.17 and above	Utilisez-le pour indiquer qu'une fonctionnalité est disponible dans la version de FreeCAD spécifiée et les versions ultérieures.
VersionNotePlus	0.17 and above	Idem (variante de l'exposant).
ColoredText	Colored Text	Utilisez ce modèle pour colorer l'arrière-plan, le texte, ou l'arrière-plan et le texte. (ColoredText page pour plus d'exemples)
ColoredParagraph	Colored Paragraph	Utilisez ce modèle pour colorer le fond, le texte, ou le fond et le texte d'un paragraphe entier. (La page ColoredParagraph pour plus d'exemples)

Modèles complexes

Ces modèles requièrent davantage de paramètres d'entrée ou produisent un bloc de texte d'un format particulier.

Modèle	Apparence	Description
Prettytable	Ce tableau	Utilisez-le pour formater des tableaux comme celui-ci. Des propriétés de tableaux supplémentaires peuvent être ajoutées.
Caption	Une légende pour une image .	Utilisez-le pour ajouter une explication sous une image. Elle peut être alignée à gauche ou au centre.
Clear		Utilisez-le pour effacer des colonnes. Suivez la définition du modèle pour une explication détaillée. Il est souvent utilisé pour empêcher le texte de déborder à côté d'images sans rapport.
Code	import FreeCAD	Utilisez-le pour inclure des exemples de code multi-lignes avec une police monospace. Le langage par défaut est Python, mais d'autres langages peuvent être spécifiés. 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.
CodeDownload	Quelques étiquettes	A utiliser pour créer un lien sur une page macro.
Codeextralink	{{{2}}}	A utiliser si le code d'une macro est trop volumineux pour être hébergé sur le wiki. Le code peut alors être hébergé ailleurs, et le lien brut vers celui-ci spécifié avec ce modèle. Le gestionnaire des extensions utilisera ce lien.
Fake heading	Heading	Utilisez-le pour créer un titre qui ne sera pas automatiquement inclus dans la table des matières.
GuiCommand	See GuiCommand model	UUtilisez-le pour créer une boîte contenant des informations utiles pour documenter les commandes de l'atelier (outils).
TutorialInfo	Voir par exemple Tutoriel de modélisation de base.	Utilisez-le pour créer une boîte contenant des informations utiles pour documenter les tutoriels.
Macro	Voir par exemple Macro FlattenWire.	Utilisez-le pour créer une boîte contenant des informations utiles pour documenter les macros.
Docnav	Online Help Startpage Feature list Index	Utilisez-le pour créer une barre avec des flèches et des liens appropriés, ce qui est utile pour placer des pages dans un ordre particulier.
VeryImportantMessage	Important Message	Utilisez-le pour créer une boîte en surbrillance contenant un message très important. Utilisez-le avec parcimonie, uniquement pour indiquer des problèmes majeurs dans la fonctionnalité du logiciel, l'abandon d'outils, etc.
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.	Utilisez cette option pour les pages qui sont toujours en cours ou qui sont en train d'être retravaillées. N'oubliez pas de le supprimer lorsque la page est prête.
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.	Utilisez-le pour créer une boîte en surbrillance indiquant une page de documentation inachevée.
Softredirect		Utilisez-la à la place de la redirection normale, lorsque vous redirigez vers une page spéciale (comme Media: ou Category:), auquel cas la redirection normale est désactivée.
Quote	Cry "Havoc" and let slip the dogs of war. —William Shakespeare, Julius Caesar, act III, scene I	Utilisez-le pour créer un encadré de texte avec une citation et une référence littérale.
Userdocnavi, Powerdocnavi		Utilisez-les pour créer des boîtes de navigation pour la documentation utilisateur, la documentation pour les utilisateurs expérimentés et la documentation pour les développeurs. Cela permet de passer rapidement d'une section à l'autre de la documentation. Ils placent également la page correspondante dans la catégorie appropriée.

Les images et les captures d'écran sont nécessaires pour produire une documentation complète de FreeCAD. Elles sont particulièrement utiles pour illustrer les exemples et les tutoriels. Les images doivent être affichées dans leur taille originale, afin de présenter suffisamment de détails et d'être lisibles si elles contiennent du texte. Les images Bitmap ne doivent pas être redimensionnées.

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

Les images peuvent être téléchargées via la page Téléverser un fichier.

Nom

Donnez des noms significatifs à vos images. Si vous avez une image qui présente les caractéristiques d'une commande particulière, vous devez utiliser le nom de cette commande avec _example à la fin. Par exemple, pour la commande Draft Décaler, l'image doit s'appeler Draft_Offset_example.png.

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 devriez pas dépendre d'une configuration personnalisée de votre bureau ou de votre système d'exploitation lorsque vous créez des captures d'écran et vous devriez utiliser les défauts visuels de l'interface FreeCAD chaque fois que possible.

Pour créer une capture d'écran, vous pouvez utiliser les options fournies par votre système d'exploitation, ou l'une de ces macros : Macro Snip et Macro Screen Wiki.

Texte

Pour faciliter la traduction de la documentation, essayez d'éviter les captures d'écran contenant du texte. Si vous ne pouvez pas l'éviter, envisagez de prendre des captures d'écran distinctes de l'interface et de la Vue 3D. L'image de la vue 3D peut être réutilisée dans chaque traduction, tandis qu'un traducteur peut prendre une capture d'écran de l'interface localisée si nécessaire.

Icônes et illustrations

Référez-vous à la page Graphisme pour toutes les illustrations et icônes qui ont été créées pour FreeCAD, et qui peuvent également être utilisées dans les pages de documentation. Si vous souhaitez contribuer aux icônes, veuillez lire les Recommandations pour la charte graphique.

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 :

• Liste des codes ISO 639-1 pour identifier le code à deux lettres d'une langue particulière vers laquelle vous souhaitez traduire.
• Google Translate pour obtenir de l'aide sur les traductions.
• Deepl translator pour obtenir de l'aide sur les traductions.

Quelques conseils pour les traducteurs

Traduire le 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]]
}}

Traduit en :

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

Traduire les navi

{{FEM_Tools_navi}}

Traduit en :

{{FEM_Tools_navi/fr}}

Traduire les liens

[[Part_Workbench|Part Workbench]]

Traduit en :

[[Part_Workbench/fr|Atelier Part]]

Traduire les Docnav

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

Traduit en :

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

Exemple avec des icônes :

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

Traduit en :

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