doc.scripts.PrettyPrinter.html Maven / Gradle / Ivy
Pipeline Script: Pretty Printer
Pipeline Script: Pretty Printer
Overview
This script will the Pretty Print the XML documents in a fileset. It can be used for DTBs and/or (most types of) standalone XML documents.
Pretty printing means adding indentation and line breaks to the XML source code of the document.
Pretty printing seldom has any effect on the experience of the end user. However, in the case of DTB filesets, there are certain players that are very sensitive to the
XML source code layout. It is therefore a good idea to pretty print DTB filesets before distribution, using a pretty printer (like this one) that takes special care to make sure the output
is compatibilized.
Input Requirements
Output
Configuration
- Input file
- Required. The input fileset manifest file (NCC, OPF, XHTML document, DTBook document, etc)
- Output directory
- Required. The directory to store the output in. This can be set as the same as the input directory, but it is recommended to use another directory than the input directory. Choosing the same directory for input and output is risky.
- Linebreak type
- Optional. Lets you choose between DOS and UNIX linebreaks. Normally, this should be left at the default value
DOS. Some DAISY players depend on linebreaks being DOS.
Appendix: List of Transformers used
The documents linked below are parts of the Transformer technical documentation. These are developer and systems-administrator centric documents.