]> source.dussan.org Git - poi.git/commitdiff
made docs meaningful
authorAndrew C. Oliver <acoliver@apache.org>
Sat, 2 Feb 2002 02:41:34 +0000 (02:41 +0000)
committerAndrew C. Oliver <acoliver@apache.org>
Sat, 2 Feb 2002 02:41:34 +0000 (02:41 +0000)
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352073 13f79535-47bb-0310-9956-ffa450edef68

src/documentation/xdocs/hssf/index.xml

index f230683cdb517b7956b830cdb6c40d114e8938c1..f956b0f28985e2c2c8fd64babe53ef590bdf9b64 100644 (file)
  <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>