doc.scripts.EmbossPEF.html Maven / Gradle / Ivy
Pipeline Script: Emboss PEF
Pipeline Script: Emboss PEF
Overview
This script embosses PEF 2008-1 documents.
To achieve correct result using Braillo embossers, the embosser must be
configured for "USA 6 DOT 001.00" or "ENGLAND 6 DOT 044.00".
To achieve correct result using other embossers with the script "Emboss PEF
(generic embosser)", the embosser must be configured for North American ASCII
Braille and dual-sided embossing.
Note that, when using "Emboss PEF (generic embosser)" some features will not
be available. These are marked with * below.
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.
Limitations
The scripts assumes that the Marburg
Medium spacing measurments can be used when calculating space reqirements
etc. In other words, to achieve correct result, braille cells must be 6 mm wide
and lines must be 10 mm high once embossed.
This script does not support files containing braille patterns specific for
8 dot braille.
FAQ
I get an error message saying "Cannot fit page on paper"...
- What does it mean?
It means that the page is too wide for the selected paper/embosser
combination.
Note that the maximum width for a particular paper depends on the physical
properties of the selected embosser. For example, the maximum width on an
A4 paper range from 30 to 35 cells, depending on embosser model.
- What should I do?
Use a wider paper.
I get an error message saying "Cannot fit page on paper with offset
[x]"...
- What does it mean?
It means that the current offset setting is pushing the page off the
paper.
- What should I do?
Reduce the offset setting and adjust the embosser's paper guide
instead.
I get an error message saying "Could not find embosser". What should I
do?
Check the device name parameter for typos. Note that the device name is case
sensitive.
I don't know what "device name" is. How do I find it?
On windows, do the following:
- Go to Start/Printers and Faxes (or Start/Control panel/Printers and
Faxes)
- The value in the "Name" column is the device name
I have a Braillo embosser and everything comes out wrong...
- Why is that?
The braille table used by the embosser is not the same as the one used
in the script.
- Why doesn't the script take care of this?
The script cannot tell the embosser which table to use because Braillo
embossers do not support this feature.
- What should I do?
Manually set the embosser's braille table to match the value used in the
script.
My document contains more than 100 pages but my Braillo 440 embosser
cannot handle that amount of pages in one go. What should I do?
If the document has been organized into volumes, there is nothing to worry
about since each volume will be sent separately to the embosser. If a single
volume happens to contain more than 99 pages, the script will report an error
and abort.
Input Requirements
This script accepts PEF 2008-1 documents (containing 6 dot braille patterns
only).
Output
The output is an embossed document.
Each volume in the input document will result in a separate physical unit if
embossed using an embosser that supports volume assembly (e.g. Braillo 440SW
and Braillo 440SWSF).
Configuration
- Input file
- Select input PEF document.
- Embosser *
- Select the make and model of the target embosser.
- Paper size
- Set the size of the paper in the embosser.
- Device name
- Type in the name of the embosser as labelled by the computer OS. The
device name is case sensitive, but Emboss PEF will try to find the
embosser even if only a part of the device name is entered.
- Copies
- Set the number of document copies.
- Page range
- Select a range of pages to emboss.
- Note for Braillo 440 SW (using four page mode) and Braillo 440 SWSF
embossers: Embossing the whole file at once will not equal the combined
result of embossing the same set of pages in arbitrary page range chunks
(unless each range spans a number of complete volumes). This is due to
the physical properties of these prints. For example, if a book whose
first volume spans pages 1-96 is embossed in two chunks, first pages 1-4
and then pages 5-96, the result will not equal embossing once using page
range 1-96.
- Paper width error handling *
- Select a fallback action to use when the selected paper is wider than
specified in the file.
- Offset *
If the paper is wider than specified in the file, it is possible to
adjust the margin offset (in characters). Offset depends on paper width
error handling and is directed away from the alignment edge.
Note that this setting only has effect if the selected paper is
wider than specified in the file.
- Mirror recto-verso alignment *
Applies to double sided material when the paper is wider than
specified in the file. If true, left-hand pages will have the opposite
alignment compared to right-hand pages. If false, left-hand pages will
have the same alignment as right-hand pages.
Note that this setting only has effect if the selected paper is
wider than specified in the file.
- Keep output file
- Select a destination for the file that is sent to the embosser.
- Note that this feature is not compatible with some embosser
models.
Appendix: List of Transformers used
The documents linked below are parts of the Transformer technical
documentation. These are developer and systems-administrator centric
documents.