Step html-to-epub3 {http://www.daisy.org/ns/pipeline/xproc}

Defined in: http://www.daisy.org/pipeline/modules/html-to-epub3/library.xpl

Input Ports

PortDescription
input.fileset primary
input.in-memory sequence

Input HTML document(s) and resources

If the fileset includes a navigation document, it should be marked with a role attribute with value nav, and it should be a HTML document. At most one navigation document may be specified. If no navigation document is specified, one is generated from all the HTML documents.

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

metadata sequence

Metadata

tts-config

TTS configuration file

Configuration file with voice mappings, PLS lexicons and annotations.

Output Ports

PortDescription
fileset.out primary
in-memory.out sequence

The EPUB 3 publication (not zipped)

status

Status of the TTS step and EPUB validation.

A result attribute indicates whether both the TTS step and the EPUB validation were successful ("ok"), or whether at least one of them failed ("error").

A tts-success-rate attribute contains the percentage of the input text that got successfully converted to speech.

temp-audio-files

List of audio files

List of audio files generated by the TTS step. May be deleted when the result fileset is stored.

tts-log sequence

Options

Local NameNamespace URIDefaultDescription
stylesheet''

CSS style sheets as space separated list of absolute URIs.

lexicon()

PLS lexicons as list of absolute URIs.

include-tts-log'false'

Whether or not to make the TTS log available on the "tts-log" port.

output-dir required

Root directory of the (expanded) EPUB 3.

temp-dir''

Empty directory dedicated to this conversion. May be left empty in which case temporary directories will be automatically created where needed.

output-validation'off'
skip-cleanup'false'

Skip the HTML upgrade and clean up steps.

audio'false'

Enable TTS

Whether to use a speech synthesizer to produce audio files.

audio-file-type'audio/mpeg'

The desired file type of the generated audio files, specified as a MIME type.

Examples:

  • "audio/mpeg"
  • "audio/x-wav" (but note that this is not a core media type)
process-css'true'

Set to false to bypass aural CSS processing.