Outils pour utilisateurs

Outils du site


public:tutoriel_macros

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Prochaine révision
Révision précédente
public:tutoriel_macros [2013/05/03 10:09]
matthieu.decorde@ens-lyon.fr créée
public:tutoriel_macros [2019/05/21 10:37] (Version actuelle)
matthieu.decorde@ens-lyon.fr
Ligne 1: Ligne 1:
 <​note>​En cours de rédaction</​note>​ <​note>​En cours de rédaction</​note>​
  
-Macro +Les macros sont des scripts (utilisant le langage Groovy) qui permettent d'​automatiser des tâches dans TXM tout en permettant aussi : 
-  * script groovy +  * de lance plus facilement du script par un simple double-click 
-  * paramètres ​configurable ​: valeur par défaut, nom, type ...+  * 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   * se lance par un double clic dans la vue Macro
-  * au lancement créé une UI pour les paramètres +  * au lancement créé une UI pour les paramètres ​annotés (voir plus bas pour l'​annotation) 
-  * stockés dans le dossier "​macros"​ +  * stockés dans le dossier "$TXMHOME/​scripts/​macros"​ 
-  * possède les mêmes variables globales (bindings) que les scripts Groovy de TXM : corporaSelection,​ ...+  * possède les mêmes variables globales (bindings) que les autres ​scripts Groovy de TXM : corporaSelection,​ ...
  
-=== Créer ​ ===+=== Créer ​une macro ===
   * Ouvrir vue "​Macros"​   * Ouvrir vue "​Macros"​
-  * Cliquer sur bouton "New macro" ou à partir du menu contextuel +  * Cliquer sur bouton "New macro" ​(ou à partir du menu contextuel ​de la vue) 
-  * Une fenetre ​s'​ouvre : rentrer le nom de la macro. contraintes de noms: premieres lettre ​!= nombre ​pas de ponctuation ​ou char spécial+  * 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   * La nouvelle macro apparaît dans la vue macro
  
Ligne 19: Ligne 41:
 Description de la syntaxe d'​annotation (Java) des paramètres Description de la syntaxe d'​annotation (Java) des paramètres
  
-=== Liste des éléments de paramètrage ​=== +=== Liste des types d'éléments de paramétrage ​=== 
-  * Chaîne de caractère ​: un champ textuel +  * String ​: un champ textuel 
-  * Chaîne de caractère avec sauts de ligne : une zone de texte éditable +  * Text (old String-Long) ​: une zone de texte éditable 
-  * Entier ​: un Spinner ​champ textuel ​+ controle chars +  * Password : une zone de texte de mot de passe 
-  * Flotant ​: champ textuel ​+ controle chars +  * Query : un champ de requête 
-  * Boolean : un bouton de type check box" +  * Integer ​: un Spinner, un champ textuel ​avec contrôle des caractères 
-  * Date :  +  * Float un champ textuel ​avec contrôle des caractères 
-  * Fichier ​: ouvre une popup de sélection de fichier +  * Boolean : un bouton de type check box 
-  * Dossier ​: ouvre une popup de sélection de dossier+  * Date : année / mois / jours / heure - durée ou date (pas implémenté) 
 +  * FileOpen ​: ouvre une popup de sélection de fichier 
 +  * FileSave : ouvre une popup de sélection de fichier à créer 
 +  * Folder (old File-Folder) ​: ouvre une popup de sélection de dossier 
 +  * Separator : affiche une ligne horizontale pour organiser les paramètres,​ si '​@value'​ est renseigné alors la ligne est préfixé de '​@value'​
public/tutoriel_macros.1367568589.txt.gz · Dernière modification: 2013/05/03 10:09 par matthieu.decorde@ens-lyon.fr