avik 2003/11/19 11:01:23
Modified: src/documentation/content/xdocs index.xml todo.xml
src/documentation/content/xdocs/hssf alternatives.xml
formula.xml how-to.xml index.xml limitations.xml
src/documentation/skins/poi-site/css site.css
src/documentation/skins/poi-site/xslt/html document2html.xsl
Log:
documentation update for 2.0
Revision Changes Path
1.12 +5 -4 jakarta-poi/src/documentation/content/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/index.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- index.xml 6 Aug 2003 18:49:31 -0000 1.11
+++ index.xml 19 Nov 2003 19:01:23 -0000 1.12
@@ -7,6 +7,7 @@
<authors>
<person id="AO" name="Andrew C. Oliver" email="[EMAIL PROTECTED]"/>
<person id="GJS" name="Glen Stampoultzis" email="[EMAIL PROTECTED]"/>
+ <person id="AS" name="Avik Sengupta" email="[EMAIL PROTECTED]"/>
</authors>
</header>
@@ -31,7 +32,7 @@
<p>
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
- 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
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.
@@ -45,7 +46,7 @@
</p>
<p>
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!
</p>
@@ -75,7 +76,7 @@
<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.
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><title>HPSF</title>
<p>HPSF is our port of the OLE 2 property set format to pure
1.7 +9 -9 jakarta-poi/src/documentation/content/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/todo.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- todo.xml 5 Aug 2003 04:00:13 -0000 1.6
+++ todo.xml 19 Nov 2003 19:01:23 -0000 1.7
@@ -5,31 +5,31 @@
<todo><title>Things To Do for Poi</title>
<devs>
- <!-- in strict alphabetical order -->
<person id="AO" name="Andrew C. Oliver" email="[EMAIL PROTECTED]"/>
<person id="GS" name="Glen Stampoultzis" email="[EMAIL PROTECTED]"/>
<person id="MJ" name="Marc Johnson" email="mjohnson at apache dot
org"/>
<person id="NKB" name="Nicola Ken Barozzi" email="[EMAIL PROTECTED]"/>
+ <person id="RA" name="Ryan Ackley" email="[EMAIL PROTECTED]"/>
+ <person id="AS" name="Avik Sengupta" email="[EMAIL PROTECTED]"/>
<person id="open" name="POI Developers" email="[EMAIL PROTECTED]"/>
+ <person id="Everyone" name="POI Developers" email="[EMAIL
PROTECTED]"/>
</devs>
<actions priority="high">
- <action context="code" dev="NKB">
+ <action context="code" dev="RA">
Finish HWPF
</action>
<action context="code" dev="GS">
Finish Charts
</action>
- <action context="code" dev="open">
- Finish Formulas.
+ <action context="code" dev="Everyone">
+ Evaluate and bugfix performance code in HEAD
</action>
+
</actions>
<actions priority="medium">
<action context="code" dev="open">
- Expose functionality in low level records in higher level API
- </action>
- <action context="code" dev="open">
Implement more record types.
</action>
<action context="code" dev="open">
@@ -44,8 +44,8 @@
Create new adapter object for handling MulBlank, MulRk, Rk
records.
</action>
- <action context="code" dev="open">
- Add a way to copy sheets.
+ <action context="code" dev="AS">
+ Improve formulas (Shared Formulas, Unkown PTG's)
</action>
</actions>
1.4 +2 -1
jakarta-poi/src/documentation/content/xdocs/hssf/alternatives.xml
Index: alternatives.xml
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/documentation/content/xdocs/hssf/alternatives.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- alternatives.xml 18 Jul 2003 12:19:26 -0000 1.3
+++ alternatives.xml 19 Nov 2003 19:01:23 -0000 1.4
@@ -15,7 +15,8 @@
<p>
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.
</p>
<table>
<tr>
1.3 +10 -11 jakarta-poi/src/documentation/content/xdocs/hssf/formula.xml
Index: formula.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hssf/formula.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- formula.xml 24 Apr 2003 00:53:29 -0000 1.2
+++ formula.xml 19 Nov 2003 19:01:23 -0000 1.3
@@ -12,7 +12,7 @@
<section><title>Introduction</title>
<p>
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
when they are added.
</p>
@@ -36,16 +36,14 @@
<li>String, integer and floating point literals</li>
<li>Area references</li>
<li>Relative or absolute references</li>
- <li>Arithmetic Operators</li>
- <li>Sheet Functions</li>
+ <li>Arithmetic and logical operators</li>
+ <li>Sheet or Macro Functions (inlcuding logical functions)</li>
+ <li>Sheet References</li>
+ <li>Formual return values (number or string)</li>
</ul>
</section>
<section><title>Partially supported</title>
<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>:
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
@@ -60,9 +58,10 @@
<section><title>Not yet supported</title>
<ul>
<li>Array formulas</li>
- <li>Formulas with logical operations (IF) </li>
- <li>Sheet References in formulas</li>
- <li>Everything else :) </li>
+ <li>Unary Operators</li>
+ <li>3D References</li>
+ <li>Error Values (cells containing #REF's or #VALUE's)</li>
+ <li>Everything else :) </li>
</ul>
</section>
@@ -87,4 +86,4 @@
</section>
</body>
-</document>
\ No newline at end of file
+</document>
1.6 +16 -26 jakarta-poi/src/documentation/content/xdocs/hssf/how-to.xml
Index: how-to.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hssf/how-to.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- how-to.xml 30 Aug 2003 09:18:15 -0000 1.5
+++ how-to.xml 19 Nov 2003 19:01:23 -0000 1.6
@@ -11,23 +11,23 @@
</authors>
</header>
<body>
- <section><title>How to use the HSSF prototype API</title>
+ <section><title>How to use the HSSF API</title>
<section><title>Capabilities</title>
<p>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.</p>
<p>
- 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.</p>
+ memory footprint.
+ </p>
</section>
<section><title>General Use</title>
<section><title>User API</title>
@@ -474,25 +474,15 @@
</section>
<section><title>What's Next?</title>
-<p>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).</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>
+<p>Further effort on HSSF is going to focus on the following major areas: </p>
+<ul>
+<li>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. </li>
+<li>Charts: This is a hard problem, with very little documentation.</li>
+</ul>
+<p><link href="../getinvolved/index.html"> So jump in! </link> </p>
+
</section>
</section>
1.6 +4 -10 jakarta-poi/src/documentation/content/xdocs/hssf/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hssf/index.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.xml 19 Oct 2003 09:54:06 -0000 1.5
+++ index.xml 19 Nov 2003 19:01:23 -0000 1.6
@@ -25,23 +25,17 @@
<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
+ 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).
+ 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.
</p>
<p>
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>
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.
</p>
</section>
1.4 +6 -8 jakarta-poi/src/documentation/content/xdocs/hssf/limitations.xml
Index: limitations.xml
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/documentation/content/xdocs/hssf/limitations.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- limitations.xml 18 Jul 2003 12:19:26 -0000 1.3
+++ limitations.xml 19 Nov 2003 19:01:23 -0000 1.4
@@ -9,7 +9,7 @@
</authors>
</header>
<body>
- <section><title>Version 1.5 limitations</title>
+ <section><title>Version 2.0 limitations</title>
<p>
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 @@
<ul>
<li>
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
a new spreadsheet out. This is possible because POI attempts
to keep existing records
intact as far as possible.<br/><br/>
@@ -39,15 +39,13 @@
</li>
<li>
Macros<br/><br/>
- 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.<br/><br/>
+ Macros can not be created. However, reading and re-writing
files containing macros will
+ safely preserve the macros.<br/><br/>
</li>
<li>
Pivot Tables<br/><br/>
- 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.
</li>
</ul>
</section>
1.2 +3 -0 jakarta-poi/src/documentation/skins/poi-site/css/site.css
Index: site.css
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/skins/poi-site/css/site.css,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- site.css 11 Oct 2003 18:21:00 -0000 1.1
+++ site.css 19 Nov 2003 19:01:23 -0000 1.2
@@ -79,3 +79,6 @@
.crumbSeparator
{
}
+#authors {
+ font-size: x-small;
+}
\ No newline at end of file
1.2 +2 -2
jakarta-poi/src/documentation/skins/poi-site/xslt/html/document2html.xsl
Index: document2html.xsl
===================================================================
RCS file:
/home/cvs/jakarta-poi/src/documentation/skins/poi-site/xslt/html/document2html.xsl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- document2html.xsl 11 Oct 2003 18:21:00 -0000 1.1
+++ document2html.xsl 19 Nov 2003 19:01:23 -0000 1.2
@@ -48,7 +48,7 @@
</xsl:for-each>
</div>
</xsl:if>
- <xsl:call-template name="pdflink"/>
+ <!--xsl:call-template name="pdflink"/-->
</body>
</document>
</xsl:if>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
