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.
Dominik Stadler 434b1ab8e6 Add one more case where timestamp could end up 12 hours ago
.github update github actions 6 months ago
gradle/wrapper gradle 8.8 5 days ago
jenkins Jenkins DSL: Use sonar-task and sonar.token instead of sonar.login 4 months ago
legal 2024 5 months ago
lib.stored Store jars for svnant locally 3 years ago
osgi rename as 5.3.0-SNAPSHOT due to some changes in behaviour 1 month ago
poi Add one more case where timestamp could end up 12 hours ago
poi-examples Adjust test for XLS2CSV for different newlines on Windows 2 months ago
poi-excelant update guava 2 weeks ago
poi-integration update guava 2 weeks ago
poi-ooxml ZipFile deprecation warnings 2 weeks ago
poi-ooxml-full [bug-66650] add chartex classes to poi-ooxml-full 1 year ago
poi-ooxml-lite Add one more xsb which is missing in one of my projects 6 months ago
poi-ooxml-lite-agent byte buddy 1.14.16 1 month ago
poi-scratchpad BoundedInputStream deprecation warnings 2 weeks ago
src/resources [GitHub-562] Add extra pivot table classes to poi-ooxml-lite. This closes #562 6 months ago
test-data Change one exception to warning-log to avoid regressions in mass-tests 3 weeks ago
.asf.yaml github config 2 years ago
.gitattributes Add .gitattribute file and set lf for one sample-file, see bug 61609 6 years ago
.gitignore Ignore compile module-info class-files 1 year ago
KEYS update fanningpj key 2 months ago
README.rst build details 2 years ago
SECURITY.md security docs 8 months ago
build.gradle gradle 8.8 5 days ago
build.xml update guava 2 weeks ago
doap_POI.rdf poi 5.2.5 release 7 months ago
file-leak-detector.exclude Adjust file-handle-leak exlusions 1 year ago
gradle.properties enable gradle caching again 3 months ago
gradlew gradle 8.6 3 months ago
gradlew.bat add back gradle wrapper jar due to windows build issues 10 months ago
patch.xml Tweak 8 years ago
settings.gradle Use parallel build to speed up building and running tests 2 years ago
wrapper.gradle remove gradle-wrapper jar because it is against ASF policy to ship jars in source releases 10 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/