aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/0.94/compiling.xml
diff options
context:
space:
mode:
authorVincent Hennebert <vhennebert@apache.org>2007-08-23 18:30:05 +0000
committerVincent Hennebert <vhennebert@apache.org>2007-08-23 18:30:05 +0000
commit99cfed96f71c2deff9afdf30c71f93c2ca30d005 (patch)
tree960682f0658c15dcddf2ec5f615c7c0f179ee7f1 /src/documentation/content/xdocs/0.94/compiling.xml
parentaa33ef3ebb6e48dae2da620f596d34d7548bf402 (diff)
downloadxmlgraphics-fop-99cfed96f71c2deff9afdf30c71f93c2ca30d005.tar.gz
xmlgraphics-fop-99cfed96f71c2deff9afdf30c71f93c2ca30d005.zip
Merged revisions 556567-558280,558282-562946,562948-563926,563928-563950,563952-563955,563957-564855,564857-567293,567295-567296,567298-567302,567304-569099 via svnmerge from
https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_94 ........ r560595 | vhennebert | 2007-07-28 21:26:51 +0200 (sam, 28 jui 2007) | 2 lines Remove tab for the no longer supported 0.20.5 version ........ r560596 | vhennebert | 2007-07-28 21:28:30 +0200 (sam, 28 jui 2007) | 2 lines Create a tab for the new 0.94 version ........ r560600 | vhennebert | 2007-07-28 21:45:13 +0200 (sam, 28 jui 2007) | 2 lines Remove any reference to the old maintenance branch ........ r560886 | vhennebert | 2007-07-30 10:19:59 +0200 (lun, 30 jui 2007) | 2 lines Update the documentation before releasing ........ r562023 | clay | 2007-08-02 08:08:49 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562024 | clay | 2007-08-02 08:09:33 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562027 | clay | 2007-08-02 08:27:01 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562332 | clay | 2007-08-03 07:09:50 +0200 (ven, 03 aoû 2007) | 1 line Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information. ........ r562333 | clay | 2007-08-03 07:10:47 +0200 (ven, 03 aoû 2007) | 1 line Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information. ........ r562880 | vhennebert | 2007-08-05 17:05:41 +0200 (dim, 05 aoû 2007) | 4 lines - Update the website content - Fix some typos - Fix broken links ........ r562881 | vhennebert | 2007-08-05 17:06:59 +0200 (dim, 05 aoû 2007) | 5 lines Changes in the trunk tab: - update content - fix typos - fix broken links ........ r562887 | vhennebert | 2007-08-05 17:22:15 +0200 (dim, 05 aoû 2007) | 2 lines Merge changes on the Trunk tab from revision 562881 ........ r562891 | vhennebert | 2007-08-05 17:32:33 +0200 (dim, 05 aoû 2007) | 4 lines Update the list of known issues: - border-collapsing model for tables is available - internal links point to the exact location ........ r562900 | vhennebert | 2007-08-05 17:48:50 +0200 (dim, 05 aoû 2007) | 2 lines Setup the "known issues" infrastructure for the 0.94 tab ........ r562903 | vhennebert | 2007-08-05 18:23:59 +0200 (dim, 05 aoû 2007) | 2 lines Style only: remove tab characters ........ r562909 | vhennebert | 2007-08-05 19:11:58 +0200 (dim, 05 aoû 2007) | 2 lines Disable "Valid HTML" icons. The site isn't valid... ........ r562919 | vhennebert | 2007-08-05 19:52:13 +0200 (dim, 05 aoû 2007) | 3 lines Disable any link to relnotes.html. This file is not properly placed (in no tab), and only contains release notes for versions up to 0.92. TODO determine what to do with this file; newer versions have their own system ........ r562924 | vhennebert | 2007-08-05 20:09:44 +0200 (dim, 05 aoû 2007) | 2 lines Add a link to the Release Notes for version 0.94 ........ r562925 | vhennebert | 2007-08-05 20:10:34 +0200 (dim, 05 aoû 2007) | 2 lines Replace "Apache Forrest" with "Apache FOP". Copy-paste error? ........ r564159 | vhennebert | 2007-08-09 11:56:41 +0200 (jeu, 09 aoû 2007) | 2 lines Introduce 0.94 in status.xml and README ........ r564233 | vhennebert | 2007-08-09 17:09:49 +0200 (jeu, 09 aoû 2007) | 2 lines Update the compliance page ........ r564864 | vhennebert | 2007-08-11 10:41:15 +0200 (sam, 11 aoû 2007) | 2 lines Fix error that made the 0.94 menu appear in the Trunk tab and vice-versa ........ r564866 | vhennebert | 2007-08-11 10:45:39 +0200 (sam, 11 aoû 2007) | 2 lines Add my key for signing the release ........ r564871 | vhennebert | 2007-08-11 10:51:35 +0200 (sam, 11 aoû 2007) | 2 lines Update dependency on version 1.2 of XML Graphics Commons ........ r567299 | vhennebert | 2007-08-18 19:23:09 +0200 (sam, 18 aoû 2007) | 2 lines Update .htaccess to 0.94 release ........ r567539 | clay | 2007-08-20 06:12:42 +0200 (lun, 20 aoû 2007) | 1 line Added formatting for code in page. ........ git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@569104 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs/0.94/compiling.xml')
-rw-r--r--src/documentation/content/xdocs/0.94/compiling.xml141
1 files changed, 141 insertions, 0 deletions
diff --git a/src/documentation/content/xdocs/0.94/compiling.xml b/src/documentation/content/xdocs/0.94/compiling.xml
new file mode 100644
index 000000000..c6c17a3c0
--- /dev/null
+++ b/src/documentation/content/xdocs/0.94/compiling.xml
@@ -0,0 +1,141 @@
+<?xml version="1.0" standalone="no"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!-- $Id$ -->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Apache FOP: Building from Source Code</title>
+ <version>$Revision$</version>
+ </header>
+ <body>
+ <section id="build-needed">
+ <title>Do You Need To Build?</title>
+ <p>
+ FOP distributions are either pre-compiled binary or source.
+ If you are using a binary distribution, it is already built and there is no need to build it again.
+ See the <a href="../download.html">Download Instructions</a> for information about whether a
+ binary or source distribution is best for your needs.
+ </p>
+ <p>
+ If you got the source code from a repository snapshot or via Subversion you will need to build FOP
+ in any case.
+ </p>
+ </section>
+ <section id="env">
+ <title>Set Up Your Environment</title>
+ <section id="env-jdk">
+ <title>JDK</title>
+ <p>
+ Building FOP requires a minimum Java Development Kit (JDK/SDK) of 1.3
+ (A Java Runtime Environment is not sufficient).
+ </p>
+ </section>
+ <section id="env-classpath">
+ <title>CLASSPATH</title>
+ <p>
+ There is generally no need to setup a classpath. All libraries needed to compile FOP are included
+ in the source distribution and are referenced by the build script.
+ You will only need to adjust the classpath if you build FOP in some other way. See the build
+ script build.xml for details.
+ </p>
+ </section>
+ <section id="env-java-home">
+ <title>JAVA_HOME</title>
+ <p>
+ The build script uses <a href="ext:ant">Apache Ant</a>, a popular
+ Java-based build tool, which usually requires that the environment variable JAVA_HOME point to
+ your local JDK root directory. This is true even if you use JDK 1.3 or above, which normally
+ does not need this setting.
+ </p>
+ </section>
+ <section id="env-ant">
+ <title>Apache Ant</title>
+ <p>
+ <a href="ext:ant">Apache Ant</a> must be installed in order to
+ build FOP. Following best practices we don't include Ant with FOP anymore. You can find the
+ <a href="ext:ant/manual/">instructions to install Ant in the Ant manual</a> on the web.
+ </p>
+ </section>
+ </section>
+ <section id="build-script">
+ <title>Run the Build Script</title>
+ <p>
+ Change to the FOP root directory and build FOP by executing the build script (build.xml)
+ using the "ant" command.
+ </p>
+ <note>
+ The "ant" command is only available on your system if you've properly
+ <a href="ext:ant/manual/">installed Apache Ant</a> and added Ant's location to the PATH
+ environment variable.
+ </note>
+ <p>
+ The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. It
+ contains information for numerous build targets, many of which are building blocks to more
+ useful target, and others which are primarily used by the FOP developers.
+ You may benefit from looking through this file to learn more about the various build targets.
+ To obtain a complete list of useful build targets:
+ </p>
+ <source>ant -projecthelp</source>
+ <p>The most useful targets are:</p>
+ <ul>
+ <li>
+ <strong>package</strong>: Generates the JAR files (default). This is the normal build that
+ produces a jar file usable for running FOP.
+ </li>
+ <li>
+ <strong>clean </strong>: Cleans the build directory. This is useful for making sure that
+ any build errors are cleaned up before starting a new build. It should not ordinarily be
+ needed, but may be helpful if you are having problems with the build process itself.
+ </li>
+ <li>
+ <strong>javadocs</strong>: Creates the FOP API documentation.
+ <note>A minimum JDK version of 1.4.2 is required for generating the javadocs.</note>
+ </li>
+ </ul>
+ <p>To run the build:</p>
+ <source>ant [target ...]</source>
+ <p>For example to do a normal build for the "all" target (which is the default):</p>
+ <source>ant</source>
+ <p>OR</p>
+ <source>ant all</source>
+ <p>To clean the build directory first:</p>
+ <source>ant clean all</source>
+ <note>
+ If you want to shorten the build time you can just call the "package" target which
+ doesn't perform any automated tests during the build.
+ </note>
+ </section>
+ <section id="problems">
+ <title id="Troubleshooting">Troubleshooting</title>
+ <p>If you have problems building FOP, please try the following:</p>
+ <ul>
+ <li>Run the build with the target of "clean", then rerun the build.</li>
+ <li>Delete the build directory completely, then rerun the build.</li>
+ <li>
+ Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar,
+ or another dependency product somewhere in your CLASSPATH.
+ </li>
+ <li>
+ If the build still fails, see the <a href="../gethelp.html">Getting Help</a>
+ page for further help.
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
+