Mirror of Apache POI
Go to file
Andreas Beeker 9558f2b36a fix findbugs packaging/url
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1877427 13f79535-47bb-0310-9956-ffa450edef68
2020-05-06 09:56:09 +00:00
.settings #63291 CellFormat global cache isn't thread-safe 2019-03-30 19:33:02 +00:00
gradle/wrapper gradle 6.1.1 2020-02-14 13:11:28 +00:00
jenkins Add Java 15 job 2020-04-11 23:16:18 +00:00
legal update year in NOTICE 2020-02-04 21:40:14 +00:00
maven Try to use https for poi.apache.org everywhere 2020-03-08 20:17:08 +00:00
osgi Try to use https for poi.apache.org everywhere 2020-03-08 20:17:08 +00:00
sonar bouncycastle 1.64 2020-04-08 08:29:15 +00:00
src #64411 - Provide JigSaw modules 2020-05-06 09:02:50 +00:00
test-data #55505 - CountryRecord not found 2020-04-21 22:13:59 +00:00
.classpath bouncycastle 1.64 2020-04-08 08:29:15 +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 Ignore directory ooxml-testlib 2018-10-26 09:32:24 +00:00
.project revert accidental commit 2016-06-15 03:28:11 +00:00
.travis.yml [github-140] add .travis.yml. Thanks to krichter722. This closes #140 2019-01-15 00:49:16 +00:00
KEYS pre-release maintenance: 2019-03-19 00:35:09 +00:00
README.rst Adjust README.rst somewhat, remove outdated git-link which redirects to Github now 2020-04-24 20:58:20 +00:00
build.gradle bouncycastle 1.64 2020-04-08 08:29:15 +00:00
build.xml fix findbugs packaging/url 2020-05-06 09:56:09 +00:00
doap_POI.rdf update references to 4.1.2 2020-02-13 23:26:54 +00:00
file-leak-detector.exclude One more file-leak-detector exclude 2020-03-08 08:28:20 +00:00
gradlew Update to latest Gradle 5.6 to allow to build with newer Java versions 2019-10-26 05:26:56 +00:00
gradlew.bat Update to latest Gradle 5.6 to allow to build with newer Java versions 2019-10-26 05:26:56 +00:00
patch.xml Tweak 2016-08-02 08:31:52 +00:00
settings.gradle Add initial compile steps with a simple multi-project setup to build.gradle 2016-10-07 19:33:11 +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: src/testcases/org/apache/poi/
  * OOXML APIs only: src/ooxml/testcases/org/apache/poi/
  * Scratchpad (Binary formats): src/scratchpad/testcases/org/apache/poi/
  * Test files: test-data/

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

  * Binary formats and Common APIs: src/java/org/apache/poi/
  * OOXML APIs only: src/ooxml/java/org/apache/poi/
  * Scratchpad (Binary formats): src/scratchpad/src/org/apache/poi/
  * Examples: src/examples/src/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-schemas, 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/