pashko/apache-poi
1
0
Fork 0
mirror of https://github.com/apache/poi.git synced 2026-02-27 20:40:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

latest docs

Browse Source
This commit is contained in:
PJ Fanning 2025-11-19 00:08:46 +01:00
parent 21550a7e1f
commit 01ef40b88d
4 changed files with 124 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
content/apidocs/index.html
View File

@ -30,7 +30,7 @@
|start group logo
+-->
<div class="grouplogo">
<a href="https://www.apache.org"><img class="logoImage" alt="Apache Software Foundation" src="../images/group-logo.png" title="The Apache Software Foundation is a cornerstone of the modern Open Source software ecosystem &ndash; supporting some of the most widely used and important software solutions powering today's Internet economy."></a>
<a href="https://www.apache.org"><img class="logoImage" alt="Apache Software Foundation" src="../images/asflogo_horizontal_color.svg" title="The Apache Software Foundation is a cornerstone of the modern Open Source software ecosystem &ndash; supporting some of the most widely used and important software solutions powering today's Internet economy."></a>
</div>
<!--+
|end group logo
@ -114,6 +114,9 @@ document.write("Last Published: " + document.lastModified);
<a href="../download.html">Download</a>
</div>
<div class="menuitem">
<a href="../versioning.html">Versioning</a>
</div>
<div class="menuitem">
<a href="../changes.html">Changelog</a>
</div>
<div class="menupage">
@ -189,9 +192,7 @@ document.write("Last Published: " + document.lastModified);
The Javadocs for the latest (development) version of Apache POI
can be <a href="dev/index.html">accessed online here</a>, or build
from a <a href="../devel/subversion.html">source code checkout</a>
by running the <em>javadocs</em> Ant task. The
<a href="dev/index.html">latest (development) Javadocs</a> are generally
updated every few weeks, so may lag the most recent development slightly.
by running the <em>javadoc</em> Gradle task.
</p>
<p>
For recent releases, the Javadocs for the latest stable release
@ -216,6 +217,12 @@ document.write("Last Published: " + document.lastModified);
</li>
</ul>
<p>
<a href="https://javadoc.io/doc/org.apache.poi">Javadoc.io</a> is
probably the best resource for browsing Apache POI Javadocs.
</p>
<a name="Older+Releases"></a>
<h3 class="boxed">Older Releases</h3>
<p>

79
content/changes.html
View File

@ -226,6 +226,15 @@ document.write("Last Published: " + document.lastModified);
5.5.1 (2025-12-??)
</h2>
<div class="section">
<a name="Summary"></a>
<h3 class="boxed">Summary</h3>
<ul>
<li>Upgrade commons-io dependency to 2.21.0</li>
<li>Upgrade pdfbox dependency to 3.0.6</li>
</ul>
<a name="Changes"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
@ -241,7 +250,7 @@ document.write("Last Published: " + document.lastModified);
</tr>
</thead>
<tbody>
<tr class="action">
<td><img class="icon" alt="fix" src="images/fix.png"></td><td><a href="https://github.com/apache/poi/pull/932">github-932</a></td><td>POI_Overall</td><td>Add back module-info classes that were omitted from the 5.5.0 jars by accident</td>
</tr>
@ -256,7 +265,7 @@ document.write("Last Published: " + document.lastModified);
5.5.0 (2025-11-15)
</h2>
<div class="section">
<a name="Summary"></a>
<a name="Summary-N1005D"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -281,7 +290,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade JaCoCo code-coverage tooling to 0.8.13</li>
</ul>
<a name="Changes-N10075"></a>
<a name="Changes-N10082"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -383,7 +392,7 @@ document.write("Last Published: " + document.lastModified);
5.4.1 (2025-04-06)
</h2>
<div class="section">
<a name="Summary-N101C6"></a>
<a name="Summary-N101D3"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -398,7 +407,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade graphics2d dependency to 3.0.3</li>
</ul>
<a name="Changes-N101DC"></a>
<a name="Changes-N101E9"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -488,7 +497,7 @@ document.write("Last Published: " + document.lastModified);
5.4.0 (2025-01-08)
</h2>
<div class="section">
<a name="Summary-N102FD"></a>
<a name="Summary-N1030A"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -517,7 +526,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade JaCoCo code-coverage tooling to 0.8.12</li>
</ul>
<a name="Changes-N10328"></a>
<a name="Changes-N10335"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -599,7 +608,7 @@ document.write("Last Published: " + document.lastModified);
5.3.0 (2024-07-02)
</h2>
<div class="section">
<a name="Summary-N10429"></a>
<a name="Summary-N10436"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -620,7 +629,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade xmlbeans dependency to 5.2.1</li>
</ul>
<a name="Changes-N10448"></a>
<a name="Changes-N10455"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -690,7 +699,7 @@ document.write("Last Published: " + document.lastModified);
5.2.5 (2023-11-25)
</h2>
<div class="section">
<a name="Summary-N10519"></a>
<a name="Summary-N10526"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -707,7 +716,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade xmlbeans dependency to 5.2.0</li>
</ul>
<a name="Changes-N10532"></a>
<a name="Changes-N1053F"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -761,7 +770,7 @@ document.write("Last Published: " + document.lastModified);
5.2.4 (2023-09-28)
</h2>
<div class="section">
<a name="Summary-N105C3"></a>
<a name="Summary-N105D0"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -788,7 +797,7 @@ document.write("Last Published: " + document.lastModified);
<li>Use jdk18on versions of bouncycastle jars (v1.76)</li>
</ul>
<a name="Changes-N105EB"></a>
<a name="Changes-N105F8"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -934,7 +943,7 @@ document.write("Last Published: " + document.lastModified);
5.2.3 (2022-09-16)
</h2>
<div class="section">
<a name="Summary-N107EC"></a>
<a name="Summary-N107F9"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -953,7 +962,7 @@ document.write("Last Published: " + document.lastModified);
<li>Avoid some more possible overly large memory allocations on certain input documents</li>
</ul>
<a name="Changes-N10808"></a>
<a name="Changes-N10815"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -1155,14 +1164,14 @@ document.write("Last Published: " + document.lastModified);
5.2.2 (2022-03-19)
</h2>
<div class="section">
<a name="Summary-N10AE9"></a>
<a name="Summary-N10AF6"></a>
<h3 class="boxed">Summary</h3>
<ul>
<li>Upgrade log4j-api dependency to 2.17.2 and graphics2d dependency to 0.35 as well as some test dependencies</li>
</ul>
<a name="Changes-N10AF3"></a>
<a name="Changes-N10B00"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -1216,14 +1225,14 @@ document.write("Last Published: " + document.lastModified);
5.2.1 (2022-03-03)
</h2>
<div class="section">
<a name="Summary-N10B84"></a>
<a name="Summary-N10B91"></a>
<h3 class="boxed">Summary</h3>
<ul>
<li>Upgrade curvesapi dependency to 1.07</li>
</ul>
<a name="Changes-N10B8E"></a>
<a name="Changes-N10B9B"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -1297,7 +1306,7 @@ document.write("Last Published: " + document.lastModified);
5.2.0 (2022-01-14)
</h2>
<div class="section">
<a name="Summary-N10C6F"></a>
<a name="Summary-N10C7C"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -1310,7 +1319,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade PDFBox Graphics2d dependency to 0.34 and PDFBox dependency to 2.0.25</li>
</ul>
<a name="Changes-N10C82"></a>
<a name="Changes-N10C8F"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -1404,7 +1413,7 @@ document.write("Last Published: " + document.lastModified);
5.1.0 (2021-11-01)
</h2>
<div class="section">
<a name="Summary-N10DB3"></a>
<a name="Summary-N10DC0"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -1431,7 +1440,7 @@ document.write("Last Published: " + document.lastModified);
<li>By default, no DTDs will be accepted in XML files. This can be relaxed by setting POIXMLTypeLoader.DEFAULT_XML_OPTIONS.setDisallowDocTypeDeclaration(false).</li>
</ul>
<a name="Changes-N10DDB"></a>
<a name="Changes-N10DE8"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -1633,7 +1642,7 @@ document.write("Last Published: " + document.lastModified);
5.0.0 (2021-01-20)
</h2>
<div class="section">
<a name="Summary-N110BC"></a>
<a name="Summary-N110C9"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -1660,7 +1669,7 @@ document.write("Last Published: " + document.lastModified);
<li>new experimental DeferredSXSSFWorkbook which creates fewer temp files by lazily generating rows (see DeferredGeneration in poi-examples)</li>
</ul>
<a name="Changes-N110E1"></a>
<a name="Changes-N110EE"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -1970,7 +1979,7 @@ document.write("Last Published: " + document.lastModified);
4.1.2 (2020-02-17)
</h2>
<div class="section">
<a name="Summary-N11569"></a>
<a name="Summary-N11576"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -1985,7 +1994,7 @@ document.write("Last Published: " + document.lastModified);
<li>updated dependencies to Bouncycastle 1.64</li>
</ul>
<a name="Changes-N1157F"></a>
<a name="Changes-N1158C"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -2119,7 +2128,7 @@ document.write("Last Published: " + document.lastModified);
4.1.1 (2019-10-20)
</h2>
<div class="section">
<a name="Summary-N1174A"></a>
<a name="Summary-N11757"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -2138,7 +2147,7 @@ document.write("Last Published: " + document.lastModified);
<li>CVE-2019-12415 - XML External Entity (XXE) Processing in Apache POI</li>
</ul>
<a name="Changes-N11766"></a>
<a name="Changes-N11773"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -2288,7 +2297,7 @@ document.write("Last Published: " + document.lastModified);
4.1.0 (2019-04-09)
</h2>
<div class="section">
<a name="Summary-N1196E"></a>
<a name="Summary-N1197B"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -2313,7 +2322,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade to XMLSec 2.1.2</li>
</ul>
<a name="Changes-N11993"></a>
<a name="Changes-N119A0"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -2487,7 +2496,7 @@ document.write("Last Published: " + document.lastModified);
4.0.1 (2018-12-03)
</h2>
<div class="section">
<a name="Summary-N11C04"></a>
<a name="Summary-N11C11"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -2498,7 +2507,7 @@ document.write("Last Published: " + document.lastModified);
<li>Upgrade to XMLBeans 3.0.2</li>
</ul>
<a name="Changes-N11C14"></a>
<a name="Changes-N11C21"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>
@ -2656,7 +2665,7 @@ document.write("Last Published: " + document.lastModified);
4.0.0 (2018-09-07)
</h2>
<div class="section">
<a name="Summary-N11E45"></a>
<a name="Summary-N11E52"></a>
<h3 class="boxed">Summary</h3>
<ul>
@ -2665,7 +2674,7 @@ document.write("Last Published: " + document.lastModified);
<li>New OOXML schema (1.4) necessary, because of incompatible XMLBeans loading not anymore through POIXMLTypeLoader</li>
</ul>
<a name="Changes-N11E52"></a>
<a name="Changes-N11E5F"></a>
<h3 class="boxed">Changes</h3>
<table class="POITable">
<colgroup>

17
content/security.html
View File

@ -185,7 +185,7 @@ document.write("Last Published: " + document.lastModified);
<a name="Overview"></a>
<h2 class="boxed">Overview</h2>
<div class="section">
<p>This page provides some guidance about how Apache POI can be used in security-sensible areas.</p>
<p>This page provides some guidance about how Apache POI can be used in security-sensitive areas.</p>
</div>
@ -268,6 +268,21 @@ document.write("Last Published: " + document.lastModified);
<br>
</li>
<li>
<strong>Monitor security advisories</strong>
<br>
Keep an eye on security advisories related to Apache POI. You can find them on the
<a href="https://poi.apache.org">POI website</a> and they are shared on the
<a href="https://poi.apache.org/help/index.html">POI mailing lists</a> as well as
the <a href="https://lists.apache.org/list.html?announce@apache.org">Apache Announce Mailing List</a>.
<br>
<a href="https://app.opencve.io/cve/?product=poi&amp;vendor=apache">OpenCVE</a> is one of a
number of services that can help you monitor CVEs for specific products.
<br>
</li>
</ul>
</div>

69
content/versioning.html
View File

@ -186,26 +186,63 @@ document.write("Last Published: " + document.lastModified);
<h2 class="boxed">Versioning</h2>
<div class="section">
<p>
Apache POI&trade; releases are available under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
from the <a href="download.html">Download</a> page.
</p>
Apache POI&trade; releases are available under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
from the <a href="download.html">Download</a> page.
</p>
<p>
The versioning scheme for Apache POI is based on the principles of
<a href="https://semver.org/">Semantic Versioning 2.0.0</a>.
</p>
The versioning scheme for Apache POI is based on the principles of
<a href="https://semver.org/">Semantic Versioning 2.0.0</a>.
</p>
<p>
We started using this versioning scheme in Apache POI 4.0.0. Versions prior
to this did not follow exactly the same principles with the numbers typically being of the form
X.Y. X indicated the major version but there may in some cases, have been big changes between
minor versions.
</p>
We started using this versioning scheme in Apache POI 4.0.0. Versions prior
to this did not follow exactly the same principles with the numbers typically being of the form
X.Y. X indicated the major version but there may in some cases, have been big changes between
minor versions.
</p>
<p>
We typically only release new versions and don't usually patch old releases.
We may consider patching old releases in exceptional circumstances.
It is recommended to always use the latest version of Apache POI.
</p>
We typically only release new versions and don't usually patch old releases.
We may consider patching old releases in exceptional circumstances.
It is recommended to always use the latest version of Apache POI.
</p>
</div>
<a name="Migrating+from+older+versions"></a>
<h2 class="boxed">Migrating from older versions</h2>
<div class="section">
<p>
Typically, migrating from one major version to the next should be straightforward.
Before migrating, you should check if you are using any deprecated APIs and try to update
your code by following the deprecation notices.
</p>
<p>
If you are migrating across multiple major versions, it is recommended to do this
step by step, i.e. first migrate to the next major version, test your application
and then continue to the next major version. A method might have been deprecated
in one major version and then removed in the next major version.
</p>
<p>
Minor versions may introduce new features and deprecate existing APIs.
They might also contain bug fixes that could potentially affect existing functionality.
</p>
<p>
POI 5.0.0 renamed the ooxml-schemas jar to poi-ooxml-full and
poi-ooxml-schemas jar to poi-ooxml-lite. Please check your dependencies
when migrating from POI 4.x to POI 5.x.
</p>
<p>
Please check the <a href="changes.html">Change Log</a> for details about
what has changed in each version.
</p>
<p>
The <a href="https://poi.apache.org/help/faq.html">FAQ</a> may also contain
useful information.
</p>
<p>
If you encounter any issues when migrating, please report them to the
<a href="https://poi.apache.org/help/index.html">mailing list</a>.
</p>
</div>
<p align="right">
<font size="-2">by&nbsp;PJ Fanning</font>
</p>