Download and Installation

Requirements

In order to run TMHarvest you need the following

A TM4J-Installation (0.8.3). The TM4Js project page at sourceforge contains the latest version.
A jdk1.4. You'll find one at Sun's java download page.

TMHarvest ist written in Java, just as every other component of the TM4J-project. TMHarvest runs on every plattform, for which a jdk1.4 is available.

Download

Download the actual release of TMHarvest from the TM4Js project page at sourceforge.

Run TMHarvest

In order to run TMHarvest please perform the following steps:

Download TMHarvest. Extract the archive.
Navigate to the root directory of the installation.
Edit bin/tmharvestrun.sh (bin\tmharvestrun.bat on Windows) and change the entries for TMHARVEST_HOME and TM4J_HOME.
TMHARVEST_HOME must point to the root directory of the installation (the parent of the directory you are currently in)
TM4J_HOME must point to the root directory of the tm4j-installation.
Please do not use relative paths for TM4J_HOME.
Now you are ready to execute tmharvestrun.sh (tmharvestrun.bat on Windows). If you run the script without options, TMHarvest present you a short overview about its usage and quits.

Run the examples

The directory {TMHARVEST_HOME}/doc/example/ contains several example model files.

kaq_harvest.xml: builds the Kings & Queens-Topicmap with the help of two csv-files. Kings & Queens was originally developed by Kal Ahmed.
xpath-example.xml: uses the xpath-Provider to build a small subset of the Kings & Queens-Topicmap.
metadata.xml: builds a topicmap from metadata found in mp3-, OpenOffice- and MS Office-files.
dc.xml: reads dublincore content from the userdoc and builds a topicmap from it.

In order to run the examples, perform the following steps:

Ensure, that you are ready to run TMHarvest.

Navigate to {TMHARVEST_HOME} and issue the following command:

sh bin/tmharvest.sh -m the example.xml

(On Windows, please use bin/tmharvest.bat instead.)

The resulting topicmap is written to the tempfolder.

Note

If you are running on Windows, please change the path of the resulting topicmap to a valid path on your system. In every example, you find a <saveAction> towards the end of the file. Change the filename-attribute of this action from "/tmp/some-example.xtm.xml" to something like "c:\temp\some-example.xtm.xml".