README

What is docx4j?

docx4j is an open source (Apache v2) library for creating, editing, and saving OpenXML "packages", including docx, pptx, and xslx.

It uses JAXB to create the Java representation.

• Open existing docx/pptx/xlsx
• Create new docx/pptx/xlsx
• Programmatically manipulate docx/pptx/xlsx (anything the file format allows)
• CustomXML binding (with support for pictures, rich text, checkboxes, and OpenDoPE extensions for repeats & conditionals, and importing XHTML)
• Export as HTML
• Export as PDF (using Plutext's PDF Converter, or use docx4j-export-FO project)
• Produce/consume Word 2007's xmlPackage (pkg) format
• Apply transforms, including common filters
• Font support (font substitution, and use of any fonts embedded in the document)

How do I build docx4j?

Get it from GitHub, at https://github.com/plutext/docx4j For more details, see http://www.docx4java.org/blog/2015/06/docx4j-from-github-in-eclipse-5-years-on/

If you are working with the source code, please join the developer mailing list:

    docx4j-dev-subscribe@docx4java.org

Where do I get a binary?

http://www.docx4java.org/downloads.html

How do I get started?

See the Getting Started guide: https://github.com/plutext/docx4j/tree/master/docs

and the Cheat Sheet: http://www.docx4java.org/blog/2013/05/docx4j-in-a-single-page/

And see the sample code: https://github.com/plutext/docx4j/tree/master/src/samples

You'll probably want the Helper AddIn to generate code: http://www.docx4java.org/blog/2016/05/docx4j-helper-word-addin-new-version-v3-3-0/

Java 9 or 10 with Eclipse

Use Oxygen.3a Release (4.7.3a) or later.

Make sure the Maven configuration is enabled.

In Eclipse, Ctrl-Alt-P, or right-click on the project, Maven, then select the appropriate profile. This will pull in the JAXB jars.

If errors show up, check your build path:

• check you have Java 1.6 or later system library
• check that for source folders, you don't have excluded ** for pptx4j or xlsx4j (if you do, select excluded then click remove)

Where to get help?

http://www.docx4java.org/forums or StackOverflow (use tag 'docx4j')

Please post to one or the other, not both

Legal Information

docx4j is published under the Apache License version 2.0. For the license text, please see the following files in the legals directory:

• LICENSE
• NOTICE Legal information on libraries used by docx4j can be found in the "legals/NOTICE" file.