klute 2003/08/30 02:19:04
Modified: src/documentation/content/xdocs/hpsf how-to.xml index.xml
internals.xml todo.xml
Log:
Small documentation updates for HPSF writing capabilities.
Revision Changes Path
1.3 +14 -5 jakarta-poi/src/documentation/content/xdocs/hpsf/how-to.xml
Index: how-to.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hpsf/how-to.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- how-to.xml 24 Apr 2003 00:53:29 -0000 1.2
+++ how-to.xml 30 Aug 2003 09:19:04 -0000 1.3
@@ -13,7 +13,7 @@
<body>
<section><title>How To Use the HPSF APIs</title>
- <p>This HOW-TO is organized in three sections. You should read them
+ <p>This HOW-TO is organized in four sections. You should read them
sequentially because the later sections build upon the earlier ones.</p>
<ol>
@@ -34,9 +34,18 @@
<li>
The <link href="#sec3">third section</link> tells how to read
- non-standard properties. Non-standard properties are application-specific
- triples consisting of an ID, a type, and a value.
- </li>
+ non-standard properties. Non-standard properties are application-specific
+ triples consisting of an ID, a type, and a value.
+ </li>
+
+ <li>
+ The <link href="#sec4">fourth section</link> will tell you how to write
+ property set streams - once it is written. Writing is still quite
+ rudimentary in HPSF and you have to understand the <link
+ href="#sec3">third section</link> before you should think about writing
+ properties. Stick to the Javadoc API documentation to find out more about
+ writing property sets!
+ </li>
</ol>
1.5 +4 -3 jakarta-poi/src/documentation/content/xdocs/hpsf/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hpsf/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 4 Aug 2003 03:42:46 -0000 1.4
+++ index.xml 30 Aug 2003 09:19:04 -0000 1.5
@@ -4,7 +4,7 @@
<document>
<header>
- <title>Jakarta POI - HPSF - Java APIs with XML manipulate MS-Format
Properties</title>
+ <title>Jakarta POI - HPSF - Java API to Handle Microsoft Format Document
Properties</title>
<subtitle>Overview</subtitle>
<authors>
<person name="Rainer Klute" email="[EMAIL PROTECTED]"/>
@@ -12,6 +12,7 @@
</header>
<body>
<section><title>Overview</title>
+
<p>Microsoft applications like "Word", "Excel" or "Powerpoint" let the user
describe his document by properties like "title", "category" and so on. The
application itself adds further information: last author, creation date
@@ -19,7 +20,7 @@
streams</strong>. A property set stream is a separate document within a
<link href="../poifs/index.html">POI filesystem</link>. We'll call property
set streams mostly just "property sets". HPSF is POI's pure-Java
- implementation to read (and in future to write) property sets.</p>
+ implementation to read and property sets.</p>
<p>The <link href="how-to.html">HPSF HOWTO</link> describes what a Java
application should do to read a property set using HPSF and to retrieve the
1.7 +2 -2 jakarta-poi/src/documentation/content/xdocs/hpsf/internals.xml
Index: internals.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hpsf/internals.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- internals.xml 8 Aug 2003 05:23:04 -0000 1.6
+++ internals.xml 30 Aug 2003 09:19:04 -0000 1.7
@@ -32,7 +32,7 @@
<strong>property set stream</strong>.</p>
<p>This document describes the internal structure of a property set stream,
- i.e. the <strong>HPSF</strong>. It does
+ i.e. the <strong>HPSF</strong>. It does
not describe how a Microsoft Office document is organized internally and
how to retrieve a stream from it. See the <link
href="../poifs/index.html">POIFS documentation</link> for that kind of
1.3 +5 -5 jakarta-poi/src/documentation/content/xdocs/hpsf/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/content/xdocs/hpsf/todo.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- todo.xml 24 Apr 2003 00:53:29 -0000 1.2
+++ todo.xml 30 Aug 2003 09:19:04 -0000 1.3
@@ -16,8 +16,9 @@
<ol>
<li>
- Add writing capability for property sets. Presently property sets can
- be read only.
+ Improve writing support! We need convenience classes and methods for
+ easily writing summary information streams and document summary
+ information streams.
</li>
<li>
Add codepage support: Presently the bytes making out the string in a
@@ -38,8 +39,7 @@
</li>
<li>
Add WMF to <code>java.awt.Image</code> example code in <link
- href="thumbnails.html">Thumbnail
- HOW TO</link>.
+ href="thumbnails.html">Thumbnail HOW TO</link>.
</li>
</ol>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
