This document lists roles defined by the EPUB 3 Community Group for use with the Package Document collection element.

This document is not tied to a particular version of the EPUB® specification.

This document is subject to change at any time. The terms defined herein will never be removed, but may be deprecated.

Any use of terms marked [draft] should be considered experimental.

Deprecated term are identified by the label [deprecated]. These terms are no longer recommended for use.

Roles

dictionary
Identifies the set of Content Documents that compose a single instance of an dictionary. Refer to the EPUB Dictionaries and Glossaries specification for more information.
distributable-object [draft]
Identifies the set of resources necessary for the processing/rendering of a distributable object. Refer to the EPUB Manifest Role specification for more information.
index
Identifies the set of Content Documents that compose a single instance of an index. Refer to the EPUB Indexes specification for more information.
index-group
Identifies the set of Content Documents that compose a single instance of an index group. Refer to the EPUB Indexes specification for more information.
manifest [draft]
Identifies the set of resources necessary for the processing/rendering of a collection. Refer to the EPUB Manifest Role specification for more information.
preview [draft]
Identifies the set of Content Documents to use to generate a preview of the EPUB Publication. Refer to the EPUB Previews specification for more information.
scriptable-component [draft]
Identifies the set of resources that constitute an embedded Scriptable Component. Refer to EPUB Scriptable Components Packaging and Integration for more information.

Extensions

For a list of third-party implementations of the collection element, refer to the extensions wiki at http://www.idpf.org/epub/extensions/roles.