RenderedTreeRoot

laika.io.model.RenderedTreeRoot
case class RenderedTreeRoot[F[_]](tree: RenderedTree, defaultTemplate: TemplateRoot, config: Config, outputContext: OutputContext, pathTranslator: PathTranslator, styles: StyleDeclarationSet, coverDocument: Option[RenderedDocument], staticDocuments: Seq[BinaryInput[F]])

Represents the root of a tree of rendered documents. In addition to the recursive structure of documents it holds additional items like static or cover documents, which may contribute to the output of a site or an e-book.

Value parameters

config

the root configuration of the rendered tree

coverDocument

the cover document (usually used with e-book formats like EPUB and PDF)

defaultTemplate

the default template configured for the output format, which may be used by a post-processor

outputContext

the context for the output format used in rendering (file suffix and format selector)

pathTranslator

the path translator specific to the output format produced by the renderer

staticDocuments

the paths of documents that were neither identified as text markup, config or templates, and will potentially be embedded or copied as is to the final output, depending on the output format

tree

the recursive structure of documents, usually obtained from parsing text markup

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

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

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

Attributes

val title: Option[SpanSequence]

The title of the tree, either obtained from the title document or configuration

The title of the tree, either obtained from the title document or configuration

Attributes

The optional title document of the tree.

The optional title document of the tree.

Attributes