xml.xproc.html-to-epub3.convert.xpl Maven / Gradle / Ivy
Transforms XHTML into an EPUB 3 publication.
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
TTS configuration file
Configuration file with voice mappings, PLS lexicons and annotations.
CSS style sheets as space separated list of absolute URIs.
PLS lexicons as list of absolute URIs.
The EPUB 3 publication (not zipped)
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.
List of audio files
List of audio files generated by the TTS step. May be deleted when the
result fileset is stored.
Whether or not to make the TTS log available on the "tts-log" port.
Root directory of the (expanded) EPUB 3.
Empty directory dedicated to this conversion. May be left empty in which
case temporary directories will be automatically created where needed.
Determines whether to validate the EPUB output and what to do on validation
errors. Defaults to 'off'.
Skip the HTML upgrade and clean up steps.
Enable TTS
Whether to use a speech synthesizer to produce audio files.
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)
Set to false to bypass aural CSS processing.
px:epub3-safe-uris
px:epub3-ensure-core-media
px:epub3-add-navigation-doc
px:epub3-create-mediaoverlays
px:epub3-create-package-doc
px:epub3-ocf-finalize
px:epub-validate
px:set-base-uri
px:fileset-load
px:fileset-join
px:fileset-rebase
px:fileset-purge
px:fileset-update
px:fileset-filter-in-memory
px:fileset-add-entry
px:assert
px:html-fixer
px:html-upgrade
px:diagram-to-html
px:tts-for-epub3
px:html-to-opf-metadata
pf:longest-common-uri
Move to EPUB/ directory
Remove resources that do not exist on disk or in memory
Also normalizes @href, @original-href and @xml:base
Change @href with EPUB-safe URIs
Upgrade to XHTML 5
Clean http-equiv
Set language
Fix content models
Clean outline
Fix doctype
Clean resource references
Generate the EPUB 3 navigation document
Add SMIL and audio files
Generate SMIL files and copy audio files
Extract metadata
Generate the EPUB 3 package document
Remove files from memory that are not in fileset
Validation EPUB
application/epub+zip