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.
PJ Fanning f212e7c14f try to fix rat check 2 days ago
.github [github-331] update dependabot settings. This close #331 1 month ago
gradle/wrapper gradle 7.4.2 1 month ago
jenkins revert 3 weeks ago
legal Add note about software license grant from BEA Systems back in 2003 2 weeks ago
lib.stored Store jars for svnant locally 1 year ago
osgi update osgi readme 1 week ago
poi #66115 - Some Password protected XLS files are not read 2 weeks ago
poi-examples Use gradle toolchain to specify the jdk version and vendor, e.g. 4 months ago
poi-excelant poi-ooxml-lite: Check in list of classes and xsb-files to avoid the jar-to-test dependency 3 months ago
poi-integration try to fix rat check 2 days ago
poi-ooxml [bug-66138] change log level to warn (the issue is worked around) 1 week ago
poi-ooxml-full [bug-66146] poi-ooxml-full: generate classes for threadedComments and word12 xsds 2 days ago
poi-ooxml-lite revert xmlbeans jar changes 4 weeks ago
poi-ooxml-lite-agent revert xmlbeans jar changes 4 weeks ago
poi-scratchpad Fix issues found when fuzzing Apache POI via Jazzer 3 months ago
src/resources poi-ooxml-lite: Check in list of classes and xsb-files to avoid the jar-to-test dependency 3 months ago
test-data #66115 - Some Password protected XLS files are not read 2 weeks ago
.asf.yaml github config 7 months ago
.gitattributes Add .gitattribute file and set lf for one sample-file, see bug 61609 4 years ago
.gitignore Remove some remnants of sonar-directory which cause CI failures 8 months ago
KEYS update key 4 weeks ago
README.rst build details 6 months ago
SECURITY.md add SECURITY.md 7 months ago
build.gradle try to fix rat check 2 days ago
build.xml xmlbeans 5.1.0 2 weeks ago
doap_POI.rdf POI 5.2.2 release 3 months ago
file-leak-detector.exclude Add one more exclude for file-leak-detector 4 months ago
gradle.properties revert gradle memory change 4 months ago
gradlew update gradlew 9 months ago
gradlew.bat gradle 7 1 year ago
patch.xml Tweak 5 years ago
settings.gradle Use parallel build to speed up building and running tests 7 months 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::

./gradlew jar

gradlew 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/