Manuel d’utilisation du logiciel libre Annuaire®

Extensions

Vous pouvez créer vos programmes d'extension pour rajouter n'importe quelle fonction à l'Annuaire®.
Très simples à réaliser, les programmes d'extensions peuvent être écrits dans n'importe quel langage, et nécessitent juste la gestion de quelques arguments en ligne de commande.

Emplacement
Le répertoire des extensions est par défaut : <le répertoire du programme>/Plugins. Il se change dans la zone « Répertoire des extensions : » de la fenêtre Affichage/Informations...

Lancement
Une extension se lance par le menu  Outils/Extensions.../<mon extension> .

Principe
Le programme d'extension reçoit en argument le nom :
       ¨d'un fichier temporaire contenant la sélection courante (créé par l'Annuaire®), et,
       ¨d'un second fichier temporaire de résultat pour une éventuelle substitution (créé par l'extension), la sélection dans l'Annuaire étant remplacée par celui-ci,
       ¨d'un troisième fichier temporaire (créé par l'extension) pour un compte-rendu.

Si aucun fichier de résultat n'est créé, l'appel d'une extension ne modifie pas la sélection courante.

Si aucun fichier de compte-rendu n'est généré, aucun compte-rendu ne s'affiche.

Son principe est le suivant : ce programme parcourt le fichier reçu dans l'argument –In=<nomFicIn>, l'analyse, écrit le résultat sous le nom –Out=<nomFicOut>, et éventuellement des messages pour l'utilisateur dans le fichier de nom –Log=<nomlog>.

L'Annuaire® attend la fin de l'exécution de l'extension pour autoriser d'autres interventions et, en cas de fichier résultat, de mettre à jour la sélection.

Le programme d'extension est autonome. Il doit pouvoir s'exécuter sans l'Annuaire, par exemple dans Démarrer/Exécuter... + la ligne de commande, ou mieux, dans une session DOS (commande cmd.exe ou command.com).

Liste des arguments
Il faut que le programme externe gère en ligne de commande :
(facultatif) --In=<nom du fichier d'origine> (si le plugin agit sur la sélection courante).
(facultatif) --Out=<nom du fichier de résultat> (si mise à jour souhaitée sur la liste)
(facultatif) --Log=<nom du fichier de trace> (si affichage d'un message à la fin d'exécution).
(facultatif) --Rang=<colonne courante> (si l'utilisateur veut connaitre la colonne courante

Exemple de la commande de lancement
<nomplugin> [--In=<MonFichierEntree>] [--Out=<MonFichierSortie>] [--Log=<MonFichierLog>] [--Rang=<Numéro de la colonne courante>]

Les arguments <...> sont renseignés par le programme Annuaire.

Exemple de fenêtre de compte-rendu donnant un exemple de ligne de commande et des statistiques.

Limites
25 extensions différentes sont disponibles dans le menu.
La taille du compte-rendu affiché est limité à 2000 premiers caractères.