From d93f2d76dc5636f9f83760ce48d947da82a1e752 Mon Sep 17 00:00:00 2001 From: Glen Stampoultzis Date: Mon, 8 Apr 2002 12:58:00 +0000 Subject: [PATCH] More documentation. git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352357 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/xdocs/hssf/book.xml | 37 +++++----- src/documentation/xdocs/hssf/hacking-hssf.xml | 70 +++++++++++++++++++ src/documentation/xdocs/todo.xml | 3 + 3 files changed, 92 insertions(+), 18 deletions(-) create mode 100644 src/documentation/xdocs/hssf/hacking-hssf.xml diff --git a/src/documentation/xdocs/hssf/book.xml b/src/documentation/xdocs/hssf/book.xml index cc58bdd06b..672b815517 100644 --- a/src/documentation/xdocs/hssf/book.xml +++ b/src/documentation/xdocs/hssf/book.xml @@ -1,25 +1,26 @@ - + - - - + + + - - - - - - - - - - - - + + + + + + + + + + + + + diff --git a/src/documentation/xdocs/hssf/hacking-hssf.xml b/src/documentation/xdocs/hssf/hacking-hssf.xml new file mode 100644 index 0000000000..b1ed8c8c39 --- /dev/null +++ b/src/documentation/xdocs/hssf/hacking-hssf.xml @@ -0,0 +1,70 @@ + + + + +
+ Hacking HSSF + + + + +
+ +
+

+ You might find the + 'Excel 97 Developer's Kit' (out of print, Microsoft Press, no + restrictive covenants, available on Amazon.com) helpful for + understanding the file format. +

+

+ Also useful is the open office XLS spec. We + are collaborating with the maintainer of the spec so if you think you can add something to their + document just send through your changes. +

+
+
+
    +
  1. + Look at OpenOffice.org or Gnumeric sources if its implemented there. +
    2. +
  2. + Use org.apache.poi.hssf.dev.BiffViewer to view the structure of the + file. Experiment by adding one criteria entry at a time. See what it + does to the structure, infer behavior and structure from it. Using the + unix diff command (or get cygwin from www.cygwin.com for windows) you + can figure out a lot very quickly. Unimplemented records show up as + 'UNKNOWN' and prints a hex dump. +
    3. +
+
+
+

+ Low level records can be time consuming to created. We created a record + generator to help generate some of the simpler tasks. +

+

+ We use XML + descriptors to generate the Java code (which sure beats the heck out of + the PERL scripts originally used ;-) for low level records. The + generator is kinda alpha-ish right now and could use some enhancement, + so you may find that to be about 1/2 of the work. Notice this is in + org.apache.poi.hssf.record.definitions. +

+
+
+ One thing to note: ensure any participants in this process have never + signed a "Non Disclosure Agreement" with Microsoft, and have not + received any information covered by such an agreement. If they have + they'll not be able to participate in the POI project. +
+
+ Check our todo list or simply look for missing functionality. Start small + and work your way up. +
+
+ Make sure you read the contibuting section + as it contains more generation information about contributing to Poi in general. +
+ + \ No newline at end of file diff --git a/src/documentation/xdocs/todo.xml b/src/documentation/xdocs/todo.xml index ae51e4fef0..ed5307fc91 100644 --- a/src/documentation/xdocs/todo.xml +++ b/src/documentation/xdocs/todo.xml @@ -49,6 +49,9 @@ Create new adapter object for handling MulBlank, MulRk, Rk records. + + Add a way to copy sheets. + -- 2.39.5