Transformer documentation: us_rfbd_textOnlyDtbCreator [BETA]

Transformer Purpose

This transformer takes a valid Z39.86-2005 textual content file (dtbook file) as input and creates a complete, conforming Z39.86-2005 text-only DTB fileset. The output DTB includes:

The output DTB includes the following features and functions:

Input Requirements

The transformer takes a Z39.86-2005 textual content file as input (dtbook file). The file must be valid. It is recommended that any script using this transformer pass the input through the Pipeline validator prior to executing the transform.

Output

On success

The output is a Z39.86-2005 text-only fileset: package file, NCX, SMIL file(s), textual content file, resource file, and associated resource media files.

On error

Messages indicating the source of the error.

Configuration/Customization

Parameters (tdf)

input
The full path and name of the input dtbook file (required).
output
The full path in which to put the output DTB (required).
configFile
The full path and name of a configuration file (see below; optional). If not given, the default configuration file (located in the transformer directory) will be used.
resourceFile
The full path and name of a Z39.86-2005 resource file to include with the DTB (optional). If not given, the default resource file (located in the transformer directory) will be used.

Extended configurability

The transformer uses a configuration file for extended configuration options. A default file (toConfig.xml) is included in the transformer directory and will be used if a custom configuration is not provided by the user. The configuration file allows for the following customizations:

The file must be a well-formed XML document. The following describes the elements that are recognized:

<synchElement name="foo" ns="http://www.example.com/ns/" />
Element name and (optional) namespace that generates a SMIL synchronization point
<skippableElement name="foo" ns="http://www.example.com/ns/" />
Element name and (optional) namespace that generates a skippable structure in SMIL
<escapableElement name="foo" ns="http://www.example.com/ns/" />
Element name and (optional) namespace that generates a skippable structure in SMIL
<smilEventThreshold value="500" />
Number of events per SMIL file before looking for an exit (defaults to 500)

All other elements in the config file will be ignored.

Further development

This transformer is in beta release. It has not been fully tested against a wide variety of inputs to confirm robustness.

This transformer does not include support for MathML, but ought to.

Dependencies

None.

Author

James Pritchett, Recording for the Blind & Dyslexic (RFB&D), USA

Licensing