diff --git a/src/documentation/content/xdocs/hpsf/how-to.xml b/src/documentation/content/xdocs/hpsf/how-to.xml index 57f880700..03ade0a18 100644 --- a/src/documentation/content/xdocs/hpsf/how-to.xml +++ b/src/documentation/content/xdocs/hpsf/how-to.xml @@ -13,7 +13,7 @@
How To Use the HPSF APIs -

This HOW-TO is organized in three sections. You should read them +

This HOW-TO is organized in four sections. You should read them sequentially because the later sections build upon the earlier ones.

    @@ -34,9 +34,18 @@
  1. The third section tells how to read - non-standard properties. Non-standard properties are application-specific - triples consisting of an ID, a type, and a value. -
    2. + non-standard properties. Non-standard properties are application-specific + triples consisting of an ID, a type, and a value. + + +
  2. + The fourth section 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 third section before you should think about writing + properties. Stick to the Javadoc API documentation to find out more about + writing property sets! +
diff --git a/src/documentation/content/xdocs/hpsf/index.xml b/src/documentation/content/xdocs/hpsf/index.xml index e5a34f774..4f21c1479 100644 --- a/src/documentation/content/xdocs/hpsf/index.xml +++ b/src/documentation/content/xdocs/hpsf/index.xml @@ -4,7 +4,7 @@
- Jakarta POI - HPSF - Java APIs with XML manipulate MS-Format Properties + Jakarta POI - HPSF - Java API to Handle Microsoft Format Document Properties Overview @@ -12,6 +12,7 @@
Overview +

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. A property set stream is a separate document within a POI filesystem. 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.

+ implementation to read and property sets.

The HPSF HOWTO describes what a Java application should do to read a property set using HPSF and to retrieve the diff --git a/src/documentation/content/xdocs/hpsf/internals.xml b/src/documentation/content/xdocs/hpsf/internals.xml index 0adabeaef..1a42d6806 100644 --- a/src/documentation/content/xdocs/hpsf/internals.xml +++ b/src/documentation/content/xdocs/hpsf/internals.xml @@ -32,7 +32,7 @@ property set stream.

This document describes the internal structure of a property set stream, - i.e. the HPSF. It does + i.e. the HPSF. It does not describe how a Microsoft Office document is organized internally and how to retrieve a stream from it. See the POIFS documentation for that kind of diff --git a/src/documentation/content/xdocs/hpsf/todo.xml b/src/documentation/content/xdocs/hpsf/todo.xml index 3c3ca4e7f..d99e7ff5d 100644 --- a/src/documentation/content/xdocs/hpsf/todo.xml +++ b/src/documentation/content/xdocs/hpsf/todo.xml @@ -16,8 +16,9 @@

  1. - 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.
  2. Add codepage support: Presently the bytes making out the string in a @@ -38,8 +39,7 @@
  3. Add WMF to java.awt.Image example code in Thumbnail - HOW TO. + href="thumbnails.html">Thumbnail HOW TO.