DTBook to eBraille

Inputs

• Media-type:

  • application/xml
  Sequence: yes
• DTBook
  The 2005-3 DTBook or NIMAS file to be transformed.
  Media-type:

  • application/x-dtbook+xml
  Sequence: no
• Attach CSS style sheets
  CSS style sheet(s) to be attached with the HTML documents of the eBraille publication.

  CSS style sheet(s) to be attached with the HTML documents of the eBraille publication.

  The style sheets are associated with each HTML file through link elements. This script does not allow specifying media attributes on the link elements. If media queries are needed, they must be specified in the CSS itself, through @media and @import rules.

  The style sheets are included as-is, and should therefore apply to HTML, not DTBook.

  Media-type:

  • text/css
  • text/x-scss
  Sequence: yes

Reports

• Validation reports

Outputs

• eBraille
  The resulting eBraille publication.
  Media-type:

  • text

Options

• Braille transcription style sheet parameters
  A list of parameters passed to the braille transcription style sheets.

  A list of parameters passed to the braille transcription style sheets.

  Style sheets, whether they’re user style sheets (specified with the “Braille transcription style sheets” option) 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: ()
• Validation
  Whether to abort on validation issues.
  Possible values: One of the following:

  off

  No validation

  report

  Report validation issues

  abort

  Abort on validation issues

  Default value: report
• Braille transcription style sheets
  A list of CSS/Sass style sheets to take into account for braille transcription.

  A list of CSS/Sass style sheets to take into account for braille transcription.

  Must be a space separated list of URIs, absolute or relative to the input.

  Note that any CSS provided through this option will not end up in the eBraille publication. The “Attach CSS style sheets” option should be used for that purpose.

  Style sheets specified through this 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 “braille” media are taken into account. Styles that do not influence the braille transcription, are ignored.

  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.

  Style sheets are interpreted according to braille CSS rules.

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

  Possible values: <anyURI>
  Default value:
• NIMAS input
  Whether the input DTBook is a NIMAS 1.1-conformant XML content file.
  Possible values: true or false
  Default value: false
• Include original text
  Include the original text as a secondary rendition.
  Possible values: Any <string>
  Default value: false()
• Package in EPUB container
  Whether to package the eBraille publication in an EPUB 3-compatible container, or store it unzipped.

  Whether to package the eBraille publication in an EPUB 3-compatible container, or store it unzipped.

  When packaged in an EPUB container, the output is a single file with file extension .ebrl. When stored unzipped, the eBraille file set is contained in a directory.

  Possible values: Any <string>
  Default value: false()
• 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: