documentation changes
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@833281 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
982819c470
commit
308d893190
@ -28,35 +28,8 @@
|
|||||||
<menu-item label="Home" href="index.html"/>
|
<menu-item label="Home" href="index.html"/>
|
||||||
<menu-item label="Download" href="download.html"/>
|
<menu-item label="Download" href="download.html"/>
|
||||||
<menu-item label="FAQ" href="faq.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="Changes" href="changes.html"/>
|
||||||
|
<menu-item label="Javadocs" href="ext:javadoc"/>
|
||||||
<menu-item label="Source Repository" href="subversion.html"/>
|
<menu-item label="Source Repository" href="subversion.html"/>
|
||||||
<menu-item label="Mailing Lists" href="mailinglists.html"/>
|
<menu-item label="Mailing Lists" href="mailinglists.html"/>
|
||||||
<menu-item label="Bug Database" href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI"/>
|
<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="Resolutions" href="resolutions/index.html"/>
|
||||||
<menu-item label="Get Involved" href="getinvolved/index.html"/>
|
<menu-item label="Get Involved" href="getinvolved/index.html"/>
|
||||||
<menu-item label="Who We Are" href="who.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>
|
||||||
|
|
||||||
<menu label="Misc">
|
<menu label="Misc">
|
||||||
@ -71,6 +59,7 @@
|
|||||||
<menu-item label="References" href="references/index.html"/>
|
<menu-item label="References" href="references/index.html"/>
|
||||||
<menu-item label="POI in the News" href="news.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="Sponsors" href="http://www.apache.org/foundation/thanks.html" />
|
||||||
|
<menu-item label="History and Future" href="historyandfuture.html"/>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
</book>
|
</book>
|
||||||
|
@ -33,7 +33,7 @@
|
|||||||
</p>
|
</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Latest stable release: <link href="download.html#POI-3.5-FINAL">Apache POI 3.5</link></li>
|
<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>
|
</ul>
|
||||||
<p>
|
<p>
|
||||||
Apache POI releases are available under the <link href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</link>
|
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>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
</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>
|
<section><title>Verify</title>
|
||||||
<anchor id="verify"/>
|
<anchor id="verify"/>
|
||||||
<p>
|
<p>
|
||||||
|
@ -22,13 +22,13 @@
|
|||||||
<faqs title="Frequently Asked Questions">
|
<faqs title="Frequently Asked Questions">
|
||||||
<faq>
|
<faq>
|
||||||
<question>
|
<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>
|
</question>
|
||||||
<answer>
|
<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
|
on your classpath. Quite a few runtimes and other packages
|
||||||
will ship an older version of POI, so this is an easy problem
|
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
|
<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
|
with a few lines of java. These will load one of the core POI
|
||||||
classes, and report where it came from.</p>
|
classes, and report where it came from.</p>
|
||||||
@ -46,8 +46,7 @@ System.out.println("Core POI came from " + path);
|
|||||||
</question>
|
</question>
|
||||||
<answer>
|
<answer>
|
||||||
<p>You almost certainly have an older version earlier on your
|
<p>You almost certainly have an older version earlier on your
|
||||||
classpath. See the answer to the similar question above for
|
classpath. See the prior answer.</p>
|
||||||
how to track this down.</p>
|
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</faq>
|
||||||
<faq>
|
<faq>
|
||||||
@ -56,7 +55,7 @@ System.out.println("Core POI came from " + path);
|
|||||||
</question>
|
</question>
|
||||||
<answer>
|
<answer>
|
||||||
<p>You've probably enabled logging. Logging is intended only for
|
<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
|
by a factor of at least 100. Logging is helpful for understanding
|
||||||
why POI can't read some file or developing POI itself. Important
|
why POI can't read some file or developing POI itself. Important
|
||||||
errors are thrown as exceptions, which means you probably don't need
|
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"?
|
What is the HSSF "eventmodel"?
|
||||||
</question>
|
</question>
|
||||||
<answer>
|
<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
|
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
|
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>
|
</answer>
|
||||||
|
|
||||||
</faq>
|
</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?
|
Why am I getting an exception each time I attempt to read my spreadsheet?
|
||||||
</question>
|
</question>
|
||||||
<answer>
|
<answer>
|
||||||
<p>It's possible your spreadsheet contains a feature that is not currently supported by HSSF.
|
<p>It's possible your spreadsheet contains a feature that is not currently supported by POI.
|
||||||
For example - spreadsheets containing cells with rich text are not currently supported.</p>
|
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>
|
</answer>
|
||||||
</faq>
|
</faq>
|
||||||
<faq>
|
<faq>
|
||||||
<question>
|
<question>
|
||||||
Does HSSF support protected spreadsheets?
|
How do you tell if a spreadsheet cell contains a date?
|
||||||
</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?
|
|
||||||
</question>
|
</question>
|
||||||
<answer>
|
<answer>
|
||||||
<p>Excel stores dates as numbers therefore the only way to determine if a cell is
|
<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
|
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>
|
Thanks to Jason Hoffman for providing the solution.</p>
|
||||||
<source>
|
<source>
|
||||||
case HSSFCell.CELL_TYPE_NUMERIC:
|
case HSSFCell.CELL_TYPE_NUMERIC:
|
||||||
@ -181,7 +171,7 @@ System.out.println("Core POI came from " + path);
|
|||||||
</question>
|
</question>
|
||||||
<answer>
|
<answer>
|
||||||
<p>
|
<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>
|
</p>
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</faq>
|
||||||
@ -191,7 +181,7 @@ System.out.println("Core POI came from " + path);
|
|||||||
</question>
|
</question>
|
||||||
<answer>
|
<answer>
|
||||||
<p>
|
<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>
|
</p>
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</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>
|
We will probably enhance HSSF in the future to make this process easier.</p>
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</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>
|
<faq>
|
||||||
<question>
|
<question>
|
||||||
I am using styles when creating a workbook in POI, but Excel refuses to open the file, complaining about "Too Many Styles".
|
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>
|
fileOut.close(); </source>
|
||||||
</answer>
|
</answer>
|
||||||
</faq>
|
</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>
|
</faqs>
|
||||||
|
@ -32,8 +32,8 @@
|
|||||||
<p>
|
<p>
|
||||||
Most users of the source code probably don't need to have day to
|
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
|
day access to the source code as it changes. For these users we
|
||||||
provide easy to unpack source code downloads via our
|
provide easy to unpack source code from releases via our
|
||||||
<link href="ext:download">download pages.</link>
|
<link href="download.html">download page.</link>
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
<section><title>Access the Version Controlled Source Code</title>
|
<section><title>Access the Version Controlled Source Code</title>
|
||||||
@ -57,11 +57,6 @@
|
|||||||
your hard-disk and wasting bandwidth.
|
your hard-disk and wasting bandwidth.
|
||||||
</p>
|
</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>
|
<ul>
|
||||||
<li>For read only access to the Apache POI svn, please use
|
<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>
|
<link href="http://svn.apache.org/repos/asf/poi/trunk/">http://svn.apache.org/repos/asf/poi/trunk/</link></li>
|
||||||
|
Loading…
Reference in New Issue
Block a user