126 lines
4.8 KiB
XML
126 lines
4.8 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
====================================================================
|
|
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.
|
|
====================================================================
|
|
-->
|
|
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "./dtd/document-v13.dtd">
|
|
|
|
<document>
|
|
<header>
|
|
<title>Apache POI - How To Build</title>
|
|
<authors>
|
|
<person email="user@poi.apache.org" name="Glen Stampoultzis" id="GS"/>
|
|
<person email="tetsuya@apache.org" name="Tetsuya Kitahata" id="TK"/>
|
|
<person email="dfisher@jmlafferty.com" name="David Fisher" id="DF"/>
|
|
</authors>
|
|
</header>
|
|
<body>
|
|
<section>
|
|
<title>JDK Version</title>
|
|
<p>
|
|
POI 3.5 and later requires the JDK version 1.5 or later.
|
|
Versions prior to 3.5 require JDK 1.4+
|
|
</p>
|
|
</section>
|
|
<section>
|
|
<title>Install Apache Ant</title>
|
|
<p>
|
|
The POI build system requires <link href="http://ant.apache.org/bindownload.cgi">Apache Ant</link>
|
|
</p>
|
|
<p>
|
|
Specifically the build has been tested to work with Ant version
|
|
1.7.1. To install the product download the distribution and follow the instructions.
|
|
</p>
|
|
<p>
|
|
Remember to set the ANT_HOME environment variable and add ANT_HOME/bin
|
|
to your shell's PATH.
|
|
</p>
|
|
</section>
|
|
<section>
|
|
<title>Install JUnit</title>
|
|
<p>
|
|
Running unit tests and building a distribution requires <link href="http://www.junit.org/">JUnit</link>.
|
|
</p>
|
|
<p>
|
|
Just pick the latest versions of the jars from
|
|
<link href="http://sourceforge.net/projects/junit/files/junit/">SourceForge</link> and place
|
|
them in ANT_HOME/lib. Make sure that optional.jar is in ANT_HOME/lib.
|
|
</p>
|
|
</section>
|
|
<section>
|
|
<title>Install Apache Forrest</title>
|
|
<p>
|
|
The POI build system requires <link href="http://forrest.apache.org/">Apache Forrest</link> to build the documentation.
|
|
</p>
|
|
<p>
|
|
Specifically the build has been tested to work with Forrest 0.5. This is an old release which is available
|
|
<link href="http://archive.apache.org/dist/forrest/pre-0.6/">here</link>.
|
|
</p>
|
|
<p>
|
|
Remember to set the FORREST_HOME environment variable.
|
|
</p>
|
|
</section>
|
|
<section>
|
|
<title>Building Targets with Ant</title>
|
|
<p>
|
|
The main targets of interest to our users are:
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<th>Ant Target</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>clean</td>
|
|
<td>Erase all build work products (ie. everything in the
|
|
build directory</td>
|
|
</tr>
|
|
<tr>
|
|
<td>compile</td>
|
|
<td>Compiles all files from main, ooxml and scratchpad</td>
|
|
</tr>
|
|
<tr>
|
|
<td>test</td>
|
|
<td>Run all unit tests from main, ooxml and scratchpad</td>
|
|
</tr>
|
|
<tr>
|
|
<td>jar</td>
|
|
<td>Produce jar files</td>
|
|
</tr>
|
|
<tr>
|
|
<td>assemble</td>
|
|
<td>Produce .zip and tar.gz distribution packages</td>
|
|
</tr>
|
|
<tr>
|
|
<td>docs</td>
|
|
<td>Generate all documentation (Requires Apache Forrest)</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
<footer>
|
|
<legal>
|
|
Copyright (c) @year@ The Apache Software Foundation. All rights reserved.
|
|
<br />
|
|
Apache POI, POI, Apache, the Apache feather logo, and the Apache
|
|
POI project logo are trademarks of The Apache Software Foundation.
|
|
</legal>
|
|
</footer>
|
|
</document>
|
|
|
|
|