Apache ODF Toolkit (Incubating)
Latest commit 99975f3 Oct 2, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
assemble Several fixes of documentation and enhancement of build parameters Mar 23, 2017
generator ODFTOOLKIT-478 - Adding namespaces to manifest and digital signature … Oct 2, 2018
legal Several fixes of documentation and enhancement of build parameters Mar 23, 2017
odfdom ODFTOOLKIT-478 - Adding namespaces to manifest and digital signature … Oct 2, 2018
simple #ODFTOOLKIT-474# Patch by Georg Fuechsle - Simple API: List decorator… May 9, 2018
taglets #ODFTOOLKIT-448# #ODFTOOLKIT-415# Update Java baseline to JDK 8, upgr… Apr 11, 2017
validator ODFTOOLKIT-437 validator: add -m flag for MathML schema Jun 22, 2018
xslt-runner-task [maven-release-plugin] prepare for next development iteration Mar 28, 2017
xslt-runner #ODFTOOLKIT-448# #ODFTOOLKIT-415# Update Java baseline to JDK 8, upgr… Apr 11, 2017
.gitignore .gitignore & Validator patches from Michael Stahl (jar access via com… Sep 19, 2012
CHANGES.txt Adding Tom Barber as mentor to the CHANGES.txt Mar 23, 2017
DISCLAIMER.txt Several fixes of documentation and enhancement of build parameters Mar 23, 2017
HEADER.txt fix the broken line endings issue in LICENSE.txt, HEADER.txt, and pom… Dec 14, 2011
KEYS Added gpg key of Svante Schubert Mar 1, 2017
LICENSE ODFTOOLKIT-365: Renamed NOTICE and LICENSE so they will hopefully be … Jul 8, 2013
NOTICE Several fixes of documentation and enhancement of build parameters Mar 23, 2017
README.txt test commit - this should fail as the repo should be read-only Jan 5, 2018
pom.xml Minor pom.xml updates related to JDK8 Apr 11, 2017



                            Apache ODF Toolkit  

The Apache ODF Toolkit (incubating) 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.
It's an incubator project of the Apache Software Foundation <http://www.apache.org/>.

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 (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 web page:
    for details regarding the online tool.

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.

Getting Started

The ODF Toolkit is based on Java 6 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

The simplest way to use these modules are just put the jars files in your classpath
directly. If you are not using maven you can see the versions of the major components for
your release in CHANGES.txt.


The Home Page for the ODF Toolkit:
ODFDOM Getting Start Guide:    
Simple API Getting Start Guide:    
Simple API Cookbook:
Simple API Demos:
Simple API Online JavaDoc:
ODF Validator Getting Start Guide:   
ODF XSLT Runner Getting Start Guide:   
License (see also LICENSE.txt)

Collective work: Copyright 2011-2017 The Apache Software Foundation.

Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Apache 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.txt file.
Mailing Lists

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

Development Mailing List
    Subscribe: odf-dev-subscribe@incubator.apache.org
    Post (after subscription): odf-dev@incubator.apache.org
    Unsubscribe: odf-dev-unsubscribe@incubator.apache.org
    (1) Markmail - http://markmail.org/search/+list:org.apache.incubator.odf-dev/
    (2) Apache - http://mail-archives.apache.org/mod_mbox/incubator-odf-dev/

Users Mailing List
    Subscribe: odf-users-subscribe@incubator.apache.org
    Post (after subscription): odf-users@incubator.apache.org
    Unsubscribe: odf-users-unsubscribe@incubator.apache.org
    Archives: http://mail-archives.apache.org/mod_mbox/incubator-odf-users/

Notification on all code changes are sent to the following mailing list:


The mailing lists are open to anyone and publicly archived.

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 at
https://issues.apache.org/jira/browse/ODFTOOLKIT. There you can also find the
latest information on known issues and recent bug fixes and enhancements.