<relative-root>

Description

Metadata element specifying the relative root from which relative paths should be resolved.

Relative paths in the immediate document are resolved by starting from the document location, applying the relative root, then applying the relative path. The <relative-root> metadata element thus allows a starting folder which is different to the folder containing the document itself. This can be useful for multiple document projects, when relative paths to images and urls should be resolved from a common location.

Attributes

Element name Relation
url The relative path from the document's folder to the relative root folder.

Immediate descendants

No element descendants are defined for the <relative-root> element.

Immediate ancestors

Element name Relation
<metadata> The enclosing metadata element containing the relative root element.

Example

<document xmlns="http://boradoc.org/1.0">
  <metadata>
    <-- Resolve urls from the parent folder of the folder containing the document. -->
    <relative-root url=".." />
  </metadata>
  <-- Main document content follows.. -->
</document>