Oxygen XML Author plugin 13.2.0

Configuring the Application | 424• ${cfdu} - Current file folder as URL, that is the path of the current edited document up to the name of the parentfolder, 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 parentfolder.• ${cfn} - Current file name without extension and without parent folder.• ${cfne} - Current file name with extension.• ${cf} - Current file as file path, that is the absolute file path of the current edited document.• ${cfu} - The path of the current file as a URL.• ${af} - The file path of the zip archive that includes the current transformed file (this variable is available only in atransformation scenario).• ${afu} - The URL of the zip archive that includes the current transformed file (this variable is available only in atransformation scenario).• ${afd} - The directory of the zip archive that includes the current transformed file (this variable is available only ina transformation scenario).• ${afdu} - The URL of the directory of the zip archive that includes the current transformed file (this variable isavailable only in a transformation scenario).• ${afn} - The file name (without parent directory and without file extension) of the zip archive that includes thecurrent transformed file (this variable is available only in a transformation scenario).• ${afne} - The file name (with file extension, for example .zip or .epub, but without parent directory) of the ziparchive that includes the current transformed file (this variable is available only in a transformation scenario).• ${currentFileURL} - Current file as URL, that is the absolute file path of the current edited document representedas 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 transformationresults 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 XML content of the current selection in the editor panel. This variable can be used in a codetemplate and Author operations,• ${id} - Application-level unique identifier.• ${uuid} - Universally unique identifier.• ${env(VAR_NAME)} - Value of the VAR_NAME environment variable.• ${ask('user-message', param-type, 'default-value' ?)} - To prompt for values at runtime, use the ask('user-message',param-type, 'default-value' ?) editor variable. The following parameters can be set:• 'user-message' - the actual message to be displayed. Note the quotes that enclose the message.• param-type - optional parameter. Can have one of the following values:• url - input is considered to be an URL. Oxygen XML Author plugin checks that the URL is valid beforepassing it to the transformation.• password - input characters are hidden.• generic - the input is treated as generic text that requires no special handling.• 'default-value' - optional parameter. Provides a default value in the input text box.Examples:• ${ask('message')} - Only the message displayed for the user is specified.• ${ask('message', generic, 'default')} - 'message' will be displayed for the user, thetype is not specified (the default is string), the default value will be 'default'.• ${ask('message', password)} - 'message' will be displayed for the user, the characters typedwill be replaced with a circle character.• ${ask('message', password, 'default')} - Same as above, default value will be 'default'.