Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation updates 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352295 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Glen Stampoultzis 2002-03-29 11:06:05 +00:00
parent 7d1ba7ecc3
commit 6dbd4cdc6b
7 changed files with 188 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
src/documentation/xdocs/changes.xml
View File

@ -1,24 +1,85 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE changes PUBLIC "-//APACHE//DTD Changes V1.0//EN" "src/documentation/xdocs/dtd/changes-v10.dtd"> <!DOCTYPE changes PUBLIC "-//APACHE//DTD Changes V1.0//EN" "dtd/changes-v10.dtd">
<changes title="History of Changes"> <changes title="History of Changes">
<devs> <devs>
<!-- in strict alphabetical order --> <!-- in strict alphabetical order -->
<person id="AO" name="Andrew C. Oliver" email="acoliver2@users.sourceforge.net"/> <person id="AO" name="Andrew C. Oliver" email="acoliver2@users.sourceforge.net"/>
<person id="GS" name="Glen Stampoultzis" email="gstamp@iprimus.com.au"/> <person id="GJS" name="Glen Stampoultzis" email="glens@apache.org"/>
<person id="MJ" name="Marc Johnson" email="mjohnson@apache.org"/> <person id="MJ" name="Marc Johnson" email="mjohnson@apache.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="open" name="Poi Developers" email="poi-dev@jakarta.apache.org"/> <person id="POI-DEVELOPERS" name="Poi Developers" email="poi-dev@jakarta.apache.org"/>
</devs> </devs>
<release version="@version@" date="@date@"> <release version="@version@" date="@date@">
<action dev="NKB" type="update"> <action dev="NKB" type="update">New project build.</action>
New project build. <action dev="NKB" type="update">New project documentation system based on Cocoon.</action>
</action> <action dev="POI-DEVELOPERS" type="update">Package rename</action>
<action dev="NKB" type="update"> <action dev="POI-DEVELOPERS" type="fix">Various bug fixes</action>
New project documentation system based on Cocoon. <action dev="POI-DEVELOPERS" type="add">Early stages of HSF development (not ready for development)</action>
</action> <action dev="POI-DEVELOPERS" type="add">Initial low level record support for charting (not complete)</action>
</release> </release>
<release version="1.1.0" date="">
<action dev="POI-DEVELOPERS">Created new event model</action>
<action dev="POI-DEVELOPERS">Optimizations made to HSSF including aggregate records for
values, rows, etc.</action>
<action dev="POI-DEVELOPERS">predictive sizing, offset based writing (instead of lots of
array copies)</action>
<action dev="POI-DEVELOPERS">minor re-factoring and bug fixes.</action>
</release>
<release version="1.0.0" date="???">
<action dev="POI-DEVELOPERS">Minor documentation updates.</action>
</release>
<release version="0.14.0" date="???">
<action dev="POI-DEVELOPERS">Added DataFormat helper class and exposed set and get format
on HSSFCellStyle</action>
<action dev="POI-DEVELOPERS">Fixed column width apis (unit wise) and various javadoc on
the subject</action>
<action dev="POI-DEVELOPERS">Fix for Dimensions record (again)... (one of these days I'll
write a unit test for this ;-p).</action>
<action dev="POI-DEVELOPERS">Some optimization on sheet creation.</action>
</release>
<release version="0.13.0" date="???">
</release>
<release version="0.12.0" date="???">
<action dev="POI-DEVELOPERS">Added MulBlank, Blank, ColInfo</action>
<action dev="POI-DEVELOPERS">Added log4j facility and removed all sys.out type logging</action>
<action dev="POI-DEVELOPERS">Added support for adding font's, styles and corresponding
high level api for styling cells</action>
<action dev="POI-DEVELOPERS">added support for changing row height, cell width and default
row height/cell width.</action>
<action dev="POI-DEVELOPERS">Added fixes for internationalization (UTF-16 should work now
from HSSFCell.setStringValue, etc when the encoding is set)</action>
<action dev="POI-DEVELOPERS">added support for adding/removing and naming sheets.</action>
</release>
<release version="0.11.0" date="???">
<action dev="POI-DEVELOPERS">Bugfix release. We were throwing an exception when reading
RKRecord objects.</action>
</release>
<release version="0.10.0" date="???">
<action dev="POI-DEVELOPERS">Got continuation records to work (read/write)</action>
<action dev="POI-DEVELOPERS">Added various pre-support for formulas</action>
<action dev="POI-DEVELOPERS">Massive API reorganization, repackaging.</action>
<action dev="POI-DEVELOPERS">BiffViewer class added for validating HSSF &amp; POI and/or
HSSF Output.</action>
<action dev="POI-DEVELOPERS">Better API support for modification.</action>
</release>
<release version="0.7 (and interim releases)" date="???">
<action dev="POI-DEVELOPERS">Added encoding flag to high and low level api to use utf-16
when needed (HSSFCell.setEncoding())</action>
<action dev="POI-DEVELOPERS">added read only support for Label records (which are
reinterpreted as LabelSST when written)</action>
<action dev="POI-DEVELOPERS">Broken continuation record implementation (oops)</action>
<action dev="POI-DEVELOPERS">BiffViewer class added for validating HSSF &amp; POI and/or
HSSF Output.</action>
</release>
<release version="0.6 (release)" date="???">
<action dev="POI-DEVELOPERS">Support for read/write and modify.</action>
<action dev="POI-DEVELOPERS">Read only support for MulRK records (converted to Number when
writing)
</action>
</release>
</changes> </changes>

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

@ -19,16 +19,17 @@
</s2> </s2>
<s2 title="Capabilities"> <s2 title="Capabilities">
<p>This release of the how-to outlines functionality included in a <p>This release of the how-to outlines functionality for 1.5.
development build of HSSF. Those looking for information on the Those looking for information on the release edition should
release edition should look in the poi-src for the release or at a look in the poi-src for the release or at a
previous edition in CVS tagged for that release.</p> previous edition in CVS tagged for that release.</p>
<p> <p>
This release allows numeric and string cell values to be written to This release allows numeric and string cell values to be written to
or read from an XLS file. Also in this release is row and column or read from an XLS file as well as reading and writing dates. Also
sizing, cell styling (bold, italics, borders,etc), and support for in this release is row and column sizing, cell styling (bold,
built-in data formats. New to this release is an event-based API italics, borders,etc), and support for built-in data formats. New
for reading XLS files. It differs greatly from the read/write API to this release 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 and is intended for intermediate developers who need a smaller
memory footprint. It will also serve as the basis for the HSSF memory footprint. It will also serve as the basis for the HSSF
Generator.</p> Generator.</p>
@ -57,10 +58,8 @@ org.apache.poi.hssf.usermodel.HSSFWorkbook.
</p> </p>
<p>Sheets are created by calling createSheet() from an existing <p>Sheets are created by calling createSheet() from an existing
instance of HSSFWorkbook, the created sheet is automatically added in instance of HSSFWorkbook, the created sheet is automatically added in
sequence to the workbook. In this release there will always be at sequence to the workbook. Sheets do not in themselves have a sheet
least three sheets generated regardless of whether you have three name (the tab at the bottom); you set
sheets. More than three sheets is probably not supported. Sheets do
not in themselves have a sheet name (the tab at the bottom); you set
the name associated with a sheet by calling the name associated with a sheet by calling
HSSFWorkbook.setSheetName(sheetindex,&quot;SheetName&quot;).</p> HSSFWorkbook.setSheetName(sheetindex,&quot;SheetName&quot;).</p>
<p>Rows are created by calling createRow(rowNumber) from an existing <p>Rows are created by calling createRow(rowNumber) from an existing
@ -242,7 +241,7 @@ method (sheet.removeRow(hssfrow)) and create objects just as you
would if creating a new xls. When you are done modifying cells just would if creating a new xls. When you are done modifying cells just
call workbook.write(outputstream) just as you did above.</p> call workbook.write(outputstream) just as you did above.</p>
<p>An example of this can be seen in <p>An example of this can be seen in
<link href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/poi/poi/production/src/net/sourceforge/poi/hssf/dev/HSSF.java?rev=HEAD&amp;content-type=text/plain">org.apache.poi.hssf.dev.HSSF</link>.</p> <link href="http://cvs.apache.org/viewcvs/~checkout~/jakarta-poi/src/java/org/apache/poi/hssf/dev/HSSF.java?rev=1.1">org.apache.poi.hssf.dev.HSSF</link>.</p>
</s4> </s3> </s4> </s3>
<s3 title="Event API"> <s3 title="Event API">
@ -438,34 +437,46 @@ most likely fail. No big deal. </code></li>
</ul> </ul>
</s3> </s3>
<s3 title="HSSF Logging facility"> <s3 title="HSSF Logging facility">
<p>HSSF now has a logging facility (using log4j - thanks jakarta!) <p>HSSF now has a logging facility (using
<link href="http://jakarta.apache.org/commons/logging.html">commons logging</link>)
that will record massive amounts of debugging information. Its mostly that will record massive amounts of debugging information. Its mostly
useful to us hssf-developing geeks, but might be useful in tracking useful to us hssf-developing geeks, but might be useful in tracking
down problems. By default we turn this off because it results in down problems.
unnecessary performance degradation when fully turned on! Using it is </p>
simple. You need an hssflog.properties file (example listed below, <p>So Why use commons logging rather than log4j? Well the following discussion from
those familiar with log4j can customize this as they wish). You can the jakarta-general mailing list sums it up pretty well. (Thanks Morgan)
either put this in your home directory (or wherever the default </p>
directory is on windows which I suspect is c:\windows) or you can put <p>Here's the problem, as I see it.
it wherever you want and set the HSSF.log to the path ending in &quot;/&quot; </p>
(or &quot;\\&quot; on windows). If for any reason HSSF can't find it, <p><em>Suppose Commons component A decides to adopt Log4J, Commons component B
you get no logging. If the log configuration dictates the logging be decides to adopt LogKit, and Commons component C adopts JDK1.4 logging.
turned off, you get no logging.</p> They will all minimally function with the right jars in the classpath.
<p>Here is an example hssflog.properties (actually its not an example However you (the end-user) are left with maintaining configuration for 3
its mine): different logging APIs, which is tedious at best. When you take into
<source># Set root category priority to DEBUG and its only appender to A1. account cool features like variable log levels, Log4J appenders and the
log4j.rootCategory=DEBUG, A1 like, you're pretty much guaranteed to swallow up useful configuration
options because sophisticated configurations are too difficult to maintain
# A1 is set to be a ConsoleAppender. over mutiple logging implementations.</em>
log4j.appender.A1=org.apache.log4j.ConsoleAppender </p>
<p>
# A1 uses PatternLayout. <em>Contrarily, if all three Commons components use a logging facade, you can
log4j.appender.A1.layout=org.apache.log4j.PatternLayout focus all your configuration efforts on one logging implementation. Sure,
log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n there is a trade-off; you don't have access to all the features, and the
#uncomment below to change the level to WARN to disable debugging information. This effectively turns off logging. interface between the facade and the implementation must be maintained. But
#the default level is DEBUG (and changing it to DEBUG is the basically the same thing as leaving it commented out). the benefits are not just political; they potentially make the end-users
#log4j.category.org.apache.poi=WARN</source></p> configuration much easier.</em>
</p>
<p><em>Even if all Commons components used the same logging implementation (Log4J
for example), other projects in Jakarta-land may choose otherwise. If you
add enough Jakarta projects to your environment, you eventually end up with
the scenario described above. It's a worthwhile effort to attempt a logging
solution that plays well with the Jakarta community at large. I think in
many cases the Commons Logging component can fill that role.</em>
</p>
<p>
Refer to the commons logging package level javadoc for more information concerning how to
<link href="http://jakarta.apache.org/commons/logging/api/index.html">configure commons logging.</link>
</p>
</s3> </s3>
<s3 title="HSSF Developer's tools"> <s3 title="HSSF Developer's tools">
@ -523,108 +534,8 @@ As a general principal, HSSF's goal is to support HSSF-Serializer
are you using HSSF/POIFS? How would you like to use it? What features are you using HSSF/POIFS? How would you like to use it? What features
are most important first? are most important first?
</p> </p>
<p>This release is near feature freeze for the 1.0-beta. All
priorities refer to things we'll be adding in the next release
(probably 2.0). The 1.0-beta is scheduled for release in the mid to
late December timeframe. While it's way to early to say when the
2.0-beta will be released, my &quot;gut&quot; feeling is to aim for
around March and have at least the first three items.</p>
<p>Current list of priorities:</p>
<ol>
<li>Helper class for fonts, etc.</li>
<li>Add Formulas.</li>
<li>Implement more record types (for other things ... not sure
what this will mean yet).</li>
<li>Add more dummy checks (for when API user's do things they
&quot;can't&quot; do)</li>
<li>Add support for embedded graphics and stuff like that.</li>
<li>Create new adapter object for handling MulBlank, MulRk, Rk
records.</li>
</ol>
</s3> </s3>
<s3 title="Changes">
<s4 title="1.1.0">
<ol>
<li>Created new event model</li>
<li>Optimizations made to HSSF including aggregate records for
values, rows, etc.</li>
<li>predictive sizing, offset based writing (instead of lots of
array copies)</li>
<li>minor re-factoring and bug fixes.</li>
</ol>
</s4>
<s4 title="1.0.0">
<ol>
<li>Minor documentation updates.</li>
</ol>
</s4>
<s4 title="0.14.0">
<ol>
<ol>
<li>Added DataFormat helper class and exposed set and get format
on HSSFCellStyle</li>
<li>Fixed column width apis (unit wise) and various javadoc on
the subject</li>
<li>Fix for Dimensions record (again)... (one of these days I'll
write a unit test for this ;-p).</li>
<li>Some optimization on sheet creation.</li>
</ol>
</ol>
</s4>
<s4 title="0.13.0">
<p>- NO WAY!</p>
</s4>
<s4 title="0.12.0">
<ol>
<li>Added MulBlank, Blank, ColInfo</li>
<li>Added log4j facility and removed all sys.out type logging</li>
<li>Added support for adding font's, styles and corresponding
high level api for styling cells</li>
<li>added support for changing row height, cell width and default
row height/cell width.</li>
<li>Added fixes for internationalization (UTF-16 should work now
from HSSFCell.setStringValue, etc when the encoding is set)</li>
<li>added support for adding/removing and naming sheets.</li>
</ol>
</s4>
<s4 title="0.11.0">
<ol>
<li>Bugfix release. We were throwing an exception when reading
RKRecord objects.</li>
</ol>
</s4>
<s4 title="0.10.0">
<ol>
<li>Got continuation records to work (read/write)</li>
<li>Added various pre-support for formulas</li>
<li>Massive API reorganization, repackaging.</li>
<li>BiffViewer class added for validating HSSF &amp; POI and/or
HSSF Output.</li>
<li>Better API support for modification.</li>
</ol>
</s4>
<s4 title="0.7 (and interim releases)">
<ol>
<li>Added encoding flag to high and low level api to use utf-16
when needed (HSSFCell.setEncoding())</li>
<li>added read only support for Label records (which are
reinterpreted as LabelSST when written)</li>
<li>Broken continuation record implementation (oops)</li>
<li>BiffViewer class added for validating HSSF &amp; POI and/or
HSSF Output.</li>
</ol>
</s4>
<s4 title="0.6 (release)">
<ol>
<li>Support for read/write and modify.</li>
<li>Read only support for MulRK records (converted to Number when
writing)
</li>
</ol>
</s4>
</s3>
</s2> </s2>
</s1> </s1>

53
src/documentation/xdocs/livesites.xml
View File

@ -2,32 +2,29 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "dtd/document-v10.dtd"> <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "dtd/document-v10.dtd">
<document> <document>
<header> <header>
<title>Live Sites using Poi</title> <title>Live Sites using Poi</title>
<authors> <authors>
<person name="Donald Ball" email="balld@webslingerZ.com"/> <person name="Donald Ball" email="balld@webslingerZ.com"/>
<person name="Stefano Mazzocchi" email="stefano@apache.org"/> <person name="Stefano Mazzocchi" email="stefano@apache.org"/>
<person name="Robin Green" email="greenrd@hotmail.com"/> <person name="Robin Green" email="greenrd@hotmail.com"/>
<person name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/> <person name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/>
</authors> <person name="Glen Stampoultzis" email="glens@apache.org"/>
</header> </authors>
</header>
<body><s1 title="Live Sites using Poi">
<p>Here is a list of some of the web sites that are proudly using Poi 1.X (in no particular order): <body>
</p> <s1 title="Live Sites using Poi">
<!-- <p>Currently we don't have any sites listed that use Poi, but we're sure they're out there.
<ul> Help us change this. If you've
<li><link href=""></link></li> written a site that utilises Poi let us know.
</ul> </p>
</s1> <!--
--> <ul>
<p> <li><link href=""></link></li>
If you do not find your site here, make sure you tell us </ul>
(use the word &quot;Livesites&quot; in the email subject, confirm that </s1>
you want to be listed publicly, say which version of Poi, and do not -->
forget to tell us the URL). </s1>
We would like to see this list grow bigger every day :-) </body>
</p>
</s1>
</body>
</document> </document>

4
src/documentation/xdocs/plan/POI10Vision.xml
View File

@ -99,7 +99,7 @@
solution for outputting Office Document formats often involves solution for outputting Office Document formats often involves
actually manipulating the software as an OLE Server. This method actually manipulating the software as an OLE Server. This method
provides extremely low performance, extremely high overhead and is provides extremely low performance, extremely high overhead and is
only capable of handing one document at a time. only capable of handling one document at a time.
</p> </p>
<ol> <ol>
<li> <li>
@ -110,7 +110,7 @@
<li> <li>
Our intended audience for the HSSF Our intended audience for the HSSF
library portion of this project is ourselves as we are developing library portion of this project is ourselves as we are developing
the serializer and anyone who needs to write to Excel spreadsheets the Serializer and anyone who needs to write to Excel spreadsheets
in a non-XML Java environment or who has specific needs not in a non-XML Java environment or who has specific needs not
addressed by the Serializer. addressed by the Serializer.
</li> </li>

6
src/documentation/xdocs/plan/POI20Vision.xml
View File

@ -22,7 +22,7 @@
changed a bit. We're not going to change the vision document to changed a bit. We're not going to change the vision document to
reflect this (however proper that may be) because it would only reflect this (however proper that may be) because it would only
involve deletion. There is no purpose in providing less involve deletion. There is no purpose in providing less
information provded we give clarification. information provided we give clarification.
</p> </p>
<p> <p>
This document was created before the POI components for This document was created before the POI components for
@ -275,10 +275,10 @@
<table> <table>
<tr> <tr>
<td> <td>
Benefit <b>Benefit</b>
</td> </td>
<td> <td>
Supporting Features <b>Supporting Features</b>
</td> </td>
</tr> </tr>
<tr> <tr>

33
src/documentation/xdocs/todo.xml
View File

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE todo PUBLIC "-//APACHE//DTD Todo V1.0//EN" "src/documentation/xdocs/dtd/todo-v10.dtd"> <!DOCTYPE todo PUBLIC "-//APACHE//DTD Todo V1.0//EN" "dtd/todo-v10.dtd">
<todo title="Things To Do for Poi"> <todo title="Things To Do for Poi">
<devs> <devs>
<!-- in strict alphabetical order --> <!-- in strict alphabetical order -->
<person id="AO" name="Andrew C. Oliver" email="acoliver2@users.sourceforge.net"/> <person id="AO" name="Andrew C. Oliver" email="acoliver2@users.sourceforge.net"/>
<person id="GS" name="Glen Stampoultzis" email="gstamp@iprimus.com.au"/> <person id="GS" name="Glen Stampoultzis" email="gstamp@iprimus.com.au"/>
<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="open" name="Poi Developers" email="poi-dev@jakarta.apache.org"/> <person id="open" name="Poi Developers" email="poi-dev@jakarta.apache.org"/>
@ -15,14 +15,39 @@
<actions priority="high"> <actions priority="high">
<action context="code" assigned-to="NKB"> <action context="code" assigned-to="NKB">
do it Finish HDF
</action>
<action context="code" assigned-to="NKB">
Finish Charts
</action>
<action context="code">
Add Formulas.
</action> </action>
</actions> </actions>
<actions priority="medium"> <actions priority="medium">
<action context="code"> <action context="code">
do it Expose functionality in low level records in higher level API
</action>
<action context="code">
Implement more record types (for other things ... not sure
what this will mean yet).
</action>
<action context="code">
Implement more record types (for other things ... not sure
what this will mean yet).
</action>
<action context="code">
Add more dummy checks (for when API user's do things they
&quot;can't&quot; do)
</action>
<action context="code">
Add support for embedded graphics and stuff like that.
</action>
<action context="code">
Create new adapter object for handling MulBlank, MulRk, Rk
records.
</action> </action>
</actions> </actions>

4
src/documentation/xdocs/who.xml
View File

@ -43,12 +43,12 @@
<li><link href="http://trilug.org/~acoliver">Andrew C. Oliver</link> (acoliver at apache dot org)</li> <li><link href="http://trilug.org/~acoliver">Andrew C. Oliver</link> (acoliver at apache dot org)</li>
<li><link href="http://www.marcj.com">Marc Johnson</link> (mjohnson at apache dot org)</li> <li><link href="http://www.marcj.com">Marc Johnson</link> (mjohnson at apache dot org)</li>
<li>Glen Stampoultzis (glens at apache.org)</li> <li>Glen Stampoultzis (glens at apache.org)</li>
<li><link href="http://www.rainer-klute.de/">Rainer Klute</link> (klute at apache dot org)</li> <li><link href="http://www.rainer-klute.de/">Rainer Klute</link> (klute at apache dot org)</li>
<li>Nicola Ken Barozzi (barozzi at nicolaken dot com)</li>
</ul> </ul>
</s2> </s2>
<s2 title="Developers"> <s2 title="Developers">
<ul> <ul>
<li>Nicola Ken Barozzi (barozzi at nicolaken dot com)</li>
<li>Ryan Ackley (sackley at cfl dot rr dot com)</li> <li>Ryan Ackley (sackley at cfl dot rr dot com)</li>
</ul> </ul>
</s2> </s2>