doc.scripts.DTBookToTranslatedBrailleDTBook.html Maven / Gradle / Ivy
Pipeline Script: DTBook to translated Braille DTBook [BETA]
Pipeline Script: DTBook to translated Braille DTBook [BETA]
Overview
This script converts a DTBook 2005 document to another DTBook
document where all the text nodes are translated Braille.
The script can be used to translate DTBook to Braille for later
formatting.
You need to
install Liblouis
for this transformer to work.
This script has mostly been tested on Linux. When
the LibLouis library is not installed in a standard location and
cannot found (resulting in a UnsatisfiedLinkError),
the Java VM has to be started with the option -Djna.library.path=/path/to/liblouis/
This script maps
an ISO language
code taken from the xml:lang attribute and a
contraction grade to a specific Liblouis table. If this mapping is
not according to your specification check the mapping in the xsl
in the transformer.
Input Requirements
No specific requirements beyond that the input needs to be a
valid DTBook 2005 document.
Output
The script generates DTBook XML. All text nodes will be
translated to Braille according to the xml:lang tag in
the root node of the DTBook XML and the given contraction
grade.
Configuration
- Input DTBook
- Required. The input DTBook document; the grammar version needs to be in the 2005 series.
- Output DTBook
- Required. Resulting DTBook document.
- Contraction Grade
- Required. The contraction grade of the
Braille translation. The three possible values are:
- Grade 0
- Translate with grade 0 contraction. For
many locales this results in uncontracted Braille.
- Grade 1
- Translate with grade 1 contraction. For
some locales this also results in uncontracted Braille.
- Grade 2
- Translate with grade 2 contraction. For
most locales this results in contracted Braille
Appendix: List of Transformers used
The documents linked below are parts of the Transformer technical documentation. These are developer and systems-administrator centric documents.