Template:GuiCommand/fr

Emplacement du menu
{{{Name/fr}}}
Aucun
Ateliers
{{{Workbenches}}}
Raccourci par défaut
Aucun
Introduit dans la version
-
Voir aussi
Aucun

Utilisation

Ce modèle génère le cartouche (infobox) qui est situé à droite des pages documentant les commandes de l'interface graphique (GuiCommands). Ce cartouche inclut les informations essentielles sur la commande ainsi que la table des matières. Le modèle doit être inséré à la toute première ligne des nouveaux documents.

Le code minimal requis pour l'utilisation de ce modèle est tel que ci-dessous (résultat affiché ci-contre à droite) :

{{GuiCommand/fr|Name=SampleCommand|Name/fr=SampleCommand(titre traduit)|MenuLocation=Sample → Commande...|Workbenches=Wb1,Wb2}}

Emplacement du menu
SampleCommand
Sample → Command...
Ateliers
Wb1,Wb2
Raccourci par défaut
DefaultShortcut
Introduit dans la version
-
Voir aussi
OtherTopic

Paramètres minimaux

Les paramètres suivants sont utilisés au format [parametètre]=[valeur], avec chaque paramètre de la liste séparé par une barre verticale (|) :

Name: Le nom de la commande à documenter, dans sa version d'origine anglaise, en respectant la capitalisation.; Le nom permet aussi d'extraire et d'afficher l'icône de la commande au format .PNG depuis le dépôt d'images du wiki.
Name/fr: Le nom de la commande à documenter, dans sa traduction française. Dans le cas où l'icône n'est pas trouvé un icône générique est affiché (voir Empty)).
MenuLocation: L'emplacement de la commande dans la structure de menus de FreeCAD.
Workbenches: Le ou les atelier(s) de FreeCAD où la commande peut être trouvée.

Paramètres optionnels

Les paramètres suivants sont optionnels. S'ils ne sont pas inclus dans le modèle, par défaut les champs correspondants afficheront « Aucun ».

Shortcut: Le raccourci-clavier par défaut dans FreeCAD.
SeeAlso: Lien optionnel vers des commandes connexes.
Icon: une icône avec un nom différent comme pagename.png peut être utilisée en définissant la variable Icon (un autre format peut être utilisé, par exemple: myIcon.svg)
Empty: Si Empty=1 alors aucun icône n'est affiché
Version: insère le numéro de version de FreeCAD dans lequel la commande a été introduite pour la première fois. Pas besoin d'ajouter le numéro de révision. Merci d’envisager d’ajouter ce paramètre à toutes les nouvelles commandes.

Localisation

Le code requis pour ce modèle est différent si vous utilisez une version localisée. Pour plus d'information voir la page Localisation.

En premier lieu, une version localisée du modèle doit exister ou être créée (il s'agit de cette version).
Le modèle localisé doit être nommé :
```
Template:GuiCommand/AA
```
où /AA est le suffixe de deux lettres pour la langue désirée, par exemple /fr pour la localisation française.
La méthode pour appeler le modèle GuiCommand localisé dans un document GuiCommand est :
```
{{GuiCommand/AA|Name=SampleCommand|Name/AA=SampleCommand(titre traduit)|MenuLocation=Sample → Commande...|Workbenches=Wb1,Wb2}}
```
où /AA est le suffixe de deux lettres pour la langue désirée, par exemple /fr pour la localisation française.
- Dans l'exemple ci-dessus, le format du paramètre Name est crucial. Name=SampleCommand permet d'afficher le bon fichier d'icône, qui n,est pas localisé. Name/AA=SampleCommand(titre traduit) affiche le nom localisé de la commande.
Assurez-vous d'ajouter la version localisée de ce modèle à la liste de langues du modèle GuiCommand original.

Modèle GuiCommand

Pour un modèle complet d'une page GuiCommand, voir GuiCommand model/fr.