Template:Macro/fr

From FreeCAD Documentation
Jump to: navigation, search

Generic macro icon {{{Name}}}

Description
{{{Description}}}

Auteur
[[User:{{{Author}}}|{{{Author}}}]]
Téléchargement
None
Liens
Version Macro
1.0
Dernière modification
None
Version(s) FreeCAD
None
Raccourci clavier
None
Voir aussi
None


Utilisation

Ce modèle est l'outil principal pour documenter les macros. Il doit être inséré comme première ligne dans les pages de documentation, après les codes <languages/> et <translate>. Voir un exemple ci dessous.

Generic macro icon SomeMacro

Description
Cette macro améliore toutes les formes du solide.

Version macro : 2.0
Date dernière modification : 2018-11-20
Auteur
WikiNomUtilisateur
Téléchargement
None
Liens
Version Macro
2.0
Dernière modification
2018-11-20
Version(s) FreeCAD
None
Raccourci clavier
None
Voir aussi
None


{{Macro/fr
|Name=SomeMacro
|Description=Cette macro améliore toutes les formes du solide.
|Author=WikiUserName
|Download=[https://www.freecadweb.org/wiki/images/2/2c/Text-x-python.png Text-x-python.png]
|Version=2.0
|Date=2018-11-20
}}

Les paramètres requis sont:

{{Macro/fr
|Name=SomeMacro
|Description=Cette macro améliore toutes les formes du solide.
|Author=WikiNomUtilisateur
|Download=Fichiers à télécharger, par exemple l'icône de la barre d'outils ...
|Date=2018-11-20
|Version=2.0
|FCVersion= 0.16 to 0.19
}}

D'autres paramètres peuvent être omis ou rester libre.

Paramètres requis

Le paramètre est spécifié avec sa valeur après le signe égal,parameter=value.

Chaque paramètre de la liste est séparé par le symbole barre verticale |.

|... |Name=MaMacro|Author=WikiNomUtilisateur| ...

Les paramètres peuvent être placés sur la même ligne, ou un paramètre par ligne.

|...
|Name=MaMacro
|Author=WikiNomUtilisateur
| ...

Les paramètres suivants sont requis.

Name
Le nom correctement capitalisé de la macro à documenter.
Le nom est utilisé pour récupérer l'icône MaMacro.svg ou MaMacro.png depuis le référentiel sur le wiki. Le modèle fonctionne correctement et si l'icône n'existe pas, dans ce cas, une icône générique Text-x-python.png est affichée.
Description
Une courte description de ce que fait la macro. Cette description est affichée dans Addon Manager.
Author
L'auteur de la macro. Ce nom est lié à la page de l'utilisateur sur le wiki, c'est-à-dire User:Author. Puisque les macros ne font pas partie intégrantes du code officiel de FreeCAD, les utilisateurs doivent adresser leurs questions au créateur de la macro. L'auteur d'une macro doit être accessible dans le forum, avec le même nom d'utilisateur que sur le wiki.
Download
Le ou les fichiers à télécharger , par exemple l'icône de la barre d'outils ou autres fichiers. Donner le lien complet de l'objet ex: Download=[https://www.freecadweb.org/wiki/images/2/2c/Text-x-python.png Text-x-python.png]
Date
Toutes les macros doivent avoir une date. Ceci est utile pour indiquer la dernière modification de la macro et avertir l'utilisateur de l'âge du code. Les macros très anciennes peuvent être obsolètes et ne pas fonctionner avec une version récente de FreeCAD.
FCVersion
Version(s) de FreeCAD utilisable(s) par la macro ex: FCVersion=0.16 to 0.19.

Paramètres optionnels

Les paramètres suivants sont facultatifs. S'ils ne sont pas inclus dans le modèle, ils afficheront une valeur par défaut.

Translate
Le nom traduit dans votre langue ce nom sera affiché dans le titre de la fenêtre. Par exemple Translate=Titre_traduit
Links
Autres liens d’aide par exemple, vidéo de macro, page de didacticiels associée à la macro.
Version
La version de la macro. Si aucune valeur n'est donnée, la valeur par défaut sera 1.0. Ceci est utile pour les auteurs, afin qu'ils puissent documenter des versions particulières de leurs propres macros.
Shortcut
Certaines macros peuvent introduire des raccourcis pour lancer des outils spécifiques. Indiquez les boutons de raccourci sur lesquels appuyer avec cette valeur. Si aucune valeur n'est donnée, la valeur par défaut est "Aucun".
SeeAlso
Liens facultatifs vers d'autres commandes connexes, par exemple, SeeAlso=[[Some Tool|Tool]].
Icon
Un fichier image différent de MaMacro.svg ou MaMacro.png pour utiliser comme icône. Ceci peut être utilisé pour inclure un icône spécifique qui ne porte pas le nom de la macro, par exemple, Icon=Some_other_name.svg