DTBook to DAISY 3

Inputs

• DTBook file
  The 2005-3 DTBook file to be transformed.
  Media-type:

  • application/x-dtbook+xml
  Sequence: no
• 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

Outputs

• DAISY 3
  The resulting DAISY 3 publication.
• TTS log
  Log file with information about text-to-speech process.

Options

• Detect words
  Whether to detect and mark up words with `<w>` tags.

  Whether to detect and mark up words with `` tags.

  By default word detection is performed but an option is provided to disable it because some DAISY 3 reading systems can’t handle the word tags.

  </div> </div>

  Possible values: true or false

  Default value: true

  </li>
• Enable text-to-speech
  Whether to use a speech synthesizer to produce audio files.
  Possible values: true or false
  Default value: false
• 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:
• Enable TTS log
  Whether or not to make the TTS log available.

  Whether or not to make the TTS log available.

  The TTS log contains a great deal of additional information that is not present in the main job log and that is helpful for troubleshooting. Most of the log entries concern particular chunks of text of the input document.

  The default can be changed using the org.daisy.pipeline.tts.log property.

  Possible values: true or false
  Default value: p:system-property('d:org.daisy.pipeline.tts.log')
• Publisher
  The agency responsible for making the Digital Talking Book available. If left blank, it will be retrieved from the DTBook meta-data.
  Possible values: Any <string>
  Default value:
• With text
  Includes DTBook in output, as opposed to audio only.
  Possible values: true or false
  Default value: true
• 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 “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: ()
• 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')
</ul> </div>

Usage: dp2 [GLOBAL_OPTIONS] dtbook-to-daisy3 [OPTIONS]

Options:

--source source	The 2005-3 DTBook file to be transformed.
--tts-config tts-config	Configuration file for text-to-speech.
--word-detection [word-detection]	Detect words (default: true)
--audio [audio]	Enable text-to-speech (default: false)
--_:stylesheet [_:stylesheet]	Style sheets (default: )
--include-tts-log [include-tts-log]	Enable TTS log (default: p:system-property('d:org.daisy.pipeline.tts.log'))
--publisher [publisher]	Publisher (default: )
--with-text [with-text]	With text (default: true)
--stylesheet-parameters [stylesheet-parameters]	Style sheet parameters (default: ())
--lexicon [lexicon]	Lexicons (default: p:system-property('d:org.daisy.pipeline.tts.default-lexicon'))
-o,--output [OUTPUT]	Path where to store the results. This option is mandatory when the job is not executed in the background
-z,--zip	Write the output to a zip file rather than to a folder
-n,--nicename [NICENAME]	Set job's nice name
-r,--priority [PRIORITY]	Set job's priority (high|medium|low)
-q,--quiet	Do not print the job's messages
-p,--persistent	Delete the job after it is executed
-b,--background	Sends the job and exits