doc.scripts.PEFFileMerger.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline1-adapter Show documentation
The newest version!




  
  Pipeline Script: PEF File Merger
  



Pipeline Script: PEF File Merger




  Overview
  Input Requirements
  Output
  Configuration
  Appendix: List of Transformers used



Overview

This script merges several PEF files into one. The purpose of this script is
to facilitating the use of PEF files with braille editors that do not support
multi volume files.


Input Requirements

This script accepts a folder path as input. The folder must contain PEF
2008-1 documents only.

Merge order is determined by file name. See below for options.

The first file is copied in full, and used as a skeleton for the new file.
The contents of the <volume> parts of the other files
are appended to the new file before the </body> tag.




Output

The output is a PEF 2008-1 document.

Configuration



  Input directory
    Select input directory
  Output file
    Select output PEF document
  Identifier
    A publication identifier
  Sorting type
    Type of sorting algorithm to use. Available options are "Numeral
      grouping" and "Standard". Standard sorting can generate non-intuitive
      behaviour. E.g. the standard sort order of the files 'volume-1.pef',
      'volume-2.pef' and 'volume-10.pef' is 1, 10, 2. The "Numeral grouping"
      sorting type avoids this behaviour by evaluating the sort order of number
      groups as numbers instead of as strings, e.g. the files in the above
      example would be sorted in the order 1, 2, 10. Note that the "Numeral
      grouping" sorting algorithm disregards character case on all platforms,
      unlike the "Standard" algorithm.


Appendix: List of Transformers used

The documents linked below are parts of the Transformer technical
documentation. These are developer and systems-administrator centric
documents.

  org_pef_pefFileMerger
  int_daisy_validator