24.08.2015 Views

Oxygen XML Author plugin 13.2.0

Oxygen XML Author plugin 13.2.0

Oxygen XML Author plugin 13.2.0

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

<strong>Author</strong> Developer Guide | 199• ${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 <strong>Author</strong> operations,or in a selection <strong>plugin</strong>.• ${selection} - The <strong>XML</strong> content of the current selection in the editor panel. This variable can be used in a codetemplate and <strong>Author</strong> 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. <strong>Oxygen</strong> <strong>XML</strong> <strong>Author</strong> <strong>plugin</strong> 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'.• ${ask('message', url)} - 'message' will be displayed for the user, the type of parameter will beURL.• ${ask('message', url, 'default')} - Same as above, default value will be 'default'.• ${system(var.name)} - Value of the var.name system variable.• ${date(pattern)} - Current date. Follows the given pattern. Example: yyyy-MM-dd.• ${dbg<strong>XML</strong>} - The path to the current Debugger source selection (for tools started from the XSLT/XQuery Debugger).• ${dbgXSL} - The path to the current Debugger stylesheet selection (for tools started from the XSLT/XQueryDebugger).• ${tsf} - The transformation result file.• ${ps} - The path separator which can be used on different operating systems between libraries specified in the classpath.• ${dsu} - The path of the detected schema as a URL.• ${ds} - The path of the detected schema as a local file path.• ${cp} - Current page number.• ${tp} - Total number of pages in the document.

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!