Template:Macro/fr

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 et. Voir un exemple ci dessous.

Les paramètres requis sont:

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

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  ou   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 [[Image:Text-x-python.png|24px]] 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.


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

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.
 * Version
 * La version de la macro. Si aucune valeur n'est donnée, la valeur par défaut sera . 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,.


 * Icon
 * Un fichier image différent de  or   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,