EPUB Manifest Role

Initial Editor's Draft 2014-04-23

This version:

http://www.idpf.org/epub/vocab/package/roles/manifest/manifest-20140423.html

Latest version:

http://www.idpf.org/epub/vocab/package/roles/manifest/

Previous version:

N/A

Copyright © 2014 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.

Editors

Hadrien Gardeur  (Feedbooks), Markus Gylling (IDPF), Matt Garrish (Invited Expert)

Status of this Document

This document is an initial editor's draft produced by the IDPF EPUB 3 Working Group. It  is a work in progress and subject to change.

Table of Contents

1. Overview

1.1 Purpose and Scope

This section is informative

This specification, EPUB Manifest Role, defines the requirements for including a manifest of resources necessary for the processing and rendering of a collection [Publications301]  in an EPUB ®  Publication .

1.2 Terminology

Refer to the EPUB Specifications  for definitions of EPUB-specific terminology used in this document.

1.3 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. Manifest Collection

2.1 Introduction

A manifest collection  is similar in nature to the Package Document manifest   [Publications301] , but typically identifies a subset of Publication Resources necessary for the rendering of a specific feature of the EPUB Publication.

For example, while the primary purpose of a preview collection   [Previews]  is to identify the EPUB Content Documents containing the sample content, a Reading System also needs to know the style sheets, images and other resources used in rendering in order to effectively extract the preview for viewing. The manifest collection  allows these additional resources to be easily identified.

2.2 Format

A collection  element's role  attribute must  be set to the value " manifest " to indicate that it contains a manifest.

Each manifest collection   must  contain only one or more link  elements, where the IRI contained in each link  element's href  attribute must reference the location of a required resource. Specific implementations of the manifest collection   may  set restrictions on the types of resources that can be referenced.

The following example shows a possible manifest collection  for one chapter of an EPUB Publication.

<collection role="manifest">
	<link href="chap01.html" type="application/xhtml+xml"/>
	<link href="main.css" type="text/css"/>
	<link href="interface.css" type="text/css"/>
	<link href="c01img01.jpg" type="image/jpeg"/>
	<link href="c01img02.jpg" type="image/jpeg"/>
	<link href="c01vid01.mp4" type="video/mp4"/>
</collection>

The link  element children represent the set of Publication Resources necessary for processing the parent collection . The manifest collection   should  include a complete set of resources, including all Content Documents listed in the parent, but specific implementations of the collection   may  specify otherwise.

A manifest collection   must  be the child of another collection , and each collection   should  include only a maximum of one manifest collection .

References

Normative References

[Previews] EPUB Previews .

[Publications301] EPUB Publications 3.0.1 .

[RFC2119] Key words for use in RFCs to Indicate Requirement Levels  (RFC 2119) . March 1997.
http://www.idpf.org/epub/vocab/package/roles/manifest/manifest-20140423.html
www.idpf.org
crawl=CC-MAIN-2017-43
17588
application/http; msgtype=response
sha1:F2UK4PP5HGTB4PN24CH6UGXWEN3ORS5V
<urn:uuid:1b1f3f20-d88e-493c-998f-c3e450222e9c>
2017-10-19T07:19:16Z
97.74.72.216
text/html
sha1:P4VSPIIOI5NB3D55JRWJZ7CTI7LAIU54
<urn:uuid:451f1459-c5fe-4a96-837e-65f9c3675804>
http://www.idpf.org/epub/vocab/package/roles/manifest/manifest-20140423.html
response
<urn:uuid:42d2e410-d337-453d-a70f-a688a73a39d5>
robots: classic
hostname: ip-10-157-174-116.ec2.internal
software: Nutch 1.6 (CC)
isPartOf: CC-MAIN-2017-43
operator: Common Crawl Admin
description: Wide crawl of the web for October 2017
publisher: Common Crawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf