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 bac à sable (sandbox) pour tester votre code, par exemple, FreeCADDocu:Sandbox ou une page particulière avec votre nom Sandbox:Yourname. Les pages Sandbox doivent être placées dans la catégorie Sandbox. Cela se fait en ajoutant  au bas du code du wiki.
 * 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 marquent ce que l'on appelle des unités de traduction et sont créées par le système de traduction, vous ne devez jamais les créer manuellement. 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 : 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 :, 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.

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

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
 * [[Image:Draft_Wire.svg|24px|Texte facultatif qui s'affiche lorsque vous survolez l'image|link=Draft_Wire]].

Pour utiliser une image comme lien :


 * Lien image + lien texte
 * [[Image:Draft_Wire.svg|24px|link=Draft_Wire]] 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 :

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 complexes
Ces modèles requièrent davantage de paramètres d'entrée ou produisent un bloc de texte d'un format particulier.

Illustrations
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 à la fin. Par exemple, pour la commande Draft Offset, l'image doit s'appeler.

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.

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

Traduire le GuiCommand
Traduit en:

Traduire les navi
Traduit en:

Traduire les liens
Part Module

Traduit en:

Atelier Part

Traduire les Docnav
Traduit en:

Exemple avec des icônes :

Traduit en:

Créer des pages
Avant de créer une nouvelle page, vous devez d'abord vérifier si une page similaire existe déjà. Si c'est le cas, il est généralement préférable d'éditer cette page existante. En cas de doute, veuillez d'abord ouvrir un sujet sur le forum Wiki.

Pour créer une nouvelle page, effectuez l'une des opérations suivantes :
 * Visitez l'URL avec le nom de page souhaité, par exemple :  et cliquez sur 'créer cette page'.
 * Faites une recherche wiki sur le nom de la page et cliquez sur le texte rouge dans 'Créer la page "Ma nouvelle page" sur ce wiki!'.

Renommer les pages
FreeCAD étant un projet en développement permanent, il est parfois nécessaire de réviser le contenu du wiki. Si les noms des commandes sont modifiés dans le code source, les pages wiki qui les documentent doivent également être renommées. Cette opération ne peut être effectuée que par les administrateurs du wiki. Pour les informer, ouvrez un sujet dans le forum Wiki et indiquez l'opération de renommage nécessaire 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
Si vous devez supprimer un fichier, allez sur sa page et modifiez-la. Peu importe que la page soit vide ou non, ajoutez ceci comme premier élément :  et directement en dessous, décrivez pourquoi la page doit être supprimée. En outre, ouvrez un sujet dans le forum Wiki.

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

Discussion
Le sous-forum Wiki du forum FreeCAD offre un espace dédié pour discuter des sujets relatifs au wiki, de l'apparence du wiki et de tout autre sujet lié au wiki. Posez-y vos questions et faites-y des suggestions.

En anglais
Voir Glossaire.

Autres langues

 * Italien
 * Français
 * Allemand
 * Polonais