doc.scripts.TextToPEF.html Maven / Gradle / Ivy
Pipeline Script: Text to PEF
Pipeline Script: Text to PEF
Overview
This script converts an ASCII type braille file into a PEF 2008-1
document.
What is PEF?
The Portable Embosser Format (PEF) is a data format for representing
braille books, accurately and unambiguously. PEF can be used for braille
embossing and archiving anywhere in the world, no matter where nor how it was
produced. PEF is a digital braille hardcopy - the PDF of braille books, if
you will.
For more information, see Introduction to
PEF.
See also Emboss PEF.
Input Requirements
This script accepts plain text files where each braille character is
represented by some other character. The most commonly used representation is
"North American Ascii Braille".
In addition to the characters used to represent braille, the file may
contain newline and form feed characters.
Output
The output is a PEF 2008-1 document.
Configuration
- Input file
- A braille formatted text file
- Source format
- Source format. "Detect" will attempt to automatically detect the
source format. Note that this process is not fail safe. The detected
source format might use the same set of ascii characters as another,
but with different braille interpretation.
- Output file
- Output PEF 2008-1 document
- Title
- The title of the publication
- Author
- The author of the publication
- Identifier
- The publications unique identifier. If no value is supplied, it will
be a generated.
- Language
- Set the document language (as defined by IETF RFC 3066)
Appendix: List of Transformers used
The documents linked below are parts of the Transformer technical
documentation. These are developer and systems-administrator centric
documents.