General

Components

Community

Development

PPMC

ASF

ODFDOM - the OpenDocument API

ODFDOM is a free OpenDocument Format (ODF) library. 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 lightwork programming API portable to any object-oriented language.

The current reference implementation is written in Java.

To learn more about the project's architecture, refer to the project overview and the ODFDOM Layers section.

Quickstart

Put the odfdom.jar file in your classpath. You will need Apache Xerces-J as XML parser and DOM implementation as well. Start with the following sample code to create a simple text document.

// Create a text document from a standard template (empty documents within the JAR)  
OdfTextDocument odt = OdfTextDocument.newTextDocument();  
// Append text to the end of the document.   
odt.addText("This is my very first ODF test");  
// Save document  
odt.save("MyFilename.odt");

The Earlier Release

ODFDOM 0.8.7

ODFDOM 0.8.7 was on Feb 16th 2011. Major enhancements are coming with this version:

For more details see feature summary on the mailing list and the release notes with the API change list.

Download

The ODFDOM downloads are now available from the official Maven repository:

KEYS

For information on working with the source code, please refer to the development section.

Documentation

A good starting point is reading the project overview and the ODFDOM Layers will help you to get an overview over the ODFDOM package structure.

Javadocs are viewable online or downloadable as bundle from the official Maven repository.

There are David's ODFDOM tutorials. You'll find an introduction as well as sample code for creating text and spreadsheet documents. (Note: The tutorials might not yet be adapted to the latest version).

When meeting with questions, check if FAQs can help you.

How to Participate

There are many ways to participate and we're always looking for contributors. Just on the Apache ODF Toolkit Project and afterwards watch this project. Then you may want to start with reading and posting on the mailing lists or report bugs or write documentation.

If you're a developer, just dive into the development section. Here you find information on where to access the source code and how to set up a build environment.

You can contact us by IRC "irc://irc.freenode.org/odfdom".


Powered by the Apache CMS.

Apache "ODF Toolkit" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright © 2011 The Apache Software Foundation Licensed under the Apache License, Version 2.0. Contact Us
Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
Other names appearing on the site may be trademarks of their respective owners.