aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/overview.xml
blob: 1f0eaeb74d2267804d4d2e951307b5af71df90de (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?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 V1.1//EN" "./dtd/document-v11.dtd">

<document>
  <header>
    <title>Overview</title>
    <authors>
      <person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/>
      <person id="RK" name="Rainer Klute" email="klute@apache.org"/>
    </authors>
  </header>
  
  <body>
    <section><title>What is it?</title>
      <p>The POI project is the master project for developing pure
        Java ports of file formats based on Microsoft's OLE 2 Compound
        Document Format.  OLE 2 Compound Document Format is used by
        Microsoft Office Documents, as well as by programs using MFC
        property sets to serialize their document objects.
      </p>
    </section>
    <section><title>Sub-Projects</title>
      <p>
        There following are ports, packages or components contained in the POI project.
      </p>
      <section><title>POIFS</title>
        <p>
          <link href="poifs/index.html">POIFS</link> is the set of APIs 
          for reading and writing OLE 2 Compound Document Formats using (only) Java.
        </p> 
      </section>
      
      <section><title>HSSF</title>
        <p>
          <link href="hssf/index.html">HSSF</link> is the set of APIs 
           for reading and writing Microsoft Excel 97(-XP) spreadsheets using (only) Java.
        </p>
      </section>

      <section><title>HWPF</title>
        <p>
          <link href="hwpf/index.html">HWPF</link>  is the set of APIs                   
          for reading and writing Microsoft Word 97(-XP) documents using (only) Java.
        </p>
      </section>

      <section><title>HSLF</title>
        <p>
          <link href="slideshow/index.html">HSLF</link>  is the set of APIs                   
          for reading and writing Microsoft PowerPoint 97(-XP) documents using (only) Java.
        </p>
      </section>

      <section><title>HPSF</title>
        <p>
          <link href="hpsf/index.html">HPSF</link> is the set of APIs 
          for reading property sets using (only) Java.
        </p> 
      </section>

      <section><title>POI-Utils</title>
        <p>
          <link href="utils/index.html">POI-Utils</link> are general purpose artifacts
          from POI development that have not yet been implemented elsewhere.  We're 
          always looking to donate these and maintain them as part of a general library
          used in another project.  These are things we need to complete our mission but
          are generally outside of it.  
        </p>
      </section>
    </section>

    <section>
      <title>Examples</title>

      <p>Small sample programs using the POI API are available in the
        <em>src/examples</em> directory of the source distribution. Before
        studying the source code you might want to have a look at the
        "Examples" section of the <link
          href="apidocs/overview-summary.html">POI API
          documentation</link>.</p> 
    </section>

    <section><title>Contributed Software</title>
      <p>Besides the "official" components outlined above there is some further
      software distributed with POI. This is called "contributed" software. It
        is not explicitly recommended or even maintained by the POI team, but
        it might still be useful to you.</p>

      <section>
        <title>POI Browser</title>
        <p>The POI Browser is a very simple Swing GUI tool that displays the
          internal structure of a Microsoft Office file and especially the
          property set streams. Further information and  instructions how to
          execute it can be found in the <link
            href="apidocs/org/apache/poi/contrib/poibrowser/package-summary.html#package_description">POI
            Browser package description</link>.</p>
      </section>
    </section>
  </body>
  <footer>
    <legal>
      Copyright 2007 The Apache Software Foundation or its licensors, as applicable.
      $Revision$ $Date$
    </legal>
  </footer>
</document>