doc.transformers.org_pef_dtbook2pef.html Maven / Gradle / Ivy
org_pef_dtbook2pef
Transformer documentation: org_pef_dtbook2pef
Transformer Purpose
The main purpose of this transformer is to convert DTBook into PEF 2008-1.
However, other input formats as well as other output formats are possible to
within the boundaries of the transformer. The recommended way to obtain
braille formats other than PEF (such as american ascii braille) is to feed the
output from this transformer as input to the pef2text transformer.
Input Requirements
A DTBook document.
A particular conversion setup may have further requirements.
Output
A text-oriented display format, such as PEF 2008-1.
On success
A text-oriented display format, such as PEF 2008-1.
On error
Configuration/Customization
Parameters (tdf)
- input
- The input xml file
- output
- The output xml file
- identifier
- Publication identifier
- date
- Publication date. Leave blank to use today's date formatted as defined
by dateFormat.
- setup
- Conversion setup
- outputFormat
- Output format
- config
- Path to configuration settings
- duplex
- Emboss sheets on both sides
- writeTempFiles
- Write temporary files. If true, a copy of the current temp file is
written to the directory specified by tempFilesDirectory after
each task has completed. The naming scheme is:
"debug_dtbook2pef_[step]_[task name]".
- tempFilesDirectory
- Path to the temporary files directory
- dateFormat
- Date format, see
http://java.sun.com/javase/6/docs/api/java/text/SimpleDateFormat.html.
Note that, while other date formats can be generated, PEF 2008-1 requires
ISO8601. Using other date formats will cause the resulting file to be
invalid.
Extended configurability
To use this transformer, the path to Dotify must be set using the pipeline user properties. Set the "pipeline.dotify.cli.path" to the path to Dotify's dotify-cli.jar.
For extended configurability, see javadoc documentation or package.html
Further development
Dependencies
Saxon 8
Author
Joel Håkansson, TPB
Licensing
LGPL