doc.transformers.org_pef_pef2text.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!





  
  org_pef_text/pef2text
  



Transformer documentation: org_pef_text/pef2text





  Transformer Purpose 
  Input Requirements 
  Output 
    
      On success 
      On error 
    
  
  Configuration/Customization 
    
      Parameters (tdf) 
      Extended configurability 
    
  
  Further development 
  Dependencies 
  Author 
  Licensing 



Transformer Purpose

The purpose of this transformer is to convert a PEF 2008-1 document into
plain text.

Note: This implementation is based on the December 9, 2009 Public Draft
of the PEF 1.0 Specification. 


Input Requirements

A PEF 2008-1 document.


Output

On success

A text file.


On error


Configuration/Customization

Parameters (tdf)


  xml
    Path to input PEF 2008-1 file
  out
    Path to output text file, set to "" if no output file is needed
  deviceName
    Optional. Set device name or leave blank to skip the embossing step
  embosser
    Optional. Embosser make and model.
  table
    Optional. Set braille code table
  breaks
    Optional. Line breaks
  pageRange
    Optional. Range to export
  alignmentOffset
    Optional. Alignment offset in characters
  mirrorAlign
    Optional. Mirror recto-verso alignment
  paperWidthFallback
    Optional. Paper width error handling
  papersize
    Set the size of the paper
  pad
    Optional. Pad formfeed character with newline
  cellWidth
    Not implemented
  cellHeight
    Not implemented


Extended configurability


Further development

Adding output formats and embossers.


Dependencies

None


Author

Joel Håkansson, TPB


Licensing

LGPL