4.12.20 p:navigationTree

Request a navigation tree from the Navigation Manager.

4.12.20.1 Request

The full form of this request is:

<p:navigationTree>
  <p:navigationDocument id="expr" branch="expr" language="expr"/>
  <p:activeDocument id="expr" branch="expr" language="expr"/>
  <p:activePath>expr</p:activePath>
  <p:contextualized>true|false</p:contextualized>
  <p:depth>...</p:depth>
  <p:versionMode>live|last</p:versionMode>
  <p:document>...</p:document>
</p:navigationTree>

The elements p:activeDocument, p:activePath, p:versionMode, p:depth and p:document elements are optional.

To make the active document the current context document, one can use expressions like this:

<p:navigationTree>
  <p:navigationDocument id="338-DSY"/>
  <p:activeDocument id="${id}" branch="${branch}" language="${language}"/>
</p:navigationTree>

4.12.20.1.1 Attaching additional information to the document nodes

If a p:document instruction is present, then the p:document will be executed for each document node in the navigation tree, and the response is inserted as first child of each element. This provides the ability to annotate the document nodes in the navigation tree with additional information of the document, so that you can e.g. know the document type of the document. One could even aggregate the full content of the documents, if desired.

An example:

<p:navigationTree>
  <p:navigationDocument id="338-DSY"/>
  <p:document>
    <p:annotatedDocument/>
  </p:document>
</p:navigationTree>

4.12.20.2 Response

The response of this instruction is a n:navigationTree element, with n denoting the navigation namespace.