Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation changes 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@833281 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dave Fisher 2009-11-06 02:29:17 +00:00
parent 00ac16d6e3
commit 58c3be8334
4 changed files with 34 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
src/documentation/content/xdocs/book.xml
View File

@ -28,35 +28,8 @@
<menu-item label="Home" href="index.html"/>
<menu-item label="Download" href="download.html"/>
<menu-item label="FAQ" href="faq.html"/>
<menu-item label="History and Future" href="historyandfuture.html"/>
</menu>
<menu label="Modules">
<menu-item label="Overview" href="overview.html"/>
<menu-item label="POIFS" href="poifs/index.html"/>
<menu-item label="HSSF+XSSF" href="spreadsheet/index.html"/>
<menu-item label="HWPF" href="hwpf/index.html"/>
<menu-item label="HPSF" href="hpsf/index.html"/>
<menu-item label="HSLF" href="slideshow/index.html"/>
<menu-item label="HSMF" href="hsmf/index.html"/>
<menu-item label="HDGF" href="hdgf/index.html"/>
<menu-item label="HPBF" href="hpbf/index.html"/>
<menu-item label="OpenXML4J" href="oxml4j/index.html"/>
<menu-item label="POI-Ruby" href="poi-ruby.html"/>
<menu-item label="Text Extraction" href="text-extraction.html"/>
</menu>
<menu label="Documentation">
<menu-item label="Javadocs" href="ext:javadoc"/>
<menu-item label="Legal" href="legal.html"/>
<!--
<menu-item label="To Do" href="todo.html"/>
<menu-item label="Vision" href="plan/POI20Vision.html"/>
-->
</menu>
<menu label="Development">
<menu-item label="Changes" href="changes.html"/>
<menu-item label="Javadocs" href="ext:javadoc"/>
<menu-item label="Source Repository" href="subversion.html"/>
<menu-item label="Mailing Lists" href="mailinglists.html"/>
<menu-item label="Bug Database" href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI"/>
@ -64,6 +37,21 @@
<menu-item label="Resolutions" href="resolutions/index.html"/>
<menu-item label="Get Involved" href="getinvolved/index.html"/>
<menu-item label="Who We Are" href="who.html"/>
<menu-item label="Legal" href="legal.html"/>
</menu>
<menu label="Modules">
<menu-item label="Overview" href="overview.html"/>
<menu-item label="Text Extraction" href="text-extraction.html"/>
<menu-item label="Excel (SS=HSSF+XSSF)" href="spreadsheet/index.html"/>
<menu-item label="Word (HWPF+XWPF)" href="hwpf/index.html"/>
<menu-item label="PowerPoint (HSLF+XSLF)" href="slideshow/index.html"/>
<menu-item label="OLE2 Filesystem (POIFS)" href="poifs/index.html"/>
<menu-item label="OLE2 Properties (HPSF)" href="hpsf/index.html"/>
<menu-item label="OpenXML4J" href="oxml4j/index.html"/>
<menu-item label="Outlook (HSMF)" href="hsmf/index.html"/>
<menu-item label="Visio (HDGF)" href="hdgf/index.html"/>
<menu-item label="Publisher (HPBF)" href="hpbf/index.html"/>
</menu>
<menu label="Misc">
@ -71,6 +59,7 @@
<menu-item label="References" href="references/index.html"/>
<menu-item label="POI in the News" href="news.html"/>
<menu-item label="Sponsors" href="http://www.apache.org/foundation/thanks.html" />
<menu-item label="History and Future" href="historyandfuture.html"/>
</menu>
</book>

11
src/documentation/content/xdocs/download.xml
View File

@ -33,7 +33,7 @@
</p>
<ul>
<li>Latest stable release: <link href="download.html#POI-3.5-FINAL">Apache POI 3.5</link></li>
<li><link href="download.html#archive">Release Archive</link></li>
<li><link href="http://archive.apache.org/dist/poi/">Release Archive</link></li>
</ul>
<p>
Apache POI releases are available under the <link href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</link>
@ -81,15 +81,6 @@
</ul>
</section>
</section>
<section><title>Release Archive</title>
<anchor id="archive"/>
<p>
Only current recommended releases are available on the main distribution site and its mirrors.
Older releases are available from the
<link href="http://archive.apache.org/dist/poi/">archive</link>
download site.
</p>
</section>
<section><title>Verify</title>
<anchor id="verify"/>
<p>

87
src/documentation/content/xdocs/faq.xml
View File

@ -22,13 +22,13 @@
<faqs title="Frequently Asked Questions">
<faq>
<question>
My code uses some new HSSF feature, compiles fine but fails when live with a "MethodNotFoundException"
My code uses some new feature, compiles fine but fails when live with a "MethodNotFoundException"
</question>
<answer>
<p>You almost certainly have an older version of POI earlier
<p>You almost certainly have an older version of POI
on your classpath. Quite a few runtimes and other packages
will ship an older version of POI, so this is an easy problem
to hit without realising.</p>
to hit without your realising.</p>
<p>The best way to identify the offending earlier jar file is
with a few lines of java. These will load one of the core POI
classes, and report where it came from.</p>
@ -46,8 +46,7 @@ System.out.println("Core POI came from " + path);
</question>
<answer>
<p>You almost certainly have an older version earlier on your
classpath. See the answer to the similar question above for
how to track this down.</p>
classpath. See the prior answer.</p>
</answer>
</faq>
<faq>
@ -56,7 +55,7 @@ System.out.println("Core POI came from " + path);
</question>
<answer>
<p>You've probably enabled logging. Logging is intended only for
autopsie style debugging. Having it enabled will reduce performance
autopsy style debugging. Having it enabled will reduce performance
by a factor of at least 100. Logging is helpful for understanding
why POI can't read some file or developing POI itself. Important
errors are thrown as exceptions, which means you probably don't need
@ -68,10 +67,10 @@ System.out.println("Core POI came from " + path);
What is the HSSF "eventmodel"?
</question>
<answer>
<p>The HSSF eventmodel package is a new API for reading XLS files more efficiently. It does
<p>The SS eventmodel package is an API for reading Excel files without loading the whole spreadsheet into memory. It does
require more knowledge on the part of the user, but reduces memory consumption by more than
tenfold. It is based on the AWT event model in combination with SAX. If you need read-only
access to a given XLS file, this is the best way to do it.</p>
access, this is the best way to do it.</p>
</answer>
</faq>
@ -89,28 +88,19 @@ System.out.println("Core POI came from " + path);
Why am I getting an exception each time I attempt to read my spreadsheet?
</question>
<answer>
<p>It's possible your spreadsheet contains a feature that is not currently supported by HSSF.
For example - spreadsheets containing cells with rich text are not currently supported.</p>
<p>It's possible your spreadsheet contains a feature that is not currently supported by POI.
If you encounter this then please create the simplest file that demonstrates the trouble and submit it to
<link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bugzilla.</link></p>
</answer>
</faq>
<faq>
<question>
Does HSSF support protected spreadsheets?
</question>
<answer>
<p>Protecting a spreadsheet encrypts it. We wont touch encryption because we're not legally educated
and don't understand the full implications of trying to implement this. If you wish to have a go
at this feel free to add it as a plugin module. We wont be hosting it here however.</p>
</answer>
</faq>
<faq>
<question>
How do you tell if a field contains a date with HSSF?
How do you tell if a spreadsheet cell contains a date?
</question>
<answer>
<p>Excel stores dates as numbers therefore the only way to determine if a cell is
actually stored as a date is to look at the formatting. There is a helper method
in HSSFDateUtil (since the 1.7.0-dev release) that checks for this.
in HSSFDateUtil that checks for this.
Thanks to Jason Hoffman for providing the solution.</p>
<source>
case HSSFCell.CELL_TYPE_NUMERIC:
@ -181,7 +171,7 @@ System.out.println("Core POI came from " + path);
</question>
<answer>
<p>
Yes. You first need to get a HSSFDataFormat object from the workbook and call getFormat with the desired format. Some examples are <link href="spreadsheet/quick-guide.html#DataFormats">here</link>.
Yes. You first need to get a DataFormat object from the workbook and call getFormat with the desired format. Some examples are <link href="spreadsheet/quick-guide.html#DataFormats">here</link>.
</p>
</answer>
</faq>
@ -191,7 +181,7 @@ System.out.println("Core POI came from " + path);
</question>
<answer>
<p>
Yes. This is a built-in format for excel that you can get from HSSFDataFormat object using the format string "@". Also, the string "text" will alias this format.
Yes. This is a built-in format for excel that you can get from DataFormat object using the format string "@". Also, the string "text" will alias this format.
</p>
</answer>
</faq>
@ -204,41 +194,6 @@ System.out.println("Core POI came from " + path);
We will probably enhance HSSF in the future to make this process easier.</p>
</answer>
</faq>
<faq>
<question>
I tried to set cell values and Excel sheet name on my native language,
but I failed to do it. :(
</question>
<answer>
<p>By default HSSF uses cell values and sheet names as compressed unicode,
so to support localization you should use Unicode.
To do it you should set it manually:</p>
<source>
// for sheet name
HSSFWorkbook wb = new HSSFWorkbook();
HSSFSheet s = wb.createSheet();
wb.setSheetName( 0, "SomeUnicodeName", HSSFWorkbook.ENCODING_UTF_16 );
// for cell value
HSSFRow r = s.createRow( 0 );
HSSFCell c = r.createCell( (short)0 );
c.setCellType( HSSFCell.CELL_TYPE_STRING );
c.setEncoding( HSSFCell.ENCODING_UTF_16 );
c.setCellValue( "\u0422\u0435\u0441\u0442\u043E\u0432\u0430\u044F" ); </source>
<p>
Make sure you make the call to setEncoding() before calling setCellValue(), otherwise what you pass in won't be interpreted properly.
</p>
</answer>
</faq>
<faq>
<question>
I'm having trouble creating a spreadsheet using POI using
websphere 3.5.
</question>
<answer>
<p>Make sure you have fix pack 4 installed.</p>
</answer>
</faq>
<faq>
<question>
I am using styles when creating a workbook in POI, but Excel refuses to open the file, complaining about "Too Many Styles".
@ -317,18 +272,4 @@ System.out.println("Core POI came from " + path);
fileOut.close(); </source>
</answer>
</faq>
<faq>
<question>
Will POI read any spreadsheet and rewrite it with modifications.
</question>
<answer>
<p>POI is not guanteed to read the contents of any spreadsheet.
Certain features may cause spreadsheets to fail to read. More
problematic is rewriting spreadsheets. POI tried hard to
preserve the records of the original spreadsheet but some
features may cause problems. We advise that you limit the
formatting of spreadsheets you process so as to not be
unpleasantly suprised at a later stage.</p>
</answer>
</faq>
</faqs>

9
src/documentation/content/xdocs/subversion.xml
View File

@ -32,8 +32,8 @@
<p>
Most users of the source code probably don't need to have day to
day access to the source code as it changes. For these users we
provide easy to unpack source code downloads via our
<link href="ext:download">download pages.</link>
provide easy to unpack source code from releases via our
<link href="download.html">download page.</link>
</p>
</section>
<section><title>Access the Version Controlled Source Code</title>
@ -57,11 +57,6 @@
your hard-disk and wasting bandwidth.
</p>
<p><strong>NOTE</strong>: See this
<link href="http://jakarta.apache.org/commons/svninfo.html">Subversion
information</link> page for a brief description of the relationship be
tween URL tuples such as <em>trunks-proper</em> and <em>proper</em>.</p>
<ul>
<li>For read only access to the Apache POI svn, please use
<link href="http://svn.apache.org/repos/asf/poi/trunk/">http://svn.apache.org/repos/asf/poi/trunk/</link></li>