<!-- Compiling FOP -->
<s1 title="Compiling FOP">
- <s2 title="Prerequisites">
- <s3 title="Java 1.1.x or later">
- <p>If you use Java 1.1.x you must also seperately include the swing classes, which can
- be found at the <jump href="http://java.sun.com/products/jfc/#download-swing">
- Sun website</jump>. From Java 1.2 on (aka Java 2) they are part of the standard
- distribution.
- </p>
- </s3>
- <s3 title="An XML parser">
- <p>An XML parser which supports Sax and DOM like
- <jump href="http://xml.apache.org/xerces-j/index.html">Xerces-J</jump>.
- The parser must be in your classpath</p>
- </s3>
- <s3 title="The xslt processor Xalan ">
- <p>Some of the Java source code in FOP is generated from XML using
- XSLT. Xalan must be used to generate this code.</p>
- <p>Xalan is an XSL stylesheet processor written in java. At the moment you
- can't use any other processor, because the make process makes use of some
- proprietary features of Xalan which allow to write output in more
- then one document. You can find Xalan also at <jump href="http://xml.apache.org/xalan/overview.html">
- xml.apache.org</jump>. You have to use Xalan version 0.19.5 or later.
- Xalan.jar must be in your classpath and also the file bsf.jar, which comes with Xalan.</p>
- </s3>
- <s3 title="Setting of JAVA_HOME">
- <p>You have to set the enviroment variable JAVA_HOME. It must point to your local JDK
- root directory. This is true, even if you use JDK 1.2 or above, which don't need this
- setting. It is used by the compilation software.</p>
- </s3>
- <s3 title="Settings in your classpath">
- <p>If you want Fop to use the image library jimi, it should be in your classpath during
- compilation.
- </p>
- <p>A CLASSPATH for a complete compilation of Fop could look like this, if all these jar files are in
+ <p>Compilation is started by executing build, either as a batch file on win32 (build.bat) or as a shell script on unix. Before you
+ can start one of these scripts, you have to setup your classpath and the environment variable JAVA_HOME (see below).</p>
+ <p> The compilation uses Ant,
+ a replacement of make (you can find more information about Ant at
+ <jump href="http://jakarta.apache.org/ant/">jakarte.apache.org</jump>).
+ build.xml is the replacement of makefile. Look there for detailed information on the build
+ process and different targets. </p>
+ <p>A help screen is shown by calling "build usage".</p>
+ <p>If you only want to use Fop, you don't need to build it. A fop.jar comes with the distribution.</p>
+ <s2 title="Setting up your classpath">
+ <p>The build process relies on finding following libraries in your classpath (the version numbers indicate that building with them has been successfully tested, other, later versions may work too:</p>
+ <ul>
+ <li><jump href="http://xml.apache.org/xerces-j/index.html">Xerces-J</jump> version 1.2.1 (xml parser)</li>
+ <li><jump href="http://xml.apache.org/xalan/index.html">Xalan</jump> version 1.2 (xslt processor)</li>
+ <li>bsf.jar (comes with Xalan)</li>
+ <li>jimi.jar (image processing library) this file is optional </li>
+ </ul>
+ <p>Other needed libraries and classes come with Fop (in xml-fop/lib), but the build script sets the path to
+ them, so you only need to care about them, if you build Fop in any other way. See build.bat/build.sh for
+ details.
+ </p>
+ <p>A classpath for a complete compilation of Fop could look like this, if all these jar files are in
a directory called jars (example uses windows syntax):
</p>
- <p><code>set CLASSPATH=\jars\xalan.jar;\jars\xerces.jar;\jars\bsf.jar;\jars\jimi.jar;
+ <p><code>set CLASSPATH=\jars\xalan.jar; \jars\xerces.jar; \jars\bsf.jar; \jars\jimi.jar;
</code></p>
- </s3>
</s2>
- <s2 title="Compiling">
- <p>Compilation is started by executing build, either as a batch file on win32 (build.bat) or as a shell script on unix. The compilation uses Ant,
- a replacement of make (you can find more information about Ant at
- <jump href="http://jakarta.apache.org/ant/">jakarte.apache.org</jump>).
- build.xml is the replacement of makefile. Look there for further information. </p>
- <p>A help screen is shown by calling "build usage".
- </p>
- </s2>
+ <s2 title="Setting of JAVA_HOME">
+ <p>You have to set the enviroment variable JAVA_HOME. It must point to your local JDK
+ root directory. This is true, even if you use JDK 1.2 or above, which normally don't need this
+ setting. It is used by Ant, the compilation software.</p>
+ </s2>
<s2 title="Problems">
- <p>If you have problems compiling Fop, please try this first: delete the build directory completely and
- try a new build from scratch. Check, whether you have all necessary libraries in your classpath:
- xerces.jar, xalan.jar, bsf.jar, jimi.jar (optional). If you still have problems, please look at the
- page <jump href="bugs.html">bugs</jump>, for further help.
- </p>
- </s2>
-
- <s2 title="Compiling FOP on MacOS">
- <!-- contributed by Arved Sandstrom who also manages the webpage the jump points to -->
- <p>We strongly recommend the use of Codewarrior Java. You will find
- a link to more information in the near future.
- </p>
+ <p>If you have problems compiling Fop, please try this first: </p>
+ <ul>
+ <li>delete the build directory completely and try a new build from scratch</li>
+ <li>check, whether you have all necessary libraries in your classpath:
+ xerces.jar, xalan.jar, bsf.jar, jimi.jar (optional)</li>
+ <li>check, whether you have the required versions of Xerces (>= 1.2.1) and Xalan (>=1.2) </li>
+ <li>check, whether you have an older version of xerces.jar, xalan.jar, w3c.jar somewhere in
+ you classpath.</li>
+ </ul>
+ <p>If you still have problems, please look at the
+ page <jump href="bugs.html">bugs</jump>, for further help.</p>
</s2>
</s1>
<s1 title="Examples">
<p>Examples for the use of xsl:fo can be found in the Fop distribution in
the subdirectory xml-fop/docs/examples/fo. You can start transformation of all fo files into pdf
- files by starting xml-fop/docs/examples/runtests.
+ files by starting xml-fop/docs/examples/runtests. The resulting test files can be found in
+ xml-fop/docs/examples/tests
</p>
<p>At the moment the following files are part of the distribution:</p>
<ul>
- <li>normal.fo - a very simple file showing the use of a 2 level of headings, normal text and a header.
+ <li>simple.fo - a very simple file which gives use a first impression of the structure of an fo file
+ </li>
+ <li>normal.fo - a simple file showing the use of a 2 level of headings, normal text and a header.
</li>
<li>table.fo - a simple table
</li>
<li>list.fo - a simple list
</li>
+ <li>list2.fo - some list examples
+ </li>
<li>images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.
</li>
<li>border.fo - a not so simple example how to use borders in tables
</li>
<li>leader.fo - a very simple example of a rule
</li>
+ <li>normalex.fo - shows the use of computed property values
+ </li>
+ <li>inhprop.fo - shows the use of inherited property values
+ </li>
+ <li>instream.fo - shows the use of fo:instream-foreign-object together with svg
+ </li>
+ <li>inhprop.fo - shows the use of inherited property values
+ </li>
+ <li>textdeko.fo - shows the use of the property textdecoration
+ </li>
+
<li>Look also into the directory examples/svg. There you find some very extensive svg examples.
Just start makedoc.
</li>
projects / xmlgraphics-fop.git / commitdiff