From txm

Welcome to the TXM platform development site associated with the Textometrie scientific project and the Sourceforge generic backend site.
Everybody is welcome to participate to the development of the TXM toolbox and the TXM applications.
You should find in this site all the information you need to do so.

We develop three pieces of software(1):

• the TXM toolbox: a Java library connecting together several open-source components (CQP and R), some NLP tools and corpus source files processing tools, which is aimed at being the one stop shop for anyone willing to develop textometry software
• the TXM desktop application for Windows, Mac & Linux: an Eclipse RCP application (sometimes called TXM RCP or TXM desktop (RCP), in this wiki), which builds upon the toolbox to provide a cutting edge standalone textometry application
• the TXM web portal application for Tomcat & Glassfish: a GWT application (called TXM WEB or TXM portal (GWT) in this wiki), which builds upon the toolbox to provide web based client/server textometry experience adding authentication and access control

If you want to participate, the first step is probably to send us an email to let us know what you want to do.
While trying the software you can always use the txm-open@lists.sourceforge.net mailing list to ask for help or give comments.

Contents 1 Current Source 2 Current Release (stable) 3 Previous Release (obsolete) 4 Roadmap 4.1 TXM desktop (RCP) 4.2 TXM portal (GWT) 5 Change log 6 Members 7 Participate 7.1 TXM Conception 7.2 TXM desktop (RCP) Developer 7.3 TXM portal (GWT) Developer 7.4 TXM portal (GWT) Administrator 7.5 TXM User 8 Documentation 8.1 for Developers 8.2 for Users 9 Technologies 10 Software Download Stats 11 Notes

Current Source

• Target Release: 0.7.2
  • Toolbox
  • RCP
  • GWT

Current Release (stable)

• Release 0.7.1 (SRC - BIN)

Previous Release (obsolete)

• Release 0.7 (SRC - BIN)
• Release 0.6 (SRC - BIN)
• Release 0.5 (SRC - BIN)
• Release 0.4.7 (SRC - BIN)

Roadmap

TXM desktop (RCP)

• Release 0.8
• Release 0.7.1
• Release 0.7
• Release 0.6
• Release 0.5
• Release 0.4.7
• Release 0.4.6
• Release 0.4.5

TXM portal (GWT)

• Release 0.5
• Release 0.4
• Release 0.3
• Release 0.2

Change log

Members

Participate

TXM Conception

• How to specify new functionalities
  For the moment, one can use the tracker, or create a new page in this section or in the txm-users wiki
  • general behaviour
  • corpus import : binary corpus versioning
    • xsl transformations
    • edition specification
  • XML-TXM : TXM pivot input format specification
  • aligned corpora
  • Specs_TIGERSearch
  • corpus workshop design
  • dictionnaries
  • key bindings
  • export formats
  • annotation scripts

TXM desktop (RCP) Developer

• Get the source
• Build the toolbox and the application
• Build the toolbox and the application for MACOSX
• Deployment
  • Build CWB for Linux, Windows and Mac
  • Release process (Windows, Linux, Mac OS X)
  • Test Setup (Windows, Linux)
  • Publish Setup (Windows, Linux)
  • Setup policy (Windows, Linux)
  • Update online manual
• Get in touch
  • developer mailing list : txm-info
• How to write code
  • read documentation
  • coding practices : we follow the standard Java code conventions (PDF)
  • dev cycle
    • check-in requirements
  • good bugs first
• Translate the RCP graphical user interface
• How to write or translate documentation
  • get the documentation sources from SVN
  • send us an email to propose new versions for update
• cwb analyses
• Sourceforge TXM SVN migration (April 2013)

TXM portal (GWT) Developer

• Get the source
• Build the toolbox and the application
• Deployment (GWT)
  • TXMWEB: Build War
  • TXMWEB: Test War
  • TXMWEB: Setup War
  • Release process with Glassfish (TODO)
• Deployment (GRAILS)
  • With Tomcat
• Benchmark

TXM portal (GWT) Administrator

• TXM portal : Linux installation instructions
• TXM portal : Windows installation instructions fr

TXM User

• Get the application
• Report a Bug
• Ask for Feature
• Ask for Support
• Get in touch
  • english mailing list : txm-open@lists.sourceforge.net - [SUBSCRIBE]
  • french & english mailing list : txm-users@cru.fr - SUBSCRIBE
• How to write or translate documentation
  • get the documentation sources from SVN
  • send us an email to propose new versions for update
• How to translate the user interface
  • send us an email so we can send you an archive of all the necessary "messages[_*].properties" I18N files containing the strings to translate

Documentation

for Developers

• Context : Both the toolbox and the application are developed in Java. We use subversion for source management. We also use Eclipse which not only is an excellent IDE, but must have for RCP software development. For general information about this tools, please refer to their website and documentation.
• Architecture
• Jargon file (to be done)
• User's Guide for developers :
  • Toolbox 0.4.5 User's Guide (FR)
  • RCP Application 0.4.5 User's Guide (FR)
  • Grails Application 1.0 User's Guide (FR)
  • Import Environment 0.4.5
  • Import Environment 0.4.7 (FR)
  • String externalization
  • Command line interface java api wrapper
  • Build RCP components such as Editors, views, commands...
  • Tokenizer&TagSentences
• Source Code documentation :
  • Read
    • Java and Groovy code documentation (Javadoc merged with Groovydoc)
    • TextometrieR code documentation eclipse R plugin
  • Write Java code documentation
  • Generate the javadoc:
    • with ant in eclipse: execute ant file build.xml target groovydoc

• Performance (tbd)
• Security (tbd)
• Reference:
  • Nsis
    • Documentation
    • Tutorials
    • Examples
  • Java™ Platform, Standard Edition 6 API Specification
    • Classes: File, String, Locale&Collator
    • Interfaces: IO, Util
  • Eclipse Platform API Specification
    • Many tutorials (FR) ftp://ftp-developpez.com/mbaron/eclipse/
    • Packages: SWT widget public API classes, SWT layout classes, SWT Custom widgets
    • SWT Snippets
    • JFace : dialogs [1], TableViewer [2]
    • RCP tutorials
  • Regex unicode http://www.regular-expressions.info/unicode.html
  • Batik
  • R-cran
  • CQP
  • Other APIs (in French)
  • Groovy: API, Groovy JDK API Specification
  • LIBC: SCO (libc, io, syscalls), Novell (Vol 1, Vol 2), GNU (API)
• Wiki Administration
  • edit the left menu : https://sourceforge.net/apps/mediawiki/txm/index.php?title=MediaWiki:Sidebar
  • edit the wiki logo : https://sourceforge.net/apps/mediawiki/txm/index.php?title=File:MediaWikiSidebarLogo.png

for Users

• watch the TXM introductory screencast
• read the:
  • TXM 0.5 Manual (EN)
  • Manuel de TXM 0.7 (FR)
• read and edit the:
  • TXM 0.5 Reference Manual (EN) wiki (experimental)
  • TXM 0.5 Manuel de Référence (FR) wiki (experimental)
• read the textometry fundamental texts and TXM components documentation

Technologies

Inventory of open-source technologies we could use.

• iPlots a package for the R statistical environment (see www.r-project.org) which provides high interaction statistical graphics, written in Java - http://www.rosuda.org/iplots

Software Download Stats

• 2011-2013 (statistics before november 2011 are lost: date when the project changed its name from 'textometry' to 'txm')
  • 2011
  • 2012
  • 2013
    • 2013 first half
      • January
      • Februar
      • March
      • April
      • May
      • June
    • 2013 second half
      • July
      • August
      • September
      • October
      • November
      • December

Notes

1. A first TXM web prototype has also been developed: a Grails application which builds upon the toolbox to provide web based client/server textometry experience [this version is not maintained anymore: please consider the TXM web portal application instead].