Novosoft  RTF TO XML  5.1 release notes
-----------------------------------


TABLE OF CONTENTS
-----------------

1  What is  RTF TO XML ? 
2  How to Install  RTF TO XML ?
  2.1  Windows 98/ME, Windows NT/2000/XP
  2.2  Linux
3  How to Uninstall  RTF TO XML ?
4  License Specifics and Limitations
5  Using  RTF TO XML 
6  Distribution package structure
7  Acknowledgements



1 What is  RTF TO XML ? 
-----------------

The  RTF TO XML  converter is designed for conversion of Rich Text Format (RTF)
files to Extensible Markup Language (XML) format conforming to the Extensible 
Stylesheet Language Formatting Objects (XSL FO) specification. The documents 
in this format can be converted to other common formats such as HTML and PDF,
and can be used in a variety of XSL FO processors. Moreover, the  RTF TO XML 
allows creating form templates and provides XSLT for filling form fields with
actual data.

The converter could be used via the Graphics User Interface (GUI),
as a command line tool, or via Java API requests.

 RTF TO XML  is a pure Java (TM) application. It runs under any operating system
with Java 2 Runtime Environment installed (see Section 2).
SUN JDK/JRE 1.3 or higher is recommended. Other products required for  RTF TO XML 
are included into the distribution package.

The product page:

http://www.rtf-to-xml.com

2 How to Install  RTF TO XML ? 
------------------------

 RTF TO XML  requires Java 2 Platform to be installed on the target computer.
 RTF TO XML  was tested with SUN JDK/JRE 1.2.2, 1.3, 1.4 on Windows 98/2000/XP,
and Linux. Problems were reported running  RTF TO XML  with JDK/JRE versions older
than 1.2.2_009. Please take a time to visit Java 2 Platform homepage and
download the latest update from SUN:

http://java.sun.com/j2ee/ (Java 2 Platform Enterprise Edition)
http://java.sun.com/j2se/ (Java 2 Platform Standard Edition)


2.1 Windows 98/ME, Windows NT/2000/XP
-------------------------------------------

 RTF TO XML  version 2.0 or later is installed using a setup program.
To start the setup, unzip the installation package, run setup.bat, wait 
until the setup window appears, and follow the program prompts. 
You should have Java 2 Platform installed on your computer to run the setup
successfully. 

If setup.bat does nothing, check your Java version by running the command

java -version

It should report Java version 1.2.2 or higher. If you receive another answer,
then either Java is not installed properly, or it is not installed on your
computer at all.


2.2 Linux
---------

To install on Linux with X11 desktop, unpack the installation package,
open a console and run the command

java -jar RTF_TO_XMLSetup.jar

from the directory where the installer was unpacked, then follow the setup
program prompts. You should have Java 2 Platform installed on your
computer to be able to run the setup successfully.

To install on Linux without X11 desktop, please visit the  RTF TO XML  homepage and
download the .tar.gz archive. Unpack it and edit rtf_to_xml.sh and rtf_to_xml_gui.sh so
that the INSTALL_PATH points to where you have unpacked the  RTF TO XML  files.

NOTE that running  RTF TO XML  GUI under Linux requires X11 support. If  RTF TO XML  is 
started under Linux without X11 support, rendering of tabs in converted files 
will be turned off.

XVNC or Xvfb provide X11 support for server applications. Here are some
useful links:

http://www.uk.research.att.com/vnc/xvnc.html
http://www.xfree86.org/current/Xvfb.1.html


3 How to Uninstall  RTF TO XML ?
--------------------------

To uninstall the product, remove the directory it had been installed to.


4 License Specifics and Limitations
-----------------------------------

EVALUATION version limitations:

* Characters in the text are occasionally replaced with
  punctuation marks
* In prepare-template mode, some text entries are not moved to XML data file

SIMPLE license limitations:

* No batch conversion
* No open API

SERVER and SITE license limitations:

* No limitations


5 Using  RTF TO XML 
--------------

The  RTF TO XML  home directory contains a number of files with ".bat" and ".sh"
extensions. The ".bat" files are used for running  RTF TO XML  components under
Windows and the ".sh" files are used in the Linux environment.
If you want to run  RTF TO XML  components from any directory on your computer,
just copy the ".bat" (or ".sh") files to a directory listed in the PATH
variable (or to your home directory).

To run an  RTF TO XML  component, you can open a DOS (or console) window and
type an appropriate command in it.

* The command

  rtf_to_xml_gui

  runs the  RTF TO XML  GUI component.

* The command

  rtf_to_xml rtf-file

  runs the command line  RTF TO XML  convertor itself. This run will produce
  a FO file from the input RTF file. The result meets the requirements of
  XSL FO Specification 1.0. If you plan to convert the result to PDF using
  one of recent rendering tools, you must draw special attention to 
  compatibility with the required tool (maybe you will need to use one of
  "-o" options in the run).  See the user's manual in the doc subdirectory
  of  RTF TO XML  home directory to learn more on using  RTF TO XML .


6 Distribution package structure
--------------------------------

conf/       - converter configuration files
data/       - converter data files
plugins/    - converter plugin configuration files
doc/javadoc - API documentation generated with javadoc
doc/RTF_TO_XMLGuide.pdf - Users's manual
examples/   - Examples demonstrating different features of the converter
jar/        - rtf_to_xml.jar
lib/        - auxiliary libraries used by  RTF TO XML 
license.txt - Novosoft License Agreement (commercial package only)
license-eval.txt - Novosoft License Agreement (evaluation package only)
readme.txt  - this file
rtf_to_xml.bat, rtf_to_xml.sh - used for command line conversion of .rtf to .fo
rtf_to_xml_gui.bat, rtf_to_xml_gui.sh - used for running the  RTF TO XML  GUI component


7 Acknowledgements
------------------

This product includes software developed by the Apache Software Foundation
(http://www.apache.org/). See lib/licence for details.
