Mirror of Apache POI
Go to file
Dominik Stadler fadeb68392 Store jars for svnant locally
Downloading them becomes nearly impossible now that bintray.dl closes down,
so let's rather persist the jars as part of the source distribution for now.

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1888572 13f79535-47bb-0310-9956-ffa450edef68
2021-04-10 07:16:57 +00:00
.github/workflows Fix GitHub Action yaml for Gradle build 2021-02-11 22:27:46 +00:00
gradle/wrapper gradle 6.8 2021-01-18 17:58:03 +00:00
jenkins Adjust for the new source-directories in some more places 2021-04-08 20:10:53 +00:00
legal 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
lib.stored Store jars for svnant locally 2021-04-10 07:16:57 +00:00
maven [github-233] Updated de.rototor.pdfbox:graphics2d to 0.31. Thanks to Tobias Stadler. This closes #233 2021-03-25 09:21:04 +00:00
osgi [bug-63046] Use Log4j 2 for logging 2021-02-21 20:57:25 +00:00
poi [bug-65227] add NPE guard in SheetUtil. Thanks to Petr Blaha 2021-04-09 08:21:13 +00:00
poi-examples fix merge problem 2021-04-07 21:48:05 +00:00
poi-excelant 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
poi-integration 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
poi-ooxml Ensure the cache-directory for ImageIO is set to a valid directory 2021-04-08 20:10:48 +00:00
poi-ooxml-full 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
poi-ooxml-lite 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
poi-ooxml-lite-agent 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
poi-scratchpad 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
sonar Adjust for the new source-directories in some more places 2021-04-08 20:10:53 +00:00
src/resources 65206 - Migrate ant / maven to gradle build 2021-03-27 14:03:16 +00:00
test-data Allow negative numbers in conditional part of format string 2021-03-19 09:40:10 +00:00
.gitattributes Add .gitattribute file and set lf for one sample-file, see bug 61609 2018-01-01 14:39:19 +00:00
.gitignore Add one more directory from Maven build to .gitignore 2021-04-06 12:48:16 +00:00
.travis.yml Adjust Travis-CI build to properly build Github Pull Requests 2020-12-06 22:04:02 +00:00
KEYS update key 2021-03-11 21:39:48 +00:00
README.rst Adjust for the new source-directories in some more places 2021-04-08 20:10:53 +00:00
build.gradle Adjust for the new source-directories in some more places 2021-04-08 20:10:53 +00:00
build.xml Store jars for svnant locally 2021-04-10 07:16:57 +00:00
doap_POI.rdf Bump versions to 5.0.1-SNAPSHOT 2021-01-17 18:24:31 +00:00
file-leak-detector.exclude Add one more file-leak-detector exclude 2021-01-07 06:52:51 +00:00
gradle.properties 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
gradlew gradle 6.8 2021-01-18 17:58:03 +00:00
gradlew.bat gradle 6.8 2021-01-18 17:58:03 +00:00
patch.xml Tweak 2016-08-02 08:31:52 +00:00
settings.gradle 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00

README.rst

Apache POI
======================

A Java library for reading and writing Microsoft Office binary and OOXML file formats.

The Apache POI Project's mission is to create and maintain Java APIs for manipulating various file formats based upon the Office Open XML standards (OOXML) and Microsoft's OLE 2 Compound Document format (OLE2). In short, you can read and write MS Excel files using Java. In addition, you can read and write MS Word and MS PowerPoint files using Java. Apache POI is your Java Excel solution (for Excel 97-2008). We have a complete API for porting other OOXML and OLE2 formats and welcome others to participate.

OLE2 files include most Microsoft Office files such as XLS, DOC, and PPT as well as MFC serialization API based file formats. The project provides APIs for the OLE2 Filesystem (POIFS) and OLE2 Document Properties (HPSF).

Office OpenXML Format is the new standards based XML file format found in Microsoft Office 2007 and 2008. This includes XLSX, DOCX and PPTX. The project provides a low level API to support the Open Packaging Conventions using openxml4j.

For each MS Office application there exists a component module that attempts to provide a common high level Java api to both OLE2 and OOXML document formats. This is most developed for Excel workbooks (SS=HSSF+XSSF). Work is progressing for Word documents (WP=HWPF+XWPF) and PowerPoint presentations (SL=HSLF+XSLF).

The project has some support for Outlook (HSMF). Microsoft opened the specifications to this format in October 2007. We would welcome contributions.

There are also projects for Visio (HDGF and XDGF), TNEF (HMEF), and Publisher (HPBF).

This library includes the following components, roughly in descending order of maturity:

* Excel spreadsheets (Common SS = HSSF, XSSF, and SXSSF)
* PowerPoint slideshows (Common SL = HSLF and XSLF)
* Word processing documents (Common WP = HWPF and XWPF)
* Outlook email (HSMF and HMEF)
* Visio diagrams (HDGF and XDGF)
* Publisher (HPBF)

And lower-level, supporting components:

* OLE2 Filesystem (POIFS)
* OLE2 Document Properties (HPSF)
* TNEF (HMEF) for Outlook winmail.dat files
* OpenXML4J (OOXML)

| Components named H??F are for reading or writing OLE2 binary formats.
| Components named X??F are for reading or writing OpenOffice XML (OOXML) formats.

Getting started
------------------

Website: https://poi.apache.org/

`Mailing lists`_:

* `Developers`_
* `Users`_
* `General`_ (release announcements)

Bug tracker:

* `Bugzilla`_
* `GitHub pull requests`_

Source code:

* Official `Apache Subversion repo`_ at apache.org
* `ViewVC repo browser`_ at apache.org
* `GitHub git mirror`_ at github.com

Requires Java 1.8 or later.

Contributing
------------------

* Download and install svn or git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle

* Check out the code from svn or git

* Import the project into Eclipse or your favorite IDE

* Write a unit test:

  * Binary formats and Common APIs: poi/src/test/java/org/apache/poi/
  * OOXML APIs only: poi-ooxml/src/test/java/org/apache/poi/
  * Scratchpad (Binary formats): poi-scratchpad/src/test/java/org/apache/poi/
  * Test files: test-data/

* Navigate the source, make changes, and run unit tests to verify

  * Binary formats and Common APIs: poi/src/main/java/org/apache/poi/
  * OOXML APIs only: poi-ooxml/src/main/java/org/apache/poi/
  * Scratchpad (Binary formats): poi-scratchpad/src/main/java/org/apache/poi/
  * Examples: poi-examples/src/main/java/org/apache/poi/

* More info: `How To Build page`_  at apache.org

Building jar files
------------------

To build the jar files for poi, poi-ooxml, poi-ooxml-lite, poi-ooxml-full and poi-examples::

    ant jar

.. _Mailing lists: https://poi.apache.org/mailinglists.html
.. _Developers: https://lists.apache.org/list.html?dev@poi.apache.org
.. _Users: https://lists.apache.org/list.html?user@poi.apache.org
.. _General: https://lists.apache.org/list.html?general@poi.apache.org
.. _Bugzilla: https://bz.apache.org/bugzilla/buglist.cgi?product=POI
.. _GitHub pull requests: https://github.com/apache/poi/pulls

.. _Apache Subversion repo: https://svn.apache.org/repos/asf/poi/trunk
.. _ViewVC repo browser: https://svn.apache.org/viewvc/poi/trunk
.. _GitHub git mirror: https://github.com/apache/poi
.. _How To Build page: http://poi.apache.org/devel/