An editor variable is a shorthand notation for a file path or folder path. It is used in the
definition of a command (the input URL of a transformation, the output file path of a
transformation, the command line of an external tool, etc.) to make a command or a parameter
generic and reusable with other input files. When the same command is applied to different
files, the notation is expanded at the execution of the command so that the same command has
different effects depending on the actual file.
The following editor variables can be used in Oxygen commands of external engines or
other external tools, in transformation scenarios and in validation scenarios:
- ${frameworks} - The path (as URL) of the
frameworks subfolder of the Oxygen install folder.
- ${frameworksDir} - The path (as file path) of the
frameworks subfolder of the Oxygen installation folder.
- ${home} - The path (as URL) of the user home folder.
- ${homeDir} - The path (as file path) of the user home folder.
- ${cfdu} - Current file folder as URL, that is the path of the
current edited document up to the name of the parent folder, represented as a URL.
- ${cfd} - Current file folder as file path, that is the path of the
current edited document up to the name of the parent folder.
- ${cfn} - Current file name without extension and without parent
folder.
- ${cf} - Current file as file path, that is the absolute file path
of the current edited document.
- ${currentFileURL} - Current file as URL, that is the absolute file
path of the current edited document represented as URL.
- ${ps} - Path separator, that is the separator which can be used on
the current platform (Windows, Mac OS X, Linux) between library files specified in the class
path.
- ${timeStamp} - Time stamp, that is the current time in Unix format.
It can be used for example to save transformation results in different output files on each
transform.
- ${caret} - The position where the caret is inserted. This variable
can be used in a code template.
- ${selection} - The text content of the current selection in the
editor panel. This variable can be used in a code template
.