moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

documentation update for 2.0

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353455 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Avik Sengupta 2003-11-19 19:01:23 +00:00
parent 9d2c36fad3
commit 0d1e4189e5
9 changed files with 55 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/documentation/content/xdocs/hssf/alternatives.xml
View File

@ -15,7 +15,8 @@
<p> <p>
Maybe it's unwise to advertise your competitors but we believe Maybe it's unwise to advertise your competitors but we believe
competition is good and we have the best support reading and 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.
</p> </p>
<table> <table>
<tr> <tr>

19
src/documentation/content/xdocs/hssf/formula.xml
View File

@ -12,7 +12,7 @@
<section><title>Introduction</title> <section><title>Introduction</title>
<p> <p>
This document describes the current state of formula support in POI. This document describes the current state of formula support in POI.
The information in this document applies to the 2.0-dev version of POI (i.e. CVS HEAD). The information in this document currently applies to the 2.0 version of POI.
Since this area is a work in progress, this document will be updated with new features as and Since this area is a work in progress, this document will be updated with new features as and
when they are added. when they are added.
</p> </p>
@ -36,16 +36,14 @@
<li>String, integer and floating point literals</li> <li>String, integer and floating point literals</li>
<li>Area references</li> <li>Area references</li>
<li>Relative or absolute references</li> <li>Relative or absolute references</li>
<li>Arithmetic Operators</li> <li>Arithmetic and logical operators</li>
<li>Sheet Functions</li> <li>Sheet or Macro Functions (inlcuding logical functions)</li>
<li>Sheet References</li>
<li>Formual return values (number or string)</li>
</ul> </ul>
</section> </section>
<section><title>Partially supported</title> <section><title>Partially supported</title>
<ul> <ul>
<li>
The formula parser now has the ability to parse formulas containing strings. However
formulas that return a string value are not yet supported.
</li>
<li>Formula tokens in Excel are stored in one of three possible <em> classes </em>: <li>Formula tokens in Excel are stored in one of three possible <em> classes </em>:
Reference, Value and Array. Based on the location of a token, its class can change Reference, Value and Array. Based on the location of a token, its class can change
in complicated and undocumented ways. While we have support for most cases, we in complicated and undocumented ways. While we have support for most cases, we
@ -60,9 +58,10 @@
<section><title>Not yet supported</title> <section><title>Not yet supported</title>
<ul> <ul>
<li>Array formulas</li> <li>Array formulas</li>
<li>Formulas with logical operations (IF) </li> <li>Unary Operators</li>
<li>Sheet References in formulas</li> <li>3D References</li>
<li>Everything else :) </li> <li>Error Values (cells containing #REF's or #VALUE's)</li>
<li>Everything else :) </li>
</ul> </ul>
</section> </section>

42
src/documentation/content/xdocs/hssf/how-to.xml
View File

@ -11,23 +11,23 @@
</authors> </authors>
</header> </header>
<body> <body>
<section><title>How to use the HSSF prototype API</title> <section><title>How to use the HSSF API</title>
<section><title>Capabilities</title> <section><title>Capabilities</title>
<p>This release of the how-to outlines functionality for the CVS HEAD. <p>This release of the how-to outlines functionality for the CVS HEAD.
Those looking for information on previous releases should Those looking for information on previous releases should
look in the documentation distributed with that release.</p> look in the documentation distributed with that release.</p>
<p> <p>
This release allows numeric and string cell values to be written to HSSF allows numeric, string, date or formuala cell values to be written to
or read from an XLS file as well as reading and writing dates. Also or read from an XLS file. Also
in this release is row and column sizing, cell styling (bold, in this release is row and column sizing, cell styling (bold,
italics, borders,etc), and support for both built-in and user italics, borders,etc), and support for both built-in and user
defined data formats. New defined data formats. Also available is
to this release is an event-based API for reading XLS files. an event-based API for reading XLS files.
It differs greatly from the read/write API It differs greatly from the read/write API
and is intended for intermediate developers who need a smaller and is intended for intermediate developers who need a smaller
memory footprint. It will also serve as the basis for the HSSF memory footprint.
Generator.</p> </p>
</section> </section>
<section><title>General Use</title> <section><title>General Use</title>
<section><title>User API</title> <section><title>User API</title>
@ -474,25 +474,15 @@ yet. When it does something, we'll document it.</p>
</section> </section>
<section><title>What's Next?</title> <section><title>What's Next?</title>
<p>This release contains code that supports &quot;internationalization&quot; <p>Further effort on HSSF is going to focus on the following major areas: </p>
or more accurately non-US/UK languages; however, it has not been <ul>
tested with the new API changes (please help us with this). We've <li>Performance: A lot of work is going on in CVS and mailing lists for greatly improving the
shifted focus a bit for this release in recognition of the memory efficiency of POI, as well as improving speed. Many approaches have been suggested, and a lot of code as been written.
international support we've gotten. We're going to focus on western It now needs a lot of testing and bugfixing. </li>
European languages for our first beta. We're more than happy to <li>Charts: This is a hard problem, with very little documentation.</li>
accept help in supporting non-Western European languages if someone </ul>
who knows what they're doing in this area is willing to pitch in! <p><link href="../getinvolved/index.html"> So jump in! </link> </p>
(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).</p>
<p>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?
</p>
</section> </section>
</section> </section>

14
src/documentation/content/xdocs/hssf/index.xml
View File

@ -25,23 +25,17 @@
<li>a full usermodel api for creating, reading and modifying XLS files</li> <li>a full usermodel api for creating, reading and modifying XLS files</li>
</ul> </ul>
<p> <p>
Truth be told there is probably a better way to generate your spreadsheet An alternate way of generating a spreadsheet is via the <link href="http://cocoon.apache.org">Cocoon</link> serializer (yet you'll still be using HSSF indirectly).
generation (yet you'll still be using HSSF indirectly). At the time of With Cocoon you can serialize any XML datasource (which might be a ESQL page outputting in SQL for instance) by simply
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. applying the stylesheet and designating the serializer.
</p> </p>
<p> <p>
If you're merely reading spreadsheet data, then use the eventmodel api 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.
</p> </p>
<p> <p>
If you're modifying spreadsheet data then use the usermodel api. You If you're modifying spreadsheet data then use the usermodel api. You
can also generate spreadsheets this way, but using Cocoon (which will do can also generate spreadsheets this way.
it this way indirectly) is the best way...we promise.
</p> </p>
</section> </section>

14
src/documentation/content/xdocs/hssf/limitations.xml
View File

@ -9,7 +9,7 @@
</authors> </authors>
</header> </header>
<body> <body>
<section><title>Version 1.5 limitations</title> <section><title>Version 2.0 limitations</title>
<p> <p>
The intent of this document is to outline some of the known limitations of the 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 POI HSSF API's. It is not intended to be complete list of every bug or missing
@ -19,7 +19,7 @@
<ul> <ul>
<li> <li>
Charts<br/><br/> Charts<br/><br/>
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 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 a new spreadsheet out. This is possible because POI attempts to keep existing records
intact as far as possible.<br/><br/> intact as far as possible.<br/><br/>
@ -39,15 +39,13 @@
</li> </li>
<li> <li>
Macros<br/><br/> Macros<br/><br/>
Macros can not be created. The are currently no plans to support macros. Reading Macros can not be created. However, reading and re-writing files containing macros will
workbooks containing macros is supported but attempting to write those workbooks safely preserve the macros.<br/><br/>
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.<br/><br/>
</li> </li>
<li> <li>
Pivot Tables<br/><br/> Pivot Tables<br/><br/>
Generating pivot tables is not supported. Reading spreadsheets containing pivot tables Generating pivot tables is not supported. It has been reported that files containing pivot
has not been tested. tables can be read and re-written safely.
</li> </li>
</ul> </ul>
</section> </section>

7
src/documentation/content/xdocs/index.xml
View File

@ -7,6 +7,7 @@
<authors> <authors>
<person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/> <person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/>
<person id="GJS" name="Glen Stampoultzis" email="poi-user@jakarta.apache.org"/> <person id="GJS" name="Glen Stampoultzis" email="poi-user@jakarta.apache.org"/>
<person id="AS" name="Avik Sengupta" email="poi-user@jakarta.apache.org"/>
</authors> </authors>
</header> </header>
@ -31,7 +32,7 @@
<p> <p>
As a general policy we try to collaborate as much as possible with other projects to As a general policy we try to collaborate as much as possible with other projects to
provide this functionality. Examples include: <link href="http://xml.apache.org/cocoon">Cocoon</link> for provide this functionality. Examples include: <link href="http://xml.apache.org/cocoon">Cocoon</link> for
which you'll soon find generators and serializers for our projects; which there are serializers for HSSF;
<link href="http://www.openoffice.org">Open Office.org</link> with whom we collaborate in documenting the <link href="http://www.openoffice.org">Open Office.org</link> with whom we collaborate in documenting the
XLS format; and <link href="http://jakarta.apache.org/lucene">Lucene</link> for which we'll soon have file XLS format; and <link href="http://jakarta.apache.org/lucene">Lucene</link> for which we'll soon have file
format interpretors. When practical, we donate components directly to those projects for POI-enabling them. format interpretors. When practical, we donate components directly to those projects for POI-enabling them.
@ -45,7 +46,7 @@
</p> </p>
<p> <p>
You'd use POIFS if you had a document written in OLE 2 Compound Document Format, probably written using 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 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! we say that POIFS is the most complete and correct implementation of this file format to date!
</p> </p>
@ -75,7 +76,7 @@
<section><title>HWPF</title> <section><title>HWPF</title>
<p>HWPF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability. <p>HWPF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability.
Please see <link href="./hwpf/index.html">the HWPF project page for more information</link>. This component is Please see <link href="./hwpf/index.html">the HWPF project page for more information</link>. This component is
in the early stages of design. Jump in!</p> in the early stages of development.It can already read and write simple files. Jump in!</p>
</section> </section>
<section><title>HPSF</title> <section><title>HPSF</title>
<p>HPSF is our port of the OLE 2 property set format to pure <p>HPSF is our port of the OLE 2 property set format to pure

18
src/documentation/content/xdocs/todo.xml
View File

@ -5,30 +5,30 @@
<todo><title>Things To Do for Poi</title> <todo><title>Things To Do for Poi</title>
<devs> <devs>
<!-- in strict alphabetical order -->
<person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/> <person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/>
<person id="GS" name="Glen Stampoultzis" email="poi-user@jakarta.apache.org"/> <person id="GS" name="Glen Stampoultzis" email="poi-user@jakarta.apache.org"/>
<person id="MJ" name="Marc Johnson" email="mjohnson at apache dot org"/> <person id="MJ" name="Marc Johnson" email="mjohnson at apache dot org"/>
<person id="NKB" name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/> <person id="NKB" name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/>
<person id="RA" name="Ryan Ackley" email="poi-dev@jakarta.apache.org"/>
<person id="AS" name="Avik Sengupta" email="poi-dev@jakarta.apache.org"/>
<person id="open" name="POI Developers" email="poi-dev@jakarta.apache.org"/> <person id="open" name="POI Developers" email="poi-dev@jakarta.apache.org"/>
<person id="Everyone" name="POI Developers" email="poi-dev@jakarta.apache.org"/>
</devs> </devs>
<actions priority="high"> <actions priority="high">
<action context="code" dev="NKB"> <action context="code" dev="RA">
Finish HWPF Finish HWPF
</action> </action>
<action context="code" dev="GS"> <action context="code" dev="GS">
Finish Charts Finish Charts
</action> </action>
<action context="code" dev="open"> <action context="code" dev="Everyone">
Finish Formulas. Evaluate and bugfix performance code in HEAD
</action> </action>
</actions> </actions>
<actions priority="medium"> <actions priority="medium">
<action context="code" dev="open">
Expose functionality in low level records in higher level API
</action>
<action context="code" dev="open"> <action context="code" dev="open">
Implement more record types. Implement more record types.
</action> </action>
@ -44,8 +44,8 @@
Create new adapter object for handling MulBlank, MulRk, Rk Create new adapter object for handling MulBlank, MulRk, Rk
records. records.
</action> </action>
<action context="code" dev="open"> <action context="code" dev="AS">
Add a way to copy sheets. Improve formulas (Shared Formulas, Unkown PTG's)
</action> </action>
</actions> </actions>

3
src/documentation/skins/poi-site/css/site.css
View File

@ -79,3 +79,6 @@ div#banner {
.crumbSeparator .crumbSeparator
{ {
} }
#authors {
font-size: x-small;
}

2
src/documentation/skins/poi-site/xslt/html/document2html.xsl
View File

@ -48,7 +48,7 @@ $Id$
</xsl:for-each> </xsl:for-each>
</div> </div>
</xsl:if> </xsl:if>
<xsl:call-template name="pdflink"/> <!--xsl:call-template name="pdflink"/-->
</body> </body>
</document> </document>
</xsl:if> </xsl:if>