Mirror of Apache POI
Go to file
PJ Fanning 41ea754510 update javadoc
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1920232 13f79535-47bb-0310-9956-ffa450edef68
2024-08-27 18:46:55 +00:00
.github update github actions 2023-11-30 15:37:44 +00:00
gradle/wrapper gradle 8.10 2024-08-16 12:08:48 +00:00
jenkins Jenkins DSL: Use sonar-task and sonar.token instead of sonar.login 2024-02-20 21:09:44 +00:00
legal 2024 2023-12-31 12:42:38 +00:00
lib.stored Store jars for svnant locally 2021-04-10 07:16:57 +00:00
osgi snapshot version 2024-07-02 12:37:38 +00:00
poi update javadoc 2024-08-27 18:46:55 +00:00
poi-examples Adjust test for XLS2CSV for different newlines on Windows 2024-04-22 13:16:10 +00:00
poi-excelant upgrade guava 2024-08-20 16:29:36 +00:00
poi-integration upgrade guava 2024-08-20 16:29:36 +00:00
poi-ooxml [github-682] Add CellPropertyType and CellPropertyCategory enums. Thanks to Danila Avdeyenko. This closes #682 2024-08-27 18:36:59 +00:00
poi-ooxml-full [github-673] Add word10.xsd to poi-ooxml-full. Thanks to fangd1997. This closes #673 2024-08-16 12:06:41 +00:00
poi-ooxml-lite Add one more xsb which is missing in one of my projects 2023-12-06 19:49:59 +00:00
poi-ooxml-lite-agent upgrade bytebuddy 2024-08-20 16:30:34 +00:00
poi-scratchpad Bug 66425: Avoid exceptions found via poi-fuzz 2024-07-18 07:09:32 +00:00
src/resources [GitHub-562] Add extra pivot table classes to poi-ooxml-lite. This closes #562 2023-12-10 12:53:05 +00:00
test-data Bug 66425: Avoid exceptions found via poi-fuzz 2024-07-28 11:02:18 +00:00
.asf.yaml github config 2021-11-14 11:36:33 +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 compile module-info class-files 2023-01-01 15:59:37 +00:00
KEYS update fanningpj key 2024-04-21 22:03:36 +00:00
README.rst POI tm 2024-07-16 12:33:05 +00:00
SECURITY.md security docs 2023-10-24 21:50:57 +00:00
build.gradle upgrade commons-compress 2024-08-20 16:28:30 +00:00
build.xml upgrade bytebuddy 2024-08-20 16:30:34 +00:00
doap_POI.rdf snapshot version 2024-07-02 12:37:38 +00:00
file-leak-detector.exclude Adjust file-handle-leak exlusions 2023-01-30 12:19:33 +00:00
gradle.properties enable gradle caching again 2024-02-28 09:42:29 +00:00
gradlew gradle 8.10 2024-08-16 12:08:48 +00:00
gradlew.bat gradle 8.10 2024-08-16 12:08:48 +00:00
patch.xml Tweak 2016-08-02 08:31:52 +00:00
settings.gradle Use parallel build to speed up building and running tests 2021-11-07 14:59:48 +00:00
wrapper.gradle remove gradle-wrapper jar because it is against ASF policy to ship jars in source releases 2023-08-05 13:14:56 +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::

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