EPUB to braille

Inputs

• Input EPUB
  The EPUB you want to convert to braille.

  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.

  Media-type:

  • application/epub+zip
  • application/oebps-package+xml
  Sequence: no
• Preamble HTML
  An HTML file to be prepended to the EPUB spine.
  Media-type:

  • application/xhtml+xml
  • text/html
  Sequence: no

Outputs

• HTML with inline CSS
  The intermediary HTML file with inline CSS.
  Media-type:

  • application/xhtml+xml
• PEF
  The intermediary PEF file.
  Media-type:

  • application/x-pef+xml
• Preview
  An HTML preview of the braille result.
  Media-type:

  • text/html
• Output file
  The output braille file.
  Media-type:

  • text
• OBFL
  The intermediary OBFL file.
  Media-type:

  • application/x-obfl+xml

Options

• Page height
  The height of the targeted medium.

  The height of the targeted medium.

  Sets the default page height, and affects media queries that use the ‘height’ and ‘device-height’ media features. The ‘height’ media feature describes the height of the targeted display area, i.e. the printable area of the page. The ‘device-height’ media feature describes the total height of the rendering surface, i.e. the page height.

  The height may be specified in an absolute (mm, cm, in, …) or cell-relative (em) length. A dimension without a unit is interpreted as a multiple of the braille cell height.

  See the CSS specification for more info:

  • the @page rule
  • the size property
  • the page dimensions media features
  Possible values: A length

  The syntax is as follows (described in terms of CSS grammar):

  length
   : number unit?
   ;
  unit
   : 'mm' | 'cm' | 'in' | 'px' | 'em'
   ;
  

  Default value: ()
• Style sheet parameters
  A list of parameters passed to the style sheets.

  A list of parameters passed to the style sheets.

  Style sheets, whether they’re user style sheets (specified through options) or author style sheets (associated with the source), may have parameters (Sass variables). This option, which takes a comma-separated list of key-value pairs enclosed in parenthesis, can be used to set these variables.

  For example, if a style sheet uses the Sass variable “foo”:

  @if $foo {
     /* some style that should only be enabled when "foo" is truthy */
  }
  

  you can control that variable with the following parameters list: (foo:true).

  Possible values: <stylesheet-parameters>
  Default value: ()
• Saddle stitch (folio binding)
  Whether the targeted medium is bound in folios.

  Whether the targeted medium is bound in folios.

  In this mode, sheets of paper are folded once to produce two leaves (four pages). This option affects media queries that use the ‘-daisy-saddle-stitch’ media feature.

  Possible values: Any <string>
  Default value: ()
• Duplex
  Whether to print on both sides of the leaves.

  Whether to print on both sides of the leaves.

  Sets the number of printed sides per leaf, and affects media queries that use the ‘-daisy-duplex’ media feature.

  Possible values: Any <string>
  Default value: ()
• Output file format
  The file format in which to store the braille result.

  The file format in which to store the braille result.

  The file format must be expressed in the media query syntax. For example, to select a file format suited for the U.S., set the option to (-daisy-locale: en-US). To use the braille character set used in the Netherlands and store to a file with extension “.brl”, set the option to (-daisy-locale: nl) AND (-daisy-file-extension: \.brl).

  If left blank, the braille will be stored in PEF (Portable Embosser Format).

  Possible values: <medium>
  Default value:
• Apply document-specific CSS
  If this option is enabled, any pre-existing CSS in the EPUB with media "embossed" (or "all") will be used.

  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.

  Possible values: true or false
  Default value: false
• Include HTML with inline CSS
  Whether or not the include the intermediary HTML with all CSS styles inlined (for debugging).
  Possible values: true or false
  Default value: false
• Include preview
  Whether or not to include a HTML preview of the braille result.
  Possible values: true or false
  Default value: false
• Include OBFL
  Whether or not the keep the intermediary OBFL file (for debugging).

  Whether or not the keep the intermediary OBFL file (for debugging).

  OBFL (Open Braille Formatting Language) is an internal data format used by DAISY Pipeline to represent an intermediary stage of the document being transformed (before it is formatted).

  The OBFL file may be used for debugging, or it may also be edited and re-transformed to the final braille document using the “OBFL to braille” script.

  Possible values: true or false
  Default value: false
• Page width
  The width of the targeted medium.

  The width of the targeted medium.

  Sets the default page width, and affects media queries that use the ‘width’ and ‘device-width’ media features. The ‘width’ media feature describes the width of the targeted display area, i.e. the printable area of the page. The ‘device-width’ media feature describes the total width of the rendering surface, i.e. the page width.

  Note that the default page width may be overwritten with @page rules, but this does not affect media queries.

  The width may be specified in an absolute (mm, cm, in, …) or cell-relative (ch) length. A dimension without a unit is interpreted as a multiple of the braille cell width.

  See the CSS specification for more info:

  • the @page rule
  • the size property
  • the page dimensions media features
  Possible values: A length

  The syntax is as follows (described in terms of CSS grammar):

  length
   : number unit?
   ;
  unit
   : 'mm' | 'cm' | 'in' | 'px' | 'ch'
   ;
  

  Default value: ()
• Braille code
  Braille code to be used for braille transcription.

  Braille code to be used for braille transcription.

  If set, braille transcription is done using the selected braille code. If left empty, the braille code is determined by the document language. Note that braille transcription can also be controlled through CSS @text-transform rules.

  Possible values: <liblouis-table-query>
  Default value:
• Style sheets
  CSS/Sass style sheets to take into account.

  CSS/Sass style sheets to take into account.

  Each style sheet must be specified as a URI, absolute or relative to the input.

  Style sheets specified through this option or through the “Formatting standard” option are called “user style sheets”. Style sheets can also be attached to the source document. These are referred to as “author style sheets”. They can be linked (using an ‘xml-stylesheet’ processing instruction or a ‘link’ element), embedded (using a ‘style’ element) and/or inlined (using ‘style’ attributes). Only author styles that apply to “embossed” media are taken into account.

  All style sheets are applied at once, but the order in which they are specified has an influence on the cascading order. Author styles take precedence over user styles, and user style sheets specified through this option take precedence over the selected formatting standard.

  Style sheets are interpreted according to braille CSS rules.

  For info on how to use Sass (Syntactically Awesome StyleSheets) see the Sass manual.

  A number of 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: for generating a table of content
  • http://www.daisy.org/pipeline/modules/braille/html-to-pef/_tables.scss: for styling tables
  • http://www.daisy.org/pipeline/modules/braille/html-to-pef/_definition-lists.scss: for styling definition lists
  • http://www.daisy.org/pipeline/modules/braille/html-to-pef/_legacy.scss: collection of styles that used to be included by default
  Possible values: <anyURI>
  Default value:
• Hyphenation at page boundaries
  Whether hyphenation of words at page boundaries is allowed or not.

  Whether hyphenation of words at page boundaries is allowed or not.

  This option only determines whether hyphenation is allowed at page boundaries. The “Hyphenation” option and the CSS determine how the hyphenation is done, when allowed.

  Possible values: One of the following:

  false

  Never hyphenate words at page boundaries

  except-at-volume-breaks

  Allow hyphenation at page boundaries except when it's a volume boundary

  true

  Allow hyphenation at page boundaries

  Default value: false
• Transformer features
  Features of the braille transformer.

  Features of the braille transformer.

  Features of the braille transformer to be used for creating the paginated braille document from the CSS styled input document. Together with the “Braille code” option this determines the transformer that is selected.

  Possible values: A query

  The syntax is as follows (described in terms of CSS grammar):

  query
   : feature*
   ;
  feature
   : '(' S* IDENT S* [ ':' S* value ]? ')' S*
   ;
  value
   : string | integer | IDENT
   ;
  

  Default value: (translator:liblouis)(formatter:dotify)
• Formatting standard
  Standard to be used for braille formatting.

  Standard to be used for braille formatting.

  If set, braille formatting is done using the selected formatting standard. If left empty, the formatting of the document is determined entirely by custom styles.

  It is important to understand that when no formatting standard or custom style sheets are specified, the output will not be formatted (meaning everything will be aligned to the left, without blank lines, pages will be filled completely, and there will be no page numbering).

  Custom formatting rules may be specified using the “Custom style sheets” option, or in style sheets attached to the source document.

  Possible values: One of the following:

  -

  https://raw.githubusercontent.com/daisy/braille-stylesheets/refs/heads/main/bana/bana.scss

  United States and Canada (BANA)

  The document is formatted according to the rules of the Braille Authority of North America (BANA). UEB is used as the braille code for all text.

  Equivalent to specifying the value https://raw.githubusercontent.com/daisy/braille-stylesheets/refs/heads/main/bana/bana.scss for the “Custom style sheets” option.

  See the online documentation for more information.

  Default value:
• Trimming of overflowing text
  Allow trimming of overflowing text.

  Allow trimming of overflowing text.

  By default, text that overflows its containing box will result in an error. By selecting this option, overflowing text will be truncated and generate a warning instead whenever possible. Notably, this will happen with text within page margins (top, right, bottom and left) that is too long to fit the space.

  Possible values: true or false
  Default value: false
• Include PEF
  Whether or not to keep the intermediary PEF file (for debugging).

  Whether or not to keep the intermediary PEF file (for debugging).

  PEF (Portable Embosser Format) is an internal data format used by DAISY Pipeline to represent the final formatted braille document, before it is converted to another embosser-ready format.

  Possible values: true or false
  Default value: false
• ASCII braille table for HTML preview
  The ASCII braille table used to render the HTML and PDF previews.

  The ASCII braille table used to render the HTML and PDF previews.

  If left blank, the locale information in the input document will be used to select a suitable table.

  Possible values: <preview-table>
  Default value: