Add stub hsmf documentation

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@554782 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml
index a0f10c0dbed07990474904a0589dca73d0d6b32a..36c50e6fe9cbe064b6f90c48ac4b421ddbc9b07e 100644 (file)
--- a/src/documentation/content/xdocs/book.xml
+++ b/src/documentation/content/xdocs/book.xml
@@ -39,6 +39,7 @@
         <menu-item label="HWPF" href="hwpf/index.html"/>
         <menu-item label="HPSF" href="hpsf/index.html"/>
         <menu-item label="HSLF" href="hslf/index.html"/>
+        <menu-item label="HSMF" href="hsmf/index.html"/>
         <menu-item label="HDGF" href="hdgf/index.html"/>
                <menu-item label="POI-Ruby" href="poi-ruby.html"/>
         <menu-item label="POI-Utils" href="utils/index.html"/>

diff --git a/src/documentation/content/xdocs/hsmf/book.xml b/src/documentation/content/xdocs/hsmf/book.xml
new file mode 100644 (file)
index 0000000..a6cc4c7
--- /dev/null
+++ b/src/documentation/content/xdocs/hsmf/book.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+   ====================================================================
+   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 book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd">
+
+<book software="POI Project"
+    title="HSMF"
+    copyright="@year@ POI Project">
+
+    <menu label="Apache POI">
+        <menu-item label="Top" href="../index.html"/>
+    </menu>
+
+    <menu label="HSMF">
+        <menu-item label="Overview" href="index.html"/>
+       </menu>
+       
+</book>

diff --git a/src/documentation/content/xdocs/hsmf/index.xml b/src/documentation/content/xdocs/hsmf/index.xml
new file mode 100755 (executable)
index 0000000..3fef953
--- /dev/null
+++ b/src/documentation/content/xdocs/hsmf/index.xml
@@ -0,0 +1,51 @@
+<?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>POI-HSMF - Java API To Access Microsoft Outlook MSG Files</title>
+        <subtitle>Overview</subtitle>
+        <authors>
+            <person name="Nick Burch" email="nick at apache dot org"/>
+            <person name="Travis Ferguson" email="uniformstupidity at gmail dot com"/>
+        </authors>
+    </header>
+
+    <body>
+        <section>
+            <title>Overview</title>
+
+            <p>HSMF is the POI Project's pure Java implementation of the Outlook MSG format.</p>
+                       <p>At this time, it provides simple read access to some of the
+                          textual content of MSG files. Further support and documentation
+                          is expected over the comming weeks and months. For now, users
+                          are advised to consult the unit tests for example use.</p>
+            <note> 
+                This code currently lives the 
+                <link href="http://svn.apache.org/viewcvs.cgi/poi/trunk/src/scratchpad/">scratchpad area</link> 
+                of the POI SVN repository. 
+                               Ensure that you have the scratchpad jar or the scratchpad 
+                build area in your
+                               classpath before experimenting with this code.
+                       </note>
+        </section>
+    </body>
+</document>