You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2021/04/10 11:44:31 UTC
svn commit: r1888580 [1/2] - in /poi: site/src/documentation/content/xdocs/
site/src/documentation/content/xdocs/apidocs/
site/src/documentation/content/xdocs/components/
site/src/documentation/content/xdocs/components/diagram/
site/src/documentation/c...
Author: kiwiwings
Date: Sat Apr 10 11:44:30 2021
New Revision: 1888580
URL: http://svn.apache.org/viewvc?rev=1888580&view=rev
Log:
fix paths for integration build, docs, add site task to main build.gradle
Modified:
poi/site/src/documentation/content/xdocs/apidocs/index.xml
poi/site/src/documentation/content/xdocs/components/diagram/index.xml
poi/site/src/documentation/content/xdocs/components/document/index.xml
poi/site/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml
poi/site/src/documentation/content/xdocs/components/document/quick-guide.xml
poi/site/src/documentation/content/xdocs/components/hmef/index.xml
poi/site/src/documentation/content/xdocs/components/hpbf/file-format.xml
poi/site/src/documentation/content/xdocs/components/hpbf/index.xml
poi/site/src/documentation/content/xdocs/components/hsmf/index.xml
poi/site/src/documentation/content/xdocs/components/index.xml
poi/site/src/documentation/content/xdocs/components/poifs/how-to.xml
poi/site/src/documentation/content/xdocs/components/slideshow/index.xml
poi/site/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml
poi/site/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml
poi/site/src/documentation/content/xdocs/components/spreadsheet/examples.xml
poi/site/src/documentation/content/xdocs/components/spreadsheet/excelant.xml
poi/site/src/documentation/content/xdocs/components/spreadsheet/how-to.xml
poi/site/src/documentation/content/xdocs/encryption.xml
poi/site/src/documentation/content/xdocs/help/faq.xml
poi/site/src/documentation/content/xdocs/site.xml
poi/site/src/documentation/resources/stylesheets/snipplets2document.xsl
poi/trunk/build.gradle
poi/trunk/poi-integration/build.xml
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFCell.java
poi/trunk/poi/src/main/java/org/apache/poi/hssf/extractor/ExcelExtractor.java
Modified: poi/site/src/documentation/content/xdocs/apidocs/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/apidocs/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/apidocs/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/apidocs/index.xml Sat Apr 10 11:44:30 2021
@@ -42,10 +42,10 @@
each the family can also be browsed online:
</p>
<ul>
- <li><a href="5.0/index.html">Apache POI 5.0.x Javadocs</a></li>
- <li><a href="4.1/index.html">Apache POI 4.1.x Javadocs</a></li>
- <li><a href="4.0/index.html">Apache POI 4.0.x Javadocs</a></li>
- <li><a href="3.17/index.html">Apache POI 3.17 Javadocs</a></li>
+ <li><a href="ext:apidocs/v50">Apache POI 5.0.x Javadocs</a></li>
+ <li><a href="ext:apidocs/v41">Apache POI 4.1.x Javadocs</a></li>
+ <li><a href="ext:apidocs/v40">Apache POI 4.0.x Javadocs</a></li>
+ <li><a href="ext:apidocs/v317">Apache POI 3.17 Javadocs</a></li>
</ul>
<section><title>Older Releases</title>
Modified: poi/site/src/documentation/content/xdocs/components/diagram/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/diagram/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/diagram/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/diagram/index.xml Sat Apr 10 11:44:30 2021
@@ -32,39 +32,39 @@
<section>
<title>Overview</title>
- <p>HDGF is the POI Project's pure Java implementation of the
+ <p>HDGF is the POI Project's pure Java implementation of the
Visio binary (VSD) file format. XDGF is the POI Project's
pure Java implementation of the Visio XML (VSDX) file format.</p>
<!-- TODO More about XDGF here! -->
- <p>Currently, HDGF provides a low-level, read-only api for
- accessing Visio documents. It also provides a
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/src/org/apache/poi/hdgf/extractor/">way</a>
+ <p>Currently, HDGF provides a low-level, read-only api for
+ accessing Visio documents. It also provides a
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hdgf/extractor/">way</a>
to extract the textual content from a file.
</p>
<p>At this time, there is no <em>usermodel</em> 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
+ supplied with
<a href="http://web.archive.org/web/20071212220759/http://www.gnome.ru/projects/vsdump_en.html">vsdump</a>
to get a feel for how Visio files are structured.</p>
<p>To get a feel for the contents of a file, and to track down
where data of interest is stored, HDGF comes with
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/src/org/apache/poi/hdgf/dev/">VSDDumper</a>
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hdgf/dev/">VSDDumper</a>
to print out the contents of the file. Users should also make
- use of
+ use of
<a href="http://web.archive.org/web/20071212220759/http://www.gnome.ru/projects/vsdump_en.html">vsdump</a>
to probe the structure of files.</p>
- <note>
- This code currently lives the
- <a href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/">scratchpad area</a>
+ <note>
+ This code currently lives the
+ <a href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/">scratchpad area</a>
of the POI SVN repository. To use this component, ensure
you have the Scratchpad Jar on your classpath, or a dependency
defined on the <em>poi-scratchpad</em> artifact - the main POI
jar is not enough! See the
<a href="site:components">POI Components Map</a>
- for more details.
+ for more details.
</note>
<section>
@@ -75,9 +75,9 @@
implement it.</p>
<ol>
<li>Re-write the decompression support in LZW4HDGF as
- HDGFLZW, which will be much better documented, and also
+ HDGFLZW, which will be much better documented, and also
under the ASL. <strong>Completed October 2007</strong></li>
- <li>Add compression support to HDGFLZW.
+ <li>Add compression support to HDGFLZW.
<strong>In progress - works for small streams but encoding
goes wrong on larger ones</strong></li>
<li>Have HDGF just write back the raw bytes it read in, and
@@ -87,16 +87,16 @@
without re-compressing. Plus test to ensure file is
un-changed.</li>
<li>Have HDGF generate the bytes to write out from the
- Stream stores, re-compressing any streams that were
+ Stream stores, re-compressing any streams that were
decompressed. Plus test to ensure file is un-changed.</li>
<li>Have HDGF re-generate the offsets in pointers for the
locations of the streams. Plus test to ensure file is
un-changed.</li>
<li>Have HDGF re-generate the bytes for all the chunks, from
- the chunk commands. Tests to ensure the chunks are
+ the chunk commands. Tests to ensure the chunks are
serialized properly, and then that the file is un-changed</li>
<li>Alter the data of one command, but keep it the same
- length, and check visio can open the file when written
+ length, and check visio can open the file when written
out.</li>
<li>Alter the data of one command, to a new length, and
check that visio can open the file when written out.</li>
Modified: poi/site/src/documentation/content/xdocs/components/document/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/document/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/document/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/document/index.xml Sat Apr 10 11:44:30 2021
@@ -51,11 +51,11 @@
<p>As detailed in the <a href="site:components">Components
Page</a>, HWPF is contained within the poi-scratchpad-XXX.jar, while XWPF
- is in the poi-ooxml-XXX.jar. You will need to ensure you include the appropriate
+ is in the poi-ooxml-XXX.jar. You will need to ensure you include the appropriate
jars (and their dependencies!) in your classpath to use HWPF or XWPF.</p>
-
- <p>Please note that in version 3.12, due to a bug, you might need to include
- poi-scratchpad-XXX.jar when using XWPF. This has been fixed again for the next
+
+ <p>Please note that in version 3.12, due to a bug, you might need to include
+ poi-scratchpad-XXX.jar when using XWPF. This has been fixed again for the next
release as there should not be such a dependency.</p>
</section>
@@ -96,15 +96,15 @@
<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
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hwpf">HWPF</a>
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hwpf">HWPF</a>
and
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xwpf">XWPF</a>.
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xwpf">XWPF</a>.
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
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/testcases/org/apache/poi/hwpf">HWPF</a>
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-scratchpad/src/test/java/org/apache/poi/hwpf">HWPF</a>
and
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/ooxml/testcases/org/apache/poi/xwpf">XWPF</a>.
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-ooxml/src/test/java/org/apache/poi/xwpf">XWPF</a>.
Contributions of more examples, whether inspired by the unit tests or
not, would be most welcomed!
</p>
@@ -113,7 +113,7 @@
<section>
<title>HWPF Notes</title>
- <p>A .doc Word document, as handled by HWPF, can be considered as very long single
+ <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
@@ -145,7 +145,7 @@
everything that the current POI committers need it to do, and so none of
the committers are actively adding new features.</p>
- <p>If you come across a feature in XWPF that you need, and isn't currently
+ <p>If you come across a feature in XWPF that you need, and isn't currently
there, please do send in a patch to add the extra functionality! More details
on contributing patches are available on the <a
href="site:guidelines">"Contribution to POI" page</a>.</p>
@@ -164,10 +164,10 @@
pointman, you should look into the Microsoft Word internals. A good
starting point seems to be Ryan Ackley's <a
href="site:docformat">overview</a>. An introduction to the binary
- file formats is <a
+ file formats is <a
href="https://msdn.microsoft.com/en-us/library/cc998577%28v=office.12%29.aspx">available
from Microsoft</a>, which has some good references and links. After that,
- the full details on the word format are available from
+ the full details on the word format are available from
<a href="https://msdn.microsoft.com/en-us/library/cc313153%28v=office.12%29.aspx">Microsoft</a>,
but the documentation can be a little hard to get into at first... Try reading the
<a href="site:docformat">overview</a> first, and looking at the existing
@@ -193,8 +193,8 @@
href="http://issues.apache.org/">Bugzilla</a> and nag <a
href="mailto:dev@poi.apache.org">the dev list</a> until someone commits
them. Besides the actual checking in of HWPF patches, current POI
- committers will also do some minor reviews now and then of your source code
- patches, test cases and documentation to help ensure software quality. But
+ committers will also do some minor reviews now and then of your source code
+ patches, test cases and documentation to help ensure software quality. But
most of the time you will be on your own. However, anyone offering useful
contributions over a period of time will be offered committership!</p>
Modified: poi/site/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml Sat Apr 10 11:44:30 2021
@@ -37,22 +37,22 @@
<a href="site:guidelines">"Contribution to POI" page</a>.</p>
<section><title>Basic Text Extraction</title>
- <p>For basic text extraction, make use of
+ <p>For basic text extraction, make use of
<code>org.apache.poi.xwpf.extractor.XWPFWordExtractor</code>. It accepts an input
-stream or a <code>XWPFDocument</code>. The <code>getText()</code>
-method can be used to
+stream or a <code>XWPFDocument</code>. The <code>getText()</code>
+method can be used to
get the text from all the paragraphs, along with tables, headers etc.
</p>
</section>
-
+
<section><title>Specific Text Extraction</title>
- <p>To get specific bits of text, first create a
+ <p>To get specific bits of text, first create a
<code>org.apache.poi.xwpf.XWPFDocument</code>. Select the <code>IBodyElement</code>
of interest (Table, Paragraph etc), and from there get a <code>XWPFRun</code>.
Finally fetch the text and properties from that.
</p>
</section>
-
+
<section><title>Headers and Footers</title>
<p>To get at the headers and footers of a word document, first create a
<code>org.apache.poi.xwpf.XWPFDocument</code>. Next, you need to create a
@@ -61,7 +61,7 @@ XWPFDocument. Finally, the XWPFHeaderFoo
footers, including first / even / odd page ones if defined in your
document.</p>
</section>
-
+
<section><title>Changing Text</title>
<p>From a <code>XWPFParagraph</code>, it is possible to fetch the existing
<code>XWPFRun</code> elements that make up the text. To add new text,
@@ -70,7 +70,7 @@ document.</p>
used to add a new <code>XWPFRun</code> at a specific point in the
paragraph.
</p>
- <p>Once you have a <code>XWPFRun</code>, you can use the
+ <p>Once you have a <code>XWPFRun</code>, you can use the
<code>setText(String)</code> method to make changes to the text. To add
whitespace elements such as tabs and line breaks, it is necessary to use
methods like <code>addTab()</code> and <code>addCarriageReturn()</code>.
@@ -79,9 +79,9 @@ document.</p>
<section><title>Further Examples</title>
<p>For now, there are a limited number of XWPF examples in the
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xwpf">Examples Package</a>.
- Beyond those, the best source of additional examples is in the unit
- tests. <a href="http://svn.apache.org/viewvc/poi/trunk/src/ooxml/testcases/org/apache/poi/xwpf/">
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xwpf">Examples Package</a>.
+ Beyond those, the best source of additional examples is in the unit
+ tests. <a href="http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/test/java/org/apache/poi/xwpf/">
Browse the XWPF unit tests.</a>
</p>
</section>
Modified: poi/site/src/documentation/content/xdocs/components/document/quick-guide.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/document/quick-guide.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/document/quick-guide.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/document/quick-guide.xml Sat Apr 10 11:44:30 2021
@@ -30,31 +30,31 @@
<body>
<p>HWPF is still in early development. It is in the <a
- href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/">
+ href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/">
scratchpad section of the SVN.</a> You will need to ensure you
either have a recent SVN checkout, or a recent SVN nightly build
(including the scratchpad jar!)</p>
<section><title>Basic Text Extraction</title>
- <p>For basic text extraction, make use of
+ <p>For basic text extraction, make use of
<code>org.apache.poi.hwpf.extractor.WordExtractor</code>. It accepts an input
-stream or a <code>HWPFDocument</code>. The <code>getText()</code>
-method can be used to
+stream or a <code>HWPFDocument</code>. The <code>getText()</code>
+method can be used to
get the text from all the paragraphs, or <code>getParagraphText()</code>
can be used to fetch the text from each paragraph in turn. The other
option is <code>getTextFromPieces()</code>, which is very fast, but
tends to return things that aren't text from the page. YMMV.
</p>
</section>
-
+
<section><title>Specific Text Extraction</title>
- <p>To get specific bits of text, first create a
-<code>org.apache.poi.hwpf.HWPFDocument</code>. Fetch the range
+ <p>To get specific bits of text, first create a
+<code>org.apache.poi.hwpf.HWPFDocument</code>. Fetch the range
with <code>getRange()</code>, then get paragraphs from that. You
can then get text and other properties.
</p>
</section>
-
+
<section><title>Headers and Footers</title>
<p>To get at the headers and footers of a word document, first create a
<code>org.apache.poi.hwpf.HWPFDocument</code>. Next, you need to create a
@@ -65,9 +65,9 @@ document. Additionally, HeaderStores pro
any macros in the text, which is helpful as many headers and footers
do end up with macros in them.</p>
</section>
-
+
<section><title>Changing Text</title>
- <p>It is possible to change the text via
+ <p>It is possible to change the text via
<code>insertBefore()</code> and <code>insertAfter()</code>
on a <code>Range</code> object (either a <code>Range</code>,
<code>Paragraph</code> or <code>CharacterRun</code>).
@@ -78,9 +78,9 @@ do end up with macros in them.</p>
</section>
<section><title>Further Examples</title>
- <p>For now, the best source of additional examples is in the unit
+ <p>For now, the best source of additional examples is in the unit
tests. <a
- href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/testcases/org/apache/poi/hwpf/">
+ href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/test/java/org/apache/poi/hwpf/">
Browse the HWPF unit tests.</a>
</p>
</section>
Modified: poi/site/src/documentation/content/xdocs/components/hmef/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/hmef/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/hmef/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/hmef/index.xml Sat Apr 10 11:44:30 2021
@@ -37,8 +37,8 @@
which is used by Outlook and Exchange in some situations.</p>
<p>Currently, HMEF provides a read-only api for accessing common
message and attachment attributes, including the message body
- and attachment files. In addition, it's possible to have
- read-only access to all of the underlying TNEF and MAPI
+ and attachment files. In addition, it's possible to have
+ read-only access to all of the underlying TNEF and MAPI
attributes of the message and attachments.</p>
<p>HMEF also provides a command line tool for extracting out
the message body and attachment files from a TNEF (winmail.dat)
@@ -49,9 +49,9 @@
<a href="site:guidelines">Contribution Guidelines</a> then
<a href="site:mailinglists">join the dev list</a>!</p>
- <note>
- This code currently lives the
- <a href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/">scratchpad area</a>
+ <note>
+ This code currently lives the
+ <a href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/">scratchpad area</a>
of the POI SVN repository. To use this component, ensure
you have the Scratchpad Jar on your classpath, or a dependency
defined on the <em>poi-scratchpad</em> artifact - the main POI
@@ -66,10 +66,10 @@
<section>
<title>Easy extraction of message body and attachment files</title>
-
+
<p>The class <em>org.apache.poi.hmef.extractor.HMEFContentsExtractor</em>
provides both command line and Java extraction. It allows the
- saving of the message body (an RTF file), and all of the
+ saving of the message body (an RTF file), and all of the
attachment files, to a single directory as specified.</p>
<p>From the command line, simply call the class specifying the
@@ -85,13 +85,13 @@
<source>
public void extract(String winmailFilename, String directoryName) throws Exception {
HMEFContentsExtractor ext = new HMEFContentsExtractor(new File(winmailFilename));
-
+
File dir = new File(directoryName);
File rtf = new File(dir, "message.rtf");
if(! dir.exists()) {
throw new FileNotFoundException("Output directory " + dir.getName() + " not found");
}
-
+
System.out.println("Extracting...");
ext.extractMessageBody(rtf);
ext.extractAttachments(dir);
@@ -99,14 +99,14 @@ public void extract(String winmailFilena
}
</source>
</section>
-
+
<section>
<title>Attachment attributes and contents</title>
-
+
<p>To get at your attachments, simply call the
<em>getAttachments()</em> method on a <em>HMEFMessage</em>
instance, and you'll receive a list of all the attachments.</p>
- <p>When you have a <em>org.apache.poi.hmef.Attachment</em> object,
+ <p>When you have a <em>org.apache.poi.hmef.Attachment</em> object,
there are several helper methods available. These will all
return the value of the appropriate underlying attachment
attributes, or null if for some reason the attribute isn't
@@ -114,22 +114,22 @@ public void extract(String winmailFilena
<ul>
<li><em>getFilename()</em> - returns the name of the attachment
file, possibly in 8.3 format</li>
- <li><em>getLongFilename()</em> - returns the full name of the
+ <li><em>getLongFilename()</em> - returns the full name of the
attachment file</li>
<li><em>getExtension()</em> - returns the extension of the
attachment file, including the "."</li>
- <li><em>getModifiedDate()</em> - returns the date that the
+ <li><em>getModifiedDate()</em> - returns the date that the
attachment file was last edited on</li>
<li><em>getContents()</em> - returns a byte array of the contents
of the attached file</li>
- <li><em>getRenderedMetaFile()</em> - returns a byte array of
+ <li><em>getRenderedMetaFile()</em> - returns a byte array of
a windows meta file representation of the attached file</li>
</ul>
</section>
-
+
<section>
<title>Message attributes and message body</title>
-
+
<p>A <em>org.apache.poi.hmef.HMEFMessage</em> instance is created
from an <em>InputStream</em> of the underlying TNEF (winmail.dat)
file.</p>
@@ -139,21 +139,21 @@ public void extract(String winmailFilena
<li><em>getBody()</em> - returns a String containing the RTF
contents of the message body. </li>
<li><em>getSubject()</em> - returns the message subject</li>
- <li><em>getAttachments()</em> - returns the list of
+ <li><em>getAttachments()</em> - returns the list of
<em>Attachment</em> objects for the message</li>
</ul>
</section>
-
+
<section>
<title>Low level attribute access</title>
-
+
<p>Both Messages and Attachments contain two kinds of attributes.
These are <em>TNEFAttribute</em> and <em>MAPIAttribute</em>.</p>
- <p>TNEFAttribute is specific to TNEF files in terms of the
+ <p>TNEFAttribute is specific to TNEF files in terms of the
available types and properties. In general, Attachments have a
few more useful ones of these then Messages.</p>
<p>MAPIAttributes hold standard MAPI properties and values, and
- work in a similar way to <a href="../hsmf/">HSMF
+ work in a similar way to <a href="../hsmf/">HSMF
(Outlook)</a> does. There are typically many of these on both
Messages and Attachments. <em>Note - see limitations</em></p>
<p>Both <em>HMEFMessage</em> and <em>Attachment</em> supports
@@ -190,7 +190,7 @@ for(Attachment attach : msg.getAttachmen
<p>To get a feel for the contents of a file, and to track down
where data of interest is stored, HMEF comes with
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/scratchpad/src/org/apache/poi/hmef/dev/">HMEFDumper</a>
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hmef/dev/">HMEFDumper</a>
to print out the contents of the file.</p>
</section>
@@ -201,7 +201,7 @@ for(Attachment attach : msg.getAttachmen
works yet. The current limitations are:</p>
<ul>
<li>Non-standard MAPI properties from the range 0x8000 to 0x8fff
- may not be being quite correctly turned into attributes.
+ may not be being quite correctly turned into attributes.
The values show up, but the name and type may not always
be correct.</li>
<li>All testing so far has been performed on a small number of
Modified: poi/site/src/documentation/content/xdocs/components/hpbf/file-format.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/hpbf/file-format.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/hpbf/file-format.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/hpbf/file-format.xml Sat Apr 10 11:44:30 2021
@@ -88,9 +88,9 @@ Root Entry -
(so the first short has values 0, then 1, then 2). After that it
seems to vary.</p>
<p>At 0x200 we have the text, stored as little endian 16 bit unicode.</p>
- <p>After the text comes all sorts of other stuff, presumably as
+ <p>After the text comes all sorts of other stuff, presumably as
described by the sequences.</p>
- <p>For a contents stream of length 7168 / 0x1c00 bytes, the start
+ <p>For a contents stream of length 7168 / 0x1c00 bytes, the start
looks something like:</p>
<source>
CHNKINK // "CHNKINK "
@@ -101,66 +101,66 @@ CHNKINK // "CHNKINK "
f8 01 13 00 // Normally f8 01 11/13 00
ff ff ff ff // Normally seems to be ffffffff
-18 00
+18 00
TEXT 00 00 01 00 00 00 // TEXT 0 1 0
TEXT 00 02 00 00 d0 03 00 00 // TEXT from: 200 (512), len: 3d0 (976)
-18 00
+18 00
STSH 00 00 01 00 00 00 // STSH 0 1 0
STSH d0 05 00 00 1e 00 00 00 // STSH from: 5d0 (1488), len: 1e (30)
-18 00
+18 00
STSH 01 00 01 00 00 00 // STSH 1 1 0
STSH ee 05 00 00 b8 01 00 00 // STSH from: 5ee (1518), len: 1b8 (440)
-18 00
+18 00
STSH 02 00 01 00 00 00 // STSH 2 1 0
STSH a6 07 00 00 3c 00 00 00 // STSH from: 7a6 (1958), len: 3c (60)
-18 00
+18 00
FDPP 00 00 01 00 00 00 // FDPP 0 1 0
FDPP 00 08 00 00 00 02 00 00 // FDPP from: 800 (2048), len: 200 (512)
-18 00
+18 00
FDPC 00 00 01 00 00 00 // FDPC 0 1 0
FDPC 00 0a 00 00 00 02 00 00 // FDPC from: a00 (2560), len: 200 (512)
-18 00
+18 00
FDPC 01 00 01 00 00 00 // FDPC 1 1 0
FDPC 00 0c 00 00 00 02 00 00 // FDPC from: c00 (3072), len: 200 (512)
-18 00
+18 00
SYID 00 00 01 00 00 00 // SYID 0 1 0
SYID 00 0e 00 00 20 00 00 00 // SYID from: e00 (3584), len: 20 (32)
-18 00
+18 00
SGP 00 00 01 00 00 00 // SGP 0 1 0
SGP 20 0e 00 00 0a 00 00 00 // SGP from: e20 (3616), len: a (10)
-18 00
+18 00
INK 00 00 01 00 00 00 // INK 0 1 0
INK 2a 0e 00 00 04 00 00 00 // INK from: e2a (3626), len: 4 (4)
-18 00
+18 00
BTEP 00 00 01 00 00 00 // BTEP 0 1 0
PLC 2e 0e 00 00 18 00 00 00 // PLC from: e2e (3630), len: 18 (24)
-18 00
+18 00
BTEC 00 00 01 00 00 00 // BTEC 0 1 0
PLC 46 0e 00 00 20 00 00 00 // PLC from: e46 (3654), len: 20 (32)
-18 00
+18 00
FONT 00 00 01 00 00 00 // FONT 0 1 0
FONT 66 0e 00 00 48 03 00 00 // FONT from: e66 (3686), len: 348 (840)
-18 00
+18 00
TCD 03 00 01 00 00 00 // TCD 3 1 0
PLC ae 11 00 00 24 00 00 00 // PLC from: 11ae (4526), len: 24 (36)
-18 00
+18 00
TOKN 04 00 01 00 00 00 // TOKN 4 1 0
PLC d2 11 00 00 0a 01 00 00 // PLC from: 11d2 (4562), len: 10a (266)
-18 00
+18 00
TOKN 05 00 01 00 00 00 // TOKN 5 1 0
PLC dc 12 00 00 2a 01 00 00 // PLC from: 12dc (4828), len: 12a (298)
-18 00
+18 00
STRS 00 00 01 00 00 00 // STRS 0 1 0
PLC 06 14 00 00 46 00 00 00 // PLC from: 1406 (5126), len: 46 (70)
-18 00
+18 00
MCLD 00 00 01 00 00 00 // MCLD 0 1 0
MCLD 4c 14 00 00 16 06 00 00 // MCLD from: 144c (5196), len: 616 (1558)
-18 00
+18 00
PL 00 00 01 00 00 00 // PL 0 1 0
PL 62 1a 00 00 48 00 00 00 // PL from: 1a62 (6754), len: 48 (72)
00 00 // Blank entry follows
00 00 00 00 00 00
-00 00 00 00 00 00 00 00
+00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
(the text will then start)
@@ -178,7 +178,7 @@ PL 62 1a 00 00 48 00 00 00 // PL fro
is stored as little endian 16 bit unicode strings.</p>
</section>
<section><title>Structure of PLC bit</title>
- <p>The first four bytes seem to hold the count of the
+ <p>The first four bytes seem to hold the count of the
entries in the bit, and the second four bytes seem to hold
the type. There is then some pre-data, and then data for
each of the entries, the exact format dependant on the type.</p>
@@ -189,7 +189,7 @@ PL 62 1a 00 00 48 00 00 00 // PL fro
<p>Type 8 has 7 2 byte unsigned ints, then a pair of 4 byte
unsigned ints for each entry.</p>
<p>Type 12 holds hyperlinks, and is very much more complex.
- See <a href="https://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hpbf/model/qcbits/QCPLCBit.java?view=markup"><code>org.apache.poi.hpbf.model.qcbits.QCPLCBit</code></a>
+ See <a href="https://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java/org/apache/poi/hpbf/model/qcbits/QCPLCBit.java?view=markup"><code>org.apache.poi.hpbf.model.qcbits.QCPLCBit</code></a>
for our best guess as to how the contents match up.</p>
</section>
</section>
Modified: poi/site/src/documentation/content/xdocs/components/hpbf/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/hpbf/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/hpbf/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/hpbf/index.xml Sat Apr 10 11:44:30 2021
@@ -32,7 +32,7 @@
<section>
<title>Overview</title>
- <p>HPBF is the POI Project's pure Java implementation of the
+ <p>HPBF is the POI Project's pure Java implementation of the
Publisher file format.</p>
<p>Currently, HPBF is in an early stage, whilst we try to
figure out the file format. So far, we have basic text
@@ -45,7 +45,7 @@
the document (partly supported). Additional low level
code to process the file format may follow, if there
is demand and developer interest warrants it.</p>
- <p>Text Extraction is available via the
+ <p>Text Extraction is available via the
<em>org.apache.poi.hpbf.extractor.PublisherTextExtractor</em>
class.</p>
<p>At this time, there is no <em>usermodel</em> api or similar.
@@ -62,9 +62,9 @@
on the <a href="https://msdn.microsoft.com/en-us/library/cc313105(v=office.12).aspx">Microsoft Office File Format Open Specification Technical Documentation</a>.
</p>
- <note>
- This code currently lives the
- <a href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/">scratchpad area</a>
+ <note>
+ This code currently lives the
+ <a href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/">scratchpad area</a>
of the POI SVN repository. To use this component, ensure
you have the Scratchpad Jar on your classpath, or a dependency
defined on the <em>poi-scratchpad</em> artifact - the main POI
Modified: poi/site/src/documentation/content/xdocs/components/hsmf/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/hsmf/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/hsmf/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/hsmf/index.xml Sat Apr 10 11:44:30 2021
@@ -39,13 +39,13 @@
to all</p>
<p>There is an example MSG textual renderer, which shows how to access the
common parts such as sender, subject, message body and examples. This is
- in the
- <a href="http://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/hsmf/">HSMF examples area</a>
+ in the
+ <a href="http://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hsmf/">HSMF examples area</a>
of SVN. You may also wish to look at the unit tests for more use guides.</p>
- <note>
- This code currently lives the
- <a href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/">scratchpad area</a>
+ <note>
+ This code currently lives the
+ <a href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/src/main/java">scratchpad area</a>
of the POI SVN repository. To use this component, ensure
you have the Scratchpad Jar on your classpath, or a dependency
defined on the <em>poi-scratchpad</em> artifact - the main POI
Modified: poi/site/src/documentation/content/xdocs/components/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/index.xml Sat Apr 10 11:44:30 2021
@@ -383,8 +383,8 @@
<section><title>Examples</title>
<p>
Small sample programs using the POI API are available in the
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples">src/examples</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples">viewvc</a>) directory of the source distribution.
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples">src/examples</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples">viewvc</a>) directory of the source distribution.
</p>
<p>
All of the examples are included in POI distributions as a poi-examples artifact.
Modified: poi/site/src/documentation/content/xdocs/components/poifs/how-to.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/poifs/how-to.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/poifs/how-to.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/poifs/how-to.xml Sat Apr 10 11:44:30 2021
@@ -619,7 +619,7 @@
}
]]></source>
<p>For an example of an in-place change to one stream within a file, you can see the example
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hpsf/examples/ModifyDocumentSummaryInformation.java">
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hpsf/ModifyDocumentSummaryInformation.java">
org/apache/poi/hpsf/examples/ModifyDocumentSummaryInformation.java
</a>
</p>
Modified: poi/site/src/documentation/content/xdocs/components/slideshow/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/slideshow/index.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/slideshow/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/slideshow/index.xml Sat Apr 10 11:44:30 2021
@@ -41,9 +41,9 @@
<li>api for data extraction (text, pictures, embedded objects, sounds)</li>
<li>usermodel api for creating, reading and modifying ppt files</li>
</ul>
- <note>
- This code currently lives the
- <a href="http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/">scratchpad area</a>
+ <note>
+ This code currently lives the
+ <a href="http://svn.apache.org/viewvc/poi/trunk/poi-scratchpad/">scratchpad area</a>
of the POI SVN repository. To use this component, ensure
you have the Scratchpad Jar on your classpath, or a dependency
defined on the <em>poi-scratchpad</em> artifact - the main POI
@@ -51,21 +51,21 @@
<a href="site:components">POI Components Map</a>
for more details.
</note>
- <p>The <a href="./quick-guide.html">quick guide</a> documentation provides
+ <p>The <a href="./quick-guide.html">quick guide</a> documentation provides
information on using this API. Comments and fixes gratefully accepted on the POI
dev mailing lists.</p>
</section>
<section>
<title>POI-XSLF</title>
<p>
- XSLF is the POI Project's pure Java implementation of the PowerPoint 2007 OOXML (.xlsx) file format.
+ XSLF is the POI Project's pure Java implementation of the PowerPoint 2007 OOXML (.xlsx) file format.
Whilst HSLF and XSLF provide similar features, there is not a common interface across the two of them at this time.
</p>
<p>
- Please note that XSLF is still in early development and is a subject to incompatible changes in future.
+ Please note that XSLF is still in early development and is a subject to incompatible changes in future.
</p>
<p>
- A quick guide is available in the <a href="./xslf-cookbook.html">XSLF Cookbook</a>
+ A quick guide is available in the <a href="./xslf-cookbook.html">XSLF Cookbook</a>
</p>
</section>
</body>
Modified: poi/site/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml Sat Apr 10 11:44:30 2021
@@ -31,7 +31,7 @@
<title>Rendering slideshows, WMF, EMF and EMF+</title>
<p>
For rendering slideshow (HSLF/XSLF), WMF, EMF and EMF+ pictures, POI provides an utility class
- <a href="https://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/util/PPTX2PNG.java?view=markup">
+ <a href="https://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xslf/util/PPTX2PNG.java?view=markup">
PPTX2PNG</a>:
</p>
Modified: poi/site/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml Sat Apr 10 11:44:30 2021
@@ -30,7 +30,7 @@
<section><title>XSLF Cookbook</title>
<p>
This page offers a short introduction into the XSLF API. More examples can be found in the
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xslf/"> XSLF Examples</a>
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xslf/"> XSLF Examples</a>
in the POI SVN repository.
</p>
<note>
@@ -272,9 +272,8 @@ Options:
<p>
where graphics is a class implementing java.awt.Graphics2D. In PPTX2PNG the graphic canvas is derived from
java.awt.image.BufferedImage, i.e. the destination is an image in memory, but in general case you can pass
- any compliant implementation of java.awt.Graphics2D. The
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xslf/PPTX2SVG.txt">PPTX2SVG</a>
- example demonstrates how to use Apache Batik to convert .pptx slides into SVG format.
+ any compliant implementation of java.awt.Graphics2D.
+ Find more information in the designated <a href="site:slrender">render page</a>, e.g. on how to render SVG images.
</p>
</section>
<anchor id="Merge"/>
Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/examples.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/examples.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/spreadsheet/examples.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/spreadsheet/examples.xml Sat Apr 10 11:44:30 2021
@@ -39,7 +39,7 @@
or
BusinessPlan -xlsx
</source>
- <p>All sample source is available in <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/">SVN</a></p>
+ <p>All sample source is available in <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/">SVN</a></p>
<p>In addition, there are a handful of
<a href="#hssf-only">HSSF only</a> and
<a href="#xssf-only">XSSF only</a> examples as well.
@@ -73,48 +73,40 @@
<anchor id="ss-common" />
<anchor id="business-plan" />
<section><title>Business Plan</title>
- <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/BusinessPlan.java">BusinessPlan</a>
+ <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/BusinessPlan.java">BusinessPlan</a>
application creates a sample business plan with three phases, weekly iterations and time highlighting. Demonstrates advanced cell formatting
(number and date formats, alignments, fills, borders) and various settings for organizing data in a sheet (freezed panes, grouped rows).
</p>
- <p>
- <img src="images/businessplan.jpg" alt="business plan demo"/>
- </p>
+ <figure src="images/businessplan.jpg" alt="business plan demo"/>
</section>
<anchor id="calendar" />
<section><title>Calendar</title>
- <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/CalendarDemo.java">Calendar</a>
+ <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/CalendarDemo.java">Calendar</a>
demo creates a multi sheet calendar. Each month is on a separate sheet.
</p>
- <p>
- <img src="images/calendar.jpg" alt="calendar demo"/>
- </p>
+ <figure src="images/calendar.jpg" alt="calendar demo"/>
</section>
<anchor id="loan-calculator" />
<section><title>Loan Calculator</title>
- <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/LoanCalculator.java">LoanCalculator</a>
+ <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/LoanCalculator.java">LoanCalculator</a>
demo creates a simple loan calculator. Demonstrates advance usage of cell formulas and named ranges.
</p>
- <p>
- <img src="images/loancalc.jpg" alt="loan calculator demo"/>
- </p>
+ <figure src="images/loancalc.jpg" alt="loan calculator demo"/>
</section>
<anchor id="timesheet" />
<section><title>Timesheet</title>
- <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/TimesheetDemo.java">Timesheet</a>
+ <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/TimesheetDemo.java">Timesheet</a>
demo creates a weekly timesheet with automatic calculation of total hours. Demonstrates advance usage of cell formulas.
</p>
- <p>
- <img src="images/timesheet.jpg" alt="timesheet demo"/>
- </p>
+ <figure src="images/timesheet.jpg" alt="timesheet demo"/>
</section>
<anchor id="conditional-formats" />
<section><title>Conditional Formats</title>
- <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/ConditionalFormats.java">ConditionalFormats</a>
+ <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/ConditionalFormats.java">ConditionalFormats</a>
demo is a collection of short examples showing what you can do with Excel conditional formatting in POI:
</p>
<ul>
@@ -132,23 +124,23 @@
<anchor id="common-formulas" />
<section><title>Formula Examples</title>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/formula/CalculateMortgage.java">CalculateMortgage</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/CalculateMortgage.java">CalculateMortgage</a>
example demonstrates a simple user-defined function to calculate
principal and interest.</p>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/formula/CheckFunctionsSupported.java">CheckFunctionsSupported</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/CheckFunctionsSupported.java">CheckFunctionsSupported</a>
example shows how to test what functions and formulas aren't
supported from a given file.</p>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/formula/SettingExternalFunction.java">SettingExternalFunction</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/SettingExternalFunction.java">SettingExternalFunction</a>
example demonstrates how to use externally provided (third-party)
formula add-ins.</p>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/formula/UserDefinedFunctionExample.java">UserDefinedFunctionExample</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/formula/UserDefinedFunctionExample.java">UserDefinedFunctionExample</a>
example demonstrates how to invoke a User Defined Function for a
given Workbook instance using POI's UDFFinder implementation.</p>
</section>
<anchor id="add-dimensioned-image" />
<section><title>Add Dimensioned Image</title>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/AddDimensionedImage.java">AddDimensionedImage</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/AddDimensionedImage.java">AddDimensionedImage</a>
example demonstrates how to add an image to a worksheet and set that
images size to a specific number of millimetres irrespective of the
width of the columns or height of the rows.</p>
@@ -156,26 +148,26 @@
<anchor id="aligned-cells" />
<section><title>Aligned Cells</title>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/AligningCells.java">AligningCells</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/AligningCells.java">AligningCells</a>
example demonstrates how various alignment options work.</p>
</section>
<anchor id="cell-style-details" />
<section><title>Cell Style Details</title>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/CellStyleDetails.java">CellStyleDetails</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/CellStyleDetails.java">CellStyleDetails</a>
example demonstrates how to read excel styles for cells.</p>
</section>
<anchor id="linked-dropdown" />
<section><title>Linked Dropdown Lists</title>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/LinkedDropDownLists.java">LinkedDropDownLists</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/LinkedDropDownLists.java">LinkedDropDownLists</a>
example demonstrates one technique that may be used to create linked
or dependent drop down lists.</p>
</section>
<anchor id="performance-test" />
<section><title>Common SS Performance Test</title>
- <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/SSPerformanceTest.java">SSPerformanceTest</a>
+ <p>The <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/SSPerformanceTest.java">SSPerformanceTest</a>
example provides a way to create simple example files of varying
sizes, and to calculate how long they take. Useful for benchmarking
your system, and to also test if slow performance is due to Apache
@@ -184,14 +176,14 @@
<anchor id="to-html" />
<section><title>ToHtml</title>
- <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/html/ToHtml.java">ToHtml</a>
+ <p> The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/html/ToHtml.java">ToHtml</a>
example shows how to display a spreadsheet in HTML using the classes for spreadsheet display.
</p>
</section>
<anchor id="to-csv" />
<section><title>ToCSV</title>
- <p>The <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/ToCSV.java">ToCSV</a>
+ <p>The <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java">ToCSV</a>
example demonstrates <em>one</em> way to convert an Excel spreadsheet into a CSV file.
</p>
</section>
@@ -200,36 +192,36 @@
<anchor id="hssf-only" />
<section><title>HSSF-only Examples</title>
<p>All the HSSF-only examples can be found in
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/">SVN</a></p>
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/">SVN</a></p>
<ul>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/CellComments.java">CellComments</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/HyperlinkFormula.java">HyperlinkFormula</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/EventExample.java">EventExample</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/OfficeDrawingWithGraphics.java">OfficeDrawingWithGraphics</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/CreateDateCells.java">CreateDateCells</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/NewWorkbook.java">NewWorkbook</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/EmeddedObjects.java">EmeddedObjects</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/Hyperlinks.java">Hyperlinks</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/OfficeDrawing.java">OfficeDrawing</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/HSSFReadWrite.java">HSSFReadWrite</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/NewSheet.java">NewSheet</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/SplitAndFreezePanes.java">SplitAndFreezePanes</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/InCellLists.java">InCellLists</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/RepeatingRowsAndColumns.java">RepeatingRowsAndColumns</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/MergedCells.java">MergedCells</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/CellTypes.java">CellTypes</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/ZoomSheet.java">ZoomSheet</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/ReadWriteWorkbook.java">ReadWriteWorkbook</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/CreateCells.java">CreateCells</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/Alignment.java">Alignment</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/FrillsAndFills.java">FrillsAndFills</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/AddDimensionedImage.java">AddDimensionedImage</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/Borders.java">Borders</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/NewLinesInCells.java">NewLinesInCells</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/WorkingWithFonts.java">WorkingWithFonts</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/BigExample.java">BigExample</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/Outlines.java">Outlines</a></li>
- <li><a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java">XLS2CSVmra</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CellComments.java">CellComments</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/HyperlinkFormula.java">HyperlinkFormula</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/EventExample.java">EventExample</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/OfficeDrawingWithGraphics.java">OfficeDrawingWithGraphics</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CreateDateCells.java">CreateDateCells</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/NewWorkbook.java">NewWorkbook</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/EmeddedObjects.java">EmeddedObjects</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Hyperlinks.java">Hyperlinks</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/OfficeDrawing.java">OfficeDrawing</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/HSSFReadWrite.java">HSSFReadWrite</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/NewSheet.java">NewSheet</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/SplitAndFreezePanes.java">SplitAndFreezePanes</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/InCellLists.java">InCellLists</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/RepeatingRowsAndColumns.java">RepeatingRowsAndColumns</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/MergedCells.java">MergedCells</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CellTypes.java">CellTypes</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ZoomSheet.java">ZoomSheet</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/ReadWriteWorkbook.java">ReadWriteWorkbook</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/CreateCells.java">CreateCells</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Alignment.java">Alignment</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/FrillsAndFills.java">FrillsAndFills</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/AddDimensionedImage.java">AddDimensionedImage</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Borders.java">Borders</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/NewLinesInCells.java">NewLinesInCells</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/WorkingWithFonts.java">WorkingWithFonts</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/BigExample.java">BigExample</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/Outlines.java">Outlines</a></li>
+ <li><a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java">XLS2CSVmra</a></li>
</ul>
</section>
Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/excelant.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/excelant.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/spreadsheet/excelant.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/spreadsheet/excelant.xml Sat Apr 10 11:44:30 2021
@@ -96,11 +96,10 @@ workbooks then you need to have the foll
to integrate a worksheet into an app, you may want to know that it's going to work before
you actually try to write that code. ExcelAnt helps with that.</p>
- <p>Consider the mortgage-calculation.xls file found in the Examples
- (/examples/src/org/apache/poi/examples/ss/excelant/simple-mortgage-calculation.xls). This sheet
- is shown below:</p>
+ <p>Consider the <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/excelant/simple-mortgage-calculation.xls">mortgage-calculation.xls</a>
+ file found in the Examples (link broken / file is missing). This sheet is shown below:</p>
- <!--img src="images/simple-xls-with-function.jpg" alt="mortgage calculation spreadsheet"/-->
+ <figure src="images/simple-xls-with-function.jpg" alt="mortgage calculation spreadsheet"/>
<p>This sheet calculates the principal and interest payment for a mortgage based
on the amount of the loan, term and rate. To write a simple ExcelAnt test you
@@ -162,10 +161,10 @@ Total time: 391 milliseconds
is how we will set that up:</p>
<source><![CDATA[
-<setDouble cell="'MortgageCalculator'!$B$1" value="240000"/>
-<setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/>
-<setDouble cell="'MortgageCalculator'!$B$3" value ="30"/>
-<evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="2285.576149" precision="1.0e-4" />
+ <setDouble cell="'MortgageCalculator'!$B$1" value="240000"/>
+ <setDouble cell="'MortgageCalculator'!$B$2" value ="0.11"/>
+ <setDouble cell="'MortgageCalculator'!$B$3" value ="30"/>
+ <evaluate showDelta="true" cell="'MortgageCalculator'!$B$4" expectedValue="2285.576149" precision="1.0e-4" />
]]></source>
<p>Don't forget that we're verifying the behavior so you need to put all this
Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/how-to.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/how-to.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/spreadsheet/how-to.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/spreadsheet/how-to.xml Sat Apr 10 11:44:30 2021
@@ -33,7 +33,7 @@
<section><title>How to use the HSSF API</title>
<section><title>Capabilities</title>
- <p>This release of the how-to outlines functionality for the
+ <p>This release of the how-to outlines functionality for the
current svn trunk.
Those looking for information on previous releases should
look in the documentation distributed with that release.</p>
@@ -41,12 +41,12 @@
HSSF allows numeric, string, date or formula cell values to be written to
or read from an XLS file. Also
in this release is row and column sizing, cell styling (bold,
- italics, borders,etc), and support for both built-in and user
+ italics, borders,etc), and support for both built-in and user
defined data formats. Also available is
an event-based API for reading XLS files.
It differs greatly from the read/write API
and is intended for intermediate developers who need a smaller
- memory footprint.
+ memory footprint.
</p>
</section>
<section><title>Different APIs</title>
@@ -73,7 +73,7 @@
</p>
<p>Workbooks are created by creating an instance of
org.apache.poi.ss.usermodel.Workbook. Either create
- a concrete class directly
+ a concrete class directly
(org.apache.poi.hssf.usermodel.HSSFWorkbook or
org.apache.poi.xssf.usermodel.XSSFWorkbook), or use
the handy factory class
@@ -85,9 +85,9 @@
name (the tab at the bottom); you set
the name associated with a sheet by calling
Workbook.setSheetName(sheetindex,"SheetName",encoding).
- For HSSF, the name may be in 8bit format
+ For HSSF, the name may be in 8bit format
(HSSFWorkbook.ENCODING_COMPRESSED_UNICODE)
- or Unicode (HSSFWorkbook.ENCODING_UTF_16). Default
+ or Unicode (HSSFWorkbook.ENCODING_UTF_16). Default
encoding for HSSF is 8bit per char. For XSSF, the name
is automatically handled as unicode.
</p>
@@ -164,7 +164,7 @@ f2.setStrikeout( true );
//set cell stlye
cs.setFont(f);
-//set the cell format
+//set the cell format
cs.setDataFormat(df.getFormat("#,##0.0"));
//set a thin border
@@ -178,7 +178,7 @@ cs2.setDataFormat(HSSFDataFormat.getBuil
cs2.setFont(f2);
// set the sheet name in Unicode
-wb.setSheetName(0, "\u0422\u0435\u0441\u0442\u043E\u0432\u0430\u044F " +
+wb.setSheetName(0, "\u0422\u0435\u0441\u0442\u043E\u0432\u0430\u044F " +
"\u0421\u0442\u0440\u0430\u043D\u0438\u0447\u043A\u0430" );
// in case of plain ascii
// wb.setSheetName(0, "HSSF Test");
@@ -210,7 +210,7 @@ for (rownum = (short) 0; rownum < 30; ro
// create a string cell (see why += 2 in the
c = r.createCell((short) (cellnum + 1));
-
+
// on every other row
if ((rownum % 2) == 0)
{
@@ -284,7 +284,7 @@ method (sheet.removeRow(hssfrow)) and cr
would if creating a new xls. When you are done modifying cells just
call workbook.write(outputstream) just as you did above.</p>
<p>An example of this can be seen in
-<a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/usermodel/HSSFReadWrite.java">org.apache.poi.hssf.usermodel.examples.HSSFReadWrite</a>.</p>
+<a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/usermodel/HSSFReadWrite.java">org.apache.poi.hssf.usermodel.examples.HSSFReadWrite</a>.</p>
</section>
</section>
@@ -430,7 +430,7 @@ public class EventExample
<anchor id="record_aware_event_api" />
<section><title>Record Aware Event API (HSSF Only)</title>
<p>
-This is an extension to the normal
+This is an extension to the normal
<a href="#event_api">Event API</a>. With this, your listener
will be called with extra, dummy records. These dummy records should
alert you to records which aren't present in the file (eg cells that have
@@ -465,14 +465,14 @@ to the event model, and start that as no
<p>
One example use for this API is to write a CSV outputter, which always
outputs a minimum number of columns, even where the file doesn't contain
-some of the rows or cells. It can be found at
+some of the rows or cells. It can be found at
<code>/src/examples/src/org/apache/poi/examples/hssf/eventusermodel/XLS2CSVmra.java</code>,
and may be called on the command line, or from within your own code.
The latest version is always available from
-<a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/hssf/eventusermodel/">subversion</a>.
+<a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/hssf/eventusermodel/">subversion</a>.
</p>
<p>
-<em>In POI versions before 3.0.3, this code lived in the scratchpad section.
+<em>In POI versions before 3.0.3, this code lived in the scratchpad section.
If you're using one of these older versions of POI, you will either
need to include the scratchpad jar on your classpath, or build from a</em>
<a href="site:subversion">subversion checkout</a>.
@@ -483,11 +483,11 @@ The latest version is always available f
<section><title>XSSF and SAX (Event API)</title>
<p>If memory footprint is an issue, then for XSSF, you can get at
- the underlying XML data, and process it yourself. This is intended
- for intermediate developers who are willing to learn a little bit of
+ the underlying XML data, and process it yourself. This is intended
+ for intermediate developers who are willing to learn a little bit of
low level structure of .xlsx files, and who are happy processing
XML in java. Its relatively simple to use, but requires a basic
- understanding of the file structure. The advantage provided is that
+ understanding of the file structure. The advantage provided is that
you can read a XLSX file with a relatively small memory footprint.
</p>
<p>One important thing to note with the basic Event API is that it
@@ -502,9 +502,9 @@ The latest version is always available f
It provides methods to get the raw xml data from the rest of the
file, which you will then pass to SAX.</p>
<p>This example shows how to get at a single known sheet, or at
- all sheets in the file. It is based on the example in
- <a href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java">svn
- src/examples/src/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java</a></p>
+ all sheets in the file. It is based on the example in
+ <a href="http://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java">svn
+ poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/FromHowTo.java</a></p>
<source><![CDATA[
import java.io.InputStream;
import java.util.Iterator;
@@ -627,9 +627,9 @@ public class ExampleEventUserModel {
For a fuller example, including support for fetching number formatting
information and applying it to numeric cells (eg to format dates or
percentages), please see
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">the XLSX2CSV example in svn</a>
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">the XLSX2CSV example in svn</a>
</p>
- <p>An example is also <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/streaming/HybridStreaming.java">provided</a>
+ <p>An example is also <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/streaming/HybridStreaming.java">provided</a>
showing how to combine the user API and the SAX API by doing a streaming parse
of larger worksheets and a traditional user-model parse of the rest of a workbook.</p>
</section>
@@ -654,16 +654,16 @@ public class ExampleEventUserModel {
via getRow() anymore.
</p>
<p>
- The default window size is <em>100</em> and defined by SXSSFWorkbook.DEFAULT_WINDOW_SIZE.
+ The default window size is <em>100</em> and defined by SXSSFWorkbook.DEFAULT_WINDOW_SIZE.
</p>
<p>
A windowSize of -1 indicates unlimited access. In this case all
records that have not been flushed by a call to flushRows() are available
- for random access.
+ for random access.
</p>
- <p>
+ <p>
Note that SXSSF allocates temporary files that you <strong>must</strong> always clean up explicitly, by calling the dispose method.
- </p>
+ </p>
<p>
SXSSFWorkbook defaults to using inline strings instead of a shared strings
table. This is very efficient, since no document content needs to be kept in
@@ -682,9 +682,9 @@ public class ExampleEventUserModel {
Carefully review your memory budget and compatibility needs before deciding
whether to enable shared strings or not.
</p>
- <p> The example below writes a sheet with a window of 100 rows. When the row count reaches 101,
+ <p> The example below writes a sheet with a window of 100 rows. When the row count reaches 101,
the row with rownum=0 is flushed to disk and removed from memory, when rownum reaches 102 then the row with rownum=1 is flushed, etc.
- </p>
+ </p>
<source><![CDATA[
@@ -719,7 +719,7 @@ import org.apache.poi.xssf.streaming.SXS
for(int rownum = 900; rownum < 1000; rownum++){
Assert.assertNotNull(sh.getRow(rownum));
}
-
+
FileOutputStream out = new FileOutputStream("/temp/sxssf.xlsx");
wb.write(out);
out.close();
@@ -751,7 +751,7 @@ import org.apache.poi.xssf.streaming.SXS
cell.setCellValue(address);
}
- // manually control how rows are flushed to disk
+ // manually control how rows are flushed to disk
if(rownum % 100 == 0) {
((SXSSFSheet)sh).flushRows(100); // retain 100 last rows and flush all others
@@ -771,12 +771,12 @@ import org.apache.poi.xssf.streaming.SXS
]]></source>
-<p>SXSSF flushes sheet data in temporary files (a temp file per sheet) and the size of these temporary files
+<p>SXSSF flushes sheet data in temporary files (a temp file per sheet) and the size of these temporary files
can grow to a very large value. For example, for a 20 MB csv data the size of the temp xml becomes more than a gigabyte.
If the size of the temp files is an issue, you can tell SXSSF to use gzip compression:
</p>
<source><![CDATA[
- SXSSFWorkbook wb = new SXSSFWorkbook();
+ SXSSFWorkbook wb = new SXSSFWorkbook();
wb.setCompressTempFiles(true); // temp files will be gzipped
]]></source>
@@ -800,7 +800,7 @@ documentation for the POIFS libraries as
</section>
<section><title>Generating XLS from XML</title>
<p>If you wish to generate an XLS file from some XML, it is possible to
-write your own XML processing code, then use the User API to write out
+write your own XML processing code, then use the User API to write out
the document.</p>
<p>The other option is to use <a href="http://cocoon.apache.org/">Cocoon</a>.
In Cocoon, there is the <a href="http://cocoon.apache.org/2.1/userdocs/xls-serializer.html">HSSF Serializer</a>,
Modified: poi/site/src/documentation/content/xdocs/encryption.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/encryption.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/encryption.xml (original)
+++ poi/site/src/documentation/content/xdocs/encryption.xml Sat Apr 10 11:44:30 2021
@@ -242,7 +242,7 @@
to protect it from unauthorized modifications, i.e. modifications without having the original certificate.
The current implementation is based on the <!--<a href="http://eid-applet.googlecode.com">eID Applet</a>-->
<a href="https://github.com/e-Contract/eid-applet">eID Applet</a> which
- is dual-licensed to <!--<a href="https://code.google.com/p/eid-applet/source/browse/trunk/README.txt">ASF/POI</a>-->
+ is dual-licensed to
<a href="https://github.com/e-Contract/eid-applet/blob/master/README.md#7-license">Apache License 2.0 and LGPL v3.0</a>.
Instead of using the internal <a href="http://www.jsourcecode.com/class.php?proj=jdk%5Copenjdk&jar=openjdk-6-b14&class=org.jcp.xml.dsig.internal.dom.DOMXMLSignatureFactory">JDK API</a>
this version is based on <a href="https://santuario.apache.org">Apache Santuario</a>.</p>
@@ -259,7 +259,7 @@
depend on supporting services and although the code is adopted, the integration is not well tested ... please support us on
integration (testing) with timestamp and revocation (OCSP) services.
</p>
- <p>Further test examples can be found in the corresponding <a href="https://svn.apache.org/viewvc/poi/trunk/src/ooxml/testcases/org/apache/poi/poifs/crypt/TestSignatureInfo.java?view=markup">test class</a>.</p>
+ <p>Further test examples can be found in the corresponding <a href="https://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/test/java/org/apache/poi/poifs/crypt/dsig/TestSignatureInfo.java?view=markup">test class</a>.</p>
<p>If you want to use a hash algorithm with 64 bytes (currently only applies to SHA512),
<a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=42061">a base64 "feature"</a> in xmlsec
@@ -366,7 +366,7 @@
to extract an OOXML spreadsheet zipped container and write the contents to disk using AES
encryption.</p>
- <p>See <a href="https://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/temp/SXSSFWorkbookWithCustomZipEntrySource.java?view=markup">SXSSFWorkbookWithCustomZipEntrySource.java</a>
+ <p>See <a href="https://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/temp/SXSSFWorkbookWithCustomZipEntrySource.java?view=markup">SXSSFWorkbookWithCustomZipEntrySource.java</a>
and other <a href="https://svn.apache.org/viewvc?view=revision&revision=1768744">files</a>
that are needed for this example.</p>
</section>
Modified: poi/site/src/documentation/content/xdocs/help/faq.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/help/faq.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/help/faq.xml (original)
+++ poi/site/src/documentation/content/xdocs/help/faq.xml Sat Apr 10 11:44:30 2021
@@ -382,8 +382,8 @@ case HSSFCell.CELL_TYPE_NUMERIC:
<p>Apache POI ships with a few programs and a few example programs,
which can be used to do some basic performance checks. For testing
file generation, the class to use is in the examples package,
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/SSPerformanceTest.java">SSPerformanceTest</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/ss/SSPerformanceTest.java">viewvc</a>).
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/SSPerformanceTest.java">SSPerformanceTest</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/SSPerformanceTest.java">viewvc</a>).
Run SSPerformanceTest with arguments of the writing type (HSSF, XSSF
or SXSSF), the number rows, the number of columns, and if the file
should be saved. If you can't run that with 50,000 rows and 50 columns
@@ -391,11 +391,11 @@ case HSSFCell.CELL_TYPE_NUMERIC:
(and ideally all 3 in less than that!), then the problem is with
your environment.</p>
<p>Next, use the example program
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/ss/ToCSV.java">ToCSV</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/ss/ToCSV.java">viewvc</a>)
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java">ToCSV</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/ss/ToCSV.java">viewvc</a>)
to try reading the file in with HSSF or XSSF. Related is
- <a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">XLSX2CSV</a>
- (<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">viewvc</a>),
+ <a href="https://svn.apache.org/repos/asf/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">XLSX2CSV</a>
+ (<a href="https://svn.apache.org/viewvc/poi/trunk/poi-examples/src/main/java/org/apache/poi/examples/xssf/eventusermodel/XLSX2CSV.java">viewvc</a>),
which uses SAX parsing for .xlsx. Run this against both your problem file,
and a simple one generated by SSPerformanceTest of the same size. If this is
slow, then there could be an Apache POI problem with how the file is being
Modified: poi/site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/site.xml?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/site.xml (original)
+++ poi/site/src/documentation/content/xdocs/site.xml Sat Apr 10 11:44:30 2021
@@ -158,5 +158,12 @@ See http://xml.apache.org/forrest/linkin
<junit href="junit/index.html"/>
<jdepend href="jdepend/index.html"/>
<download href="https://www.apache.org/dyn/closer.lua/poi/"/>
+ <apidocs href="http://poi.apache.org/apidocs/">
+ <v317 href="3.17/"/>
+ <v40 href="4.0/"/>
+ <v41 href="4.1/"/>
+ <v50 href="5.0/"/>
+ <dev href="dev/"/>
+ </apidocs>
</external-refs>
</site>
Modified: poi/site/src/documentation/resources/stylesheets/snipplets2document.xsl
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/resources/stylesheets/snipplets2document.xsl?rev=1888580&r1=1888579&r2=1888580&view=diff
==============================================================================
--- poi/site/src/documentation/resources/stylesheets/snipplets2document.xsl (original)
+++ poi/site/src/documentation/resources/stylesheets/snipplets2document.xsl Sat Apr 10 11:44:30 2021
@@ -42,8 +42,8 @@
</xsl:copy>
</xsl:template>
- <xsl:variable name="ASCII">!"#$%&'()*+,-./0123456789:;=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~</xsl:variable>
- <xsl:variable name="DOTS">............................................................................................</xsl:variable>
+ <xsl:variable name="ASCII">!"#$%&'()*+,-./0123456789:;=&<>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~</xsl:variable>
+ <xsl:variable name="DOTS">..............................................................................................</xsl:variable>
<xsl:template match="source">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org