Document Root

On the top level (issue) an ofip manifest contains publication metadata and a list of stories (items). The order in which these stories appear in the document also defines the reading order.

Story 

Each story (item) consists of metadata and a list of logical pages. Each logical page has a vertical and/or horizontal page. The total number of horizontal and vertical pages for a story do not need to match.

Page 

A page has a background image (ppreview) and a list of interactive objects placed on top of it.

Objects 

Each interactive object has metadata including position and size. The type element defines the type of the object.
Possible values are:

1. activeelement. An inline webview that can used to display a web page or html widget. Requires a link child element.
2. audio. An audio clip. Requires a audio child element.
3. graphic. A slideshow object, Requires a slideshow child element.
4. custom. Custom object. Requires a customobject child element.
5. hotspot. An area on the page that can be tapped on. Requires a hotspot child element.
6. movie. A video item. Requires a movie child element.
7. scrollarea. An area on the page with scrollable content. Requires a scrollarea child element.
8. storylink. Reference to a story inside the document. Requires a storylink child element.
9. weblink. A web page opened in a popup window or external browser. Requires a link child element.

Audio 

By default audio objects start playing after the user interacts with the object on the page. The url can point to either a resource within the archive, or to a resource on the web. Using the autoplay element audio clips can be started automatically when the user accesses the page. The backgroundaudio element hides the audio controls.

Video 

By default video objects start playing after the user interacts with the object on the page. The url can point to either a resource within the archive, or to a resource on the web. Using the autoplay element videos can be started automatically when the user accesses the page. The autofullscreen element can be used to indicate the video should be shown in fullscreen mode. The moviecontrols element defines whether video controls will be hidden. The removeafterplay element indicates the entire video object will disappear from the page once it completes playing.

Hotspot 

The hotspot element itself defines the area on the page that the user needs to tap to activate the hotspot object. The url element points to an image that will be shown when the hotspot is not active. Furthermore, a hotspot consists of a number of child components serving different purposes:

1. The optional activearea element points to an item that will replace the hotspot image when the hotspot is active.
2. The popup element is the item that will be shown when a hotspot is activated.
3. The optional close element defines a dedicated item on the page, including an image, that will be show when a hotspot is active and that can be used to close the hotspot. When omitted, the user needs to tap the activearea or the hotspot itself to close the popup.

When active a hotspot can contain interactive objects. The schema does not limit the type of objects that can be used, nor limits the number of levels of child objects.

Scrollable Area

The url element points to the image content that is being scrolled within the area. The contentcoordinates element of the scrollable area defines the starting point and the dimensions of the content that is being scrolled. The objects element contains a list of interactive objects that appear on the scrollable area. The schema does not limit the type of objects that can be used, nor limits the number of levels of child objects.

Story Link

The itemid element contains the id of another story within the publication. The pageindex contains the index of the logical page within that story.