En cours de rédaction

Les macros sont des scripts (utilisant le langage Groovy) qui permettent d'automatiser des tâches dans TXM tout en permettant aussi :

  • de lance plus facilement du script par un simple double-click
  • de permettre de construire facilement un interface graphique de paramétrage du script

Rajouter une macro : Pour rajouter une macro, il suffit de copier le fichier “UneMacro.groovy” dans le dossier “$TXMHOME/scripts/macros"
Une fois cela fait, la macro sera disponible dans la vue Macro (ouvrable depuis le menu Affichage > Vues > Macros") avec le nom
"UneMacro".

Lancer une macro :
La macro se lance en faisant un double-clique sur le nom du fichier. Une macro pourra utilisé la sélection courante de la vue Corpus.

TXMHOME est le chemin du dossier utilisateur de TXM, il est différent entre chaque architecture. Par exemple :
  * Windows XP : "C:\Documents and settings\<user>\TXM"
  * Windows Vista&7 : "C:\Users\<user>\TXM"
  * Linux : "/home/<user>/TXM"
  * Mac : "/Users/<user>/TXM"

Définition technique :

  * Une macro est un script groovy
  * les paramètres configurables et typés : valeur par défaut, nom, type ...
  * se lance par un double clic dans la vue Macro
  * au lancement créé une UI pour les paramètres annotés (voir plus bas pour l'annotation)
  * stockés dans le dossier "$TXMHOME/scripts/macros”

  • possède les mêmes variables globales (bindings) que les autres scripts Groovy de TXM : corporaSelection, …

Créer une macro

  • Ouvrir vue “Macros”
  • Cliquer sur bouton “New macro” (ou à partir du menu contextuel de la vue)
  • Une fenêtre s'ouvre : rentrer le nom de la macro. Il y a quelques contraintes de noms:
    • La premieres lettre n'est pas un nombre
    • pas de ponctuation
    • pas de caractère spécial
  • La nouvelle macro apparaît dans la vue macro

Définir les paramètres

Description de la syntaxe d'annotation (Java) des paramètres

Liste des types d'éléments de paramétrage

  • String : un champ textuel
  • String-Long : une zone de texte éditable
  • Query : un champ de requête
  • Integer : un Spinner, un champ textuel avec contrôle des caractères
  • Float : un champ textuel avec contrôle des caractères
  • Boolean : un bouton de type check box
  • Date : année / mois / jours / heure - durée ou date (pas implémenté)
  • File : ouvre une popup de sélection de fichier
  • File-Folder : ouvre une popup de sélection de dossier
public/tutoriel_macros.txt · Dernière modification: 2014/01/23 17:50 par matthieu.decorde@ens-lyon.fr