README.md

The ODF Toolkit

Visit our latest documentation on GitHub.

The ODF Toolkit is a set of Java modules that allow programmatic creation, scanning and manipulation of Open Document Format (ISO/IEC 26300 == ODF) documents. Unlike other approaches which rely on runtime manipulation of heavy-weight editors via an automation interface, the ODF Toolkit is lightweight and ideal for server use.

The ODF Toolkit consists of four subcomponents:

1. ODFDOM (odfdom-java-*.jar) This is an Open Document Format (ODF) framework. Its purpose is to provide an easy, common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy, lightweight programming API portable to any object-oriented language.

2. Simple API (deprecated) - (simple-odf-*.jar) The Simple Java API for ODF is an easy-to-use, high-level Java API for creating, modifying and extracting data from ODF 1.2 documents. It is written in pure Java and does not require that you install any document editor on your system. The Simple Java API for ODF is a high level abstraction of the lower-level ODFDOM API

3. ODF Validator (odfvalidator-*.war) This is a tool that validates Open Document Format (ODF) files and checks them for conformance according to the ODF Standard. ODF Validator is available as an online service and as a command line tool. This page primarily describes the command line tool. Please visit the ODF Validator documentation for details.

4. ODF XSLT Runner(xslt-runner-.jar, xslt-runner-task-.jar) ODF XSLT Runner is a small Java application that allows you to apply XSLT stylesheets to XML streams included in ODF packages without extracting them from the package. It can be used from the command line. A driver to use it within an Ant build file, ODF XSLT Runner Task, is also available.

People interested should follow the mail list to track progress.

Getting Started

The ODF Toolkit is based on Java (tested with JDK 11) and uses the Maven 3 http://maven.apache.org/ build system. To build ODF Toolkit, use the following command in this directory:

mvn clean install

Recent Releases

1. We have a release 0.11.0 using >=JDK 11 for ODF 1.2- Doing a full refactoring of the ODFDOM code generation and containing updates to the new collaboration API: RELEASE (0.11.0):
   • ODFDOM
   • ODF Validator
   • XSLT Runner

For more details see the release notes.

Documentation

• The Home Page for the ODF Toolkit
• ODFDOM Getting Start Guide
• Simple API (deprecated) - Getting Start Guide
• Simple API (deprecated) - Cookbook
• Simple API (deprecated) - Demos
• Simple API (deprecated) - Online JavaDoc
• ODF Validator Getting Start Guide
• ODF XSLT Runner Getting Start Guide

Mailing Lists

Discussion about ODF Toolkit takes place on the following mailing lists:

• Development and Users Mailing List
  • Subscribe: [email protected]
  • Post (after subscription): [email protected]
  • Unsubscribe: [email protected]
  • Mail archives

The mailing lists are open to anyone and publicly archived.

• To confidentially report a security issue, please mail to: [email protected]

Issue Tracker

If you encounter errors in ODF Toolkit or want to suggest an improvement or a new feature, please visit the ODF Toolkit issue tracker. There you can also find the latest information on known issues and recent bug fixes and enhancements.

License

The ODF Toolkit includes a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the licenses listed in the LICENSE file. Copyright ownership information can be found in NOTICE.