From f2b76afe66d8a19616f7d9193ab3bf383eca5a07 Mon Sep 17 00:00:00 2001 From: David Fisher Date: Thu, 19 Nov 2009 21:22:21 +0000 Subject: [PATCH] Many documentation changes. See https://issues.apache.org/bugzilla/show_bug.cgi?id=48242 git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@882301 13f79535-47bb-0310-9956-ffa450edef68 --- build.xml | 6 +- forrest.properties | 2 +- src/documentation/content/xdocs/book.xml | 38 +- .../content/xdocs/casestudies.xml | 17 + src/documentation/content/xdocs/download.xml | 74 +++- src/documentation/content/xdocs/faq.xml | 393 +++++++++--------- .../content/xdocs/guidelines.xml | 197 +++++++++ .../content/xdocs/howtobuild.xml | 88 ++-- src/documentation/content/xdocs/index.xml | 194 +++------ src/documentation/content/xdocs/legal.xml | 20 +- .../content/xdocs/mailinglists.xml | 3 +- src/documentation/content/xdocs/overview.xml | 294 +++++++++---- .../content/xdocs/subversion.xml | 13 +- .../content/xdocs/text-extraction.xml | 81 ++-- src/documentation/content/xdocs/who.xml | 39 +- .../images/built-with-forrest-button.png | Bin 0 -> 1936 bytes src/documentation/skinconf.xml | 13 +- .../skins/poi-site/xslt/fo/document2fo.xsl | 3 + .../poi-site/xslt/html/document2html.xsl | 2 +- .../skins/poi-site/xslt/html/site2xhtml.xsl | 10 +- 20 files changed, 912 insertions(+), 575 deletions(-) create mode 100644 src/documentation/content/xdocs/guidelines.xml create mode 100644 src/documentation/resources/images/built-with-forrest-button.png diff --git a/build.xml b/build.xml index 3cfb9aed7..7bc888f38 100644 --- a/build.xml +++ b/build.xml @@ -56,7 +56,7 @@ under the License. --> - The POI project Ant build. + The Apache POI project Ant build. @@ -214,7 +214,7 @@ under the License. - + - Execute "ant -projecthelp" to view a listing of the main build targets. @@ -836,7 +836,7 @@ under the License. Please install Apache Forrest (see -<http://xml.apache.org/forrest/index.html>) and set the +<http://forrest.apache.org/index.html>) and set the FORREST_HOME environment variable! diff --git a/forrest.properties b/forrest.properties index 0db98743c..b4578ab44 100644 --- a/forrest.properties +++ b/forrest.properties @@ -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 diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml index afcf3a7a7..048ca3f44 100644 --- a/src/documentation/content/xdocs/book.xml +++ b/src/documentation/content/xdocs/book.xml @@ -24,33 +24,37 @@ copyright="@year@ POI Project" xmlns:xlink="http://www.w3.org/1999/xlink"> - + - - - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + - - + diff --git a/src/documentation/content/xdocs/casestudies.xml b/src/documentation/content/xdocs/casestudies.xml index 6b3b4e5c9..3646c42b1 100644 --- a/src/documentation/content/xdocs/casestudies.xml +++ b/src/documentation/content/xdocs/casestudies.xml @@ -25,6 +25,7 @@ + @@ -196,6 +197,22 @@ format,

It is obvious that Microsoft Excel files are also supported. POI has been used to successfully implement this support in ETL4ALL.

+
+ JM Lafferty Associates, Inc. +

+ On its ForecastWorks website + JM Lafferty Associates, Inc. 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. +

+
    +
  • The PPT files produced are of high quality which is on a par with similar PDF files.
    • +
  • The XLS files produced contain a complex forecasting model built from a template with a VBA Macro.
    • +
+

+ David Fisher (dfisher@jmlafferty.com) +

+
diff --git a/src/documentation/content/xdocs/download.xml b/src/documentation/content/xdocs/download.xml index 72a58735e..6a8d2bb89 100755 --- a/src/documentation/content/xdocs/download.xml +++ b/src/documentation/content/xdocs/download.xml @@ -21,27 +21,28 @@
- Apache POI - Download + Apache POI - Download Release Artifacts
-
Downloads +
Available Downloads

- Use the links below to download Apache POI releases from one of our mirrors. - You should verify the integrity - 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.

    -
  • Latest stable release: Apache POI 3.5
    • -
  • Release Archive
    • +
  • The latest stable release is Apache POI 3.5
    • +
  • Archives of all prior releases

Apache POI releases are available under the Apache License, Version 2.0. See the NOTICE file contained in each release artifact for applicable copyright attribution notices. -

+

+

+ To insure that you have downloaded the true release you should verify the integrity + of the files using the signatures and checksums available from this page. +

-
28 September 2009 - POI 3.5-FINAL available - +
28 September 2009 - POI 3.5-FINAL available

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.

@@ -81,11 +82,11 @@
-
Verify - +
Verify

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 Verifying Apache HTTP Server Releases + for more information on why you should verify our releases. This page provides detailed instructions which you can use for POI artifacts.

The PGP signatures can be verified using PGP or GPG. First download the KEYS file as well as the .asc signature files @@ -93,19 +94,54 @@ rather than from a mirror. Then verify the signatures using

- % pgpk -a KEYS - % pgpv poi-X.Y.Z.jar.asc +% pgpk -a KEYS +% pgpv poi-X.Y.Z.jar.asc

or

- % pgp -ka KEYS - % pgp poi-X.Y.Z.jar.asc +% pgp -ka KEYS +% pgp poi-X.Y.Z.jar.asc

or

- % gpg --import KEYS - % gpg --verify poi-X.Y.Z.jar.asc +% gpg --import KEYS +% gpg --verify poi-X.Y.Z.jar.asc +

Sample verification of poi-bin-3.5-FINAL-20090928.tar.gz

+ +% gpg --import KEYS +gpg: key 12DAE9BE: "Glen Stampoultzis <glens at apache dot org>" not changed +gpg: key 4CEED75F: "Nick Burch <nick at gagravarr dot org>" not changed +gpg: key 84B5A42E: "Rainer Klute <rainer.klute at gmx dot de>" not changed +gpg: key F5BB52CD: "Yegor Kozlov <yegor.kozlov at gmail dot com>" 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 <yegor.kozlov at gmail dot com>" +gpg: aka "Yegor Kozlov <yegor at dinom dot ru>" +gpg: aka "Yegor Kozlov <yegor at apache dot org>" +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 <yegor.kozlov at gmail dot com> +uid Yegor Kozlov <yegor at dinom dot ru> +uid Yegor Kozlov <yegor at apache dot org> +sub 4096g/7B45A98A 2007-06-18 [expires: 2012-06-16] + +
+
Release Archives +

+ 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 Apache Jakarta. +

+
    +
  • Binary Artifacts
    • +
  • Source Artifacts
    • +
  • Keys
    • +
  • Artifacts from prior to 3.0
    • +