File Formats

From XOCPWiki

This page describes the file format used for slide decks.

A slide deck is contained as a .cpxo file. A .cpxo file is a zip archive containing the following:

an XML file that defines the structure of the deck
the graphic files that make up the deck

The .cpxo archive should not contain any directories. It should be a flat structure, with only filenames (and no paths.)

XML Index File Format

The XML file should be named deck.xml and it should be a valid XML 1.0 document, in UTF-8 encoding.

There should be one root <deck> element.

The <deck> element may contain any number of <slide> elements, one per slide in the deck. Each <slide> element should have a name attribute. The name should be unique to the slide. It will likely never be displayed to the user except for debugging, so it can be machine-generated. Optionally, a <slide> element may have height and width attributes that define the size of the slide.

Within the <slide> element, the resources that make up the slide should be listed. First, the graphic layers that make up the slide are listed, each in their own <layer> element. These will be drawn in the order they appear, so the first <layer> is on the bottom and the last is on the top. If no height and width were specified in the <slide> element, the size of the graphic for the first <layer> will define the size of the slide. Paths to graphic files inside the <layer> element should be relative to the deck.xml file.

<layer> elements may optionally contain x and y attributes, which define the position of the top left corner of the layer. If these are not specified, they are assumed to be 0, 0.

The <slide> element also contains <ink> elements. These work the same as layers, but are represented differently so that the program may differentiate the objects that make up the slide from annotations which have been added by the user.

The <slide> element may also contain a <thumb> element that specifies the relative path to a thumbnail image for the slide. This thumbnail should be a small PNG file for display in the sidebar.