src/documentation/content/xdocs/overview.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    ====================================================================
   4    Licensed to the Apache Software Foundation (ASF) under one or more
   5    contributor license agreements.  See the NOTICE file distributed with
   6    this work for additional information regarding copyright ownership.
   7    The ASF licenses this file to You under the Apache License, Version 2.0
   8    (the "License"); you may not use this file except in compliance with
   9    the License.  You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18    ====================================================================
  19 -->
  20 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "./dtd/document-v13.dtd">
  21
  22 <document>
  23   <header>
  24     <title>Overview</title>
  25     <authors>
  26       <person id="AO" name="Andrew C. Oliver" email="acoliver@apache.org"/>
  27       <person id="RK" name="Rainer Klute" email="klute@apache.org"/>
  28     </authors>
  29   </header>
  30
  31   <body>
  32     <section><title>What is it?</title>
  33       <p>The POI project is the master project for developing pure
  34         Java ports of file formats based on Microsoft's OLE 2 Compound
  35         Document Format.  OLE 2 Compound Document Format is used by
  36         Microsoft Office Documents, as well as by programs using MFC
  37         property sets to serialize their document objects.
  38       </p>
  39     </section>
  40     <section><title>Sub-Projects</title>
  41       <p>
  42         There following are ports, packages or components contained in the POI project.
  43       </p>
  44       <section><title>POIFS</title>
  45         <p>
  46           <link href="poifs/index.html">POIFS</link> is the set of APIs
  47           for reading and writing OLE 2 Compound Document Formats using (only) Java.
  48         </p>
  49       </section>
  50
  51       <section><title>HSSF</title>
  52         <p>
  53           <link href="hssf/index.html">HSSF</link> is the set of APIs
  54            for reading and writing Microsoft Excel 97(-XP) spreadsheets using (only) Java.
  55         </p>
  56       </section>
  57
  58       <section><title>HWPF</title>
  59         <p>
  60           <link href="hwpf/index.html">HWPF</link>  is the set of APIs
  61           for reading and writing Microsoft Word 97(-XP) documents using (only) Java.
  62         </p>
  63       </section>
  64
  65       <section><title>HSLF</title>
  66         <p>
  67           <link href="hslf/index.html">HSLF</link>  is the set of APIs
  68           for reading and writing Microsoft PowerPoint 97(-XP) documents using (only) Java.
  69         </p>
  70       </section>
  71
  72       <section><title>HPSF</title>
  73         <p>
  74           <link href="hpsf/index.html">HPSF</link> is the set of APIs
  75           for reading property sets using (only) Java.
  76         </p>
  77       </section>
  78
  79       <section><title>POI-Utils</title>
  80         <p>
  81           <link href="utils/index.html">POI-Utils</link> are general purpose artifacts
  82           from POI development that have not yet been implemented elsewhere.  We're
  83           always looking to donate these and maintain them as part of a general library
  84           used in another project.  These are things we need to complete our mission but
  85           are generally outside of it.
  86         </p>
  87       </section>
  88     </section>
  89
  90     <section>
  91       <title>Examples</title>
  92
  93       <p>Small sample programs using the POI API are available in the
  94         <em>src/examples</em> directory of the source distribution. Before
  95         studying the source code you might want to have a look at the
  96         "Examples" section of the <link
  97           href="apidocs/overview-summary.html">POI API
  98           documentation</link>.</p>
  99     </section>
 100
 101     <section><title>Contributed Software</title>
 102       <p>Besides the "official" components outlined above there is some further
 103       software distributed with POI. This is called "contributed" software. It
 104         is not explicitly recommended or even maintained by the POI team, but
 105         it might still be useful to you.</p>
 106
 107       <section>
 108         <title>POI Browser</title>
 109         <p>The POI Browser is a very simple Swing GUI tool that displays the
 110           internal structure of a Microsoft Office file and especially the
 111           property set streams. Further information and  instructions how to
 112           execute it can be found in the <link
 113             href="apidocs/org/apache/poi/contrib/poibrowser/package-summary.html#package_description">POI
 114             Browser package description</link>.</p>
 115       </section>
 116     </section>
 117   </body>
 118   <footer>
 119     <legal>
 120       Copyright 2007 The Apache Software Foundation or its licensors, as applicable.
 121       $Revision$ $Date$
 122     </legal>
 123   </footer>
 124 </document>