External Tools

The External Tools preferences panel is opened from menu OptionsPreferences+External Tools

The user can run within <oXygen/> other tools as if from the command line of the operating system shell. The configuration of such a tool is done in the following dialog.

 

Figure 20.67. The external tools configuration dialog

The external tools configuration dialog

Name

The name of the menu entry corresponding to this tool that will be displayed in the External Tools menu and in the external tools combo box on the toolbar.

Description

The description of the tool displayed in the Preferences->External Tools option.

Output Encoding

The encoding that <oXygen/> uses to read the output stream data of the external tool.

Error Encoding

The encoding that <oXygen/> uses to read the error stream data of the external tool.

Shortcut key

The keyboard shortcut that launches the external tool.

Working directory

The directory the external tool will use to store intermediate and final results. Here you can use one of the following editor variables:

${homeDir}

The path to user home directory.

${cfd}

The path of current file directory.

${pd}

The project directory.

${oxygenInstallDir}

The installation directory of <oXygen/>.

Command line

The command line that will start the external tool. Here you can use one of the following editor variables:

${dbgXML}

The path to the current Debugger source selection.

${dbgXSL}

The path to the current Debugger stylesheet selection.

${homeDir}

The path to user home directory.

${cfn}

The current file name without extension.

${cfne}

The current file name with extension.

${cf}

The path of the currently edited file.

${cfd}

The path of current file directory.

${tsf}

Transformation result file.

${pd}

The project directory.

${oxygenInstallDir}

The installation directory of the application.

${frameworksDir}

The directory where the <oXygen/> frameworks are located.

${ps}

The separator which can be used on different operating systems between libraries specified in the class path.

${timeStamp}

Time Stamp - The current Unix time on the computer which can be used to save transformation results in different output files on each transform.

[Note]Note

The quote character (") is used to delimit parameters and files that have spaces in their names.

 cmd /c dir "c:\samples\dir with spaces"                                         
                        
[Note]Note

There are cases in which you need to specify in the command line a parameter that contains a quote. You will need to escape the quote by using the character:^.

 cmd /c dir "c:\samples\dir with ^"quotes^" and spaces"