OBFL to braille

Inputs

• Input OBFL
  The OBFL document to convert.

  The OBFL document to convert.

  An OBFL (Open Braille Formatting Language) document describes how text is to be formatted and transcribed to braille. The text may also have been transcribed to braille already.

  The typical use case is when the “OBFL” output of one of the braille production scripts has been edited, and needs to be transformed to a formatted braille document.

  The following special metadata (meta) fields in the “http://www.daisy.org/ns/pipeline/” namespace are supported:

  • style-type (supported value: “text/css”): specifies the media type of style elements. The value “text/css” indicates that the styles (name attributes) are to be interpreted according to braille CSS rules.
  • css-text-transform-definitions: zero or more @-daisy-text-transform at-rules containing custom text transformation definitions, available for use in -daisy-text-transform properties in CSS styles. May be used e.g. to switch between braille codes, or to apply emphasis.
  • css-hyphenation-resource-definitions: zero or more @-daisy-hyphenation-resource at-rules containing custom hyphenation resource definitions for specific languages.
  • css-counter-style-definitions: zero or more @counter-style at-rules containing custom counter style definitions, available for use in -dotify-counter-style properties.
  • default-mode: specifies the overall braille transcription mode/policy, i.e. the mode to be used when no translate attribute has been set, or when it has been set to the empty value. Both the default-mode meta field and the translate attribute support the braille transformer query syntax.
  • braille-charset: specifies the braille character set that is used to encode braille present in the OBFL. If not specified, Unicode braille is assumed.
  Media-type:

  • application/x-obfl+xml
  Sequence: no

Outputs

• Preview
  An HTML preview of the braille result.
  Media-type:

  • text/html
• PEF
  The intermediary PEF file.
  Media-type:

  • application/x-pef+xml
• Output file
  The output braille file.
  Media-type:

  • text
• PDF
  A PDF version of the braille showing ASCII braille.
  Media-type:

  • application/pdf

Options

• 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:
• Include PDF
  Whether or not to include a PDF version of the braille result showing ASCII braille.
  Possible values: true or false
  Default value: false
• 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
• Include preview
  Whether or not to include a HTML preview of the braille result.
  Possible values: true or false
  Default value: false
• 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
• 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: