Represents the root of a tree of documents. In addition to the recursive structure of documents, usually obtained by parsing text markup, it holds additional items like styles and static documents, which may contribute to the rendering of a site or an e-book.
The styles property of this type is currently only populated and processed when rendering PDF or XSL-FO. Styles for HTML or EPUB documents are part of the staticDocuments property instead and will be integrated into the final output, but not interpreted.
Value parameters
- coverDocument
-
the cover document (usually used with e-book formats like EPUB and PDF)
- staticDocuments
-
the descriptors for documents that were neither identified as text markup, config or templates, and will be copied as is to the final output
- styles
-
the styles to apply when rendering this tree, only populated for PDF or XSL-FO output
- tree
-
the recursive structure of documents, usually obtained from parsing text markup
Attributes
- Companion
- object
- Source
- documents.scala
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Adds the specified static document references to this document tree.
Adds the specified static document references to this document tree.
Attributes
- Source
- documents.scala
Adds the specified styles (CSS for PDF) to this document tree.
Selects and applies the templates contained in this document tree for the specified output format to all documents within this tree recursively.
Selects and applies the templates contained in this document tree for the specified output format to all documents within this tree recursively.
Attributes
- Source
- documents.scala
Modifies the existing config instance for this document tree by appending one or more additional values.
Modifies the existing config instance for this document tree by appending one or more additional values.
This method is much more efficient than withConfig when existing config values should be retained.
Attributes
- Source
- documents.scala
Creates a new tree by applying the specified function to all documents in this tree recursively.
Creates a new tree by applying the specified function to all documents in this tree recursively.
Attributes
- Source
- documents.scala
Creates a new instance by applying the specified function to the root tree.
Creates a new instance by applying the specified function to the root tree.
Attributes
- Source
- documents.scala
Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rules.
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.
Attributes
- Source
- documents.scala
Selects the configuration associated with a subtree.
Selects the configuration associated with a subtree. In case the subtree does not exist it will recursively try parent trees to reflect the inheritance nature of tree configuration. Will always succeed and return the root config if no matching children are found.
Attributes
- Source
- documents.scala
Associates the specified config instance with this document tree.
Associates the specified config instance with this document tree.
If you want to add values to the existing configuration of this instance, use modifyConfig instead, which is more efficient than re-assigning a full new instance which is based on the existing one.
Attributes
- Source
- documents.scala
Adds the specified document as the cover for this tree, replacing the existing cover document if present.
Adds the specified document as the cover for this tree, replacing the existing cover document if present.
Attributes
- Source
- documents.scala
Adds the specified document as the cover document for this tree replacing the existing cover document if present or, if the parameter is empty, removes any existing cover document.
Adds the specified document as the cover document for this tree replacing the existing cover document if present or, if the parameter is empty, removes any existing cover document.
Attributes
- Source
- documents.scala
Concrete fields
All documents contained in this tree, fetched recursively, depth-first.
All documents contained in this tree, fetched recursively, depth-first.
Attributes
- Source
- documents.scala
The configuration associated with the root of the tree.
The configuration associated with the root of the tree.
Like text markup documents and templates, configurations form a tree structure and sub-trees may override and/or add properties that have only an effect in that sub-tree.
Attributes
- Source
- documents.scala
Attributes
- Source
- documents.scala
Indicates whether this tree does not contain any markup document.
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.
Attributes
- Source
- documents.scala
Attributes
- Source
- documents.scala
Attributes
- Source
- documents.scala
The title of this tree, obtained from configuration.
The title document for this tree, if present.
The title document for this tree, if present.
At the root level the title document, if present, will be rendered after the cover document.
Attributes
- Source
- documents.scala
Attributes
- Source
- documents.scala