CARIS HPD : HPD® User Guide : Publications : About Publications Module : Transformation Files
 

Transformation Files

Transformation files are an important component of Publications Module. These files serve two purposes:

• Transform HPD data to Publication Module list records, notices and instructions. See How Publications Module Processes Data.

• Format XML files for publication.

Transformation files can be XSLT (Extensible Stylesheet Language Transformations) or any scripting language that is supported by your computer (for example, Python, Perl, VBScript).

Contact Teledyne CARIS to learn more about transformation files in Publications Module.

Sample XSLT files and Python scripts are provided with Publications Module. These files allow you to better understand how the files are applied to publications, and can be used as the starting points for customization for production.

The files are located in the following folders:

• XSLT: C:\Program Files\CARIS\HPD\<version>\system\PubConfig\SampleRules\XSLT

• Python: C:\Program Files\CARIS\HPD\<version>\system\PubConfig\SampleRules\Python

Command

Sample File

Paste Special for Publications

generate_chart_notice_instruction.xsl

generateInstruction.py

lookup.py

Generate List Records

generate_light_records.xsl

generateLightRecord.py

lookup.py

Generate List Record Notices

generate_light_record_instructions.xsl

generateLightRecord.py

lookup.py

Refresh Preview window

preview.xsl

These commands require transformation files.

Command

Type

Description

Paste Special for Publications

XSLT

The transformation file converts XML content on the clipboard into the format of the destination. For example, it converts a copied list record into a notice instruction.

Capture Project

Any

A transformation file is required to format project information to a Publications Module format.

Generate List Records

Any

List information is recorded in an internal XML file. A transformation file is required to format the list record information in the XML document to a Publications Module format.

Update List Record

Any

List information is recorded in an internal XML document. A transformation file is required to format the list record information to a Publications Module format.

Generate Instructions

Any

Instruction information is recorded in an internal XML document. A transformation file is required to format the instruction information in the XML document to a Publications Module format.

Update Instruction

Any

Instruction information is recorded in an internal XML document. A transformation file is required to format the instruction information in the XML document to a Publications Module format.

Generate List Record Notices

Any

A transformation file is required to reformat the updated list records to a notice format.

Refresh Preview window

Any

A transformation file is required to format the exported XML content.

Export Publication

Any

A transformation file can be used to format the finished publication. A stylesheet option can also be used,