- HPSF documentation added.

- Stylesheets modified to support table heads.
- Document DTD modified to support blocks in table cells and list items.
- hpsf/book.xml added to sitemap (whatever that might be good for).


git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352128 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute 2002-03-02 15:54:08 +00:00
parent 4360f6f2f8
commit 275f0310ef
13 changed files with 3899 additions and 40 deletions

View File

@ -140,7 +140,7 @@
<div align="right">
<table cellspacing="0" cellpadding="2" border="0" width="100%">
<tr>
<td bgcolor="#525D76"><font color="#ffffff" size="+1"><font face="Arial,sans-serif"><b> 1.1-dev (March 1 2002)</b></font></font></td>
<td bgcolor="#525D76"><font color="#ffffff" size="+1"><font face="Arial,sans-serif"><b> 1.1-dev (March 2 2002)</b></font></font></td>
</tr>
<tr>
<td>

View File

@ -25,12 +25,23 @@
<li>
<a href="../index.html"><font size="-1">Main</font></a>
</li>
</ul>
</font>
<br>
<font size="+1" color="#000000">HPSF</font><font size="-1">
<ul>
<li>
<a href="index.html"><font size="-1">Overview</font></a>
</li>
<li>
<a href="how-to.html"><font size="-1">How To</font></a>
</li>
<li>
<a href="internals.html"><font size="-1">Internals</font></a>
</li>
<li>
<a href="todo.html"><font size="-1">To Do</font></a>
</li>
</ul>
</font>
<br>

View File

@ -25,12 +25,23 @@
<li>
<a href="../index.html"><font size="-1">Main</font></a>
</li>
</ul>
</font>
<br>
<font size="+1" color="#000000">HPSF</font><font size="-1">
<ul>
<li>
<a href="index.html"><font size="-1">Overview</font></a>
</li>
<li>
<a href="how-to.html"><font size="-1">How To</font></a>
</li>
<li>
<a href="internals.html"><font size="-1">Internals</font></a>
</li>
<li>
<a href="todo.html"><font size="-1">To Do</font></a>
</li>
</ul>
</font>
<br>
@ -62,9 +73,27 @@
<tr>
<td>
<br>
<p align="justify">TODO: This documentation is still to be written.</p>
<p align="justify">Microsoft applications like "Word" or "Excel" offer the user to
describe his document by properties like "title", "category" and so
on. The application adds further information by itself: last
author, creation date etc. Internally these properties are stored in
so-called <em>property set streams</em>. A property set stream is a
separate document within a <a href="../poifs/index.html">POI
filesystem</a>. HPSF is POI's pure-Java implementation to read (and in
future to write) property set streams.</p>
<p align="justify">Once the <a href="how-to.html">HPSF HOWTO</a> is ready, it will
describe what a Java application should do to read a property set using
HPSF and retrieve the information it needs. Currently this is explained
in the javadocs of the <code>org.apache.poi.hpsf</code> package only.</p>
<p align="justify">HPSF supports OLE2 property set streams in general, not only the special
case of document properties mentioned above. The <a href="internals.html">HPSF description</a> describes the internal
structure of property set streams.</p>
</td>
</tr>
</table>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,133 @@
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>To Do</title>
</head>
<body bgcolor="#ffffff" marginheight="4" marginwidth="4" leftmargin="4" topmargin="4" alink="#023264" vlink="#023264" link="#525D76" text="#000000">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top"><a href="http://jakarta.apache.org/index.html"><img src="images/jakarta-logo.gif" border="0" vspace="0" hspace="0"></a></td><td bgcolor="#ffffff" align="left" valign="top" width="100%"><img src="images/header.gif" align="right" border="0" vspace="0" hspace="0"></td>
</tr>
<tr>
<td colspan="2" height="2" width="100%">
<hr size="1" noshade="">
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" width="1%"></td><td nowrap="1" valign="top" width="14%">
<br>
<font face="arial,helvetica,sanserif">
<br>
<font size="+1" color="#000000">Navigation</font><font size="-1">
<ul>
<li>
<a href="../index.html"><font size="-1">Main</font></a>
</li>
</ul>
</font>
<br>
<font size="+1" color="#000000">HPSF</font><font size="-1">
<ul>
<li>
<a href="index.html"><font size="-1">Overview</font></a>
</li>
<li>
<a href="how-to.html"><font size="-1">How To</font></a>
</li>
<li>
<a href="internals.html"><font size="-1">Internals</font></a>
</li>
<li>
<a href="todo.html"><font size="-1">To Do</font></a>
</li>
</ul>
</font>
<br>
<br>
</font></td><td align="left" valign="top" width="*">
<title>To Do</title>
<center>
<table width="80%">
<tr>
<td bgcolor="#F3DD61"><font face="Arial,sans-serif" size="+1">
<center>
<b>To Do</b>
</center>
</font></td>
</tr>
</table>
</center>
<font size="-2" color="#000000">
<p>
<a href="mailto:"></a>
</p>
</font>
<br>
<div align="right">
<table cellspacing="0" cellpadding="2" border="0" width="100%">
<tr>
<td bgcolor="#525D76"><font color="#ffffff" size="+1"><font face="Arial,sans-serif"><b>To Do</b></font></font></td>
</tr>
<tr>
<td>
<br>
<p align="justify">The following functionalities should be added to HPFS:</p>
<ol>
<li>
<p align="justify">Add writing capability for property sets.</p>
</li>
<li>
<p align="justify">Add codepage support.</p>
</li>
<li>
<p align="justify">Add Unicode support.</p>
</li>
<li>
<p align="justify">Add resource bundles to
<code>org.apache.poi.hpsf.wellknown</code> to ease
localizations.</p>
</li>
</ol>
</td>
</tr>
</table>
</div>
<br>
</td>
</tr>
</table>
<br>
<table cellpadding="0" cellspacing="0" border="0" width="100%">
<tr>
<td>
<hr size="1" noshade="">
</td>
</tr>
<tr>
<td align="center"><font color="#525D76" size="-1" face="arial,helvetica,sanserif"><i>
Copyright &copy;2002 Apache Software Foundation
</i></font></td><td width="5%" align="right"><img src="images/cocoon2-small.jpg" align="right" border="0" vspace="0" hspace="0"></td>
</tr>
</table>
</body>
</html>

View File

@ -112,6 +112,7 @@
<map:part src="cocoon:/doclist/xdocs/poifs/book.xml"/>
<map:part src="cocoon:/doclist/xdocs/hdf/book.xml"/>
<map:part src="cocoon:/doclist/xdocs/hssf/book.xml"/>
<map:part src="cocoon:/doclist/xdocs/hpsf/book.xml"/>
<map:part src="cocoon:/doclist/xdocs/utils/book.xml"/>
</map:aggregate>
<map:transform src="stylesheets/doclist2document.xsl"/>

View File

@ -424,6 +424,13 @@
<xsl:apply-templates/>
</xsl:template>
<xsl:template match="entry[@role='th']">
<td align="center" bgcolor="#006CB8" valign="top"
style="font-weight: bold">
<font color="#ffffff" size="-1"><xsl:apply-templates/></font>
</td>
</xsl:template>
<xsl:template match="entry">
<td align="left" bgcolor="#a0ddf0" valign="top">
<font color="#000000" size="-1"><xsl:apply-templates/></font>

View File

@ -144,11 +144,7 @@
<table>
<tgroup>
<xsl:attribute name="cols"><xsl:value-of select="count(tr/td)"/></xsl:attribute>
<xsl:if test="th">
<thead>
<xsl:apply-templates select="th"/>
</thead>
</xsl:if>
<xsl:apply-templates select="th"/>
<tbody>
<xsl:apply-templates select="tr"/>
</tbody>
@ -156,7 +152,13 @@
</table>
</xsl:template>
<xsl:template match="th|tr">
<xsl:template match="th">
<entry role="th">
<xsl:apply-templates/>
</entry>
</xsl:template>
<xsl:template match="tr">
<row>
<xsl:apply-templates/>
</row>
@ -174,4 +176,3 @@
</xsl:copy>
</xsl:template>
</xsl:stylesheet>

View File

@ -405,12 +405,12 @@ COPYRIGHT:
<!ATTLIST tr %common.att;>
<!-- The table row header element -->
<!ELEMENT th (%content.mix;)*>
<!ELEMENT th (%blocks;|%content.mix;)*>
<!ATTLIST th %common.att;
%cell.span;>
<!-- The table row description element -->
<!ELEMENT td (%content.mix;)*>
<!ELEMENT td (%blocks;|%content.mix;)*>
<!ATTLIST td %common.att;
%cell.span;>
@ -443,7 +443,7 @@ COPYRIGHT:
<!ATTLIST sl %common.att;>
<!-- List item -->
<!ELEMENT li (%content.mix;|%lists;)*>
<!ELEMENT li (%blocks;|%content.mix;)*>
<!ATTLIST li %common.att;>
<!-- Definition list (typically two-column) -->
@ -455,7 +455,7 @@ COPYRIGHT:
<!ATTLIST dt %common.att;>
<!-- Definition description -->
<!ELEMENT dd (%content.mix;)*>
<!ELEMENT dd (%blocks;|%content.mix;)*>
<!ATTLIST dd %common.att;>
<!-- ==================================================== -->

View File

@ -7,8 +7,12 @@
<menu label="Navigation">
<menu-item label="Main" href="../index.html"/>
</menu>
<menu label="HPSF">
<menu-item label="Overview" href="index.html"/>
<menu-item label="How To" href="how-to.html"/>
<menu-item label="Internals" href="internals.html"/>
<menu-item label="To Do" href="todo.html"/>
</menu>
</book>

View File

@ -1,16 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../dtd/document-v10.dtd">
<document>
<header>
<title>HPSF (Horrible Property Set Format)</title>
<subtitle>Overview</subtitle>
<authors>
<person name="Rainer Klute" email="klute@rainer-klute.de"/>
</authors>
</header>
<body>
<s1 title="Overview">
<p class="todo">TODO: This documentation is still to be written.</p>
</s1>
</body>
<header>
<title>HPSF (Horrible Property Set Format)</title>
<subtitle>Overview</subtitle>
<authors>
<person name="Rainer Klute" email="klute@rainer-klute.de"/>
</authors>
</header>
<body>
<s1 title="Overview">
<p>Microsoft applications like "Word" or "Excel" let the user describe his
document by properties like "title", "category" and so on. The application
itself adds further information: last author, creation date etc. These
properties are stored in so-called <strong>property set streams</strong>. A
property set stream is a separate document within a <link
href="../poifs/index.html">POI filesystem</link>. HPSF is POI's pure-Java
implementation to read (and in future to write) property set streams.</p>
<p>Once the <link href="how-to.html">HPSF HOWTO</link> is ready, it will
describe what a Java application should do to read a property set using
HPSF and retrieve the information it needs. Currently this is explained
in the javadocs of the <code>org.apache.poi.hpsf</code> package only.</p>
<p>HPSF supports OLE2 property set streams in general, not only the special
case of document properties mentioned above. The <link
href="internals.html">HPSF description</link> describes the internal
structure of property set streams.</p>
</s1>
</body>
</document>
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-omittag:nil
sgml-shorttag:nil
sgml-namecase-general:nil
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../dtd/document-v10.dtd">
<document>
<header>
<title>To Do</title>
<authors>
<person name="Rainer Klute" email="klute@rainer-klute.de"/>
</authors>
</header>
<body>
<s1 title="To Do">
<p>The following functionalities should be added to HPFS:</p>
<ol>
<li>
<p>Add writing capability for property sets.</p>
</li>
<li>
<p>Add codepage support.</p>
</li>
<li>
<p>Add Unicode support.</p>
</li>
<li>
<p>Add resource bundles to
<code>org.apache.poi.hpsf.wellknown</code> to ease
localizations.</p>
</li>
</ol>
</s1>
</body>
</document>
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-omittag:nil
sgml-shorttag:nil
sgml-namecase-general:nil
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->