Custom Engines

One can configure transformation engines other than the ones which come with the <oXygen/> distribution. Such an external engine can be used for XSLT / XQuery transformations within <oXygen/>, in the Editor perspective, and is available in the list of engines in the dialog for editing transformation scenarios. However it cannot be used in the Debugger perspective.

The Custom Engines preferences panel is opened from menu OptionsPreferences+XML+XSLT/FO/XQuery+Custom Engines

 

Figure 24.63. Configuration of custom transformation engines

Configuration of custom transformation engines

The following parameters can be configured for a custom engine:

 

Figure 24.64. Parameters of a custom transformation engine

Parameters of a custom transformation engine

Engine type

Combo box allowing you to choose the transformer type. There are two options: XSLT engines and XQuery engines.

Name

The name of the transformer displayed in the dialog for editing transformation scenarios

Description

Text description of the transformer

Output Encoding

The encoding of the characters sent to the output stream of the transformer

Error Encoding

The encoding of the characters sent to the error stream of the transformer

Working directory

The start directory of the transformer executable program. The following editor variables are available for making the path to the working directory independent of the input XML file:

  • ${homeDir} - the user home directory in the operating system

  • ${cfd} - the path to the directory of the current file

  • ${pd} - the path to the directory of the current project

  • ${oxygenInstallDir} - the <oXygen/> install directory

Command line

The command line that must be executed by <oXygen/> to perform a transformation with the engine. The following editor variables are available for making the items of the command line (the transformer executable, the input files) independent of the input XML file:

  • ${xml} - the XML input document as a file path

  • ${xmlu} - the XML input document as a URL

  • ${xsl} - the XSL / XQuery input document as a file path

  • ${xslu} - the XSL / XQuery input document as a URL

  • ${out} - the output document as a file path

  • ${outu} - the output document as a URL

  • ${ps} - the separator which can be used on different operating systems between libraries specified in the class path.