summaryrefslogtreecommitdiffstats
path: root/src/documentation/xdocs
diff options
context:
space:
mode:
authorAndrew C. Oliver <acoliver@apache.org>2002-02-02 02:41:34 +0000
committerAndrew C. Oliver <acoliver@apache.org>2002-02-02 02:41:34 +0000
commit0dd1673fd228bce162cef7750d24cedf6ad583e2 (patch)
tree122a503e208177d3d9c528a7174052d0e364f5af /src/documentation/xdocs
parentf8e3aa617966660d59c5cd913f8de1a791165b1b (diff)
downloadpoi-0dd1673fd228bce162cef7750d24cedf6ad583e2.tar.gz
poi-0dd1673fd228bce162cef7750d24cedf6ad583e2.zip
made docs meaningful
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352073 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/xdocs')
-rw-r--r--src/documentation/xdocs/hssf/index.xml28
1 files changed, 26 insertions, 2 deletions
diff --git a/src/documentation/xdocs/hssf/index.xml b/src/documentation/xdocs/hssf/index.xml
index f230683cdb..f956b0f289 100644
--- a/src/documentation/xdocs/hssf/index.xml
+++ b/src/documentation/xdocs/hssf/index.xml
@@ -15,8 +15,32 @@
<s1 title="Overview">
<p>HSSF is the POI Project's pure Java implementation of the Excel '97(-2002) file format.</p>
- <p>Please see the HOWTO for usage information.</p>
- <p>TODO: turn this page into a meaningful summary.</p>
+ <p>HSSF provides a way to read spreadsheets create, modify, read and write XLS spreadsheets
+ It provides:
+ </p>
+ <ul>
+ <li>low level structures for those with special needs</li>
+ <li>an eventmodel api for efficient read-only access</li>
+ <li>a full usermodel api for creating, reading and modifying XLS files</li>
+ </ul>
+ <p>
+ Truth be told there is probably a better way to generate your spreadsheet
+ generation (yet you'll still be using HSSF indirectly). At the time of
+ this writing we're in the process of moving the HSSF Serializer over to
+ the <link href="http://xml.apache.org/cocoon">Apache Cocoon
+ Project</link>. With Cocoon you can serialize any XML datasource (of
+ which might be a ESQL page outputting in SQL for instance) by simply
+ applying the stylesheet and designating the serializer.
+ </p>
+ <p>
+ If you're merely reading spreadsheet data, then use the eventmodel api
+ in the org.apache.poi.hssf.eventmodel package.
+ </p>
+ <p>
+ If you're modifying spreadsheet data then use the usermodel api. You
+ can also generate spreadsheets this way, but using Cocoon (which will do
+ it this way indirectly) is the best way...we promise.
+ </p>
</s1>
</body>