moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Small documentation updates for HPSF writing capabilities.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353323 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute 2003-08-30 09:19:04 +00:00
parent 75e9b60135
commit 8e2ec11a70
4 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/documentation/content/xdocs/hpsf/how-to.xml
View File

@ -13,7 +13,7 @@
<body> <body>
<section><title>How To Use the HPSF APIs</title> <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> sequentially because the later sections build upon the earlier ones.</p>
<ol> <ol>
@ -34,9 +34,18 @@
<li> <li>
The <link href="#sec3">third section</link> tells how to read The <link href="#sec3">third section</link> tells how to read
non-standard properties. Non-standard properties are application-specific non-standard properties. Non-standard properties are application-specific
triples consisting of an ID, a type, and a value. triples consisting of an ID, a type, and a value.
</li> </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> </ol>

5
src/documentation/content/xdocs/hpsf/index.xml
View File

@ -4,7 +4,7 @@
<document> <document>
<header> <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> <subtitle>Overview</subtitle>
<authors> <authors>
<person name="Rainer Klute" email="klute@apache.org"/> <person name="Rainer Klute" email="klute@apache.org"/>
@ -12,6 +12,7 @@
</header> </header>
<body> <body>
<section><title>Overview</title> <section><title>Overview</title>
<p>Microsoft applications like "Word", "Excel" or "Powerpoint" let the user <p>Microsoft applications like "Word", "Excel" or "Powerpoint" let the user
describe his document by properties like "title", "category" and so on. The describe his document by properties like "title", "category" and so on. The
application itself adds further information: last author, creation date 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 streams</strong>. A property set stream is a separate document within a
<link href="../poifs/index.html">POI filesystem</link>. We'll call property <link href="../poifs/index.html">POI filesystem</link>. We'll call property
set streams mostly just "property sets". HPSF is POI's pure-Java 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 <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 application should do to read a property set using HPSF and to retrieve the

2
src/documentation/content/xdocs/hpsf/internals.xml
View File

@ -32,7 +32,7 @@
<strong>property set stream</strong>.</p> <strong>property set stream</strong>.</p>
<p>This document describes the internal structure of a property set stream, <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 not describe how a Microsoft Office document is organized internally and
how to retrieve a stream from it. See the <link how to retrieve a stream from it. See the <link
href="../poifs/index.html">POIFS documentation</link> for that kind of href="../poifs/index.html">POIFS documentation</link> for that kind of

8
src/documentation/content/xdocs/hpsf/todo.xml
View File

@ -16,8 +16,9 @@
<ol> <ol>
<li> <li>
Add writing capability for property sets. Presently property sets can Improve writing support! We need convenience classes and methods for
be read only. easily writing summary information streams and document summary
information streams.
</li> </li>
<li> <li>
Add codepage support: Presently the bytes making out the string in a Add codepage support: Presently the bytes making out the string in a
@ -38,8 +39,7 @@
</li> </li>
<li> <li>
Add WMF to <code>java.awt.Image</code> example code in <link Add WMF to <code>java.awt.Image</code> example code in <link
href="thumbnails.html">Thumbnail href="thumbnails.html">Thumbnail HOW TO</link>.
HOW TO</link>.
</li> </li>
</ol> </ol>
</section> </section>