Skip to content

Latest commit

 

History

History
1100 lines (1060 loc) · 42.8 KB

epub-properties-use.md

File metadata and controls

1100 lines (1060 loc) · 42.8 KB

Candidate Recommendation Exit Criteria

The EPUB Working Group intends to exit the Candidate Recommendation stage and submit the EPUB 3.3 specification for consideration as a W3C Proposed Recommendation after documenting implementation of each feature.

For this specification to advance to Proposed Recommendation, it has to be proven that metadata defined and required in this specification have sufficient usage by the target communities. This metadata falls into two categories:

  1. metadata for expressing information about the publication in the package document; and
  2. metadata for expressing preferred rendering of the content

Usage of these properties, as listed in the following tables, means that the organizations regularly include the metadata in the package document (for publishers) or use them in bookshelves, content rendering, etc. (for reading system developers).

Publisher Implementations

Meta Properties Vocabulary

The following table lists organizations that have stated that they are currently using the meta properties in production.

Meta properties are expressed in the meta element's property attribute.

Property Used By
alternate-script
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • EDRLab (Thorium Reader)
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
authority
  • American Academy of Pediatrics
  • KnowledgeWorks Global Ltd.
belongs-to-collection
  • Advantage | ForbesBooks
  • BookFusion Inc
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
collection-type
  • Advantage | ForbesBooks
  • Liturgical Press
display-seq
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • KADOKAWA
  • Macmillan Learning
  • Moody Publishers
  • Pearson
  • Penguin Random House North America
  • Taylor & Francis
  • University of Minnesota Press
  • University of Nebraska Press
  • VitalSource Technologies, LLC
  • Wiley
file-as
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • Amnet
  • Carson Dellosa Education
  • Chicago Distribution Center
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • KADOKAWA
  • Lerner Publishing Group
  • Moody Publishers
  • Pearson
  • Penguin Random House North America
  • University of Minnesota Press
  • University of Nebraska Press
  • Wiley
group-position
  • BookFusion Inc
  • Liturgical Press
identifier-type
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • Amnet
  • BroadStreet Publishing Group LLC
  • Carson Dellosa Education
  • Charisma Media
  • Chicago Distribution Center
  • Consonance
  • Hachette Book Group
  • KnowledgeWorks Global Ltd.
  • Lerner Publishing Group
  • Macmillan Learning
  • new harbinger publications
  • Pearson
  • Taylor & Francis
  • The Quarto Group
  • University of Minnesota Press
  • University of Nebraska Press
  • Westchester Publishing Services
  • Wiley
meta-auth

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

role
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • Amnet
  • BroadStreet Publishing Group LLC
  • Carson Dellosa Education
  • Charisma Media
  • Chicago Distribution Center
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • Industrial Press, Inc.
  • KADOKAWA
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Macmillan Learning
  • Moody Publishers
  • Pearson
  • Penguin Random House North America
  • PRH UK
  • Simon & Schuster
  • Taylor & Francis
  • Teacher Created Materials
  • University of Minnesota Press
  • University of Nebraska Press
  • VitalSource Technologies, LLC
  • Westchester Publishing Services
  • Wiley
source-of
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • BookFusion Inc
  • Chicago Distribution Center
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Macmillan Learning
  • Pearson
  • Penguin Random House North America
  • Taylor & Francis
  • Westchester Publishing Services
  • Wiley
term
  • American Academy of Pediatrics
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • University of Nebraska Press
  • VitalSource Technologies, LLC
title-type
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • Amnet
  • BroadStreet Publishing Group LLC
  • Charisma Media
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Macmillan Learning
  • Pearson
  • Penguin Random House North America
  • Simon & Schuster
  • The Quarto Group
  • University of Minnesota Press
  • University of Nebraska Press
  • Westchester Publishing Services
  • Wiley

Link Vocabulary

Link Relationships

The following table lists organizations that have stated that they are currently using the link relationships in production.

Link relationships are expressed in the link element's rel attribute.

Property Used By
alternate
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
marc21xml-record

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

mods-record

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

onix-record

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

record
  • Advantage | ForbesBooks
  • Liturgical Press
  • Macmillan Learning
  • Taylor & Francis
voicing
  • KnowledgeWorks Global Ltd.
  • CYPAC/Voice of DAISY 5 version 5.7
xml-signature

This property deprecated and is no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

xmp-record

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

Link Properties

The following table lists organizations that have stated that they are currently using the link properties in production.

Link properties are expressed in the link element's properties attribute.

Property Used By
onix
  • Advantage | ForbesBooks
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Macmillan Learning
  • Taylor & Francis

Package Rendering Vocabulary

General Properties

The following table lists organizations that have stated that they are currently using the general package rendering properties in production.

General package rendering properties are expressed both globally in the meta element's property attribute and as overrides in the itemref element's properties attribute.

Property Used By
rendition:flow
  • Advantage | ForbesBooks
  • EDRLab (Thorium Reader)
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Pearson
  • VitalSource Technologies, LLC
rendition:flow-auto
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • VitalSource Technologies, LLC
rendition:flow-paginated
  • EDRLab (Thorium Reader)
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • VitalSource Technologies, LLC
rendition:flow-scrolled-continuous
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • VitalSource Technologies, LLC
rendition:flow-scrolled-doc
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • VitalSource Technologies, LLC
rendition:align-x-center
  • KnowledgeWorks Global Ltd.
  • VitalSource Technologies, LLC

Fixed-Layout Properties

The following table lists organizations that have stated that they are currently using the fixed-layout rendering properties in production.

Fixed-layout properties are expressed both globally in the meta element's property attribute and as overrides in the itemref element's properties attribute.

Property Used By
rendition:layout
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • Carson Dellosa Education
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Lee & Low Books
  • Lerner Publishing Group
  • Liturgical Press
  • Moody Publishers
  • Penguin Random House North America
  • PRH UK
  • Simon & Schuster
  • VitalSource Technologies, LLC
rendition:layout-pre-paginated
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Moody Publishers
  • Penguin Random House North America
  • Simon & Schuster
  • Teacher Created Materials
  • VitalSource Technologies, LLC
rendition:layout-reflowable
  • Advantage | ForbesBooks
  • Beaufort Books
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Penguin Random House North America
  • VitalSource Technologies, LLC
rendition:orientation
  • Amnet
  • Beaufort Books
  • Carson Dellosa Education
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Lerner Publishing Group
  • Moody Publishers
  • PRH UK
  • Simon & Schuster
  • VitalSource Technologies, LLC
  • Westchester Publishing Services
rendition:orientation-auto
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • Carson Dellosa Education
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America
  • Simon & Schuster
  • Teacher Created Materials
  • VitalSource Technologies, LLC
rendition:orientation-landscape
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America
  • Simon & Schuster
  • VitalSource Technologies, LLC
rendition:orientation-portrait
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Penguin Random House North America
  • Simon & Schuster
  • VitalSource Technologies, LLC
rendition:spread
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • Carson Dellosa Education
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Lee & Low Books
  • Lerner Publishing Group
  • Moody Publishers
  • Pearson
  • Penguin Random House North America
  • PRH UK
  • Simon & Schuster
  • Teacher Created Materials
  • VitalSource Technologies, LLC
  • Westchester Publishing Services
rendition:spread-auto
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • Carson Dellosa Education
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • KnowledgeWorks Global Ltd.
  • Moody Publishers
  • Penguin Random House North America
  • Simon & Schuster
  • VitalSource Technologies, LLC
rendition:spread-both
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America
  • VitalSource Technologies, LLC
rendition:spread-landscape
  • Advantage | ForbesBooks
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America
  • Simon & Schuster
  • VitalSource Technologies, LLC
rendition:spread-none
  • Advantage | ForbesBooks
  • Beaufort Books
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Moody Publishers
  • Penguin Random House North America
  • VitalSource Technologies, LLC
rendition:spread-portrait

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

rendition:page-spread-center
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • Consonance
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America
  • VitalSource Technologies, LLC
rendition:page-spread-left
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Penguin Random House North America
  • VitalSource Technologies, LLC
rendition:page-spread-right
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Penguin Random House North America
  • VitalSource Technologies, LLC
rendition:viewport

This property is deprecated and no longer recommended for use in EPUB publications. It is only listed for completeness of reporting.

Manifest Properties Vocabulary

The following table lists organizations that have stated that they are currently using the manifest properties in production.

Manifest properties are expressed in the item element's properties attribute.

Property Used By
cover-image
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • Carson Dellosa Education
  • Charisma Media
  • Chicago Distribution Center
  • Consonance
  • CYPAC/Voice of DAISY 5 version 5.7
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • House of Anansi Press/Groundwood Books
  • Industrial Press, Inc.
  • KADOKAWA
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Lee & Low Books
  • Lerner Publishing Group
  • Liturgical Press
  • Macmillan Learning
  • Moody Publishers
  • Pearson
  • Penguin Random House North America
  • PRH UK
  • Simon & Schuster
  • Taylor & Francis
  • Teacher Created Materials
  • The Quarto Group
  • University of Minnesota Press
  • University of Nebraska Press
  • VitalSource Technologies, LLC
  • W. W. Norton & Company, Inc. (Educational)
  • Westchester Publishing Services
  • Wiley
mathml
  • Amnet
  • KnowledgeWorks Global Ltd.
  • Macmillan Learning
  • Taylor & Francis
  • VitalSource Technologies, LLC
  • Westchester Publishing Services
  • Wiley
nav
  • Advantage | ForbesBooks
  • American Academy of Pediatrics
  • Amnet
  • Beaufort Books
  • BookFusion Inc
  • Carson Dellosa Education
  • Charisma Media
  • Chicago Distribution Center
  • Consonance
  • EDRLab (Thorium Reader)
  • Hachette Book Group
  • House of Anansi Press/Groundwood Books
  • Industrial Press, Inc.
  • KADOKAWA
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Lerner Publishing Group
  • Liturgical Press
  • Macmillan Learning
  • Moody Publishers
  • Pearson
  • Penguin Random House North America
  • PRH UK
  • Simon & Schuster
  • Taylor & Francis
  • Teacher Created Materials
  • The Quarto Group
  • University of Minnesota Press
  • University of Nebraska Press
  • VitalSource Technologies, LLC
  • Westchester Publishing Services
  • W. W. Norton & Company, Inc. (Educational)
  • Wiley
remote-resources
  • Carson Dellosa Education
  • KnowledgeWorks Global Ltd.
  • Macmillan Learning
  • VitalSource Technologies, LLC
  • W. W. Norton & Company, Inc. (Educational)
scripted
  • Advantage | ForbesBooks
  • Amnet
  • Hachette Book Group
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Macmillan Learning
  • Moody Publishers
  • Penguin Random House North America
  • Taylor & Francis
  • VitalSource Technologies, LLC
  • W. W. Norton & Company, Inc. (Educational)
  • Westchester Publishing Services
svg
  • Advantage | ForbesBooks
  • Amnet
  • Consonance
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Liturgical Press
  • Macmillan Learning
  • Moody Publishers
  • Penguin Random House North America
  • Taylor & Francis
  • VitalSource Technologies, LLC
  • Westchester Publishing Services
switch

This property indicates that the deprecated switch element is present. It is only listed for completeness of reporting.

Spine properties vocabulary

The following table lists organizations that have stated that they are currently using the spine properties in production.

Spine properties are expressed in the itemref element's properties attribute.

Property Used By
page-spread-left
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • Consonance
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Lee & Low Books
  • Lerner Publishing Group
  • Liturgical Press
  • Penguin Random House North America
  • PRH UK
  • Teacher Created Materials
  • VitalSource Technologies, LLC
page-spread-right
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • Consonance
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KADOKAWA
  • KnowledgeWorks Global Ltd.
  • Lee & Low Books
  • Lerner Publishing Group
  • Liturgical Press
  • Penguin Random House North America
  • PRH UK
  • Teacher Created Materials
  • VitalSource Technologies, LLC

Media Overlays Vocabulary

The following table lists organizations that have stated that they are currently using the Media Overlays properties in production.

Media Overlays properties are expressed in the meta element's property attribute.

Property Used By
active-class
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • Kaplan North America, LLC
  • KnowledgeWorks Global Ltd.
  • Lerner Publishing Group
  • Liturgical Press
  • Penguin Random House North America
  • Teacher Created Materials
duration
  • Advantage | ForbesBooks
  • Amnet
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • House of Anansi Press/Groundwood Books
  • KnowledgeWorks Global Ltd.
  • Lerner Publishing Group
  • Penguin Random House North America
  • Teacher Created Materials
narrator
  • Advantage | ForbesBooks
  • Amnet
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America
playback-active-class
  • Advantage | ForbesBooks
  • BookFusion Inc
  • EDRLab (Thorium Reader)
  • KnowledgeWorks Global Ltd.
  • Penguin Random House North America

Validation and Authoring Tool Implementations

Where machine-testable assertions are made about the use of this metadata, conformance is checked by EPUBCheck. In particular, it is able to determine if authors have not set manifest properties correctly.