OpenDocument

OpenDocument is a package to create, read and update Open Document Format files. ODF is an XML-based file format for office documents such as spreadsheets, charts, presentations and word processing documents, with a standardised specification as an OASIS Committee Specification (v.1.2) and ISO/IEC 26300:2006 (v.1.0 with v.1.1 currently a Draft Amendment). The former specification is the most recently updated, is publicly available, and is the one we're working from for this PEAR package.

This wiki page coordinates the development of OpenDocument. It's not the documentation; just ideas about what we want and how we'll do it.

Development of the OpenDocument package was part of a Google Summer of Code project (anyone know which year?).

• OpenDocumentPHP by Norman Markgraf and Alex Latchford: http://opendocumentphp.org/ and http://sourceforge.net/projects/opendocumentphp/ Dormant since 2010-11-29.
• Dio by Étienne Bersac: http://gitorious.org/dio/pages/Home Domant since 2009-01-29.

The current (26db346) OpenDocument class layout looks like this:

The specification has the following structure:

Namespaces: animation, chart, config, database, dr3d, drawing, form, manifest, meta, data style, office, presentation, script, table, text, style, xsl-fo-compatible, svg-compatible, smil-compatible, of, & odf.

ODF documents have two file-level organisational paradigms: the most common one is a packaged zip file containing a number of XML and other files; the second is a stand-alone single XML file. Both follow the standard file extension nomenclature: .odt for word processing (text) documents; .ods for spreadsheets; .odp for presentations; .odb for databases; .odg for graphics; .odf for formulae, mathematical equations.

Within these various XML files are the following elements:

The <office:body> element contains what we think of as the actual different document types: <office:chart>, <office:database>, <office:drawing>, <office:image>, <office:presentation>, <office:spreadsheet>, <office:text>.

• http://cvs.php.net/viewvc.cgi/pear/OpenDocument/examples/create.php?view=markup
• https://github.com/pear/OpenDocument/blob/master/examples/create.php

Some notes about possibilities for the further development of this package...

• OpenDocument_Element to be a sub-class of DOMElement;
• All elements to be sub-classes of OpenDocument_Element, grouped by namespace;
• The five root elements to be subclasses of DOMDOcument (these get used only by the storage class, usually);
• Each of the seven ODF document types to be represented by OpenDocument sub-classes (these are the primary means of using the API).
• The OpenDocument class is the means of interacting with the eight second-level elements (office:automatic-styles, office:body, office:font-face-decls, office:master-styles, office:meta, office:scripts, office:settings, and office:styles)
• A couple of use cases:

  •       // A new text document, saved.
          $textDoc = new OpenDocument_Text();
          $heading = new OpenDocument_Element_Text_H();
          $heading->textContent = 'Hello World';
          $textDoc->getBody()->insertBefore($heading, null);
          $textDoc->save('hello.odt');
     

  •       // An existing spreadsheet, as a stand-alone file.
          $spreadsheet = new OpenDocument_Spreadsheet('existing.ods');
          $spreadsheet->setStorage(new OpenDocument_Storage_Single());
          $spreadsheet->save();
     

  • There will be additional convenience methods at various levels, things like $spreadsheet->getTable(1)->addRows($dataArray) and $textDoc->toHtml().

The (incomplete) hierarchy would then be along these lines: