aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/components/hpsf/index.xml
blob: 88c4f306c57d2dd70fedccee2dff1b072a05a59b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?xml version="1.0" encoding="UTF-8"?>
<!--
   ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
   ====================================================================
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

<document>
 <header>
  <title>Apache POI™ - HPSF - Java API for Microsoft Format Document
   Properties</title>
  <subtitle>Overview</subtitle>
  <authors>
   <person name="Rainer Klute" email="klute@apache.org"/>
  </authors>
 </header>
 <body>
  <section><title>Overview</title>

   <p>Microsoft applications like "Word", "Excel" or "Powerpoint" let the user
    describe a document by properties like "title", "category" and so on. The
    application itself adds further information: last author, creation date
    etc. These document properties are stored in <strong>property set
     streams</strong>. 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 write property sets.</p>

   <p>The <a href="how-to.html">HPSF HOWTO</a> describes what a Java
    application should do to read a property set using HPSF, how to retrieve
    the information it needs, and how to write properties into the
    document.</p>

   <p>HPSF supports OLE2 property set streams in general, and is not limited to
    the special case of document properties in the Microsoft Office files
    mentioned above. The <a href="internals.html">HPSF description</a>
    describes the internal structure of property set streams. A separate
    document explains the internal of <a href="thumbnails.html">thumbnail
     images</a>.</p>
  </section>
 </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:
-->