EvalTrans
A Tool for the automatic and manual evaluation of translations.

$Id: README,v 1.5 2000/07/28 14:01:54 leusch Exp $

================================================================

Contact: Gregor Leusch, Sonja Niessen
translation@i6.informatik.rwth-aachen.de

(c) 1999, 2000
Lehrstuhl f. Informatik VI
Language Processing and Pattern Recognition
RWTH - University of Technology
Aachen, Germany

================================================================


SOFTWARE REQUIREMENTS:
======================

Tcl/Tk 8.0 or higher.
See <http://dev.scriptics.com/software/tcltk/> for more.

TclExpat 1.1 or higher (Source code necessary as it must be patched)
See <http://www.zveno.com/zm.cgi/in-tclxml/> for more
(it should be possible to use TclXML after some patches)

BWidget ToolKit 1.2.1 or higher
See <http://www.unifix-online.com/BWidget/> for more.
(possibly temporarily unavailable - search for BWidget using search
engines if necessary)


CC / GCC (to build a shared library)
GNU make or compatible



INSTALLATION:
=============

- Install the above software

- In xmlparse.c  (TclExpat package), replace the following line
#define MUST_CONVERT(enc, s) (!(enc)->isUtf8)
  by 
#define MUST_CONVERT(enc, s) 0
  (since this version of Tcl/EvalTrans require ISO-8859-1 encoding,
   not UTF-8)
  and compile the package

- Place all files of EvalTrans (see below) into one directory;
   change into this directory

- Make sure that the BWidget toolkit is available in a
  subdirectory called 'BWidget'

- Check whether the paths/options in the first lines of Makefile
  are correct (CC, LD_SHARED, CC_OPTIONS, SH, WISH)

- Check whether the path to 'wish' in the first line of 
  EvalTransBatchEval.tcl is correct

- comment out the following line in Makefile if you do not use RCS
  (this should usually be the case):
# CHECKOUT_FILES =

--------------------
If you want to run EvalTrans on more than one system architecture:

- Make sure the environment variable $ARCH is set to an architecture 
  identifier (e.g. i686/alpha/IP22/...) on each system

- create a subdirectory of the EvalTrans directory named like the
  architecture identifier

- install tclexpat.so (for this architecture) into this subdirectory


If you want to run EvalTrans only on one system architecture:

- Create a subdirectory to the EvalTrans directory called "lib"

- install tclexpat.so (for this architecture) into this subdirectory

- Uncomment these two lines in Makefile:
# ARCH           = lib
# STATIC_ARCH    = 1

- Replace the following line in EvalTransBatchEval.tcl
set arch $env(ARCH)
- by
set arch lib
--------------------

- run 'make all' ('gmake all') to build/configure the necessary files
  (on each architecture if there is more than one, see above)


USAGE:
======

- To use the interactive tool, call EvalTrans.sh
  (Help is available via the 'Help' menu)

- To use the command line tool, call EvalTransBatchEval.tcl
  (Help is available via the '--help' option)
  No manual evaluation can be performed using EvalTransBatchEval.tcl.



FILES:
=====

TCL files:

EvalTrans.tcl                    Main file: 'source' other files, init, ...
EvalTransBatchEval.tcl           Batch mode
EvalTransTrainLeven.tcl          Script for the training of Levenshtein scores
EvalTransEditDialogs.tcl         Dialogs for database interaction, evaluation, ...
EvalTransEvalCalculations.tcl    Calculation routines for evaluation, statistics, ...
EvalTransFileRoutines.tcl        File routines
EvalTransGUI.tcl                 Common user interface routines
EvalTransOthers.tcl              Other routines
EvalTransWeightedLevenshtein.tcl Routines for weighted-score Levenshtein distance
htmlHelp.tcl                     Help file viewer
parseLine.tcl                    Command line parser
tkShellWindow.tcl                Debug shell


Other program files:

fastleven.c                      Fast Levenshtein edit distance routines
Makefile                         make file


Documentation:

README                           This file
EvalTransHelp.html               Online help shown with 'htmlhelp.tcl'



Gregor Leusch, Sonja Niessen
Lehrstuhl f. Informatik 6, RWTH Aachen