EPUB Publication Rendering Vocabulary

17 June 2016

Document history

Editors

Markus Gylling, International Digital Publishing Forum (IDPF)

Matt Garrish, Invited Expert

Copyright © 2010-2016 International Digital Publishing Forum™

All rights reserved. This work is protected under Title 17 of the United States Code. Reproduction and dissemination of this work with changes is prohibited except with the written permission of the International Digital Publishing Forum (IDPF).

EPUB is a registered trademark of the International Digital Publishing Forum.

  1 Overview

  1.1 Purpose and Scope

This section is informative

This vocabulary, a part of EPUB® 3, defines a set of properties for describing various features of the Package Document [Packages31].

The properties in this vocabulary are usable in the various Package Document attributes that accept the property datatype [Packages31], and are grouped by the element and attribute that they can be used in.

This vocabulary is a companion to the [Packages31] specification and is intended to be read in conjunction with that document.

  1.2 Referencing

Properties are referenceable using the base IRI http://www.idpf.org/vocab/rendition/#.

The "rendition:" prefix is reserved for use [Packages31] with these properties and does not have to be declared in the Package Document.

  1.3 Terminology

Terms with meanings specific to EPUB 3.1 are capitalized in this document (e.g., "Author", "Reading System"). A complete list of these terms and definitions is provided in [EPUB31].

Only the first instance of a term in a section is linked to its definition.

  1.4 Conformance Statements

The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in [RFC2119].

All sections of this specification are normative except where identified by the informative status label "This section is informative". The application of informative status to sections and appendices applies to all child content and subsections they may contain.

All examples in this specification are informative.

  2 Metadata meta Properties

  2.1 flow

Name: flow
Description: Specifies the Author preference for how Reading Systems should handle content overflow.
Allowed value(s):

paginated | scrolled-continuous | scrolled-doc | auto

The default value is auto.

Cardinality: Zero or one
Extends: Sets the global value for the given Rendition.
Example: <meta property="rendition:flow">scrolled-doc</meta>

  2.2 layout

Name: layout
Description: Specifies whether the given Rendition is reflowable or pre-paginated.
Allowed value(s):

reflowable | pre-paginated

The default value is reflowable.

Cardinality: Zero or one
Extends: Sets the global value for the given Rendition.
Example: <meta property="rendition:layout">pre-paginated</meta>

  2.3 orientation

Name: orientation
Description: Specifies which orientation the Author intends the given Rendition to be rendered in.
Allowed value(s):

landscape | portrait | auto

The default value is auto.

Cardinality: Zero or one
Extends: Sets the global value for the given Rendition.
Example: <meta property="rendition:orientation">landscape</meta>

  2.4 spread

Name: spread
Description: Specifies the intended Reading System synthetic spread behavior for the given Rendition.
Allowed value(s):

none | landscape | both | auto

The default value is auto.

Use of the value portrait is deprecated in [EPUB31].

Cardinality: Zero or one
Extends: Sets the global value for the given Rendition.
Example: <meta property="rendition:spread">both</meta>

  2.5 viewport [DEPRECATED]

The viewport property is deprecated in [EPUB31]. Refer to its definition in [Publications301] for more information.

  3 Spine itemref Properties

The following tables define properties for use in the itemref element [Packages31] properties attribute [Packages31].

The Cardinality field indicates the number of times the property must appear within the Package Document scope, and the Usage field indicates usage conditions.

  3.1 align-x-center

Name: align-x-center
Description: Specifies that the given spine item should be centered horizontally in the viewport or spread.
Cardinality: Zero or more
Usage: Optional.

  3.2 flow-auto

Name: flow-auto
Description: Indicates no preference for overflow content handling by the Author.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the flow-paginated, flow-scrolled-continuous or flow-scrolled-doc properties.

  3.3 flow-paginated

Name: flow-paginated
Description: Indicates the Author preference is to dynamically paginate content overflow.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the flow-auto, flow-scrolled-continuous or flow-scrolled properties.

  3.4 flow-continuous

Name: flow-scrolled-continuous
Description:

Indicates the Author preference is to provide a scrolled view for overflow content, and that consecutive spine items with this property are to be rendered as a continuous scroll.

The scroll direction is defined relative to the block flow direction [CSS3WritingModes] of the root element of the XHTML Content Document referenced by the itemref element [Packages31]. The scroll direction is vertical if the block flow direction is downward (top-to-bottom). It is horizontal if the block flow direction of the root element is rightward (left-to-right) or leftward (right-to-left).

Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the flow-auto, flow-scrolled-doc or flow-paginated properties.

  3.5 flow-scrolled-doc

Name: flow-scrolled-doc
Description: Indicates the Author preference is to provide a scrolled view for overflow content, and each spine item with this property is to be rendered as separate scrollable document.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the flow-auto, flow-scrolled-continuous or flow-paginated properties.

  3.6 layout-pre-paginated

Name: layout-pre-paginated
Description: Specifies that the given spine item is pre-paginated.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the layout-reflowable property.

  3.7 layout-reflowable

Name: layout-reflowable
Description: Specifies that the given spine item is reflowable.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the layout-pre-paginated property.

  3.8 orientation-auto

Name: orientation-auto
Description: Specifies that the Reading System can determine the orientation to rendered the spine item in.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the orientation-landscape or orientation-portrait property.

  3.9 orientation-landscape

Name: orientation-landscape
Description: Specifies that the given spine item is to be rendered in landscape orientation.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the orientation-portrait or orientation-auto property.

  3.10 orientation-portrait

Name: orientation-portrait
Description: Specifies that the given spine item is to be rendered in portrait orientation.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the orientation-landscape or orientation-auto property.

  3.11 page-spread-center

Name: page-spread-center
Description: Specifies the forced placement of a Content Document in a Synthetic Spread
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the page-spread-right or page-spread-left properties.

  3.12 page-spread-left

The rendition:page-spread-left property is an alias for the page-spread-left property [SpinePropertiesVocab].

  3.13 page-spread-right

The rendition:page-spread-right property is an alias for the page-spread-right property [RenditionVocab].

  3.14 spread-auto

Name: spread-auto
Description: Specifies the Reading System can determine when to render a synthetic spread for the spine item.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the spread-portrait, spread-landscape, spread-both or spread-none property.

  3.15 spread-both

Name: spread-both
Description: Specifies the Reading System should render a synthetic spread for the spine item in both portrait and landscape orientations.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the spread-portrait, spread-landscape, spread-auto or spread-none property.

  3.16 spread-landscape

Name: spread-landscape
Description: Specifies the Reading System should render a synthetic spread for the spine item only when in landscape orientation.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the spread-portrait, spread-both, spread-auto or spread-none property.

  3.17 spread-none

Name: spread-none
Description: Specifies the Reading System should not render a synthetic spread for the spine item.
Cardinality: Zero or more
Usage: Optional. This property must not be specified on an itemref that also specifies the spread-portrait, spread-landscape, spread-both or spread-auto property.

  3.18 spread-portrait [DEPRECATED]

The spread-portrait property is deprecated in [EPUB31]. Refer to its definition in [Publications301] for more information.

  3.19 Examples

The following example shows how a two-page spread of a map might be indicated in the spine.

<spine>
	<itemref idref="title"/>
	<itemref idref="ps-1-l" properties="page-spread-left"/>
	<itemref idref="ps-1-r" properties="page-spread-right"/>
	<itemref idref="toc"/>
	…
</spine>

  References

Normative References

[CSS3WritingModes] CSS Writing Modes Module Level 3 . Elika J. Etemad, et al.

[EPUB31] EPUB 3.1 .

[Packages31] EPUB Packages 3.1 .

[Publications301] EPUB Publications 3.0.1 .

[SpinePropertiesVocab] EPUB Spine Properties Vocabulary .