Generator: GetFile

Description

This generator returns a file specified path parameter from the PSML root folder.

This is the most generic generator to retrieve PSML data. For convenience, two similar generators are provided:

• Generator: GetContentFile to retrieve files in the /content folder.
• Generator: GetConfigFile to retrieve files in the /config folder.

Configuration

The root of the PSML folder can be configured using the global property bastille.psml.root which can be either a absolute path or a relative path from the global repository. By default, the PSML root is set to psml.

For example:

<bastille>
  <psml root="psml"/>
</bastille>

Parameters

This generator requires a path parameter. The path parameter must be a relative path from within the PSML root folder to a PSML file without the extension.

Returned XML

Like most PSML generators returning a PSML file, this generator wraps the content of the file with the <psml-file> element.

The @base attribute is the relative path from the PSML root to the folder. Since references (xrefs and image sources) in PSML are relative, this attribute can be used to construct the path to images or cross-referenced documents.

See the following:

<psml-file name="[file name]"
           base="[base path]"
           status="[status]">
  <!-- PSML content -->
<psml-file>

Error handling

If the file cannot be found or read, this generator returns the following:

<psml-file name="[file name]" base="[base path]" status="not-found">
Unable to find file: [path]
</psml-file>

The status of this generator is set to ‘NOT_FOUND’.