Task #964

DOC: Groovy script environment

Added by Matthieu Decorde about 6 years ago. Updated 4 months ago.

Status:New Start date:08/01/2014
Priority:Normal Due date:
Assignee:- % Done:

0%

Category:Documentation Spent time: -
Target version:TXM 0.8.2

Description

  • how to call a macro from a Groovy script
  • what is the Groovy classpath used by TXM
  • what is the current directory when calling a Groovy script

FR SLH A) pour pouvoir proposer qlqpart d' "ouvrir le script ~/TXM-0.8.1/scripts/groovy/user/org/txm/scripts/importer/txt/importer.groovy"
un paragraphe qui décrit la politique mise à jour d'architecture et de maintenance des scripts en 0.8.1 : chemins, séparation user et system, priorités dans la recherche de scripts, ce que l'utilisateur peut faire, ce qu'il ne doit pas faire (changer les scripts system ?)
- un paragraphe d'introduction à l'architecture des scripts de modules d'import : les noms des scripts, leur succession, leur paramètres ?, leurs sorties ?

B) pour pouvoir proposer qlqpart de "modifier le fichier ~/TXM-0.8.1/scripts/groovy/user/org/txm/scripts/filters/Tokeniser/SimpleTokenizerXml.groovy"
- une documentation qlqpart (javadoc ou ailleurs) du script importer.groovy et son usage de filtres (jusqu'à éventuellement la possibilité d'intégrer un filtre écrit en Perl ou en Python voire en XSLT)
- une documentation qlqpart (javadoc ou ailleurs) du script SimpleTokenizerXml.groovy et de sa méthode processWord en particulier

Avec tout ça je devrais pouvoir concocter une section de manuel pour aider à adapter un module d'import à des sources particulières.
Si cette adaptation passe par la copie et le renommage d'une hiérarchie de scripts d'un module existant, il me faut peut-être également un documentation d'un mécanisme ou script me permettant d'appeler un nouveau module d'import (doc de imports/OpenImportFormMacro.groovy ?, doc de prototypes/RunImport ?)

Solution

FR

Les macros et scripts Groovy utilisés directement par TXM se trouvent dans le répertoire "HOME/TXM-X.Y.Z/scripts/groovy/user". Le répertoire "HOME/TXM-X.Y.Z/scripts/groovy/system" est une sauvegarde du répertoire "user" à l'état initial de l'installation de TXM.

Dans le répertoire "user" , on trouve les arborescences des packages Groovy :
  • org.txm.macros : contient toutes les macros visibles de la vue Macro + les fichiers de paramétrage et quelques scripts Groovy utiliser en interne par les macro
  • org.txm.scripts : les scripts Groovy et notamment les scripts Groovy utilisés par les modules d'import
Dans les sous-packages de "org.txm.scripts.importer", on trouvera les scripts des modules d'import de TXM. Pour un module d'import "xyz", on trouvera un script point d'entrée org.txm.scripts.importer.xyz.xyzLoader.groovy. Ce script prépare entre autres (en fonction du module) l'appel des scripts des étapes d'import :
  • importer.groovy : prend les sources d'origine et vise le format XML-TXM en transformant le format d'origine en XML, puis tokenise puis construit le format XML-TXM
  • annotate : cette étape ne se trouve pas dans un fichier Groovy, elle applique éventuellement un modèle TreeTagger
  • compiler.groovy : prends les fichiers XML-TXM pour construire les indexes CQP des textes
  • pager.groovy : prendre les fichiers XML-TXM pour construire les pages HTML des éditions

History

#1 Updated by Matthieu Decorde about 6 years ago

  • Subject changed from DOC: calling a macro from Groovy script to DOC: Groovy script environment

#2 Updated by Sebastien Jacquot almost 6 years ago

  • Target version changed from TXM 0.7.7 to TXM 0.7.8

#3 Updated by Matthieu Decorde about 5 years ago

  • Target version changed from TXM 0.7.8 to TXM 0.8.0a (split/restructuration)

#4 Updated by Sebastien Jacquot over 2 years ago

  • Target version changed from TXM 0.8.0a (split/restructuration) to TXM 0.8.0

#5 Updated by Matthieu Decorde over 1 year ago

  • Target version changed from TXM 0.8.0 to TXM X.X

#6 Updated by Matthieu Decorde 4 months ago

  • Description updated (diff)
  • Target version changed from TXM X.X to TXM 0.8.2

#7 Updated by Matthieu Decorde 4 months ago

  • Description updated (diff)

Also available in: Atom PDF