Examples

Date: Fri, 1 Jul 2011 11:43:06 +0000 Subject: [PATCH] misc fixes in site docs git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1141906 13f79535-47bb-0310-9956-ffa450edef68 --- .../content/xdocs/howtobuild.xml | 4 +-- .../content/xdocs/hpsf/how-to.xml | 4 +-- src/documentation/content/xdocs/overview.xml | 35 +++++++++++-------- src/documentation/content/xdocs/poi-ruby.xml | 2 +- .../content/xdocs/spreadsheet/limitations.xml | 2 +- .../content/xdocs/spreadsheet/quick-guide.xml | 4 +-- 6 files changed, 28 insertions(+), 23 deletions(-) diff --git a/src/documentation/content/xdocs/howtobuild.xml b/src/documentation/content/xdocs/howtobuild.xml index bce7552de3..ad2cd1cf87 100644 --- a/src/documentation/content/xdocs/howtobuild.xml +++ b/src/documentation/content/xdocs/howtobuild.xml @@ -91,11 +91,11 @@ compile - Compiles all files from main, contrib and scratchpad + Compiles all files from main, ooxml and scratchpad test - Run all unit tests from main, ooxml, contrib and scratchpad + Run all unit tests from main, ooxml and scratchpad jar diff --git a/src/documentation/content/xdocs/hpsf/how-to.xml b/src/documentation/content/xdocs/hpsf/how-to.xml index f7a5ad087e..520f9d0c03 100644 --- a/src/documentation/content/xdocs/hpsf/how-to.xml +++ b/src/documentation/content/xdocs/hpsf/how-to.xml @@ -352,8 +352,8 @@ else only difference is that they are not located in the POI filesystem's root but in a nested directory instead. Just register a POIFSReaderListener for the property set streams you are - interested in. For example, the POIBrowser application in the - contrib section tries to open each and every document in a POI filesystem + interested in. For example, the POIBrowser application + tries to open each and every document in a POI filesystem as a property set stream. If this operation was successful it displays the properties.

diff --git a/src/documentation/content/xdocs/overview.xml b/src/documentation/content/xdocs/overview.xml index d457d22488..02e105b470 100644 --- a/src/documentation/content/xdocs/overview.xml +++ b/src/documentation/content/xdocs/overview.xml @@ -282,33 +282,38 @@

Examples

- Small sample programs using the POI API are available in the + Small sample programs using the POI API are available in the src/examples directory of the source distribution. Before studying the source code you might want to have a look at the "Examples" section of the POI API - documentation. + documentation.

POI Browser +

+ The POI Browser is a very simple Swing GUI tool that displays the + internal structure of a Microsoft Office file and especially the + property set streams. Further information and instructions how to + execute it can be found in the POI + source code. +

- Also note that we now include all of the examples in the distribution. + All of the examples are inclided in POI distributions as a poi-examples artifact.

Contributed Software

- Besides the "official" components outlined above there is some further - software distributed with POI. This is called "contributed" software. It + Besides the "official" components outlined above there is some further + software distributed with POI. This is called "contributed" software. It is not explicitly recommended or even maintained by the POI team, but it might still be useful to you.

POI Browser -

- The POI Browser is a very simple Swing GUI tool that displays the - internal structure of a Microsoft Office file and especially the - property set streams. Further information and instructions how to - execute it can be found in the POI - Browser package description. -

+ See POI Ruby Bindings and other code in the + poi-contrib module +