Add Workbench to Addon Manager/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
(10 intermediate revisions by 2 users not shown)
Line 13: Line 13:
== Activer le mode développeur ==
== Activer le mode développeur ==


# Ouvrez l'[[Preferences Editor/fr|Éditeur de préférences]] : sélectionnez l'option {{MenuCommand|Édition → [[Image:Std_DlgPreferences.svg|16px]] Préférences...}} dans le menu.
# Ouvrez l'[[Preferences_Editor/fr|Éditeur de préférences]] : sélectionnez l'option {{MenuCommand|Édition → [[Image:Std_DlgPreferences.svg|16px]] Préférences...}} dans le menu.
# Sélectionnez l'option {{MenuCommand|[[Image:Std_AddonMgr.svg|16px]] Gestionnaire des extensions}} dans la barre de gauche.
# Sélectionnez l'option {{MenuCommand|[[Image:Std_AddonMgr.svg|16px]] Gestionnaire des extensions}} dans la barre de gauche.
# Dans l'onglet {{MenuCommand|Options du gestionnaire des extensions}}, cochez la case {{MenuCommand|Activer le mode développeur des extensions}}. Cela activera le bouton {{Button|Outils du développeur...}} dans le gestionnaire des extensions.
# Dans l'onglet {{MenuCommand|Options du gestionnaire des extensions}}, cochez la case {{MenuCommand|Activer le mode développeur des extensions}}. Cela activera le bouton {{Button|Outils du développeur...}} dans le gestionnaire des extensions.
Line 20: Line 20:
== Créer le fichier package.xml ==
== Créer le fichier package.xml ==


# Open the [[Std AddonMgr|Addon Manager]]: select the {{MenuCommand|Tools → [[Image:Std_AddonMgr.svg|16px]] Addon manager}} option from the menu.
# Ouvrez le [[Std_AddonMgr/fr|Gestionnaire des extensions]] : sélectionnez l'option {{MenuCommand|Outils → [[Image:Std_AddonMgr.svg|16px]] Gestionnaire des extensions}} dans le menu.
# Press the {{Button|Developer tools...}} button.
# Appuyez sur le bouton {{Button|Outils du développeur...}}.
# The {{MenuCommand|Addon Developer Tools}} dialog opens.<br>[[Image:Addon_Manager_Addon_Developer_Tools_Dialog.png|350px]]
# La boîte de dialogue {{MenuCommand|Outils pour le développeur d'extensions}} s'ouvre.<br>[[Image:Addon_Manager_Addon_Developer_Tools_Dialog.png|350px]]
# Saisissez les éléments suivants :
# Enter the following:
#* {{MenuCommand|Path to Addon}}: The path to the local git repository.
#* {{MenuCommand|Chemin vers l'extension}} : chemin vers le dépôt git local.
#* {{MenuCommand|Addon Name}}: This will appear in the listings of the Addon Manager.
#* {{MenuCommand|Nom de l’extension}} : ce nom apparaîtra dans les listes du gestionnaire des extensions.
#* {{MenuCommand|Description}}: Idem.
#* {{MenuCommand|Description}} : idem.
#* {{MenuCommand|Version}}: Idem.
#* {{MenuCommand|Version}} : idem.
#* {{MenuCommand|Repository URL}}
#* {{MenuCommand|URL du dépôt}} : idem.
#* {{MenuCommand|Primary branch}}
#* {{MenuCommand|Branche principale}} : idem.
#* {{MenuCommand|README URL}}: Recommended.
#* {{MenuCommand|URL du README}} : recommandé.
#* {{MenuCommand|Icon}}: The icon must be part of the repository.
#* {{MenuCommand|Icône}} : l'icône doit faire partie du dépôt.
# Press the {{Button|[[Image:List-add.svg|16px]]}} button at the bottom of the dialog.
# Appuyez sur le bouton {{Button|[[Image:List-add.svg|16px]]}} au bas de la boîte de dialogue.
# The {{MenuCommand|Content Item}} dialog opens.<br>[[Image:Addon_Manager_Content_Item_Dialog.png|350px]]
# La boîte de dialogue {{MenuCommand|Élément de contenu}} s'ouvre.<br>[[Image:Addon_Manager_Content_Item_Dialog.png|350px]]
# The {{MenuCommand|Content type}} should be set to {{Value|Workbench}}.
# Le {{MenuCommand|Type de contenu}} doit être défini sur {{Value|Atelier}}.
# Check the {{MenuCommand|This is the only item in the Addon}} checkbox.
# Cochez la case {{MenuCommand|C'est le seul élément de l'extension}}.
# Enter the {{MenuCommand|Workbench class name}}. This is the class name specified in the {{FileName|InitGui.py}} file.
# Saisissez le nom de la classe {{MenuCommand|Atelier}}. Il s'agit du nom de classe spécifié dans le fichier {{FileName|InitGui.py}}.
# For the {{MenuCommand|Subdirectory}} enter {{Value|./}}.
# Pour le {{MenuCommand|Sous-répertoire}}, entrez {{Value|./}}.
# Press the {{Button|OK}} button to close the dialog.
# Appuyez sur le bouton {{Button|OK}} pour fermer le dialogue.
# Press the {{Button|Save}} button to close the {{MenuCommand|Addon Developer Tools}} dialog and save the {{FileName|package.xml}} file.
# Appuyez sur le bouton {{Button|Enregistrer}} pour fermer la boîte de dialogue {{MenuCommand|Outils pour le développeur d'extensions}} et enregistrer le fichier {{FileName|package.xml}}.
# Press the {{Button|[[Image:Process-stop.svg|16px]] Close}} button to close the Addon Manager.
# Appuyez sur le bouton {{Button|[[Image:Process-stop.svg|16px]] Fermer}} pour fermer le gestionnaire des extensions.
# Poussez le fichier créé vers votre dépôt distant.
# Push the created file to your remote repository.


== Add the workbench to the .gitmodules file ==
== Ajouter l'atelier au fichier .gitmodules ==


# Fork https://github.com/FreeCAD/FreeCAD-addons.
# Faites un fork https://github.com/FreeCAD/FreeCAD-addons.
# Créez une nouvelle branche.
# Create a new branch.
# Edit the {{FileName|.gitmodules}} file to include your new Addon, in alphabetical order.
# Modifiez le fichier {{FileName|.gitmodules}} pour inclure votre nouvelle extension, par ordre alphabétique.
# Push the new branch to GitHub.
# Poussez la nouvelle branche vers GitHub.
# Submit a Pull Request to the FreeCAD-Addons repository with the new {{FileName|.gitmodules}} file.
# Soumettez une Pull Request au dépôt FreeCAD-Addons avec le nouveau fichier {{FileName|.gitmodules}}.


== See also ==
==Voir aussi==


* [[Workbench_creation|Workbench creation]]
* [[Workbench_creation/fr|Création d'atelier]]
* [[Package_Metadata|Package Metadata]]: Detailed information about the {{FileName|package.xml}} file.
* [[Package_Metadata|Métadonnées du package]] : informations détaillées sur le fichier {{FileName|package.xml}}.





Revision as of 08:49, 19 November 2022

Other languages:

Introduction

Ces instructions expliquent, étape par étape, comment ajouter un atelier Python au Gestionnaire des extensions.

Conditions requises :

Activer le mode développeur

  1. Ouvrez l'Éditeur de préférences : sélectionnez l'option Édition → Préférences... dans le menu.
  2. Sélectionnez l'option Gestionnaire des extensions dans la barre de gauche.
  3. Dans l'onglet Options du gestionnaire des extensions, cochez la case Activer le mode développeur des extensions. Cela activera le bouton Outils du développeur... dans le gestionnaire des extensions.
  4. Appuyez sur le bouton OK pour fermer l'éditeur de préférences.

Créer le fichier package.xml

  1. Ouvrez le Gestionnaire des extensions : sélectionnez l'option Outils → Gestionnaire des extensions dans le menu.
  2. Appuyez sur le bouton Outils du développeur....
  3. La boîte de dialogue Outils pour le développeur d'extensions s'ouvre.
  4. Saisissez les éléments suivants :
    • Chemin vers l'extension : chemin vers le dépôt git local.
    • Nom de l’extension : ce nom apparaîtra dans les listes du gestionnaire des extensions.
    • Description : idem.
    • Version : idem.
    • URL du dépôt : idem.
    • Branche principale : idem.
    • URL du README : recommandé.
    • Icône : l'icône doit faire partie du dépôt.
  5. Appuyez sur le bouton au bas de la boîte de dialogue.
  6. La boîte de dialogue Élément de contenu s'ouvre.
  7. Le Type de contenu doit être défini sur Atelier.
  8. Cochez la case C'est le seul élément de l'extension.
  9. Saisissez le nom de la classe Atelier. Il s'agit du nom de classe spécifié dans le fichier InitGui.py.
  10. Pour le Sous-répertoire, entrez ./.
  11. Appuyez sur le bouton OK pour fermer le dialogue.
  12. Appuyez sur le bouton Enregistrer pour fermer la boîte de dialogue Outils pour le développeur d'extensions et enregistrer le fichier package.xml.
  13. Appuyez sur le bouton Fermer pour fermer le gestionnaire des extensions.
  14. Poussez le fichier créé vers votre dépôt distant.

Ajouter l'atelier au fichier .gitmodules

  1. Faites un fork https://github.com/FreeCAD/FreeCAD-addons.
  2. Créez une nouvelle branche.
  3. Modifiez le fichier .gitmodules pour inclure votre nouvelle extension, par ordre alphabétique.
  4. Poussez la nouvelle branche vers GitHub.
  5. Soumettez une Pull Request au dépôt FreeCAD-Addons avec le nouveau fichier .gitmodules.

Voir aussi