8.4 EPUB step

Splits input XHTML document, whether styled or semantic, into several pages and packages these pages as an EPUB 2 book. The result of the this step is the file containing the EPUB book.

No tab expansion for EPUB 2

By default, when generating styled HTML (that is, XHTML+CSS), some JavaScript™ code (w2x_install_dir/xed/expand-tabs.js) is added to the output file. This code computes and gives a width to all <span class=”role-tab> </span>. This allows to decently emulate tab stops in any modern Web browser. More information in About tab stops.

However, this cannot work in the case of the EPUB 2 output format because scripting is disabled in the styled HTML pages comprising an EPUB book.

Same parameters as the Split step, plus the following EPUB specific parameters (for clarity, the “epub.” parameter name prefix is omitted here):

Name	Value	Description
cover-image-url-or-file	An absolute URL or a filename. A relative filename is relative to the current working directory. Default: none (no cover page).	Specifies an image file which is to be used as the cover page of the EPUB book. This image must be a PNG or JPEG image. Its size must not exceed 1000x1000 pixels.
default-lang	A language code conforming RFC 3066. Examples: de, fr-CA. Default value: en.	Main language of the EPUB book. This parameter is used only when this language cannot be determined by examining the input styled XHTML document.
identifier	String. Default: dynamically generated UUID URN.	A globally unique identifier for the generated EPUB book (typically the permanent URL of the EPUB book).
omit-toc-root	“yes” \| “no” Default: “no”.	By default, the TOC generated for an EPUB document has a single “root”. This single root always points to the page containing the title, subtitle, author, etc, of the document. Setting this parameter to “yes” prevents the generated TOC from having such single root.
out-file	A file path. No default (required).	Specifies the path of the EPUB book. A relative file path is relative to the current working directory.

Name

Value

Description

cover-image-url-or-file

An absolute URL or a filename. A relative filename is relative to the current working directory.

Default: none (no cover page).

Specifies an image file which is to be used as the cover page of the EPUB book. This image must be a PNG or JPEG image. Its size must not exceed 1000x1000 pixels.

default-lang

A language code conforming RFC 3066. Examples: de, fr-CA. Default value: en.

Main language of the EPUB book. This parameter is used only when this language cannot be determined by examining the input styled XHTML document.

identifier

String.

Default: dynamically generated UUID URN.

A globally unique identifier for the generated EPUB book (typically the permanent URL of the EPUB book).

omit-toc-root

“yes” | “no”

Default: “no”.

By default, the TOC generated for an EPUB document has a single “root”. This single root always points to the page containing the title, subtitle, author, etc, of the document. Setting this parameter to “yes” prevents the generated TOC from having such single root.

out-file

A file path.

No default (required).

Specifies the path of the EPUB book. A relative file path is relative to the current working directory.