diff options
| author | Nick Burch <nick@apache.org> | 2007-07-09 22:50:00 +0000 |
|---|---|---|
| committer | Nick Burch <nick@apache.org> | 2007-07-09 22:50:00 +0000 |
| commit | a21c4c4594a6844aaf5c8110bb3ce5ef594c4c7d (patch) | |
| tree | 6129c8177c3ab4812ee84632cb680f155eff1fda /src/documentation/content/xdocs/hsmf | |
| parent | dbc94048303ff999671f0a02966052e3321053a1 (diff) | |
| download | poi-a21c4c4594a6844aaf5c8110bb3ce5ef594c4c7d.tar.gz poi-a21c4c4594a6844aaf5c8110bb3ce5ef594c4c7d.zip | |
Add stub hsmf documentation
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@554782 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs/hsmf')
| -rw-r--r-- | src/documentation/content/xdocs/hsmf/book.xml | 34 | ||||
| -rwxr-xr-x | src/documentation/content/xdocs/hsmf/index.xml | 51 |
2 files changed, 85 insertions, 0 deletions
diff --git a/src/documentation/content/xdocs/hsmf/book.xml b/src/documentation/content/xdocs/hsmf/book.xml new file mode 100644 index 0000000000..a6cc4c761c --- /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 index 0000000000..3fef9530c4 --- /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> |