Installation

System requirements

Java^TM version

XMLmind XSL-FO Converter (XFC for short) only requires a Java runtime 1.3 or above. All additional libraries (JAXP, SAX2, and XP for JAXP) are included in the distribution for convenience.

.NET version

XFC requires the .NET Framework Redistributable Package (version 1.1 or 2.0) and the Microsoft® Visual J# Redistributable Package (same version) to be installed on the host machine. These packages are available for download on the MSDN site.

Installation

Unix

The installation procedure on a Unix system is outlined below.

1. Unpack the distribution:

   $ gunzip -c xfc-42p1.tgz | tar xvf -

   The above command will create directory xfc-42p1 in the current directory.

2. Add XFC installation directory (referred to as $XFC_HOME) to your PATH variable, or create symbolic links to $XFC_HOME/fo2rtf, $XFC_HOME/fo2wml, $XFC_HOME/fo2docx and $XFC_HOME/fo2odt in a directory already in your PATH variable (e.g. /usr/local/bin, assuming you have the required privileges):

   $ cd /usr/local/bin
   $ ln -s $XFC_HOME/fo2rtf fo2rtf
   $ ln -s $XFC_HOME/fo2wml fo2wml
   $ ln -s $XFC_HOME/fo2docx fo2docx
   $ ln -s $XFC_HOME/fo2odt fo2odt

   XFC may then be invoked with one of the following commands:

   $ fo2rtf <fo-file> <rtf-file>
   $ fo2wml <fo-file> <wml-file>
   $ fo2docx <fo-file> <docx-file>
   $ fo2odt <fo-file> <odt-file>

   You may try to convert one of the sample files in the samples directory to check the installation.

Windows

The installation procedure on a Windows platform is outlined below.

1. Unpack the distribution. The Windows distribution comes in the form of a setup program (setup.exe). Run this program and follow the instructions to perform the installation.
2. Add XFC installation directory to your PATH variable. XFC may then be invoked with one of the following commands:

   C:\> fo2rtf <fo-file> <rtf-file>
   C:\> fo2wml <fo-file> <wml-file>
   C:\> fo2docx <fo-file> <docx-file>
   C:\> fo2odt <fo-file> <odt-file>

   You may try to convert one of the sample files in the samples directory to check the installation.

Contents of the distribution

Java version

docs/apidoc/

Contains the API documentation.

docs/docbook-xsl/, docs/slides-xsl

Contains Norman Walsh's DocBook and Slides XSL stylesheets documentation.

docs/userguide/

Contains this document in HTML, XML (DocBook) and PDF formats.

docs/xslutility/

Contains XSL Utility user's guide in HTML format.

fo2docx

Unix script to convert an XSL-FO file to Open XML.

fo2docx.bat

Windows script to convert an XSL-FO file to Open XML.

fo2odt

Unix script to convert an XSL-FO file to OpenDocument.

fo2odt.bat

Windows script to convert an XSL-FO file to OpenDocument.

fo2rtf

Unix script to convert an XSL-FO file to RTF.

fo2rtf.bat

Windows script to convert an XSL-FO file to RTF.

fo2wml

Unix script to convert an XSL-FO file to WML.

fo2wml.bat

Windows script to convert an XSL-FO file to WML.

java/

Contains the Java source tree (Professional Edition, Developer and Site License only).

lib/

Contains the additional Java libraries needed to run XFC, as well as general and copyright information regarding these libraries.

license.txt

XFC license agreement (Personal Edition).

license_dev.txt, license_site.txt, license_srv.txt

XFC license agreements (Professional Edition).

samples/

Contains XSL-FO sample files. (Most of these files are simple test cases which are part of the XFC test suite.)

xfc.jar

XFC and XSL Utility binary class library. (Note: the Personal Edition library is obfuscated to prevent access to the converter API.)

xslu/config/

Contains the XML catalog, DTDs and XSL stylesheets bundled with XSL Utility.

xslu/lib/

Contains the additional Java libraries needed to run XSL Utility, as well as general and copyright information regarding these libraries.

xslu/samples/

Contains XML (DocBook) sample files.

xslutility

Unix script to run XSL Utility (graphical user interface).

xslutility.bat

Windows script to run XSL Utility (graphical user interface).

xslutil

Unix script to run XSL Utility (command-line executable).

xslutil.bat

Windows script to run XSL Utility (command-line executable).

.NET version

cs/

Contains the C# source code (Professional Edition, Developer and Site License only).

docs/apidoc/

Contains the API documentation.

docs/userguide/

Contains this document in HTML, XML (DocBook) and PDF formats.

fo2docx.exe

Command-line executable to convert an XSL-FO file to Open XML.

fo2odt.exe

Command-line executable to convert an XSL-FO file to OpenDocument.

fo2rtf.exe

Command-line executable to convert an XSL-FO file to RTF.

fo2wml.exe

Command-line executable to convert an XSL-FO file to WML.

js/

Contains the J# source code (Professional Edition, Developer and Site License only).

license.txt

XFC license agreement (Personal Edition).

license_dev.txt, license_site.txt, license_srv.txt

XFC license agreements (Professional Edition).

samples/

Contains XSL-FO sample files. (Most of these files are simple test cases which are part of the XFC test suite.)

xfc.dll

XFC binary class library. (Note: the Personal Edition library is obfuscated to prevent access to the converter API.)