From 9b7938bf81c97105af0ba031c06c446ceb1697aa Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Tue, 18 Nov 2025 23:55:40 +0100 Subject: [PATCH] update docs --- .../content/xdocs/apidocs/index.xml | 8 +- src/documentation/content/xdocs/changes.xml | 6 +- src/documentation/content/xdocs/security.xml | 12 ++- .../content/xdocs/versioning.xml | 76 ++++++++++++++----- 4 files changed, 76 insertions(+), 26 deletions(-) diff --git a/src/documentation/content/xdocs/apidocs/index.xml b/src/documentation/content/xdocs/apidocs/index.xml index 8266786b10..f3759e956e 100644 --- a/src/documentation/content/xdocs/apidocs/index.xml +++ b/src/documentation/content/xdocs/apidocs/index.xml @@ -33,9 +33,7 @@ The Javadocs for the latest (development) version of Apache POI can be accessed online here, or build from a source code checkout - by running the javadocs Ant task. The - latest (development) Javadocs are generally - updated every few weeks, so may lag the most recent development slightly. + by running the javadocs Gradle task.

For recent releases, the Javadocs for the latest stable release @@ -47,6 +45,10 @@

  • Apache POI 4.0.x Javadocs
  • Apache POI 3.17 Javadocs
    • +

    + Javadoc.io is + probably the best resource for browsing Apache POI Javadocs. +

    Older Releases

    diff --git a/src/documentation/content/xdocs/changes.xml b/src/documentation/content/xdocs/changes.xml index a6f8ffd818..b535fbb29f 100644 --- a/src/documentation/content/xdocs/changes.xml +++ b/src/documentation/content/xdocs/changes.xml @@ -71,8 +71,12 @@

    + + Upgrade commons-io dependency to 2.21.0 + Upgrade pdfbox dependency to 3.0.6 + - Add back module-info classes that were omitted from the 5.5.0 jars by accident + Add back module-info classes that were omitted from the 5.5.0 jars by accident diff --git a/src/documentation/content/xdocs/security.xml b/src/documentation/content/xdocs/security.xml index a902f05a8a..379adcb8a4 100644 --- a/src/documentation/content/xdocs/security.xml +++ b/src/documentation/content/xdocs/security.xml @@ -32,7 +32,7 @@
    Overview -

    This page provides some guidance about how Apache POI can be used in security-sensible areas.

    +

    This page provides some guidance about how Apache POI can be used in security-sensitive areas.

    @@ -99,6 +99,16 @@ inputs, even if they are not explicitly security-related.
    +
  • Monitor security advisories
    + Keep an eye on security advisories related to Apache POI. You can find them on the + POI website and they are shared on the + POI mailing lists as well as + the Apache Announce Mailing List. +
    + OpenCVE is one of a + number of services that can help you monitor CVEs for specific products. +
    +
    • diff --git a/src/documentation/content/xdocs/versioning.xml b/src/documentation/content/xdocs/versioning.xml index 195b48c381..84fa7145a7 100644 --- a/src/documentation/content/xdocs/versioning.xml +++ b/src/documentation/content/xdocs/versioning.xml @@ -29,27 +29,61 @@
    Versioning -

    - Apache POI™ releases are available under the Apache License, Version 2.0. - from the Download page. -

    -

    - The versioning scheme for Apache POI is based on the principles of - Semantic Versioning 2.0.0. -

    -

    - 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. -

    -

    - 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. -

    -
    - +

    + Apache POI™ releases are available under the Apache License, Version 2.0. + from the Download page. +

    +

    + The versioning scheme for Apache POI is based on the principles of + Semantic Versioning 2.0.0. +

    +

    + 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. +

    +

    + 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. +

    + +
    Migrating from older versions +

    + 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. +

    +

    + 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. +

    +

    + Minor versions may introduce new features and deprecate existing APIs. + They might also contain bug fixes that could potentially affect existing functionality. +

    +

    + 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. +

    +

    + Please check the Change Log for details about + what has changed in each version. +

    +

    + The FAQ may also contain + useful information. +

    +

    + If you encounter any issues when migrating, please report them to the + mailing list. +

    +
    +