From: Andrew C. Oliver Date: Sun, 20 Jul 2003 01:15:14 +0000 (+0000) Subject: no PR bunnies were hurt in the making of this commit X-Git-Tag: PERF_BEFORE_MERGE~245 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=bbc3dffb672458dd204c9c381755435bb30d1687;p=poi.git no PR bunnies were hurt in the making of this commit git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353229 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index d63f6d8662..85baeed2b4 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -20,7 +20,7 @@ The POI project consists of APIs for manipulating various file formats based upon Microsoft's OLE 2 Compound Document format using pure Java. In short, you can read and write MS Excel files using Java. Soon, you'll be able to read and write - Word files using Java. POI is your Java Excel solution as well as your Word Excel solution. + Word files using Java. POI is your Java Excel solution as well as your Java Word solution. However, we have a complete API for porting other OLE 2 Compound Document formats and welcome others to participate.

@@ -47,38 +47,13 @@ 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 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 implementation of this file format to date!

You'd use HSSF if you needed to read or write an Excel file using Java (XLS). You can also read and modify spreadsheets using this API, although right now writing is more mature.

- -
What does POI stand for? -

- 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 - much like the old DOS FAT filesystem. Microsoft Corporation 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 - to fragmentation. -

-

- Poi is also a Hawaiian delicacy that Merriam Webster's dictionary defines as: - "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. - Poi -- paste of taro root -- is well-nourished and most of the Hawaiians eat it as baby - food and therefore they will become BIG and HEAVY as grown-up - --- we think the naming of 'Poi' might be sure to fit to -the project from this point of view - and hope that our 'Poi' project to become BIGGER and more famous. -

-

- 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. -

-
- @@ -88,21 +63,21 @@ the project from this point of view components, one of which, HSSF, writes Excel files. The following are components of the entire POI project and a brief summary of their purpose.

-
POIFS (POI Filesystem) +
POIFS

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 definition. Please see the POIFS project page for more information.

-
HSSF (Horrible Spreadsheet Format) +
HSSF

HSSF is our port of the Microsoft Excel 97(-2002) file format (BIFF8) to pure Java. It supports read and write capability. Please see the HSSF project page for more information.

-
HDF (Horrible Document Format) -

HDF is our port of the Microsoft Word 97 file format to pure Java. It supports read and write capability. - Please see the HDF project page for more information. This component is +

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!

-
HPSF (Horrible Property Set Format) +
HPSF

HPSF is our port of the OLE 2 property set format to pure Java. Property sets are mostly use to store a document's properties (title, author, date of last modification etc.), but they can be used @@ -114,20 +89,13 @@ the project from this point of view

-
What happened to the HSSF Serializer? -

The HSSF Serializer, which was part of our 1.0 release and last builds on - Sourceforge, has been donated to the - Cocoon project, and is available starting from version - 2.0.2.

-
-
Contributing

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 - 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 - 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 complexity that characterizes Microsoft's file formats and help us port new ones to a superior Java platform!

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