You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andreas Beeker 32c2de2325 Fix Javadocs 9 hours ago
.github/workflows Fix GitHub Action yaml for Gradle build 2 months ago
gradle/wrapper gradle 6.8 3 months ago
jenkins Adjust for the new source-directories in some more places 1 week ago
legal 65206 - Migrate ant / maven to gradle build 1 week ago
lib.stored Store jars for svnant locally 1 week ago
maven [github-233] Updated de.rototor.pdfbox:graphics2d to 0.31. Thanks to Tobias Stadler. This closes #233 3 weeks ago
osgi [bug-63046] Use Log4j 2 for logging 1 month ago
poi Fix Javadocs 9 hours ago
poi-examples fix javadocs - remove @author tags (http://apache-poi.1045710.n5.nabble.com/Javadocs-clean-up-remove-author-tags-tp5737663.html) 4 days ago
poi-excelant Gradle: Synchronize the code in the different build-scripts across the projects 3 days ago
poi-integration Gradle: Synchronize the code in the different build-scripts across the projects 3 days ago
poi-ooxml Fix Javadocs 9 hours ago
poi-ooxml-full fix gradle builds to better comply with IntelliJ 10 hours ago
poi-ooxml-lite fix gradle builds to better comply with IntelliJ 10 hours ago
poi-ooxml-lite-agent 65206 - Migrate ant / maven to gradle build 1 week ago
poi-scratchpad Fix Javadocs 9 hours ago
sonar Adjust for the new source-directories in some more places 1 week ago
src/resources 65206 - Migrate ant / maven to gradle build 3 weeks ago
test-data [github-234] Ensure the hours position is correct. Thanks to Anthony Schott. This closes #234 3 days ago
.gitattributes Add .gitattribute file and set lf for one sample-file, see bug 61609 3 years ago
.gitignore Add one more directory from Maven build to .gitignore 1 week ago
.travis.yml Adjust Travis-CI build to properly build Github Pull Requests 4 months ago
KEYS update key 1 month ago
README.rst Adjust for the new source-directories in some more places 1 week ago
build.gradle fix gradle builds to better comply with IntelliJ 10 hours ago
build.xml Adjust paths in build-files some more and copy svn-libs 1 week ago
doap_POI.rdf Bump versions to 5.0.1-SNAPSHOT 3 months ago
file-leak-detector.exclude Add one more file-leak-detector exclude 3 months ago
gradle.properties 65206 - Migrate ant / maven to gradle build 1 week ago
gradlew gradle 6.8 3 months ago
gradlew.bat gradle 6.8 3 months ago
patch.xml Tweak 4 years ago
settings.gradle 65206 - Migrate ant / maven to gradle build 1 week ago

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/