Introduction

Maybe it's unwise to advertise your competitors but we believe competition is good and we have the best support reading and - write Excel workbooks currently available. + write Excel workbooks currently available. This however does not + purport to be a complete list.

How to use the HSSF prototype API +

How to use the HSSF API

Capabilities

This release of the how-to outlines functionality for the CVS HEAD. Those looking for information on previous releases should look in the documentation distributed with that release.

- This release allows numeric and string cell values to be written to - or read from an XLS file as well as reading and writing dates. Also + HSSF allows numeric, string, date or formuala cell values to be written to + or read from an XLS file. Also in this release is row and column sizing, cell styling (bold, italics, borders,etc), and support for both built-in and user - defined data formats. New - to this release is an event-based API for reading XLS files. + defined data formats. Also available is + an event-based API for reading XLS files. It differs greatly from the read/write API and is intended for intermediate developers who need a smaller - memory footprint. It will also serve as the basis for the HSSF - Generator.

+ memory footprint. +

General Use

User API @@ -474,25 +474,15 @@ yet. When it does something, we'll document it.

What's Next? -

This release contains code that supports "internationalization" -or more accurately non-US/UK languages; however, it has not been -tested with the new API changes (please help us with this). We've -shifted focus a bit for this release in recognition of the -international support we've gotten. We're going to focus on western -European languages for our first beta. We're more than happy to -accept help in supporting non-Western European languages if someone -who knows what they're doing in this area is willing to pitch in! -(There is next to no documentation on what is necessary to support -such a move and its really hard to support a language when you don't even -know the alphabet).

This release of HSSF does not yet support Formulas. I've been -focusing on the requests I've gotten in. That being said, if we get -more user feedback on what is most useful first we'll aim for that. -As a general principal, HSSF's goal is to support HSSF-Serializer -(meaning an emphasis on write). We would like to hear from you! How -are you using HSSF/POIFS? How would you like to use it? What features -are most important first? -

Further effort on HSSF is going to focus on the following major areas:

Performance: A lot of work is going on in CVS and mailing lists for greatly improving the +memory efficiency of POI, as well as improving speed. Many approaches have been suggested, and a lot of code as been written. +It now needs a lot of testing and bugfixing.
Charts: This is a hard problem, with very little documentation.

So jump in!

diff --git a/src/documentation/content/xdocs/hssf/index.xml b/src/documentation/content/xdocs/hssf/index.xml index bf102ba31c..6635755050 100644 --- a/src/documentation/content/xdocs/hssf/index.xml +++ b/src/documentation/content/xdocs/hssf/index.xml @@ -25,23 +25,17 @@

a full usermodel api for creating, reading and modifying XLS files

- 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 - Apache Cocoon - Project. With Cocoon you can serialize any XML datasource (of - which might be a ESQL page outputting in SQL for instance) by simply + An alternate way of generating a spreadsheet is via the Cocoon serializer (yet you'll still be using HSSF indirectly). + With Cocoon you can serialize any XML datasource (which might be a ESQL page outputting in SQL for instance) by simply applying the stylesheet and designating the serializer.

If you're merely reading spreadsheet data, then use the eventmodel api - in the org.apache.poi.hssf.eventmodel package. + in the org.apache.poi.hssf.eventusermodel package.

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. + can also generate spreadsheets this way.

diff --git a/src/documentation/content/xdocs/hssf/limitations.xml b/src/documentation/content/xdocs/hssf/limitations.xml index 1a2fec72a5..5ebab7b8a6 100644 --- a/src/documentation/content/xdocs/hssf/limitations.xml +++ b/src/documentation/content/xdocs/hssf/limitations.xml @@ -9,7 +9,7 @@ -

Version 1.5 limitations +

Version 2.0 limitations

The intent of this document is to outline some of the known limitations of the POI HSSF API's. It is not intended to be complete list of every bug or missing @@ -19,7 +19,7 @@

Charts

- You can not currently create charts. This is planned for the 2.0 release. You can + You can not currently create charts. You can however create a chart in Excel, modify the chart data values using HSSF and write a new spreadsheet out. This is possible because POI attempts to keep existing records intact as far as possible.

@@ -39,15 +39,13 @@
Macros

- Macros can not be created. The are currently no plans to support macros. Reading - workbooks containing macros is supported but attempting to write those workbooks - will fail. This is because macros are stored as extra file sytems within the - compound document, and these are not currently kept when the file is rewritten.

+ Macros can not be created. However, reading and re-writing files containing macros will + safely preserve the macros.
Pivot Tables

- Generating pivot tables is not supported. Reading spreadsheets containing pivot tables - has not been tested. + Generating pivot tables is not supported. It has been reported that files containing pivot + tables can be read and re-written safely.

diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index 4644890f3c..6e9e8658be 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -7,6 +7,7 @@ + @@ -31,7 +32,7 @@

As a general policy we try to collaborate as much as possible with other projects to provide this functionality. Examples include: Cocoon for - which you'll soon find generators and serializers for our projects; + which there are serializers for HSSF; Open Office.org with whom we collaborate in documenting the XLS format; and Lucene for which we'll soon have file format interpretors. When practical, we donate components directly to those projects for POI-enabling them. @@ -45,7 +46,7 @@

You'd use POIFS if you had a document written in OLE 2 Compound Document Format, probably written using - MFC, that you needed to read in Java. Alternatively, you'd use POI to write OLE 2 Compound Document Format + MFC, that you needed to read in Java. Alternatively, you'd use POIFS to write OLE 2 Compound Document Format if you needed to inter-operate with software running on the Windows platform. We are not just bragging when we say that POIFS is the most complete and correct implementation of this file format to date!

@@ -75,7 +76,7 @@

HWPF

HWPF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability. Please see the HWPF project page for more information. This component is - in the early stages of design. Jump in!

+ in the early stages of development.It can already read and write simple files. Jump in!

HPSF

HPSF is our port of the OLE 2 property set format to pure diff --git a/src/documentation/content/xdocs/todo.xml b/src/documentation/content/xdocs/todo.xml index fe3b5bc929..8f6081fafa 100644 --- a/src/documentation/content/xdocs/todo.xml +++ b/src/documentation/content/xdocs/todo.xml @@ -5,30 +5,30 @@ Things To Do for Poi - + + + - + Finish HWPF Finish Charts - - Finish Formulas. + + Evaluate and bugfix performance code in HEAD + - - Expose functionality in low level records in higher level API - Implement more record types. @@ -44,8 +44,8 @@ Create new adapter object for handling MulBlank, MulRk, Rk records. - - Add a way to copy sheets. + + Improve formulas (Shared Formulas, Unkown PTG's) diff --git a/src/documentation/skins/poi-site/css/site.css b/src/documentation/skins/poi-site/css/site.css index b4842df9cd..5b41ef74f9 100644 --- a/src/documentation/skins/poi-site/css/site.css +++ b/src/documentation/skins/poi-site/css/site.css @@ -79,3 +79,6 @@ div#banner { .crumbSeparator { } +#authors { + font-size: x-small; +} \ No newline at end of file diff --git a/src/documentation/skins/poi-site/xslt/html/document2html.xsl b/src/documentation/skins/poi-site/xslt/html/document2html.xsl index 7ac9509dc0..f8d235f287 100644 --- a/src/documentation/skins/poi-site/xslt/html/document2html.xsl +++ b/src/documentation/skins/poi-site/xslt/html/document2html.xsl @@ -48,7 +48,7 @@ $Id$ - +