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 2014/03/19 19:23:34 UTC
svn commit: r1579335 - in /poi/site/src/documentation/content/xdocs/hwpf:
book.xml index.xml
Author: nick
Date: Wed Mar 19 18:23:34 2014
New Revision: 1579335
URL: http://svn.apache.org/r1579335
Log:
H/X WPF docs update - mention more about XWPF, and link to other resources
Modified:
poi/site/src/documentation/content/xdocs/hwpf/book.xml
poi/site/src/documentation/content/xdocs/hwpf/index.xml
Modified: poi/site/src/documentation/content/xdocs/hwpf/book.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/hwpf/book.xml?rev=1579335&r1=1579334&r2=1579335&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/hwpf/book.xml (original)
+++ poi/site/src/documentation/content/xdocs/hwpf/book.xml Wed Mar 19 18:23:34 2014
@@ -18,11 +18,11 @@
====================================================================
-->
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd">
-<book software="POI Project" title="HWPF" copyright="@year@ POI Project">
+<book software="POI Project" title="HWPF+XWPF" copyright="@year@ POI Project">
<menu label="Apache POI">
<menu-item label="Top" href="../index.html"/>
</menu>
- <menu label="HWPF">
+ <menu label="HWPF+XWPF">
<menu-item label="Overview" href="index.html"/>
<menu-item label="Quick Guide" href="quick-guide.html"/>
<menu-item label="HWPF Format" href="docoverview.html"/>
Modified: poi/site/src/documentation/content/xdocs/hwpf/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/hwpf/index.xml?rev=1579335&r1=1579334&r2=1579335&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/hwpf/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/hwpf/index.xml Wed Mar 19 18:23:34 2014
@@ -21,7 +21,7 @@
<document>
<header>
- <title>Apache POI - HWPF - Java API to Handle Microsoft Word Files</title>
+ <title>Apache POI - HWPF and XWPF - Java API to Handle Microsoft Word Files</title>
<subtitle>Overview</subtitle>
<authors>
<person name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/>
@@ -42,12 +42,21 @@
Whilst HWPF and XWPF provide similar features, there is not a common
interface across the two of them at this time.</p>
- <p>HWPF is still in early development. It is in the <link
- 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>
+ <p>Both HWPF and XWPF could be described as "moderately functional". For some
+ use cases, especially around text extraction, support is very strong. For
+ others, support may be limited or incomplete, and it may be necessary to
+ dig down into low-level code. Error checking may be missing in places,
+ so it may be possible to accidently generate invalid files. Enhancements
+ to fix such things are generally very well received!</p>
+
+ <p>As detailed in the <link href="/overview.html#components">Components
+ Page</link>, HWPF is contained within the Scratchpad jar, while XWPF
+ is in the OOXML jar. You will need to ensure you include the appropriate
+ jars (and their dependencies!) in your classpath to use HWPF or XWPF.</p>
+ </section>
+ <section>
+ <title>An overview of the code</title>
<p>
Source code in the
<em>org.apache.poi.hdf</em>
@@ -82,7 +91,32 @@
and WordDocument) in later versions.
</p>
- <p>Word document can be considered as very long single text buffer. HWPF API provides "pointers"
+ <p>
+ The main entry point to XWPF is XWPFDocument. From there, you can get the
+ paragraphs, pictures, tables, sections, headers etc.
+ </p>
+ <p>
+ Currently, there are only a handful of example programs using HWPF and XWPF
+ available. They can be found in svn in the examples section, under
+ <link href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hwpf">HWPF</link>
+ and
+ <link href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/xwpf">XWPF</link>.
+ Both HWPF and XWPF have fairly high levels of unit test coverage, which
+ provides examples of using the various areas of functionality of both
+ modules. These can be found in svn, under
+ <link href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/testcases/org/apache/poi/hwpf">HWPF</link>
+ and
+ <link href="http://svn.apache.org/repos/asf/poi/trunk/src/ooxml/testcases/org/apache/poi/xwpf">XWPF</link>.
+ Contributions of more examples, whether inspired by the unit tests or
+ not, would be most welcomed!
+ </p>
+
+ </section>
+ <section>
+ <title>HWPF Notes</title>
+
+ <p>A .doc Word document, as handled by HWPF, can be considered as very long single
+ text buffer. The HWPF API provides "pointers"
to document parts, like sections, paragraphs and character runs. Usually user will iterates
over main document part sections, paragraphs from sections and character runs from
paragraph. Each such interface is a pointer to document text subrange along with additional
@@ -120,7 +154,7 @@
</section>
<section>
- <title>HWPF Pointman Needed!</title>
+ <title>HWPF Patches Required!</title>
<p>At the moment we unfortunately do not have someone taking care for HWPF
and fostering its development. What we need is someone to stand up, take
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org