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

EPUB 3 to braille

Transforms a EPUB 3 publication into an embosser ready braille document.

Online documentation
Defined in: http://www.daisy.org/pipeline/modules/braille/epub3-to-pef/epub3-to-pef.xpl

Output Ports

Port Description
validation-status primary

Options

Local Name Namespace URI Default Description
source required

Input EPUB 3

The EPUB you want to convert to braille. You may alternatively use the EPUB package document (the OPF-file) if your input is a unzipped/"exploded" version of an EPUB.

preamble ''

Preamble HTML

An HTML file to be prepended to the EPUB spine.

stylesheet

A number of [partials](https://sass-lang.com/documentation/at-rules/import#partials) (helper style sheet modules) are available for use in Sass style sheets: - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_generate-toc.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/_generate-toc.scss/): for generating a table of content - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_tables.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/tables): for styling tables - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_definition-lists.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/definition-lists): for styling definition lists - [http://www.daisy.org/pipeline/modules/braille/html-to-pef/_legacy.scss](http://daisy.github.io/pipeline/modules/braille/html-to-pef/src/main/resources/css/_legacy.scss/): collection of styles that used to be included by default

apply-document-specific-stylesheets 'false'

Apply document-specific CSS

If this option is enabled, any pre-existing CSS in the EPUB with media "embossed" (or "all") will be used. The input EPUB may already contain CSS that applies to embossed media. Such document-specific CSS takes precedence over any CSS attached when running this script. For instance, if the EPUB already contains the rule `p { padding-left: 2; }`, and using this script the rule `p#docauthor { padding-left: 4; }` is provided, then the `padding-left` property will get the value `2` because that's what was defined in the EPUB, even though the provided CSS is more specific.

stylesheet-parameters
braille-code
transform
include-preview
include-pef
include-obfl
output-file-format
preview-table
page-width
page-height
duplex
hyphenation
line-spacing
hyphenation-at-page-breaks
allow-text-overflow-trimming
force-braille-page-break
maximum-number-of-sheets
allow-volume-break-inside-leaf-section-factor
prefer-volume-break-before-higher-level-factor
notes-placement
result
pef
preview
obfl
temp-dir required