Appendice: Getting started with Transmorpher

Requirements

Transmorpher is developed in JAVA 2. It thus requires a Java virtual machine to run.

Using Transmorpher always requires a SAX 2.0 XML 1.0 parser and a JAXP 1.1 XSLT 1.0 engine. These are now likely to be included in your Java distribution.

All these modules can be obtained for free. The current test configuration is given below:

Software	Brand	Version min	Version max tested	Jar
Java VM	Sun JDK	1.3	1.5
SAX/JAXP	Oasis	2.0/1.1
XML parser	Apache Xerces	2.1
XSLT processor	Apache Xalan	2.4
Regular expressions	gnu.regexp	1.1.3	1.1.4	gnu-regexp-1.1.3.jar
Servlet server	Jakarta Tomcat	4.0.4	5.5.17

A chart of correspondence between various versions of Transmorpher is given in the next appendice.

In addition, performing regular expression substitution, generating servlet or using some contributed modules can require additional software.

Downloading

An archive containing a set of consistent version of the required software working with the current version of Transmorpher can also be downloaded from these sites.

Anonymous access to the git repository is now available from https://gitlab.inria.fr/moex/transmorpher/.

Installing

To install Transmorpher :

• download the Zip files for Transmorpher and required software
• unzip them (put the JAR for additional softaware in the lib directory)
• that's all

Distribution

The distribution tree contains:

FILES.TXT

the list of all the files in the archive

README.TXT

A file similar to the present appendice

LICENSE.TXT

the terms under which the software is licensed to you.

api/

javadoc API documentation in HTML

classes/

empty directory for compiling the sources

distrib/

directory required for compiling a release

docs/

developer documentation

dtd/

contains the Transmorpher DTDs (and schemas)

lib/

contains transmo.jar

refman/

reference manual in HTML

resources/

.property files that sets default values for Transmorpher variables

samples/

examples of using Transmorpher

scripts/

Ant script for testing, compiling, etc.

src/

Java sources of Transmorpher

tests/

Junit unit test hierarchy

Running Transmorpher

For running Transmorpher on a shell toplevel (Linux, Max OS X, DOS, etc.), with jar-launchable application:

• suppose you have a Transmorpher stylesheet named process.xml
• for running the stylesheet
  

  $ java -jar transmo.jar process.xml
  

• for compiling
  

  $ java -jar transmo.jar -compile process.xml
  

• for checking it
  

  $ java -jar transmo.jar -optimize process.xml > newprocess.xml
  

For running Transmorpher on a shell toplevel (Linux, Max OS X, DOS, etc.), explicitely:

• put the jarfiles for regular expressions (gnu-regexp.jar) and transmorpher (transmo.jar) and the resources directory in your CLASSPATH variable.
• for running the stylesheet
  

  $ java fr.fluxmedia.transmorpher.Application.transmorph process.xml
  

• for compiling
  

  $ java fr.fluxmedia.transmorpher.Application.transmorph -compile process.xml
  

• for checking it
  

  $ java fr.fluxmedia.transmorpher.Application.transmorph -optimize process.xml > newprocess.xml
  

$ cd samples
$ java -jar transmo.jar biblio/process.xml
$

For compiling a Java file generated by transmorpher you need the transmo.jar. If your file is a Servlet, you will need the javax.servlet packages too.

For running the compiled files, you will need the same packages as for running Transmorpher.

Bug reports

Send bug reports to transmorpher-dev@fluxmedia.fr.

Please, take care of providing the Transmorpher release number, the brand and version of each component above, the content of your CLASSPATH variable and whatever you think relevant to the problem.

Providing a bug report as a Junit test case is a must!

Quick install on Unix

This procedure is known to work under Linux RH 6.2-7.2 and MacOS X. It works for using Xalan/Xerces (provided in transmo-extra.zip). Other adds-on cannot use the jar-launchable facility.

$ mkdir transmo-1-0-7
$ cd transmo-1-0-7
$ setenv TMDIR `pwd`
$ wget -nd -q http://gforge.inria.fr/frs/download.php/1821/transmo-1-0-7.zip
$ unzip transmo-1-0-7.zip
$ cd lib
$ wget -nd -q http://gforge.inria.fr/frs/download.php/1824/transmo-extra.zip
$ unzip transmo-extra.zip
$ java -jar transmo.jar -v
$ cd ../samples
$ java -jar ../lib/transmo.jar file:music/process.xml
$

The resulting files have been generated in the biblio directory and they can be read by an HTML browser. They coresponds to the example in this manual.

Next chapter: Dependency matrix