TreeStructure

The content of this tree structure, containing all markup documents and subtrees, except for the (optional) title document.

The actual document tree that this ast structure represents.

All templates on this level of the tree hierarchy that might get applied to a document when it gets rendered.

The title document for this tree, if present.

A document with the base name title and the corresponding suffix for the input markup, e.g. title.md for Markdown, can be used as an introductory section for a chapter represented by a directory tree.

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 needs to be relative and not point to a parent tree (neither start with / nor with ..).

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 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 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 template from this tree or one of its subtrees by the specified path. The path needs to be relative.

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.

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 title of this tree, obtained from configuration.