DocumentTree

Creates a new tree by applying the specified function to all documents in this tree recursively.

Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rules.

If the rule is not defined for a specific element or the rule returns a Retain action as a result the old element remains in the tree unchanged.

If it returns Remove then the node gets removed from the ast, if it returns Replace with a new element it will replace the old one.

The rewriting is performed bottom-up (depth-first), therefore any element container passed to the rule only contains children which have already been processed.

The specified factory function will be invoked for each document contained in this tree and must return the rewrite rules for that particular document.

Appends the specified content to this tree and return a new instance.

Appends the specified content to this tree and return a new instance.

Creates the navigation structure for this tree up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of trees, documents and their sections.

Selects the template with the name default.template.<suffix> for the specified format suffix from this level of the document tree.

Prepends the specified content to this tree and return a new instance.

Prepends the specified content to this tree and return a new instance.

Selects a document from this tree or one of its subtrees by the specified path. The path must not point to a parent tree (start with ../) as this instance is not aware of its parents.

Selects a document from this tree or one of its subtrees by the specified path. The path needs to be relative and not point to a parent tree (neither start with / nor with ..).

Selects a subtree of this tree by the specified path. The path must not point to a parent tree (start with ../) as this instance is not aware of its parents.

Selects a subtree of this tree by the specified path. The path needs to be relative and it may point to a deeply nested subtree, not just immediate children.

Selects a template from this tree or one of its subtrees by the specified path. The path must not point to a parent tree (start with ../) as this instance is not aware of its parents.

Selects a template from this tree or one of its subtrees by the specified path. The path needs to be relative.

The formats this tree content should be rendered to.

Create a new document tree that contains the specified template as the default.

All documents contained in this tree, fetched recursively, depth-first.

Indicates whether this tree does not contain any markup document. Template documents do not count, as they would be ignored in rendering when there is no markup document.

The local name of this navigatable.

The title of this tree, obtained from configuration.