TXM

Synopsis
TXM is a free and open-source XML & TEI compatible textual corpus analysis framework and graphical client based on the CQP search engine and the R statistical software. It is available as a desktop software for Microsoft Windows, Linux, Mac OS X and as a J2EE web portal software.

Provides qualitative analysis tools

 * kwic concordances of word patterns based on the efficient CQP full text search engine and its powerfull CQL query language
 * word pattern frequency lists based on any word property (graphical form or type, lemma, pos...)
 * word pattern progression graphics
 * Examples of word patterns, expressed in the CQL query language which is based on word & structural level properties:
 * "aiming" to simply search for the word 'aiming'
 * ".*ing" to search for words ending in "ing" (including mainly verb forms)
 * [pos="VERB" & word=".*ing"] to search for verb forms ending in ".ing" (where Part of Speech annotation is present)
 * [lemma="group"] []{0,3} [pos="VERB" & word=".*ing"] to search for the collocation followed by a  with at most 3 words in between
 * rich HTML-based text edition navigation with links from all other tools

Provides quantitative analysis tools, based on R packages

 * factorial correspondance analysis
 * cluster analysis
 * specific word patterns analysis
 * collocations analysis

Helps to build various corpus configurations
(for contrastive analysis between text structures or word selections)
 * sub-corpora
 * partitions

Large spectrum of input formats

 * several text formats (from raw to rich):
 * Unicode TXT
 * ODT
 * XML
 * XML/w (where some or all word limits and properties can be pre-encoded)
 * XML-TEI P4 (according to Perseus project practice)
 * XML-TEI P5 (according to various projects practice: BFM, BVH, NLTK, etc.)
 * speech transcription: XML-TRS (from Transcriber software, with time synchro)
 * aligned corpora: XML-TMX (with texts in relation of translation or versioning)
 * news portal articles: XML-PPS (Factiva), Europresse
 * etc.

And more

 * Applies various NLP tools on the fly on texts before analysis (e.g. TreeTagger for lemmatization and pos tagging)
 * Indexes words and their properties as well as hierarchical structure of texts
 * Indexes external or internal text metadata or speaker metadata
 * Exports any result in CSV, XML or SVG format
 * Provides Scripting facilities for repetitive or lengthy tasks automation or for platform extension (in Groovy/Java dynamic language)
 * Includes a complete text editor to edit data sources, results and scripts
 * Runs as a desktop application for Windows, Mac OS X or Linux
 * Runs also as web portal to give corpora access and analysis online through any web browser (including account and access control management)
 * Open source licence: based on the best open source components for text analysis: CQP, R and Java & XSLT libraries
 * Modular architecture (Eclipse RCP OSGi and J2EE conformant): one toolbox connecting all core components to build the applications
 * Efficient Eclipse or Netbeans powered development framework

User comments
Please sign all comments.

System requirements
The desktop version runs on:
 * Windows - 32bit or 64bit (tested on XP, Vista, 7 and 8)
 * Mac OS X (tested on 10.5, 10.6, 10.7, 10.8 and 10.9)
 * Linux - 32bit or 64bit (tested on Ubuntu and Debian)

The portal server runs on any J2EE capable platform (tested in Tomcat and Glassfish).

Source code and licensing
Open Source under GPL V3 licence: http://sourceforge.net/p/txm/code/HEAD/tree/trunk.

Support for TEI
Supports TEI and TEI Lite "out of the box" at XML level semantics: words will be tokenized inside any #PCDATA and all the XML structure will be imported directly as textual structure.

Supports various flavours of TEI P5 encoding semantics at TEI level semantics: See the "BFM encoding manual" for an example of TEI encoding practice interpreted by TXM, in French, http://bfm.ens-lyon.fr/article.php3?id_article=158.
 * words and their properties: #PCDATA, , ...
 * editorial markup:, ...
 * texts and their properties: , ...
 * intermediate text structures and their properties:, ...
 * edition rendering: ,, ...
 * what should not be indexed but considered for edition rendering: , ...
 * alignment between texts: , , ...
 * words identifier policy: @xml:id
 * language declaration policy: @xml:lang

The "TEI P5 BFM" TXM import module consists of Groovy and XSL scripts: they can be adapted directly by the user to any specific TEI encoding usage.

TXM Import Modules also provide various import parameters to tune each import process to specific data sources.

TEI sources from the following projects are currently imported into TXM at TEI level semantics:
 * Perseus Digital Library (classical latin, old greek): http://www.perseus.tufts.edu/hopper
 * TextGrid (german): http://www.textgrid.de/en
 * Base de Français Médiéval - BFM (old french): http://bfm.ens-lyon.fr
 * BVH Epistemon (middle french): http://www.bvh.univ-tours.fr/Epistemon &amp; https://groupes.renater.fr/wiki/txm-users/public/mise_en_ligne_du_corpus_bvh_avec_txm
 * PROCLAC mesopotamian tablets (akkadian): https://groupes.renater.fr/wiki/txm-users/public/umr_proclac_corpus_akkadien
 * Bouvard&Pécuchet (french): http://dossiers-flaubert.ish-lyon.cnrs.fr
 * NLTK - Brown Corpus - TEI XML Version (american english): http://nltk.googlecode.com/svn/trunk/nltk_data/index.xml
 * Presses Universitaires de Caen (PUC), MRSH de Caen - Revues.org (french): http://www.unicaen.fr/recherche/mrsh/document_numerique/outils ([DISCOURS scientific journal])
 * Frantext - libre (french): http://www.cnrtl.fr/corpus/frantext
 * XML-TXM - TXM own pivot format (any language): https://groupes.renater.fr/wiki/txm-info/xml_tei_txm

Experiments with other TEI sources:
 * Victorian Women Writers Project (english): http://www.dlib.indiana.edu/collections/vwwp

TEI sources are preprocessed by several XSL stylesheets, one can find in TXM source code. Some of those stylesheets are available in the online TXM XSL stylesheets library: http://sourceforge.net/projects/txm/files/library/xsl

User Interface Language(s)
The user interface is currently available in:
 * desktop version:
 * English (EN)
 * French (FR)
 * Russian (RU)
 * portal version:
 * English (EN)
 * French (FR)

Documentation Language(s)
The documentation is currently available in:
 * desktop version:
 * English (EN)
 * French (FR)
 * portal version:
 * French (FR) (tutorial - alpha state)

Text/Corpus Language(s)
TXM works natively with any Unicode-conformant corpus. Language support is specific to each NLP tool used (for example, TreeTagger can tag the following languages: BG, DE, EN, ES, ET, FR, FRO, GL, IT, LA, PT, RU, SW, ZH).
 * ZH: best results have been reported by using the ZPar tokenizer &amp; tagger - http://sourceforge.net/projects/zpar

Programming Language(s)
TXM is written in the following programming languages:
 * C for CQP search engine (independent open source project http://cwb.sourceforge.net)
 * C and R for statistical packages (independent open source project http://www.r-project.org)
 * Java for the Toolbox and the Applications (driven by an independent open consortium http://jcp.org/en/home/index)
 * Eclipse RCP framework used for the desktop version (independent open source project http://wiki.eclipse.org/index.php/Rich_Client_Platform)
 * GWT framework used for the web portal version (independent open source project http://code.google.com/intl/fr/webtoolkit)
 * Groovy for the import modules and command scripts (independent open source project http://groovy.codehaus.org)

Documentation

 * TXM manual (in French) http://perso.ens-lyon.fr/serge.heiden/txm/files/software/TXM/0.7.7/Manuel%20de%20TXM%200.7%20FR.pdf
 * TXM user community wiki (in French) at https://listes.cru.fr/wiki/txm-users (includes a FAQ)
 * TXM developers wiki (in French) https://groupes.renater.fr/wiki/txm-info
 * All published documentation (for users and for developers) published on Sourceforge: http://sourceforge.net/projects/txm/files/documentation

Tech support
Tech support is community based.

Feedbacks and bug reports:
 * 1) Check if your feedback is not already reported in the TXM platform bug tracker
 * 2) If not, send your feedback either:
 * 3) * in the txm-open mailing list
 * 4) * by directly editing the txm-users wiki
 * 5) * by chating directly with the developers on the #txm IRC channel of the 'irc.freenode.net' server (web access)
 * 6) * by contacting the TXM team at the 'textometrie AT ens-lyon.fr' address

User community
TXM community uses two mailing lists and a wiki:
 * International mailing list : txm-open AT lists.sourceforge.net (very low activity for the moment)
 * See archives at http://sourceforge.net/mailarchive/forum.php?forum_name=txm-open
 * The mostly French-speaking mailing list : txm-users AT cru.fr (the most active)
 * See archives at https://listes.cru.fr/sympa/arc/txm-users
 * TXM user community wiki (in French) at https://listes.cru.fr/wiki/txm-users

Training in the use of TXM is available:
 * Monthly in Lyon (France): https://groupes.renater.fr/wiki/txm-users/public/ateliers_txm
 * Regularly in workshops: Sydney 2015, Wurzburg 2014
 * and Summer schools: MISAT 2011, Padova 2013

The JADT biennal international conference (http://jadt.org) is the main meeting place for the TXM user community.

Sample implementations
The desktop version of TXM is delivered with several sample corpora included, which can be directly analyzed from within TXM after installation.

The portal version of TXM has a demo running online at http://portal.textometrie.org/demo/?locale=en.

Current version number and date of release

 * 0.8.0 (2019-05-29)

History of versions
See software development project report page: http://forge.cbp.ens-lyon.fr/redmine/projects/txm/issues/report.

How to download or buy
http://textometrie.ens-lyon.fr/spip.php?rubrique61

Additional notes
For publications related to TXM, please visit the Textométrie project web site at http://textometrie.ens-lyon.fr/spip.php?article82&lang=en:
 * See for example: Heiden, S. (2010b). The TXM Platform: Building Open-Source Textual Analysis Software Compatible with the TEI Encoding Scheme. In K. I. Ryo Otoguro (Ed.), 24th Pacific Asia Conference on Language, Information and Computation - PACLIC24 (p. 389-398). Institute for Digital Enhancement of Cognitive Development, Waseda University, Sendai, Japan. Online.

Sponsors & Contributors:
 * Initial design and development of TXM (jan 2007- dec 2011) supported by French ANR grant #ANR-06-CORP-029
 * Currently the platform continues its development through various contracts:
 * ENS-LYON contract jun-aug 2009 (Rhône-Alpes region Cluster 13 grant): Queste del saint Graal web prototype
 * ENS-LYON contract sept 2009 - jul 2010 (ANR CORPTEF Research Project funding): portal development
 * Lyon 3 University contract jan-mar 2011: XML-Transcriber import, R GUI
 * CNRS contract 2011 (DGLFLF grant): GGHF corpus processing
 * Paris 1 University contract jan 2012 - dec 2014 (Matrice Equipex): TXM development and infrastructure for historians
 * Other independent projects also improve TXM (community of developers):
 * LASLA project 2011: import of ancient latin and greek corpora
 * GREYC-PUC project may-jul 2011: PUC corpora import, improvement of portal, test on Glassfish
 * PhD thesis on micro-finance 2011-: Factiva and Calibre import
 * ANR-DFG SRCMF contract jun-jul 2012 : Tiger Search module, import & syntactic concordances