Modification de compléments

Modification de compléments

Il est souvent nécessaire de modifier un complément afin de l'améliorer ou d'ajouter de nouvelles fonctionnalités.

Cette rubrique présente la procédure de modification d'un complément.

Etapes :

1. Vérifier que le projet de complément initial fonctionne.

   Si vous avez déjà créé un projet de complément, cette étape est quelque peu redondante. Toutefois, elle peut s'avérer utile dans les cas où du temps s'est écoulé entre la première version et la mise à jour que vous êtes sur le point d'effectuer. En outre, le fait de tester et de vérifier les fonctionnalités vous procure une base pour effectuer les modifications. Voici quelques points à prendre en compte pour cette étape de la procédure :

   • Testez votre complément sur un ordinateur utilisant les mêmes workflows que ceux des utilisateurs du complément.
   • Sauvegardez votre projet de complément existant, au cas où vous devriez annuler les changements.
   • Si des erreurs sont présentes dans la version actuelle du complément, vérifiez que vous pouvez les reproduire dans votre environnement de développement.
     Remarque :

     Ne corrigez pas le code avant d'effectuer une sauvegarde.

2. Apporter des améliorations ou ajouter de nouvelles fonctionnalités.

   Maintenant que vous disposez d'une sauvegarde du projet de complément, vous pouvez commencer à apporter des modifications :

   1. Modification des paramètres de projet ou du contenu des compléments.
      • Si vous avez besoin de mettre à jour les paramètres, tels que la description, l'image ou la version, lancez l'assistant de complément Python et naviguez vers le dossier de projet existant (pas le projet de sauvegarde).
        Remarque :

        Une zone de message s'ouvre vous informant de la sauvegarde du script Python existant et qu'un nouveau script source sera créé à l'enregistrement des modifications. Le script de sauvegarde est nécessaire lorsqu'il n'existe aucun moyen de savoir si de nouveaux types de compléments (par exemple bouton) sont créés.

      • Si des modifications sont apportées qui ne changent pas le script Python, supprimez le script nouvellement créé du dossier de travail et donnez à la sauvegarde son nom d'origine.
      • Si de nouveaux types de compléments sont ajoutés ou des modifications apportées aux noms de classe, copiez le code du script de sauvegarde dans le script nouvellement créé, le cas échéant.
   2. Modification du script Python.
      • Si vous avez simplement besoin de mettre à jour et d'ajouter des fonctionnalités au script de complément existant, il n'y a pas de nécessité d'ouvrir l'assistant de complément Python. Il vous suffit d'apporter les changements nécessaires au script Python et d'enregistrer.
        Remarque :

        Ne renommez pas la classe dans le script. Le nom de la classe est référencé dans le fichier config.xml. Le fait de le modifier dans le script implique la mise à jour du fichier config.xml.

3. Tester les modifications.

   Une fois que vous avez terminé les modifications, il est important de recréer le fichier de complément et de le tester avant de le partager. La procédure correspondante est indiquée à la rubrique Test d'un complément.

4. Repartager le complément.

   Après avoir testé le bouton et confirmé que le complément fonctionne comme prévu, vous êtes prêt à déployer et partager le complément. Pour plus d'informations, reportez-vous à la rubrique Partage des compléments.