]> source.dussan.org Git - poi.git/commitdiff
Small documentation updates for HPSF writing capabilities.
authorRainer Klute <klute@apache.org>
Sat, 30 Aug 2003 09:19:04 +0000 (09:19 +0000)
committerRainer Klute <klute@apache.org>
Sat, 30 Aug 2003 09:19:04 +0000 (09:19 +0000)
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353323 13f79535-47bb-0310-9956-ffa450edef68

src/documentation/content/xdocs/hpsf/how-to.xml
src/documentation/content/xdocs/hpsf/index.xml
src/documentation/content/xdocs/hpsf/internals.xml
src/documentation/content/xdocs/hpsf/todo.xml

index 57f880700ebd8cbe8f96cc7e5d8c1f50eab3d00e..03ade0a184712f553cc4458336942b0f7b9336a4 100644 (file)
@@ -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>
 
     <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>
 
 
index e5a34f7740467e678d53e8c5d103fa08c27066c5..4f21c1479e3225cb53546e38147ed1284d5659a3 100644 (file)
@@ -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="klute@apache.org"/>
@@ -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
index 0adabeaef3dca1f4f06aaba440ab00314b5c3e1e..1a42d680653f0c41c5328f58e19686b3af59300e 100644 (file)
@@ -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
index 3c3ca4e7f3be5e92e7391725e50162b9ce4e1145..d99e7ff5d5b1be6e6b39f533b04f86620c0c3ddf 100644 (file)
@@ -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>