ODFDOM

OpenDocument API - ODFDOM

ODFDOM has a new home, please visit http://odftoolkit.org/projects/odftoolkit/pages/ODFDOM

You should register at the ODF Toolkit project and subscribe yourself to the mailing lists of the projects you are interested in.

See you soon, Svante

Current and Future Work

The current ODFDOM version 0.6.15 and its reference implementation based on Java 5. ODFDOM is currently provided with an online API and several downloads. An online Mercurial repository is planed.

In contrary to its predecessor Odf4j ODFDOM has version number. The future version 1.0 will represent a stable API not necessarily a complete API.

Especially the convenient layer will grow on demand and surely will profit from the work done in Odf4j and the experience of the OOo API.

As ODFDOM should be the basement of many future ODF projects, a high quality is desired. Therefore automatic tests are obligatory for all new sources of the Java reference implementation.

The development is being discussed on the dev@odftoolkit.openoffice.org mailing list - subscribe by sending an empty message to dev-subscribe@odftoolkit.openoffice.org.

Anybody who is interested to get more information and/or have a real-time discussion is invited to participate in our weekly IRC meeting every Friday at 9.30 AM (CEST or UTC+2 hours) on irc://freenode/#odftoolkit . You might also join the ODF toolkit project.

Setup ODFDOM build environment

To establish your own ODFDOM build environment:

1.) Install Java / JDK 5

2.) Install NetBeans 6.1

3.) Install Mercurial 1.x

   Setup Mercurial
   Windows: <Hg Install Dir>\Mercurial.ini or Unix: <Hg Install Dir>/.hgrc
   [ui]
   username = foo@bar.com

4.) Get ODFDOM

Unpack the ODFDOM source bundle and start Netbeans. Open an existing project in Netbeans and choose the unpacked ODFDOM directory. As the ODFDOM source bundle comes together with Netbeans project files, ODFDOM opens as a preconfigured project. You still got the opportunity to work solely with ANT directly on the command line instead having the IDE GUI comfort provided by Netbeans.

Mercurial is being used as distributed revision control. Since Netbeans 6.1 the Mercurial plugin is part of the IDE, which help you to track the changes being made and ease providing patches.

In case you are new to Netbeans, there are several nice Netbeans tutorials available.

--Svante 00:33, 24 April 2008 (CEST)