EPUB to DAISY

Inputs

• Text-to-speech configuration file
  Configuration file for text-to-speech.

  Configuration file for text-to-speech.

  More details on the configuration file format.

  Media-type:

  • application/vnd.pipeline.tts-config+xml
  Sequence: no
• EPUB Publication
  The EPUB 2 or EPUB 3 you want to transform.

  The EPUB 2 or EPUB 3 you want to transform.

  You may alternatively use the “mimetype” document if your input is a unzipped/”exploded” version of an EPUB.

  Media-type:

  • application/epub+zip
  • application/oebps-package+xml
  Sequence: no

Reports

• Validation reports

Outputs

• Intermediary EPUB 3 with media-overlays
• DAISY 2.02
• DAISY 3

Options

• Perform text-to-speech
  Whether to use a speech synthesizer to produce media overlays.

  Whether to use a speech synthesizer to produce media overlays.

  This will remove any existing media overlays in the EPUB.

  Possible values: One of the following:

  true

  Yes

  false

  No

  default

  If publication has no media overlays yet

  Default value: default
• 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 with the “stylesheet” option) or author style sheets (associated with the source), may have parameters (Sass variables). The “stylesheet-parameters” 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:
• Style sheets
  A list of CSS style sheets to take into account.

  A list of CSS style sheets to take into account.

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

  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 “speech” 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.

  Possible values: <anyURI>
  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: off
• Lexicons
  A list of PLS lexicons to take into account.

  A list of PLS lexicons to take into account.

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

  Lexicons can also be attached to the source document, using a ‘link’ element.

  PLS lexicons allow you to define custom pronunciations of words. It is meant to help TTS processors deal with ambiguous abbreviations and pronunciation of proper names. When a word is defined in a lexicon, the processor will use the provided pronunciation instead of the default rendering.

  The syntax of a PLS lexicon is defined in Pronunciation Lexicon Specification (PLS) Version 1.0, extended with regular expression matching. To enable regular expression matching, add the “regex” attribute, as follows:

  <lexicon xmlns="http://www.w3.org/2005/01/pronunciation-lexicon" version="1.0"
           alphabet="ipa" xml:lang="en">
    <lexeme regex="true">
      <grapheme>([0-9]+)-([0-9]+)</grapheme>
      <alias>between $1 and $2</alias>
    </lexeme>
  </lexicon>
  

  The regex feature works only with alias-based substitutions. The regex syntax used is that from XQuery 1.0 and XPath 2.0.

  Whether or not the regex attribute is set to “true”, the grapheme matching can be made more accurate by specifying the “positive-lookahead” and “negative-lookahead” attributes:

  <lexicon version="1.0" xmlns="http://www.w3.org/2005/01/pronunciation-lexicon"
           alphabet="ipa" xml:lang="en">
    <lexeme>
      <grapheme positive-lookahead="[ ]+is">SB</grapheme>
      <alias>somebody</alias>
    </lexeme>
    <lexeme>
      <grapheme>SB</grapheme>
      <alias>should be</alias>
    </lexeme>
    <lexeme xml:lang="fr">
      <grapheme positive-lookahead="[ ]+[cC]ity">boston</grapheme>
      <phoneme>bɔstøn</phoneme>
    </lexeme>
  </lexicon>
  

  Graphemes with “positive-lookahead” will match if the beginning of what follows matches the “position-lookahead” pattern. Graphemes with “negative-lookahead” will match if the beginning of what follows does not match the “negative-lookahead” pattern. The lookaheads are case-sensitive while the grapheme contents are not.

  The lexemes are matched in this order:

  1. Graphemes with regex=”false” come first, no matter if there is a lookahead or not;
  2. then come graphemes with regex=”true” and no lookahead;
  3. then graphemes with regex=”true” and one or two lookaheads.

  Within these categories, lexemes are matched in the same order as they appear in the lexicons.

  Possible values: <anyURI>
  Default value: p:system-property('d:org.daisy.pipeline.tts.default-lexicon')