Les pages Wiki

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page WikiPages and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎polski

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 Snip.png pour saisir l'image dans la fenêtre sélectionnée ou Macro Screen Wiki Macro Screen Wiki.png 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.
    • Sur de nombreuses pages, vous verrez des balises comme <translate>...</translate> et de nombreuses balises simples comme celle-ci <!--T:8--> dans de nombreuses sections. Les premières permettent de bénéficier d'une aide à la traduction. Ne les modifiez pas. Ces derniers sont créés par le système. Ils relient titres et paragraphes avec leurs versions traduites. Si vous modifiez la numérotation, vous détruirez évidemment ces liens. Cependant, il est possible de déplacer des paragraphes ou de modifier la formulation tant que les balises restent avec eux. Si vous supprimez un paragraphe, vous devez supprimer la balise qui l'accompagne. Sachez que les changements apportés aux titres et paragraphes existants peuvent affecter les traductions en cours. Vos changements doivent en valoir la peine. Ne vous inquiétez pas lors de l'ajout de nouveau texte car le système ajoutera automatiquement de nouvelles balises après vos modifications. Pour plus d'informations, consultez Localisation et la page d'origine Mediawiki:Extension:Translate page.

Directives générales

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 Fichier → Sauvegarder, un autre modèle pour styliser les touches sur lesquelles appuyer, comme Shift, un autre modèle pour afficher une valeur booléenne true 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 {{Page in progress}} or {{UnfinishedDocu}} comme première ligne à une page. Avec {{UnfinishedDocu}}, vous invitez tout le monde à rejoindre et terminer la page avec {{Page in progress}} 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.

Structure

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.

Utiliser: Tutoriel sur la construction d'avions AeroCompany
Eviter: Tutoriel Sur La Construction d'Avions AeroCompany

Remarque: 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 WorkbenchXYZ 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 ToolTool 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|top]] en français [[#top|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 <div>. 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|pagename]]

Pour traduire cette ligne:

[[pagename/fr|nom de la page]]

Pour cette page, il s'agirait de [[WikiPages|WikiPages]]. 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#Top Page Links]]

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

[[WikiPages#Top Page Links|WikiPages]]

Pour traduire cette ligne:

[[WikiPages/fr#Début|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 [[#Top Page Links|Top Page Links]] 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 #Capture d'écran 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" .

Veuillez vous référer à la page Gui Command pour des indications spécifiques sur la façon dont ces commandes doivent être présentées, et utilisez le Modèle GuiCommand pour commencer à remplir les informations le cas échéant. Utilisez Boiler NonCommand pour renseigner les informations qui ne sont pas liées à une commande.

Tutoriels

Un tutoriel bien écrit devrait apprendre à l'utilisateur comment obtenir rapidement certains résultats pratiques. Cela ne devrait pas être extrêmement long mais il devrait inclure une quantité suffisante d'instructions étape par étape et d'images pour guider l'utilisateur dans l'utilisation de différents outils.

Une série de tutoriels dans lesquels la complexité chacun augmente et être utile pour explorer les bases, les outils intermédiaires et experts pour un ou plusieurs ateliers.

Voir les tutorial guidelines pour des idées de base sur la façon de mettre en place un tutoriel.

Voir quelques exemples

À mesure que FreeCAD évolue, certains tutoriels peuvent devenir trop anciens pour les versions modernes du programme. Il est donc important de mentionner la version ou les limitations des outils utilisés dans cette version spécifique au tutoriel.

Langue

Expressions

Vous devriez éviter les expressions génériques familières comme "un couple". Veuillez reformuler comme "certains" s'il s'agit d'un nombre indéterminé ou utilisez la quantité correcte.

Concision

Essayez d'éviter les répétitions pour que les descriptions soient courtes.

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 de modélisation de pièces solides complexes.

Style

Modèles

Le style des pages du wiki FreeCAD est obtenu grâce à l'utilisation de modèles (Help:Editing#Templates_and_transcluding_pages). Veuillez n'utiliser que les modèles répertoriés dans les tableaux ci-dessous. Cela permettra de redéfinir le style de l'ensemble du wiki en mettant à jour le modèle et aidera à obtenir un aspect et une sensation normalisés sur toutes les pages. Vous ne devrez utiliser directement les balises HTML que pour des cas particuliers.

Vous pouvez voir la liste complète des modèles définis en accédant à Special:PrefixIndex/Template:. Cependant, tous les modèles répertoriés ne sont pas utilisés pour styliser le texte et d'autres sont obsolètes. Veuillez n'utiliser que ceux des tableaux ci-dessous.

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

Modèles de style simples

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

Modèle Apparence Description
Emphasis emphasis Utilisez-le pour mettre en valeur un morceau de texte.
KEY Alt Utilisez-le pour indiquer une touche du clavier sur laquelle vous devez appuyer.
ASCII Ascii 065.svg Utilisez-le pour indiquer une touche ascii dans une image (.svg) qui doit être enfoncé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 appuye
RadioButton RadioButtonFalse.svg Cancel Utilisez-le pour indiquer un bouton radio dans l'interface utilisateur graphique qui doit être RadioButtonTrue.svg Checked ou RadioButtonFalse.svg not Checked.
CheckBox CheckBoxFalse.svg Cancel Utilisez-le pour indiquer une case à cocher dans l'interface utilisateur graphique qui doit être CheckBoxTrue.svg Checked ou CheckBoxFalse.svg not Checked.
SpinBox 1.50 SpinBox.svg Utilisez-le pour indiquer une boîte de sélection numérique dans l'interface utilisateur graphique qui doit être modifiée.
ComboBox Menu 1 ComboBox.svg Utilisez-le pour indiquer un ComboBox dans l'interface utilisateur graphique qui doit être modifié.
FALSE, false false, false Utilisez-le pour indiquer une valeur booléenne FALSE, par exemple, en tant que propriété dans l'Éditeur de propriétés. Ceci est un raccourci. Puisqu'il s'agit d'une valeur, préférez le modèle Value false
TRUE, true true, true Utilisez-le pour indiquer une valeur booléenne TRUE, par exemple, en tant que propriété dans l'Éditeur de propriétés. Ceci est un raccourci. Puisqu'il s'agit d'une valeur, préférez le modèle 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 Use it to indicate user typed input text.
SystemOutput Output text Utilisez-le pour indiquer le texte d'entrée saisi par l'utilisateur.
Optional [Insert or not] Utilisez-le dans les descriptions de programmation pour indiquer un argument de texte ou de fonction facultatif.
Choice That } Utilisez-le dans les descriptions de programmation pour indiquer un choix entre deux valeurs.
Incode import FreeCAD Utilisez-le pour inclure le code source en ligne avec une police monospace. Il doit tenir sur une seule ligne.
Variable TYPEMyAttribute Utilisez-le dans les descriptions de programmation pour indiquer une valeur ou un paramètre, éventuellement avec un type devant lui.
PropertyView ViewColor Utilisez-le pour indiquer une propriété View (Vue) dans l'Éditeur de propriétés. Les propriétés de la vue sont Line Color, Line Width, Point Color, Point Size etc...
PropertyData DataPosition Utilisez-le pour indiquer une propriété Data dans l'Éditeur de propriétés. Les propriétés des données sont différentes pour différents 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.
PropertyTasks / TasksTag TASK Tasks Utilisez-le pour indiquer l'argument des tâches.
TitleTasks ===Tasks Title=== Utilisez-le pour indiquer le titre des tâches.
Version introduced in version 0.18 Utilisez-le pour indiquer qu'une fonctionnalité particulière n'est disponible qu'à partir d'une version spécifique de FreeCAD.
VersionMinus version 0.16 and below Use it to indicate that a particular feature is below starting with a specific FreeCAD version.
VersionPlus v0.17 and above Utilisez-le pour indiquer qu'une fonctionnalité particulière est ci-dessous en commençant par une version spécifique de FreeCAD.
Obsolete obsolete in version 0.19 Utilisez-le pour indiquer qu'une fonctionnalité particulière est obsolète à partir d'une version spécifique de FreeCAD.
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 l'arrière-plan, le texte ou l'arrière-plan et le texte sur toute la longueur de la page. (ColoredParagraph page pour plus d'exemples)

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.

Modèle Apparence Description
Prettytable Ce tableau Utilisez-le pour formater des tableaux comme celui-ci; des propriétés de table supplémentaires peuvent être ajoutées.
Caption

Une légende pour une image

Une légende pour une image (centrée)

Utilisez-le pour indiquer un texte d'explication sous une image dans la documentation et les tutoriels. Il peut être aligné à gauche ou au centre.
Clear Utilisez-le pour effacer les colonnes. Suivez la définition du modèle pour une explication détaillée. Il est souvent utilisé pour empêcher le texte de circuler à côté d'images sans rapport.
Code
import FreeCAD
Style de code source. Utilisez-le pour inclure des exemples de code multiligne avec une police monospace. La langue par défaut est Python, mais d'autres langues peuvent être spécifiées.
Fake heading
Heading
Utilisez-le pour créer un en-tête qui ne sera pas inclus automatiquement dans la table des matières utilisée pour la documentation hors ligne.
GuiCommand Voir Gui Command et Modèle GuiCommand Utilisez-le pour créer une boîte contenant des informations utiles pour documenter les outils d'atelier (GuiCommands) de FreeCAD.
Macro Voir l'exemple Macro FlattenWire Utilisez-le pour créer une boîte contenant des informations utiles pour documenter les macros.
Docnav Utilisez-le pour créer une barre avec les mots "next", "previous" et "index" et des liens vers les articles appropriés, ce qui est utile pour naviguer dans certaines pages d'aide qui suivent une séquence particulière.
VeryImportantMessage
Important Message
Utilisez-le pour créer un encadré surligné avec un message très important. Utilisez-le avec parcimonie, uniquement pour indiquer des problèmes majeurs dans le fonctionnement du logiciel, l'arrêt des outils et autres.
Softredirect Utilisez-le à la place de la redirection normale lorsque vous redirigez vers une page spéciale (telle que Média: ou Catégory:), auquel cas la redirection normale est désactivée.
UnfinishedDocu

This documentation is not finished. Please help and contribute documentation.

Gui Command explains how tools should be documented. See Draft ShapeString for an example of a well documented tool. Browse Category:UnfinishedDocu/fr to see 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.
Quote

Criez "Havoc" et laissez échapper les chiens de guerre.

—William Shakespeare, Julius Caesar, act III, scene I
Utilisez-le pour créer une zone de texte avec une citation et une référence littérales.
Userdocnavi, Powerdocnavi, Devdocnavi Utilisez-les pour créer des zones de navigation pour la documentation utilisateur, la documentation utilisateur expérimenté et la documentation développeur. 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. (2019) Actuellement, Userdocnavi est le plus utilisé, tandis que les autres ne sont pas utilisés. C'est un travail en cours pour les concevoir correctement et les ajouter à toutes les pages de documentation.

Modèles obsolètes

Modèle Apparence Description
Click Deprecated Utilisez-le pour superposer un lien invisible sur une image. Vous devriez plutôt utiliser la méthode d'inclusion d'image native du wiki.
DASH Deprecated Utilisez-le pour afficher une zone de texte multiligne pour le code, avec un arrière-plan coloré. Vous devez utiliser le style que vous obtenez en commençant la ligne source avec un espace.
Disambig Deprecated Utilisez-le comme message de désambiguïsation dans une page.
Information Deprecated Utilisez-le pour créer un tableau standardisé fournissant des informations complètes sur le fichier, y compris une description de ce qu'il montre et comment il a été créé, le statut du copyright et la source.
Languages Deprecated Utilisez-le pour afficher les traductions disponibles. Il est devenu obsolète avec le nouveau wiki qui gère les traductions et les langues via un plugin dédié.
Message Deprecated Utilisez-le pour afficher un bloc de texte avec un arrière-plan coloré, pour indiquer un message de faible importance.
Screenshot Deprecated Utilisez-le pour insérer des captures d'écran du logiciel. Voir plutôt #Capture d'écran.

Pour avoir une vue globale sur l'aspect chromatique, voir Basic Graphic Template.

Code

Le code doit être stylisé à l'aide du modèle Code. La description de ce code devrait suivre par la suite. L'accentuation doit être strictement utilisée "uniquement" sur le mot ou les lignes qui doivent être accentuées.

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.

Exemple de description de code incorrect

makeAngularDimension (center,[angle1,angle2],p3): creates an angular Dimension from the given center, 
with the given list of angles, passing through p3. Returns the newly created object.

Exemple de bonne description de code

Dimension = makeAngularDimension(center, anglelist, p3)
Dimension = makeAngularDimension(center, [angle1, angle2], p3)
  • Creates an angular dimension from the given center point, the anglelist containing angle1 and angle2, and passing through point p3.
  • Returns the newly created Dimension object.

Le texte ci-dessus est laissé en anglais pour illustrer ce que devrait être la description du code.

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 _example à la fin.

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.

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.

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.

Si votre capture d'écran contient du texte, utilisez la même résolution que l'interface d'origine de FreeCAD afin que le texte soit lisible.

Bonne taille pour la lecture de texte

PartDesign Paramètres de révolution (taille d'origine, 307px)

Mauvais dimensionnement pour la lecture de texte

PartDesign Paramètres de révolution (mis à l'échelle à 190px)

Dans la deuxième image, le texte est moins clair et il y a des artefacts visuels dus à la remise à l'échelle de la largeur d'origine de 307px à 190px.

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.

Quelques conseils pour les traducteurs

Paramétrage de GuiCommand

{{GuiCommand
|Name=FEM EquationFluxsolver
|Icon=Fem-equation-fluxsolver.svg
|MenuLocation= Solve  Equation fluxsolver
|Workbenches=[[Fem Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

traduit en:

{{GuiCommand/fr
|Name=FEM EquationFluxsolver
|Name/fr=FEM Solveur du flux d'équation
|Icon=Fem-equation-fluxsolver.svg
|MenuLocation= Solveur  Solveur du flux d'équation
|Workbenches=[[Fem_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM tutoriel]]
}}

Définition du modèle

{{FEM Tools navi}}

traduit en:

{{FEM Tools navi/fr}}

Définition du lien

[[Part_Module]]

traduit en:

[[Part_Module/fr|Atelier Pièces]]

ou:

[[Part_Module|Part Module]]

traduit en:

[[Part_Module/fr|Atelier Pièces]]

Définition de Docnav

Pour localiser la barre de navigation Template:Docnav, consultez ce fil dans le forum Docnav previous/next.

Il s'agit essentiellement de créer un nouveau modèle traduit, Template:Docnav/it.

Le modèle traduit doit inclure les liens localisés appropriés en tant que paramètres "previous" et "next" ainsi que le texte traduit:

{{docnav/it
|[[Installing/it|Installazione]]
|[[Mouse Model/it|Navigazione 3D - Tipo di mouse]]
}}

Le modèle traduit doit inclure les liens localisés appropriés en tant que paramètres "previous" et "next" avec icône, ainsi que le texte traduit:

{{Docnav/it
|[[Mesh Import/it|Importa Mesh]]
|[[Mesh MeshFromShape/it|Crea uno Mesh da un shape]]
|[[Mesh_Workbench|Mesh]]
|IconL=Mesh_ImportMesh.png
|IconC=Workbench_Mesh.svg
|IconR=Mesh_FromPartShape.svg
}}

Comprend également la catégorie de langue appropriée [[Category:Template/it]]

Si la catégorie localisée n'est pas incluse dans le modèle traduit, le modèle traduit restera dans la catégorie anglaise par défaut.

Utilisation de pages spéciales

  • Special:LonelyPages répertorie les pages qui ne sont pas liées à d'autres pages du wiki FreeCAD et donc personne ne peut accéder à ces pages. Si vous en trouvez dans votre langue maternelle, essayez de créer la connexion qui existe dans la version anglaise de la page, sinon personne ne pourra les lire.
  • Special:UncategorizedPages répertorie les pages sans catégorie attribuée. Elles n'apparaissent donc pas lorsque vous parcourez le wiki par catégories. Attribuez une catégorie.
  • Special:WantedPages répertorie les pages qui sont appelées dans une page mais qui n'existent pas. Celles-ci sont affichées sous forme de liens rouges dans le texte. Déprécié et très ennuyeux.
  • Autres recherchés (fichiers et modèles)
  • Special:WantedCategories répertorie les catégories qui sont utilisées dans une page mais qui n'existent pas. Elles peuvent être créées immédiatement en cliquant sur le lien rouge. Sauter.
  • Special:Categories répertorie toutes les catégories du wiki. Cela vous permett de comparer le nombre de pages dans une catégorie traduite, qui devrait de préférence correspondre au nombre de pages dans la catégorie de langue anglaise.
  • Special:ListRedirects répertorie toutes les pages redirigées. S'il y a des liens rouges, quelque chose ne fonctionne pas bien. Recherchez le lien manquant. Des liens bleu clair mènent à des pages en dehors du site, pas de problème.
  • Special:RecentChanges répertorie les modifications les plus récentes apportées au wiki, y compris les pages modifiées, le nombre de modifications apportées à une page particulière, qu'il s'agisse d'ajouts ou de soustractions et l'utilisateur responsable.
  • Special:LanguageStats affiche les statistiques de traduction pour tous les groupes de messages pour une seule langue. Affiche les parties non traduites dans une langue donnée, uniquement pour les pages marquées pour la traduction. Pour voir ce qui n'a pas été traduit, définissez le code de langue et appuyez sur Afficher les statistiques. Il contient également le lien pour voir ce qui a été récemment traduit dans cette langue. Remarque: si la saisie du code anglais en affiche des pages, il est probable que la page d'origine contienne des erreurs de balisage, à l'exception de la barre latérale.
  • Special:PageTranslation répertorie toutes les pages marquées pour la traduction et celles non marquées mais qui ont des balises de traduction. Seuls les administrateurs peuvent marquer les pages à traduire.
  • Category:Pages to delete: répertorie toutes les pages à supprimer car elles ont été créées par erreur, sont obsolètes ou ne sont plus nécessaires.

Renommer, déplacer et supprimer

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:

ancien nom                      nouveau nom
OLD_PAGE_NAME    NEW_PAGE_NAME
...

Déplacer les fichiers

Renommer des fichiers, c'est dans de nombreux cas les déplacer. Cela signifie qu'ils deviendront un nouveau fichier sous un nouveau nom tant que son contenu sera conservé.

Pour déplacer un fichier, allez sur sa page (https://www.freecadweb.org/wiki/File:***.***) et cliquez en haut à droite sur le menu More et sélectionnez là le menu qui apparaît Move. Cela ouvre une page avec toutes les informations sur la façon d'effectuer un mouvement.

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: {{Delete}} 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.

Robots

Rendez-vous sur WikiRobots pour trouver des instructions sur la configuration et l'utilisation de robots pour automatiser des tâches répétitives sur le Wiki de FreeCAD.

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.

Réflexions

Tout ce qui suit est sujet à discussion. Vous pouvez arrêter de lire ici si vous n'avez pas l'intention de suggérer des modifications aux règles de style de FreeCAD WikiPages. Vous devriez discuter de tout sujet lié au wiki sur le [sous forum Development/Wiki]. Les contributions sont les bienvenues.


Voir Wiki brainstorming. Les informations ici ont été déplacées pour éviter d'encombrer cette page.---Vocx (talk) 00:38, 2 November 2018 (UTC)

Terminologie - Règles de dénomination

Anglais

Voir Glossary

Autres langues

Start

proposition de création de la page:

Voir Sandbox:Start center. Les informations ici ont été déplacées pour éviter d'encombrer cette page.---Vocx (talk) 00:28, 2 November 2018 (UTC)

Bac à sable pour Macro Dimensions

Voir Sandbox:Macro dimensions. Les informations ici ont été déplacées pour éviter d'encombrer cette page.---Vocx (talk) 23:43, 1 November 2018 (UTC)

Bac à sable pour PartDesign Fillet

Voir Sandbox:PartDesign fillet. Les informations ici ont été déplacées pour éviter d'encombrer cette page.---Vocx (talk) 23:36, 1 November 2018 (UTC)