Step epub3-create-package-doc {http://www.daisy.org/ns/pipeline/xproc}

Create a EPUB Package Document

Defined in: http://www.daisy.org/pipeline/modules/epub-utils/library.xpl

Input Ports

Port Description
source.fileset primary
source.in-memory sequence

Files to be included in the publication: content documents, media overlay documents and other resources.

If this fileset includes a navigation document, it should be marked with a role attribute with value nav, and this file should be a content document. At most one navigation document may be specified. If no navigation document is specified, the content document that contains a nav[@epub:type='toc'] element is picked. It is an error if there is no such document.

If the fileset includes a cover-image, it should be marked with a role attribute with value cover-image.
spine sequence

Fileset that will make up the primary spine items.

The order of the spine items is determined by the "source.fileset" input. Items that are not content documents are omitted.

If not specified, defaults to all content documents except the navigation document.

The content documents in "source.fileset" that are not in "spine" and are not the navigation document become auxiliary spine items.
metadata sequence

Sequence of metadata elements in the OPF namespace from which the metadata element for the package document will be constructed.

Will be augmented with "duration" metadata that is extracted from the media overlay documents and other automatically generated metadata.

If not specified, a metadata element with the minimal required metadata will be included.
bindings sequence

Fileset from which to contruct the bindings element of the package document.

Ignored if compatibility-mode is not true.

Output Ports

Port Description
result primary

The package document.
result.fileset

The result fileset with the package document as single file.

Options

Local Name Namespace URI Default Description
compatibility-mode 'true'

Whether to be backward compatible with Open Package Format 2.0.1.
detect-properties 'true'

Whether to automatically detect manifest item properties:

    mathml: when a document contains instances of MathML markup
    remote-resources: when a document contains references to other publication resources that are located outside of the EPUB container
    scripted: when a document is a scripted content document (contains scripted content and/or elements from HTML5 forms)
    svg: when a document is a SVG content document or contains instances of SVG markup
    switch: when a document contains epub:switch elements
reserved-prefixes ''

The reserved prefix mappings of the resulting package document. By default, prefixes are declared systematically.

output-base-uri required

The base URI of the result document.