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.

• 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.Validating <strong>XML</strong> DocumentsThe W3C <strong>XML</strong> specification states that a program should not continue to process an <strong>XML</strong> document if it finds avalidation error. The reason is that <strong>XML</strong> software should be easy to write, and that all <strong>XML</strong> documents should becompatible. With HTML it was possible to create documents with lots of errors (like when you forget an end tag). Oneof the main reasons that HTML browsers are so big and incompatible, is that they have their own ways to figure outwhat a document should look like when they encounter an HTML error. With <strong>XML</strong> this should not be possible.However, when creating an <strong>XML</strong> document, errors are very easily introduced. When working with large projects ormany files, the probability that errors will occur is even greater. Determining that your project is error-free can be timeconsuming and even frustrating. For this reason <strong>Oxygen</strong> <strong>XML</strong> <strong>Author</strong> <strong>plugin</strong> provides functions that enable easy erroridentification and rapid error location.Checking <strong>XML</strong> Well-FormednessEditing Documents | 54A Well-Formed <strong>XML</strong> document is a document that conforms to the <strong>XML</strong> syntax rules. A Namespace Well-Formed <strong>XML</strong>document is a document that is <strong>XML</strong> Well-Formed and is also namespace-wellformed and namespace-valid.

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

Saved successfully!

Ooh no, something went wrong!