EPUB Package Rendering Vocabulary (original) (raw)
WARNING: This document is OBSOLETE.
The EPUB Package Rendering Vocabulary is now now an appendix of theEPUB 3 Specification.
5 October 2016
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.
Status of this Document
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.
Requests for additions, modifications and clarifications can be made through the Issue Tracker. Pull requests are also welcome.
Refer to the IDPF Issue Reporting Guidelines for more information about the change request process.
Table of Contents
1. Overview
1.1 About this Vocabulary
This vocabulary defines a set of properties for describing various features of the EPUB® Package Document [Packages3].
The properties in this vocabulary are usable in the various Package Document attributes that accept aproperty datatype [Packages3], and are grouped by the element and attribute that they are allowed in.
1.2 Referencing
Properties are referenceable using the base IRI http://www.idpf.org/vocab/rendition/#.
The "rendition:" prefix is reserved for use [Packages3] with these properties and does not have to be declared in the Package Document.
1.3 Terminology
Terms with meanings specific to EPUB 3 are capitalized in this document (e.g., "Author", "Reading System"). A complete list of these terms and definitions is provided in [EPUB3].
Only the first instance of a term in a section is linked to its definition.
2. Metadata meta Properties
flow
Specifies the Author preference for how Reading Systems should handle content overflow.
layout
Specifies whether the given Rendition is reflowable or pre-paginated.
orientation
Specifies which orientation the Author intends the given Rendition to be rendered in.
spread
Specifies the intended Reading System synthetic spread behavior for the given Rendition.
viewport
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 [Packages3] properties attribute [Packages3].
align-x-center
Specifies that the given spine item should be centered horizontally in the viewport or spread.
flow-auto
Indicates no preference for overflow content handling by the Author.
flow-paginated
Indicates the Author preference is to dynamically paginate content overflow.
flow-scrolled-continuous
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.
flow-scrolled-doc
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.
layout-pre-paginated
Specifies that the given spine item is pre-paginated.
layout-reflowable
Specifies that the given spine item is reflowable.
orientation-auto
Specifies that the Reading System can determine the orientation to rendered the spine item in.
orientation-landscape
Specifies that the given spine item is to be rendered in landscape orientation.
orientation-portrait
Specifies that the given spine item is to be rendered in portrait orientation.
page-spread-center
Specifies the forced placement of a Content Document in a Synthetic Spread
page-spread-left
The rendition:page-spread-left property is an alias for the page-spread-left property [SpinePropertiesVocab].
page-spread-right
The rendition:page-spread-right property is an alias for the page-spread-right property [RenditionVocab].
spread-auto
Specifies the Reading System can determine when to render a synthetic spread for the spine item.
spread-both
Specifies the Reading System should render a synthetic spread for the spine item in both portrait and landscape orientations.
spread-landscape
Specifies the Reading System should render a synthetic spread for the spine item only when in landscape orientation.
spread-none
Specifies the Reading System should not render a synthetic spread for the spine item.
spread-portrait
The spread-portrait property is deprecated in [EPUB3]. Refer to its definition in [Publications301] for more information.