POI-HDGF - Java API To Access Microsoft Visio Format Files

diff --git a/src/documentation/content/xdocs/hdgf/book.xml b/src/documentation/content/xdocs/hdgf/book.xml new file mode 100644 index 0000000000..fb37a33a75 --- /dev/null +++ b/src/documentation/content/xdocs/hdgf/book.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + diff --git a/src/documentation/content/xdocs/hdgf/index.xml b/src/documentation/content/xdocs/hdgf/index.xml new file mode 100755 index 0000000000..f14bb1e766 --- /dev/null +++ b/src/documentation/content/xdocs/hdgf/index.xml @@ -0,0 +1,98 @@ + + + + + +

+ POI-HDGF - Java API To Access Microsoft Visio Format Files + Overview + + + +

+ + +

+ Overview + +

HDGF is the POI Project's pure Java implementation of the Visio file format.

Currently, HDGF provides a low-level, read-only api for + accessing Visio documents. It also provides a + way + to extract the textual content from a file. +

At this time, there is no usermodel 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 + vsdump + to get a feel for how Visio files are structured.

To get a feel for the contents of a file, and to track down + where data of interest is stored, HDGF comes with + VSDDumper + to print out the contents of the file. Users should also make + use of + vsdump + to probe the structure of files.

+ + This code currently lives the + scratchpad area + 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. + + +

+ Steps required for write support +

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.

Re-write the decompression support in LZW4HDGF to be + less opaque, and also under the ASL.
Add compression support to the new LZw4HDGF.
Have HDGF just write back the raw bytes it read in, and + have a test to ensure the file is un-changed.
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.
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.
Have HDGF re-generate the offsets in pointers for the + locations of the streams. Plus test to ensure file is + un-changed.
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
Alter the data of one command, but keep it the same + length, and check visio can open the file when written + out.
Alter the data of one command, to a new length, and + check that visio can open the file when written out.

+ + diff --git a/src/documentation/content/xdocs/hslf/book.xml b/src/documentation/content/xdocs/hslf/book.xml index 0eb4f8cb18..8ccf5c1bc4 100644 --- a/src/documentation/content/xdocs/hslf/book.xml +++ b/src/documentation/content/xdocs/hslf/book.xml @@ -20,7 +20,7 @@ diff --git a/src/documentation/content/xdocs/hslf/index.xml b/src/documentation/content/xdocs/hslf/index.xml index 779a279d16..16a3885d82 100755 --- a/src/documentation/content/xdocs/hslf/index.xml +++ b/src/documentation/content/xdocs/hslf/index.xml @@ -34,12 +34,12 @@ Overview

HSLF is the POI Project's pure Java implementation of the Powerpoint file format.

HSSF provides a way to read powerpoint presentations, and extract text from it. +

HSLF provides a way to read powerpoint presentations, and extract text from it. It also provides some (currently limited) edit capabilities.

This code currently lives the - scratchpad area + scratchpad area of the POI SVN repository. Ensure that you have the scratchpad jar or the scratchpad build area in your diff --git a/src/documentation/content/xdocs/hssf/how-to.xml b/src/documentation/content/xdocs/hssf/how-to.xml index cc578afec5..a4ac41209d 100644 --- a/src/documentation/content/xdocs/hssf/how-to.xml +++ b/src/documentation/content/xdocs/hssf/how-to.xml @@ -460,7 +460,7 @@ some of the rows or cells. It can be found at /src/scratchpad/examples/src/org/apache/poi/hssf/eventusermodel/examples/XLS2CSVmra.java, and may be called on the command line, or from within your own code. The latest version is always available from -subversion. +subversion.

This code is currently in the scratchpad section, so you will either diff --git a/src/documentation/content/xdocs/hwpf/index.xml b/src/documentation/content/xdocs/hwpf/index.xml index 1268facbee..1556869617 100644 --- a/src/documentation/content/xdocs/hwpf/index.xml +++ b/src/documentation/content/xdocs/hwpf/index.xml @@ -38,7 +38,7 @@ to pure Java.

HWPF is still in early development. It is in the + href="http://svn.apache.org/viewcvs.cgi/poi/trunk/src/scratchpad/"> scratchpad section of the SVN. You will need to ensure you either have a recent SVN checkout, or a recent SVN nightly build (including the scratchpad jar!)
diff --git a/src/documentation/content/xdocs/hwpf/quick-guide.xml b/src/documentation/content/xdocs/hwpf/quick-guide.xml index 197922f07e..bf046258e7 100644 --- a/src/documentation/content/xdocs/hwpf/quick-guide.xml +++ b/src/documentation/content/xdocs/hwpf/quick-guide.xml @@ -30,7 +30,7 @@
HWPF is still in early development. It is in the + href="http://svn.apache.org/viewcvs.cgi/poi/trunk/src/scratchpad/"> scratchpad section of the SVN. You will need to ensure you either have a recent SVN checkout, or a recent SVN nightly build (including the scratchpad jar!)
@@ -68,7 +68,7 @@ can then get text and other properties.
Further Examples
For now, the best source of additional examples is in the unit tests. + href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/testcases/org/apache/poi/hwpf/"> Browse the HWPF unit tests.

diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index da2d5ed3a8..5968f8084a 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -38,6 +38,10 @@ download the source and binaries from your local mirror.
+
We would also like to confirm that verion 3.0 of Apache POI does + not 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.

Purpose @@ -107,12 +111,19 @@ development. Jump in!

HSLF for PowerPoint Documents -
HWSL is our port of the Microsoft PowerPoint 97(-2003) file format to pure +
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 the HSLF project page for more information.

+
HDGF for Visio Documents +
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 the HDGF project page for more + information.
+

HPSF for Document Properties
HPSF is our port of the OLE 2 property set format to pure Java. Property sets are mostly use to store a document's properties diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index ef5c5aaeb4..b236f22880 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -32,7 +32,7 @@ - + Administrative updates to the Maven POMs, and the release artificat build process 23951 - [PATCH] Fix for HSSF setSheetOrder and tab names 42524 - [PATCH] Better HSLF support for problem shape groups @@ -41,6 +41,9 @@ Additional HSLF support for Title and Slide Master Sheets 42474 - [PATCH] Improved HSLF note to slide matching, and a NPE 42481 - [PATCH] Tweak some HSLF exceptions, to make it clearer what you're catching + 42667 - [PATCH] Fix for HSLF writing of files with tables + Improved way of detecting HSSF cells that contain dates, isADateFormat + Initial, read-only support for Visio documents, as HDGF -- 2.39.5