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

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

• 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'.• ${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.• ${uuid} - Universally unique identifier.• ${id} - Application-level unique identifier.• ${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.• ${cfd} - Current file folder as file path, that is the path of the current edited document up to the name of the parentfolder.• ${frameworksDir} - The path (as file path) of the frameworks subfolder of the <strong>Oxygen</strong> <strong>XML</strong> <strong>Author</strong> <strong>plugin</strong>installation folder.• ${pd} - Current project folder as file path.• ${oxygenInstallDir} - <strong>Oxygen</strong> <strong>XML</strong> <strong>Author</strong> <strong>plugin</strong> installation folder as file path.• ${homeDir} - The path (as file path) of the user home folder.• ${pn} - Current project name.• ${env(VAR_NAME)} - Value of the VAR_NAME environment variable.• ${system(var.name)} - Value of the var.name system variable.• ${date(pattern)} - Current date. Follows the given pattern. Example: yyyy-MM-dd.The arguments of InsertFragmentOperation operationfragmentThe value for this argument is a text. This is parsed by <strong>Oxygen</strong> <strong>XML</strong> <strong>Author</strong> as it was already inthe document at the caret position. You can use entity references declared in the document andit is namespace aware. The fragment may have multiple roots.Note:You can even use namespace prefixes that are not declared in the inserted fragment, ifthey are declared in the document where the insertion is done. For the sake of clarity,you should always prefix and declare namespaces in the inserted fragment!Note:<strong>Author</strong> Developer Guide | 178If the fragment contains namespace declarations that are identical to those found in thedocument, the namespace declaration attributes will be removed from elements containedby the inserted fragment.

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

Saved successfully!

Ooh no, something went wrong!