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

Fixed some links.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352653 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Glen Stampoultzis 2002-05-28 02:17:57 +00:00
parent 3bf27b7f1e
commit e3581a0396
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
src/documentation/xdocs/index.xml
View File

@ -9,25 +9,25 @@
<person id="GJS" name="Glen Stampoultzis" email="glens@apache.org"/> <person id="GJS" name="Glen Stampoultzis" email="glens@apache.org"/>
</authors> </authors>
</header> </header>
<body> <body>
<section title="Logo Contest"> <section title="Logo Contest">
<!-- <!--
<p> <p>
The POI committers have voted to The POI committers have voted to
<link href="http://jakarta.apache.org/ant">"innovate"</link> and hold a <link href="http://jakarta.apache.org/ant">"innovate"</link> and hold a
logo contest. The big P at the top of the page is just a placeholder. logo contest. The big P at the top of the page is just a placeholder.
So the rules are pretty much this: So the rules are pretty much this:
</p> </p>
<ul> <ul>
<li> <li>
<link href="http://burnallgifs.org/">Only PNG submissions</link> <link href="http://burnallgifs.org/">Only PNG submissions</link>
be accepted (we can convert them as needed). be accepted (we can convert them as needed).
</li> </li>
<li> <li>
Submissions must be sent to the <link Submissions must be sent to the <link
href="http://jakarta.apache.org/site/mail.html">POI href="http://jakarta.apache.org/site/mail.html">POI
User's mailing list</link> via an http link. If you do not User's mailing list</link> via an http link. If you do not
have an available webserver contact Andy (acoliver at apache dot have an available webserver contact Andy (acoliver at apache dot
org) and ask him to post it for you (and he will if it doesn't org) and ask him to post it for you (and he will if it doesn't
suck royally). Large binary attachments annoyingly posted to suck royally). Large binary attachments annoyingly posted to
@ -35,7 +35,7 @@
</li> </li>
<li> <li>
Image authors must be willing to work with us on any font and Image authors must be willing to work with us on any font and
sizing issues, etc. sizing issues, etc.
</li> </li>
<li> <li>
All submissions become property of the Apache Software All submissions become property of the Apache Software
@ -69,10 +69,10 @@
likes Tiki gods, but Glen suggests voting for what you like. :-) likes Tiki gods, but Glen suggests voting for what you like. :-)
</p> </p>
<p> <p>
<link href="http://jakarta.apache.org/poi/html/vote.html">Vote here now!!!</link> <link href="http://vote.sparklit.com/web_poll.spark/640946">Vote here now!!!</link>
</p> </p>
<p> <p>
<link href="http://vote.sparklit.com/web_poll.spark/640946">Click here</link> to see the current results. <link href="http://vote.sparklit.com/poll.spark/640946">Click here</link> to see the current results.
</p> </p>
</section> </section>
<section title="Purpose"> <section title="Purpose">
@ -82,51 +82,51 @@
</p> </p>
<p> <p>
OLE 2 Compound Document Format based files include most Microsoft Office OLE 2 Compound Document Format based files include most Microsoft Office
files such as XLS and DOC. files such as XLS and DOC.
</p> </p>
<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 you'll soon find generators and serializers for our projects;
<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.
</p> </p>
<section title="Why/when would I use POI?"> <section title="Why/when would I use POI?">
<p> <p>
We'll tackle this on a component level. POI refers to the whole project. We'll tackle this on a component level. POI refers to the whole project.
</p> </p>
<p> <p>
So why should you use POIFS or HSSF? So why should you use POIFS or HSSF?
</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 POI 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 port of this file format to date! we say that POIFS is the most complete and correct port of this file format to date!
</p> </p>
<p> <p>
You'd use HSSF if you needed to read or write an XLS (Excel) file using Java. You can also read and modify You'd use HSSF if you needed to read or write an XLS (Excel) file using Java. You can also read and modify
spreadsheets using this API, although right now writing is more mature. spreadsheets using this API, although right now writing is more mature.
</p> </p>
</section> </section>
<section title="What does POI stand for?"> <section title="What does POI stand for?">
<p> <p>
POI stands for Poor Obfuscation Implementation. Why would we name our project such a derogatory name? Well, POI stands for Poor Obfuscation Implementation. Why would we name our project such a derogatory name? Well,
Microsoft's OLE 2 Compound Document Format is a poorly conceived thing. It is essentially an archive structured Microsoft's OLE 2 Compound Document Format is a poorly conceived thing. It is essentially an archive structured
much like the old DOS FAT filesystem. Redmond chose, instead of using tar, gzip, zip or arc, to invent their own much like the old DOS FAT filesystem. Redmond chose, instead of using tar, gzip, zip or arc, to invent their own
archive format that does not provide any standard encryption or compression, is not very appendable and is prone archive format that does not provide any standard encryption or compression, is not very appendable and is prone
to fragmentation. to fragmentation.
</p> </p>
<p> <p>
Poi is also a Hawaiian delicacy that <link href="http://www.m-w.com">Merriam Webster's dictionary</link> defines as: Poi is also a Hawaiian delicacy that <link href="http://www.m-w.com">Merriam Webster's dictionary</link> defines as:
"A Hawaiian food of taro root cooked, pounded, and kneaded to a paste and often allowed to ferment." This seemed "A Hawaiian food of taro root cooked, pounded, and kneaded to a paste and often allowed to ferment." This seemed
strangely descriptive of the file format. strangely descriptive of the file format.
</p> </p>
<p> <p>
So if you like acronyms, then POI is an acronym. If you hate them, then we just used the name of the food for our So if you like acronyms, then POI is an acronym. If you hate them, then we just used the name of the food for our
project. If you wish to signify your love or hate for acronyms, use POI or Poi to refer to the project respectively. project. If you wish to signify your love or hate for acronyms, use POI or Poi to refer to the project respectively.
</p> </p>
</section> </section>
@ -141,16 +141,16 @@
</section> </section>
<section title="POIFS (POI Filesystem)"> <section title="POIFS (POI Filesystem)">
<p>POIFS is the oldest and most stable part of the project. It is our port of the OLE 2 Compound Document Format to <p>POIFS is the oldest and most stable part of the project. It is our port of the OLE 2 Compound Document Format to
pure Java. It supports both read and write functionality. All of our components ultimately rely on it by pure Java. It supports both read and write functionality. All of our components ultimately rely on it by
definition. Please see <link href="./poifs/index.html">the POIFS project page</link> for more information.</p> definition. Please see <link href="./poifs/index.html">the POIFS project page</link> for more information.</p>
</section> </section>
<section title="HSSF (Horrible Spreadsheet Format)"> <section title="HSSF (Horrible Spreadsheet Format)">
<p>HSSF is our port of the Microsoft Excel 97(-2002) file format (BIFF8) to pure Java. It supports read and write <p>HSSF is our port of the Microsoft Excel 97(-2002) file format (BIFF8) to pure Java. It supports read and write
capability. Please see <link href="./hssf/index.html">the HSSF project page</link> for more information.</p> capability. Please see <link href="./hssf/index.html">the HSSF project page</link> for more information.</p>
</section> </section>
<section title="HDF (Horrible Document Format)"> <section title="HDF (Horrible Document Format)">
<p>HDF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability. <p>HDF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability.
Please see <link href="./hdf/index.html">the HDF project page for more information</link>. This component is Please see <link href="./hdf/index.html">the HDF project page for more information</link>. This component is
in the early stages of design. Jump in!</p> in the early stages of design. Jump in!</p>
</section> </section>
<section title="HPSF (Horrible Property Set Format)"> <section title="HPSF (Horrible Property Set Format)">
@ -166,19 +166,19 @@
</section> </section>
<section title="What happened to the HSSF Serializer?"> <section title="What happened to the HSSF Serializer?">
<p>The HSSF Serializer, which was part of our 1.0 release and last builds on <p>The HSSF Serializer, which was part of our 1.0 release and last builds on
<link href="http://www.sourceforge.net/projects/poi">Sourceforge</link>, has been donated to the <link href="http://www.sourceforge.net/projects/poi">Sourceforge</link>, has been donated to the
<link href="http://xml.apache.org/cocoon/">Cocoon</link> project, and is available starting from version <link href="http://xml.apache.org/cocoon/">Cocoon</link> project, and is available starting from version
2.0.2.</p> 2.0.2.</p>
</section> </section>
<section title="Contributing "> <section title="Contributing ">
<p> <p>
So you'd like to contribute to the project? Great! We need enthusiastic, hard-working, talented folks to help So you'd like to contribute to the project? Great! We need enthusiastic, hard-working, talented folks to help
us on the project in several areas. The first is bug reports and feature requests! The second is documentation - us on the project in several areas. The first is bug reports and feature requests! The second is documentation -
we'll be at your every beck and call if you've got a critique or you'd like to contribute or otherwise improve we'll be at your every beck and call if you've got a critique or you'd like to contribute or otherwise improve
the documentation. We could especially use some help documenting the HSSF file format! Last, but not least, we the documentation. We could especially use some help documenting the HSSF file format! Last, but not least, we
could use some binary crunching Java coders to chew through the convolution that characterizes Microsoft's file could use some binary crunching Java coders to chew through the convolution that characterizes Microsoft's file
formats and help us port new ones to a superior Java platform! formats and help us port new ones to a superior Java platform!
</p> </p>
<p>So if you're motivated, ready, and have the time, join the mail lists and we'll be happy to help you get started on the <p>So if you're motivated, ready, and have the time, join the mail lists and we'll be happy to help you get started on the