Editor Variables

An editor variable is a shorthand notation for context-dependent information, such as a file or folder path, a time-stamp, or a date. It is used in the definition of a command (for example, the input URL of a transformation, the output file path of a transformation, or the command line of an external tool) to make a command or a parameter generic and re-usable 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.

You can use the following editor variables in Oxygen XML Editor commands of external engines or other external tools, in transformation scenarios, Author operations, and in validation scenarios:

${oxygenHome} - Oxygen XML Editor installation folder as URL.
${oxygenInstallDir} - Oxygen XML Editor installation folder as file path.
${framework} - The path (as URL) of the current framework, as part of the [OXYGEN_DIR]/frameworks directory.
${framework(fr_name)} - The path (as URL) of the fr_name framework.
${frameworkDir(fr_name)} - The path (as file path) of the fr_name framework.
Note: Because multiple frameworks might have the same name (although it is not recommended), for both ${framework(fr_name)} and ${frameworkDir(fr_name)} editor variables Oxygen XML Editor employs the following algorithm when searching for a given framework name:
- all frameworks are sorted, from high to low, according to their Priority setting from the Document Type Association preferences page. Only frameworks that have the Enabled checkbox set are taken into account.
- next, if the two or more frameworks have the same name and priority, a further sorting based on the Storage setting is made, in the exact following order:
  - frameworks stored in the internal Oxygen XML Editor options
  - additional frameworks added in the Locations preferences page
  - frameworks installed using the add-ons support
  - frameworks found in the main frameworks location (Default or Custom)
${frameworks} - The path (as URL) of the [OXYGEN_DIR] directory.
${frameworkDir} - The path (as file path) of the current framework, as part of the [OXYGEN_DIR]/frameworks directory.
${frameworksDir} - The path (as file path) of the [OXYGEN_DIR]/frameworksdirectory.
${home} - The path (as URL) of the user home folder.
${homeDir} - The path (as file path) of the user home folder.
${pdu} - Current project folder as URL. Usually the current folder selected in the Project View.
${pd} - Current project folder as file path. Usually the current folder selected in the Project View.
${pn} - Current project name.
${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. The current file is the one currently opened and selected.
${cfne} - Current file name with extension. The current file is the one currently opened and selected.
${cf} - Current file as file path, that is the absolute file path of the current edited document.
${af} - The local file path of the ZIP archive that includes the current edited document.
${afu} - The URL path of the ZIP archive that includes the current edited document.
${afd} - The local directory path of the ZIP archive that includes the current edited document.
${afdu} - The URL path of the directory of the ZIP archive that includes the current edited document.
${afn} - The file name (without parent directory and without file extension) of the zip archive that includes the current edited file.
${afne} - The file name (with file extension, for example .zip or .epub, but without parent directory) of the zip archive that includes the current edited file.
${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, 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, in Author operations, or in a selection plugin.
${selection} - The current selected text content in the current edited document. This variable can be used in a code template, in Author operations, or in a selection plugin.
${id} - Application-level unique identifier; a short sequence of 10-12 letters and digits which is not guaranteed to be universally unique.
${uuid} - Universally unique identifier, a unique sequence of 32 hexadecimal digits generated by the Java UUID class.
${env(VAR_NAME)} - Value of the VAR_NAME environment variable. The environment variables are managed by the operating system. If you are looking for Java System Properties, use the ${system(var.name)} editor variable.
${system(var.name)} - Value of the var.name Java System Property. The Java system properties can be specified in the command line arguments of the Java runtime as -Dvar.name=var.value. If you are looking for operating system environment variables, use the ${env(VAR_NAME)} editor variable instead.

${ask('message', type, ('real_value1':'rendered_value1'; 'real_value2':'rendered_value2'; ...), 'default_value')} - To prompt for values at runtime, use the ask('message', type, ('real_value1':'rendered_value1'; 'real_value2':'rendered_value2'; ...), 'default-value'') editor variable. You can set the following parameters:

'message' - The displayed message. Note the quotes that enclose the message.

type - Optional parameter, with one of the following values:

Parameter
`url`	Format: `${ask('message', url, 'default_value')}`
	Description: Input is considered a URL. Oxygen XML Editor checks that the provided URL is valid.
	Example: `${ask('Input URL', url)}` - The displayed dialog box has the name `Input URL`. The expected input type is URL. `${ask('Input URL', url, 'http://www.example.com')}` - The displayed dialog box has the name `Input URL`. The expected input type is URL. The input field displays the default value `http://www.example.com`.
`password`	Format: `${ask('message', password, 'default')}`
	Description: The input is hidden with bullet characters.
	Example: `${ask('Input password', password)}` - The displayed dialog box has the name `'Input password'` and the input is hidden with bullet symbols. `${ask('Input password', password, 'abcd')}` - The displayed dialog box has the name `'Input password'` and the input hidden with bullet symbols. The input field already contains the default `abcd` value.
`generic`	Format: `${ask('message', generic, 'default')}`
	Description: The input is considered to be generic text that requires no special handling.
	Example: `${ask('Hello world!')}` - The dialog box has a `Hello world!` message displayed. `${ask('Hello world!', generic, 'Hello again!')}` - The dialog box has a `Hello world!` message displayed and the value displayed in the input box is `'Hello again!'`.
`relative_url`	Format: `${ask('message', relative_url, 'default')}`
	Description: Input is considered a URL. Oxygen XML Editor tries to make the URL relative to that of the document you are editing. Note: If the `$ask` editor variable is expanded in content that is not yet saved (such as an untitled file, whose path cannot be determined), then Oxygen XML Editor will transform it into an absolute URL.
	Example: `${ask('File location', relative_url, 'C:/example.txt')}` - The dialog box has the name `'File location'`. The URL inserted in the input box is made relative to the current edited document location.
`combobox`	Format: `${ask('message', combobox, ('real_value1':'rendered_value1';...;'real_valueN':'rendered_valueN'), 'default')}`
	Description: Displays a dialog box that offers a drop-down list. The drop-down list is populated with the given `rendered_value` values. Choosing such a value will return its associated value (`real_value`).
	Example: `${ask('Operating System', combobox, ('win':'Microsoft Windows';'osx':'Mac OS X';'lnx':'Linux/UNIX'), 'osx')}` - The dialog box has the name `'Operating System'`. The drop-down list displays the three given operating systems. The associated value will be returned based upon your selection. Note: In this example `Mac OS X` is the default selected value and if selected it would return `osx` for the output.
`editable_combobox`	Format: `${ask('message', editable_combobox, ('real_value1':'rendered_value1';...;'real_valueN':'rendered_valueN'), 'default')}`
	Description: Displays a dialog box that offers a drop-down list with editable elements. The drop-down list is populated with the given `rendered_value` values. Choosing such a value will return its associated real value (`real_value`) or the value inserted when you edit a list entry.
	Example: `${ask('Operating System', editable_combobox, ('win':'Microsoft Windows';'osx':'Mac OS X';'lnx':'Linux/UNIX'), 'osx')}` - The dialog box has the name `'Operating System'`. The drop-down list displays the three given operating systems and also allows you to edit the entry. The associated value will be returned based upon your selection or the text you input.
`radio`	Format: `${ask('message', radio, ('real_value1':'rendered_value1';...;'real_valueN':'rendered_valueN'), 'default')}`
	Description: Displays a dialog box that offers a series of radio buttons. Each radio button displays a `'rendered_value` and will return an associated `real_value`.
	Example: `${ask('Operating System', radio, ('win':'Microsoft Windows';'osx':'Mac OS X';'lnx':'Linux/UNIX'), 'osx')}` - The dialog box has the name `'Operating System'`. The radio button group allows you to choose between the three operating systems. Note: In this example `Mac OS X` is the default selected value and if selected it would return `osx` for the output.

'default-value' - optional parameter. Provides a default value.

${date(pattern)} - Current date. The allowed patterns are equivalent to the ones in the Java SimpleDateFormat class. Example: yyyy-MM-dd;
Note: This editor variable supports both the xs:date and xs:datetime parameters. For details about xs:date, go to http://www.w3.org/TR/xmlschema-2/#date. For details about xs:datetime, go to http://www.w3.org/TR/xmlschema-2/#dateTime.
${dbgXML} - The local file path to the XML document which is current selected in the Debugger source combo box (for tools started from the XSLT/XQuery Debugger).
${dbgXSL} - The local file path to the XSL/XQuery document which is current selected in the Debugger stylesheet combo box (for tools started from the XSLT/XQuery Debugger).
${tsf} - The transformation result file path. If the current opened file has an associated scenario which specifies a transformation output file, this variable expands to it.
${dsu} - The path of the detected schema as an URL for the current validated XML document.
${ds} - The path of the detected schema as a local file path for the current validated XML document.
${cp} - Current page number. Used to display the current page number on each printed page in the Editor / Print Preferences page.
${tp} - Total number of pages in the document. Used to display the total number of pages on each printed page in the Editor / Print Preferences page.
${xpath_eval(expression)} - Evaluates an XPath 3.0 expression. Depending on the context, the expression can be:
- static, when executed in a non-XML context. For example, you can use such static expressions to perform string operations on other editor variables for composing the name of the output file in a transformation scenario's Output tab.
  Example:
```
${xpath_eval(upper-case(substring('${cfn}', 1, 4)))}
```
- dynamic, when executed in an XML context. For example, you can use such dynamic expression in a code template or as a value of an author operation's parameter.
  Example:
```
${ask('Set new ID attribute', generic, '${xpath_eval(@id)}')}
```
${i18n(key)} - Editor variable used only at document type/framework level to allow translating names and descriptions of Author actions in multiple actions. For more details see the Localizing Frameworks section.