Mirror of Apache POI
Go to file
Andreas Beeker f2f4ea44b6 #65668 - upgrade to xmlsec 2.3.0 - make secure validation configurable
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1894701 13f79535-47bb-0310-9956-ffa450edef68
2021-11-03 00:00:21 +00:00
.github dependabot 2021-09-23 16:37:46 +00:00
gradle/wrapper update gradlew 2021-10-03 23:52:51 +00:00
jenkins hs-err file location 2021-10-20 13:08: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
osgi Adjust version to 5.1.1-SNAPSHOT, adjust version replacing 2021-11-02 13:19:16 +00:00
poi forbidden api 2021-11-02 21:12:40 +00:00
poi-examples compile issue 2021-11-02 15:03:42 +00:00
poi-excelant try to add LICENSE and NOTICE to sources jars 2021-10-25 22:50:03 +00:00
poi-integration #65668 - upgrade to xmlsec 2.3.0 - make secure validation configurable 2021-11-03 00:00:21 +00:00
poi-ooxml #65668 - upgrade to xmlsec 2.3.0 - make secure validation configurable 2021-11-03 00:00:21 +00:00
poi-ooxml-full try to add LICENSE and NOTICE to sources jars 2021-10-25 22:50:03 +00:00
poi-ooxml-lite try to add LICENSE and NOTICE to sources jars 2021-10-26 00:38:50 +00:00
poi-ooxml-lite-agent byte-buddy 1.11.22 2021-10-29 16:54:46 +00:00
poi-scratchpad try to add LICENSE and NOTICE to sources jars 2021-10-26 00:38:50 +00:00
src/resources 65206 - Migrate ant / maven to gradle build 2021-03-27 14:03:16 +00:00
test-data Do not fail on different count of categories and points and fix cloning charts 2021-11-02 13:17:53 +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 Remove some remnants of sonar-directory which cause CI failures 2021-10-15 07:58:20 +00:00
KEYS update key 2021-03-11 21:39:48 +00:00
README.rst dev link 2021-10-10 22:12:17 +00:00
build.gradle snapshot version 2021-11-02 08:47:22 +00:00
build.xml revert xmlsec upgrade 2021-11-02 17:15:53 +00:00
doap_POI.rdf stub entry for 5.1.0 release 2021-10-25 14:21:28 +00:00
file-leak-detector.exclude Rework test to not cause file-handle leaks and add an exclude for Log4j 2 2021-04-26 15:12:22 +00:00
gradle.properties 65206 - Migrate ant / maven to gradle build 2021-04-07 21:40:33 +00:00
gradlew update gradlew 2021-10-03 23:52:51 +00:00
gradlew.bat gradle 7 2021-05-12 23:39:41 +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

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