diff --git a/src/documentation/content/xdocs/hwpf/docoverview.xml b/src/documentation/content/xdocs/hwpf/docoverview.xml index a82db07758..468a618bdf 100644 --- a/src/documentation/content/xdocs/hwpf/docoverview.xml +++ b/src/documentation/content/xdocs/hwpf/docoverview.xml @@ -4,8 +4,8 @@
- Jakarta POI - HWPF -Java APIs with XML manipulate MS-Word - Word file format + Jakarta POI - HWPF - Java API to Handle Microsoft Word Files + Word File Format diff --git a/src/documentation/content/xdocs/hwpf/index.xml b/src/documentation/content/xdocs/hwpf/index.xml index 494529c074..aa832bb274 100644 --- a/src/documentation/content/xdocs/hwpf/index.xml +++ b/src/documentation/content/xdocs/hwpf/index.xml @@ -4,32 +4,111 @@
- Jakarta POI - HWPF -Java APIs with XML manipulate MS-Word + Jakarta POI - HWPF - Java API to Handle Microsoft Word Files Overview +
Overview -

HWPF is the name of OUR port of the Microsoft Word 97(-2002) file format to - pure Java.

-

HWPF is still in early development. It is in the - scratchpad section of the - CVS. Source code in the org.apache.poi.hwpf.extractor tree is - legacy code. Source in the org.apache.poi.hwpf.model - tree is the old legacy code refactored into an object model. Check the How-To - page for detailed examples on using HWPF. -

-

- We are looking for developers!!! If you are interested in helping with HWPF - familiarize yourself with the source code and just start coding. Make sure - you read the guidelines for - getting involved

+

HWPF is the name of our port of the Microsoft Word 97(-2002) file format + to pure Java.

+ +

HWPF is still in early development. It is in the + scratchpad section of the CVS. Source code in the + org.apache.poi.hwpf.extractor tree is legacy code. Source in the + org.apache.poi.hwpf.model tree is the old legacy code refactored + into an object model.

+ +
+ HWPF Pointman Needed! + +

At the moment we unfortunately do not have someone taking care for HWPF + and fostering its development. What we need is someone to stand up, take + this thing under his hood as his baby and push it forward. Ryan Ackley, + who put a lot of effort into HWPF, is no longer on board, so HWPF is an + orphan child waiting to be adopted.

+ +

If you are interested in becoming the new HWPF + pointman, you should look into the Microsoft Word internals. A good + starting point seems to be Ryan Ackley's overview. This document contains a link to + a detailled Word format description you can find somewhere at + http://www.wotsit.org/. Please + do not contact Ryan Ackley directly, because he is working for a company + now that signed a NDA with Microsoft and thus he will be no longer able to + answer questions.

+ +

As a first step you should familiarize yourself with the source code, + examples, test cases, and the HWPF patches available at Bugzilla (if any). Then you + should compile an overview of

+ +
    +
  • the current HWPF status,
    • +
  • the patches in Bugzilla to be checked + in (and those that should better be ditched),
    • +
  • the available test cases and the test cases still to be written,
    • +
  • the available documentation and the docs to be written,
    • +
  • anything else that seems reasonable
    • +
+ +

When you start start coding, you will not yet have write access to the + CVS repository. Please submit your patches to Bugzilla and nag Rainer Klute until he commits + them. Besides the actual checking in of HWPF patches Rainer will also do + some minor reviews now and then of your source code patches, test cases + and documentation to help ensure software quality. But most of the time + you will be on your own.

+ +

Please do not forget to write JUnit test cases and documentation! + We won't accept code that doesn't come with test cases. And please + consider that other contributors should be able to understand your source + code easily. If you need any help getting started with JUnit test cases + for HWPF, please ask on the developers' mailing list! If you show that you + are prepared to stick at it you will most likely be given CVS commit + access.

+ +

Important: It is legally vital for POI that you have + never seen any documentation or specification from Microsoft that required + you or your employer to sign an NDA to get it. Please do read the "Contribution to POI" page for + details! This page also contains further information for you to start POI + development.

+ +

Of course we will help you as best as we can. However, presently there + is no committer who is really familiar with the Word format, so you'll be + mostly on your own. We are looking forward for you and your contributions! + Honor and glory of becoming a POI committer are waiting!

+
+ + diff --git a/src/documentation/content/xdocs/hwpf/projectplan.xml b/src/documentation/content/xdocs/hwpf/projectplan.xml index df6f18cecb..7b47465698 100644 --- a/src/documentation/content/xdocs/hwpf/projectplan.xml +++ b/src/documentation/content/xdocs/hwpf/projectplan.xml @@ -4,7 +4,7 @@
- Jakarta POI - HWPF -Java APIs with XML manipulate MS-Word + Jakarta POI - HWPF - Java API to Handle Microsoft Word Files Project Plan