You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2007/06/27 22:19:20 UTC
svn commit: r551309 - in /poi/trunk/src/documentation/content/xdocs:
book.xml changes.xml hdgf/ hdgf/book.xml hdgf/index.xml hslf/book.xml
hslf/index.xml hssf/how-to.xml hwpf/index.xml hwpf/quick-guide.xml
index.xml status.xml
Author: nick
Date: Wed Jun 27 13:19:18 2007
New Revision: 551309
URL: http://svn.apache.org/viewvc?view=rev&rev=551309
Log:
Several TLP tweaks and typo fixes in the documentation. Update the changelog for recent commits, and add some initial documentation on HDGF
Added:
poi/trunk/src/documentation/content/xdocs/hdgf/
poi/trunk/src/documentation/content/xdocs/hdgf/book.xml (with props)
poi/trunk/src/documentation/content/xdocs/hdgf/index.xml (with props)
Modified:
poi/trunk/src/documentation/content/xdocs/book.xml
poi/trunk/src/documentation/content/xdocs/changes.xml
poi/trunk/src/documentation/content/xdocs/hslf/book.xml
poi/trunk/src/documentation/content/xdocs/hslf/index.xml
poi/trunk/src/documentation/content/xdocs/hssf/how-to.xml
poi/trunk/src/documentation/content/xdocs/hwpf/index.xml
poi/trunk/src/documentation/content/xdocs/hwpf/quick-guide.xml
poi/trunk/src/documentation/content/xdocs/index.xml
poi/trunk/src/documentation/content/xdocs/status.xml
Modified: poi/trunk/src/documentation/content/xdocs/book.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/book.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/book.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/book.xml Wed Jun 27 13:19:18 2007
@@ -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="HDGF" href="hdgf/index.html"/>
<menu-item label="POI-Ruby" href="poi-ruby.html"/>
<menu-item label="POI-Utils" href="utils/index.html"/>
<menu-item label="Download" href="ext:download"/>
Modified: poi/trunk/src/documentation/content/xdocs/changes.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/changes.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/changes.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/changes.xml Wed Jun 27 13:19:18 2007
@@ -35,7 +35,7 @@
<person id="YK" name="Yegor Kozlov" email="yegor@apache.org"/>
</devs>
- <release version="3.0.1-FINAL" date="2007-06-15">
+ <release version="3.0.1-FINAL" date="2007-07-05">
<action dev="POI-DEVELOPERS" type="fix">Administrative updates to the Maven POMs, and the release artificat build process</action>
<action dev="POI-DEVELOPERS" type="fix">23951 - [PATCH] Fix for HSSF setSheetOrder and tab names</action>
<action dev="POI-DEVELOPERS" type="fix">42524 - [PATCH] Better HSLF support for problem shape groups</action>
@@ -44,6 +44,9 @@
<action dev="POI-DEVELOPERS" type="add">Additional HSLF support for Title and Slide Master Sheets</action>
<action dev="POI-DEVELOPERS" type="fix">42474 - [PATCH] Improved HSLF note to slide matching, and a NPE</action>
<action dev="POI-DEVELOPERS" type="fix">42481 - [PATCH] Tweak some HSLF exceptions, to make it clearer what you're catching</action>
+ <action dev="POI-DEVELOPERS" type="fix">42667 - [PATCH] Fix for HSLF writing of files with tables</action>
+ <action dev="POI-DEVELOPERS" type="add">Improved way of detecting HSSF cells that contain dates, isADateFormat</action>
+ <action dev="POI-DEVELOPERS" type="add">Initial, read-only support for Visio documents, as HDGF</action>
</release>
<release version="3.0-FINAL" date="2007-05-18">
Added: poi/trunk/src/documentation/content/xdocs/hdgf/book.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hdgf/book.xml?view=auto&rev=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hdgf/book.xml (added)
+++ poi/trunk/src/documentation/content/xdocs/hdgf/book.xml Wed Jun 27 13:19:18 2007
@@ -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="HGDF"
+ copyright="@year@ POI Project">
+
+ <menu label="Apache POI">
+ <menu-item label="Top" href="../index.html"/>
+ </menu>
+
+ <menu label="HDGF">
+ <menu-item label="Overview" href="index.html"/>
+ </menu>
+
+</book>
Propchange: poi/trunk/src/documentation/content/xdocs/hdgf/book.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: poi/trunk/src/documentation/content/xdocs/hdgf/index.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hdgf/index.xml?view=auto&rev=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hdgf/index.xml (added)
+++ poi/trunk/src/documentation/content/xdocs/hdgf/index.xml Wed Jun 27 13:19:18 2007
@@ -0,0 +1,98 @@
+<?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-HDGF - Java API To Access Microsoft Visio Format Files</title>
+ <subtitle>Overview</subtitle>
+ <authors>
+ <person name="Nick Burch" email="nick at apache dot org"/>
+ </authors>
+ </header>
+
+ <body>
+ <section>
+ <title>Overview</title>
+
+ <p>HDGF is the POI Project's pure Java implementation of the Visio file format.</p>
+ <p>Currently, HDGF provides a low-level, read-only api for
+ accessing Visio documents. It also provides a
+ <link href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/src/org/apache/poi/hdgf/extractor/">way</link>
+ to extract the textual content from a file.
+ </p>
+ <p>At this time, there is no <em>usermodel</em> api or similar,
+ only low level access to the streams, chunks and chunk commands.
+ Users are advised to check the unit tests to see how everything
+ works. They are also well advised to read the documentation
+ supplied with
+ <link href="http://www.gnome.ru/projects/vsdump_en.html">vsdump</link>
+ to get a feel for how Visio files are structured.</p>
+ <p>To get a feel for the contents of a file, and to track down
+ where data of interest is stored, HDGF comes with
+ <link href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/src/org/apache/poi/hdgf/dev/">VSDDumper</link>
+ to print out the contents of the file. Users should also make
+ use of
+ <link href="http://www.gnome.ru/projects/vsdump_en.html">vsdump</link>
+ to probe the structure of files.</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>
+ <title>Steps required for write support</title>
+ <p>Currently, HDGF is only able to read visio files, it is
+ not able to write them back out again. We believe the
+ following are the steps that would need to be taken to
+ implement it.</p>
+ <ol>
+ <li>Re-write the decompression support in LZW4HDGF to be
+ less opaque, and also under the ASL.</li>
+ <li>Add compression support to the new LZw4HDGF.</li>
+ <li>Have HDGF just write back the raw bytes it read in, and
+ have a test to ensure the file is un-changed.</li>
+ <li>Have HDGF generate the bytes to write out from the
+ Stream stores, using the compressed data as appropriate,
+ without re-compressing. Plus test to ensure file is
+ un-changed.</li>
+ <li>Have HDGF generate the bytes to write out from the
+ Stream stores, re-compressing any streams that were
+ decompressed. Plus test to ensure file is un-changed.</li>
+ <li>Have HDGF re-generate the offsets in pointers for the
+ locations of the streams. Plus test to ensure file is
+ un-changed.</li>
+ <li>Have HDGF re-generate the bytes for all the chunks, from
+ the chunk commands. Tests to ensure the chunks are
+ serialized properly, and then that the file is un-changed</li>
+ <li>Alter the data of one command, but keep it the same
+ length, and check visio can open the file when written
+ out.</li>
+ <li>Alter the data of one command, to a new length, and
+ check that visio can open the file when written out.</li>
+ </ol>
+ </section>
+ </section>
+ </body>
+</document>
Propchange: poi/trunk/src/documentation/content/xdocs/hdgf/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: poi/trunk/src/documentation/content/xdocs/hdgf/index.xml
------------------------------------------------------------------------------
svn:executable = *
Modified: poi/trunk/src/documentation/content/xdocs/hslf/book.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hslf/book.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hslf/book.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/hslf/book.xml Wed Jun 27 13:19:18 2007
@@ -20,7 +20,7 @@
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd">
<book software="POI Project"
- title="HSSF"
+ title="HSLF"
copyright="@year@ POI Project">
<menu label="Apache POI">
Modified: poi/trunk/src/documentation/content/xdocs/hslf/index.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hslf/index.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hslf/index.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/hslf/index.xml Wed Jun 27 13:19:18 2007
@@ -34,12 +34,12 @@
<title>Overview</title>
<p>HSLF is the POI Project's pure Java implementation of the Powerpoint file format.</p>
- <p>HSSF provides a way to read powerpoint presentations, and extract text from it.
+ <p>HSLF provides a way to read powerpoint presentations, and extract text from it.
It also provides some (currently limited) edit capabilities.
</p>
<note>
This code currently lives the
- <link href="http://svn.apache.org/viewcvs.cgi/jakarta/poi/trunk/src/scratchpad/">scratchpad area</link>
+ <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
Modified: poi/trunk/src/documentation/content/xdocs/hssf/how-to.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hssf/how-to.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hssf/how-to.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/hssf/how-to.xml Wed Jun 27 13:19:18 2007
@@ -460,7 +460,7 @@
<code>/src/scratchpad/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java</code>,
and may be called on the command line, or from within your own code.
The latest version is always available from
-<link href="http://svn.apache.org/repos/asf/jakarta/poi/trunk/src/scratchpad/examples/src/org/apache/poi/hssf/eventusermodel/examples/">subversion</link>.
+<link href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/examples/src/org/apache/poi/hssf/eventusermodel/examples/">subversion</link>.
</p>
<p>
<em>This code is currently in the scratchpad section, so you will either
Modified: poi/trunk/src/documentation/content/xdocs/hwpf/index.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hwpf/index.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hwpf/index.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/hwpf/index.xml Wed Jun 27 13:19:18 2007
@@ -38,7 +38,7 @@
to pure Java.</p>
<p>HWPF is still in early development. It is in the <link
- href="http://svn.apache.org/viewcvs.cgi/jakarta/poi/trunk/src/scratchpad/">
+ href="http://svn.apache.org/viewcvs.cgi/poi/trunk/src/scratchpad/">
scratchpad section of the SVN.</link> You will need to ensure you
either have a recent SVN checkout, or a recent SVN nightly build
(including the scratchpad jar!)</p>
Modified: poi/trunk/src/documentation/content/xdocs/hwpf/quick-guide.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/hwpf/quick-guide.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/hwpf/quick-guide.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/hwpf/quick-guide.xml Wed Jun 27 13:19:18 2007
@@ -30,7 +30,7 @@
<body>
<p>HWPF is still in early development. It is in the <link
- href="http://svn.apache.org/viewcvs.cgi/jakarta/poi/trunk/src/scratchpad/">
+ href="http://svn.apache.org/viewcvs.cgi/poi/trunk/src/scratchpad/">
scratchpad section of the SVN.</link> You will need to ensure you
either have a recent SVN checkout, or a recent SVN nightly build
(including the scratchpad jar!)</p>
@@ -68,7 +68,7 @@
<section><title>Further Examples</title>
<p>For now, the best source of additional examples is in the unit
tests. <link
- href="http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hwpf/">
+ href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/testcases/org/apache/poi/hwpf/">
Browse the HWPF unit tests.</link>
</p>
</section>
Modified: poi/trunk/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/index.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/index.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/index.xml Wed Jun 27 13:19:18 2007
@@ -38,6 +38,10 @@
<link href="http://www.apache.org/dyn/closer.cgi/poi/release/">download</link>
the source and binaries from your
<link href="http://www.apache.org/dyn/closer.cgi/poi/release/">local mirror</link>.</p>
+ <p>We would also like to confirm that verion 3.0 of Apache POI does
+ <em>not</em> contain any viruses. Users of broken virus checkers
+ which do detect a 94 byte file, sci_cec.db, as containing one are
+ advised to contact their vendor for a fix.</p>
</section>
<section><title>Purpose</title>
@@ -107,10 +111,17 @@
development. Jump in!</p>
</section>
<section><title>HSLF for PowerPoint Documents</title>
- <p>HWSL is our port of the Microsoft PowerPoint 97(-2003) file format to pure
+ <p>HSLF is our port of the Microsoft PowerPoint 97(-2003) file format to pure
Java. It supports read and write capabilities of some, but not yet all
of the core records. Please see <link
href="./hslf/index.html">the HSLF project page for more
+ information</link>.</p>
+ </section>
+ <section><title>HDGF for Visio Documents</title>
+ <p>HDGF is our port of the Microsoft Viso 97(-2003) file format to pure
+ Java. It currently only supports reading at a very low level, and
+ simple text extraction. Please see <link
+ href="./hdgf/index.html">the HDGF project page for more
information</link>.</p>
</section>
<section><title>HPSF for Document Properties</title>
Modified: poi/trunk/src/documentation/content/xdocs/status.xml
URL: http://svn.apache.org/viewvc/poi/trunk/src/documentation/content/xdocs/status.xml?view=diff&rev=551309&r1=551308&r2=551309
==============================================================================
--- poi/trunk/src/documentation/content/xdocs/status.xml (original)
+++ poi/trunk/src/documentation/content/xdocs/status.xml Wed Jun 27 13:19:18 2007
@@ -32,7 +32,7 @@
</developers>
<changes>
- <release version="3.0.1-FINAL" date="2007-06-15">
+ <release version="3.0.1-FINAL" date="2007-07-05">
<action dev="POI-DEVELOPERS" type="fix">Administrative updates to the Maven POMs, and the release artificat build process</action>
<action dev="POI-DEVELOPERS" type="fix">23951 - [PATCH] Fix for HSSF setSheetOrder and tab names</action>
<action dev="POI-DEVELOPERS" type="fix">42524 - [PATCH] Better HSLF support for problem shape groups</action>
@@ -41,6 +41,9 @@
<action dev="POI-DEVELOPERS" type="add">Additional HSLF support for Title and Slide Master Sheets</action>
<action dev="POI-DEVELOPERS" type="fix">42474 - [PATCH] Improved HSLF note to slide matching, and a NPE</action>
<action dev="POI-DEVELOPERS" type="fix">42481 - [PATCH] Tweak some HSLF exceptions, to make it clearer what you're catching</action>
+ <action dev="POI-DEVELOPERS" type="fix">42667 - [PATCH] Fix for HSLF writing of files with tables</action>
+ <action dev="POI-DEVELOPERS" type="add">Improved way of detecting HSSF cells that contain dates, isADateFormat</action>
+ <action dev="POI-DEVELOPERS" type="add">Initial, read-only support for Visio documents, as HDGF</action>
</release>
<release version="3.0-FINAL" date="2007-05-18">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org