Permalink
Browse files

Many documentation changes. See https://issues.apache.org/bugzilla/sh…

…ow_bug.cgi?id=48242

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@882301 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
1 parent 89c17f1 commit f2b76afe66d8a19616f7d9193ab3bf383eca5a07 David Fisher committed Nov 19, 2009
View
@@ -56,7 +56,7 @@ under the License.
-->
<project name="POI Build" default="help" basedir=".">
- <description>The POI project Ant build.</description>
+ <description>The Apache POI project Ant build.</description>
<property environment="env"/>
@@ -214,7 +214,7 @@ under the License.
<!-- Prints POI's Ant usage help -->
- <target name="help" description="Prints POI's Ant usage help">
+ <target name="help" description="Prints Apache POI's Ant usage help">
<echo>
- Execute "ant -projecthelp" to view a listing of the main build
targets.
@@ -836,7 +836,7 @@ under the License.
<target name="-check-forrest-installed" unless="env.FORREST_HOME">
<echo>Please install Apache Forrest (see
-&lt;http://xml.apache.org/forrest/index.html&gt;) and set the
+&lt;http://forrest.apache.org/index.html&gt;) and set the
FORREST_HOME environment variable!</echo>
<fail message="Apache Forrest is not installed."/>
</target>
View
@@ -3,7 +3,7 @@
##############
# Prints out a summary of Forrest settings for this project
-#forrest.echo=true
+forrest.echo=true
# Project name (used to name .war file)
#project.name=my-project
@@ -24,33 +24,37 @@
copyright="@year@ POI Project"
xmlns:xlink="http://www.w3.org/1999/xlink">
- <menu label="Apache POI">
+ <menu label="Overview">
<menu-item label="Home" href="index.html"/>
<menu-item label="Download" href="download.html"/>
- <menu-item label="Changes" href="changes.html"/>
+ <menu-item label="Components" href="overview.html"/>
+ <menu-item label="Text Extraction" href="text-extraction.html"/>
+ <menu-item label="Case Studies" href="casestudies.html"/>
+ <menu-item label="Legal" href="legal.html"/>
</menu>
- <menu label="Documentation">
- <menu-item label="Source" href="subversion.html"/>
- <menu-item label="Building" href="howtobuild.html"/>
+ <menu label="Help">
<menu-item label="Javadocs" href="ext:javadoc"/>
- <menu-item label="Case Studies" href="casestudies.html"/>
<menu-item label="FAQ" href="faq.html"/>
<menu-item label="Mailing Lists" href="mailinglists.html"/>
<menu-item label="Bug Database" href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI"/>
- <menu-item label="Get Involved" href="getinvolved/index.html"/>
+ <menu-item label="Changes Log" href="changes.html"/>
+ </menu>
+
+ <menu label="Getting Involved">
+ <menu-item label="Subversion Repository" href="subversion.html"/>
+ <menu-item label="How To Build" href="howtobuild.html"/>
+ <menu-item label="Contribution Guidelines" href="guidelines.html"/>
<menu-item label="Who We Are" href="who.html"/>
- <menu-item label="Legal" href="legal.html"/>
</menu>
- <menu label="Modules">
- <menu-item label="Text Extraction" href="text-extraction.html"/>
+ <menu label="Component APIs">
<menu-item label="Excel (SS=HSSF+XSSF)" href="spreadsheet/index.html"/>
<menu-item label="Word (HWPF+XWPF)" href="hwpf/index.html"/>
<menu-item label="PowerPoint (HSLF+XSLF)" href="slideshow/index.html"/>
+ <menu-item label="OpenXML4J (OOXML)" href="oxml4j/index.html"/>
<menu-item label="OLE2 Filesystem (POIFS)" href="poifs/index.html"/>
- <menu-item label="OLE2 Properties (HPSF)" href="hpsf/index.html"/>
- <menu-item label="OpenXML4J" href="oxml4j/index.html"/>
+ <menu-item label="OLE2 Document Props (HPSF)" href="hpsf/index.html"/>
<menu-item label="Outlook (HSMF)" href="hsmf/index.html"/>
<menu-item label="Visio (HDGF)" href="hdgf/index.html"/>
<menu-item label="Publisher (HPBF)" href="hpbf/index.html"/>
@@ -25,6 +25,7 @@
<authors>
<person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/>
<person id="CR" name="Cameron Riley" email="crileyNO@SPAMekmail.com"/>
+ <person id="DF" name="David Fisher" email="dfisher@jmlafferty.com"/>
</authors>
</header>
@@ -196,6 +197,22 @@ format,
<p>It is obvious that Microsoft Excel files are also supported.
POI has been used to successfully implement this support in ETL4ALL.</p>
</section>
+ <section>
+ <title>JM Lafferty Associates, Inc.</title>
+ <p>
+ On its <link href="http://www.forecastworks.com/public/">ForecastWorks</link> website
+ <link href="http://www.jmlafferty.com/">JM Lafferty Associates, Inc.</link> produces dynamic on demand
+ financial analyses of companies and institutional funds. The pages produced are selected and exported
+ in several file formats including PPT and XLS.
+ </p>
+ <ul>
+ <li>The PPT files produced are of high quality which is on a par with similar PDF files.</li>
+ <li>The XLS files produced contain a complex forecasting model built from a template with a VBA Macro.</li>
+ </ul>
+ <p>
+ David Fisher (dfisher@jmlafferty.com)
+ </p>
+ </section>
</section>
</body>
@@ -21,27 +21,28 @@
<document>
<header>
- <title>Apache POI - Download</title>
+ <title>Apache POI - Download Release Artifacts</title>
</header>
<body>
- <section><title>Downloads</title>
+ <section><title>Available Downloads</title>
<p>
- Use the links below to download Apache POI releases from one of our mirrors.
- You should <link href="download.html#verify">verify the integrity</link>
- of the files using the signatures and checksums available from this page.
+ This page provides instructions on how to download and verify Apache POI release artifacts.
</p>
<ul>
- <li>Latest stable release: <link href="download.html#POI-3.5-FINAL">Apache POI 3.5</link></li>
- <li><link href="http://archive.apache.org/dist/poi/">Release Archive</link></li>
+ <li><link href="download.html#POI-3.5-FINAL">The latest stable release is Apache POI 3.5</link></li>
+ <li><link href="download.html#archive">Archives of all prior releases</link></li>
</ul>
<p>
Apache POI releases are available under the <link href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</link>
See the NOTICE file contained in each release artifact for applicable copyright attribution notices.
- </p>
+ </p>
+ <p>
+ To insure that you have downloaded the true release you should <link href="download.html#verify">verify the integrity</link>
+ of the files using the signatures and checksums available from this page.
+ </p>
</section>
- <section><title>28 September 2009 - POI 3.5-FINAL available</title>
- <anchor id="POI-3.5-FINAL"/>
+ <section id="POI-3.5-FINAL"><title>28 September 2009 - POI 3.5-FINAL available</title>
<p>The Apache POI team is pleased to announce the release of 3.5 FINAL.
This release brings many improvements including support for the new OOXML formats introduced in Office 2007, such as XLSX and DOCX.
</p>
@@ -81,32 +82,67 @@
</ul>
</section>
</section>
- <section><title>Verify</title>
- <anchor id="verify"/>
+ <section id="verify"><title>Verify</title>
<p>
It is essential that you verify the integrity of the downloaded files using the PGP or MD5 signatures.
- Please read Verifying Apache HTTP Server Releases for more information on why you should verify our releases.
+ Please read <link href="http://httpd.apache.org/dev/verification.html">Verifying Apache HTTP Server Releases</link>
+ for more information on why you should verify our releases. This page provides detailed instructions which you can use for POI artifacts.
</p>
<p>
The PGP signatures can be verified using PGP or GPG. First download the KEYS file as well as the .asc signature files
for the relevant release packages. Make sure you get these files from the main distribution directory,
rather than from a mirror. Then verify the signatures using
</p>
<source>
- % pgpk -a KEYS
- % pgpv poi-X.Y.Z.jar.asc
+% pgpk -a KEYS
+% pgpv poi-X.Y.Z.jar.asc
</source>
<p>or</p>
<source>
- % pgp -ka KEYS
- % pgp poi-X.Y.Z.jar.asc
+% pgp -ka KEYS
+% pgp poi-X.Y.Z.jar.asc
</source>
<p>or</p>
<source>
- % gpg --import KEYS
- % gpg --verify poi-X.Y.Z.jar.asc
+% gpg --import KEYS
+% gpg --verify poi-X.Y.Z.jar.asc
+ </source>
+ <p>Sample verification of poi-bin-3.5-FINAL-20090928.tar.gz</p>
+ <source>
+% gpg --import KEYS
+gpg: key 12DAE9BE: "Glen Stampoultzis &lt;glens at apache dot org&gt;" not changed
+gpg: key 4CEED75F: "Nick Burch &lt;nick at gagravarr dot org&gt;" not changed
+gpg: key 84B5A42E: "Rainer Klute &lt;rainer.klute at gmx dot de&gt;" not changed
+gpg: key F5BB52CD: "Yegor Kozlov &lt;yegor.kozlov at gmail dot com&gt;" not changed
+gpg: Total number processed: 4
+gpg: unchanged: 4
+% gpg --verify poi-bin-3.5-FINAL-20090928.tar.gz.asc
+gpg: Signature made Mon Sep 28 10:28:25 2009 PDT using DSA key ID F5BB52CD
+gpg: Good signature from "Yegor Kozlov &lt;yegor.kozlov at gmail dot com&gt;"
+gpg: aka "Yegor Kozlov &lt;yegor at dinom dot ru&gt;"
+gpg: aka "Yegor Kozlov &lt;yegor at apache dot org&gt;"
+Primary key fingerprint: 7D77 0C77 6CE7 754E E6AF 23AA 6934 0A02 F5BB 52CD
+% gpg --fingerprint F5BB52CD
+pub 1024D/F5BB52CD 2007-06-18 [expires: 2012-06-16]
+ Key fingerprint = 7D77 0C77 6CE7 754E E6AF 23AA 6934 0A02 F5BB 52CD
+uid Yegor Kozlov &lt;yegor.kozlov at gmail dot com&gt;
+uid Yegor Kozlov &lt;yegor at dinom dot ru&gt;
+uid Yegor Kozlov &lt;yegor at apache dot org&gt;
+sub 4096g/7B45A98A 2007-06-18 [expires: 2012-06-16]
</source>
</section>
+ <section id="archive"><title>Release Archives</title>
+ <p>
+ Apache POI became a top level project in June 2007 and POI 3.0 aritfacts were re-released.
+ Prior to that date POI was a sub-project of <link href="http://jakarta.apache.org/">Apache Jakarta.</link>
+ </p>
+ <ul>
+ <li><link href="http://archive.apache.org/dist/poi/release/bin/">Binary Artifacts</link></li>
+ <li><link href="http://archive.apache.org/dist/poi/release/src/">Source Artifacts</link></li>
+ <li><link href="http://archive.apache.org/dist/poi/">Keys</link></li>
+ <li><link href="http://archive.apache.org/dist/jakarta/poi/release/">Artifacts from prior to 3.0</link></li>
+ </ul>
+ </section>
</body>
<footer>
<legal>
Oops, something went wrong.

0 comments on commit f2b76af

Please sign in to comment.