laika.tree.Documents

DocumentTree

class DocumentTree extends Navigatable

Represents a tree with all its documents and subtrees.

Linear Supertypes
Navigatable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocumentTree
  2. Navigatable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentTree(path: Path, documents: Seq[Document], templates: Seq[TemplateDocument] = immutable.this.Nil, dynamicTemplates: Seq[TemplateDocument] = immutable.this.Nil, dynamicDocuments: Seq[Document] = immutable.this.Nil, staticDocuments: Seq[Input] = immutable.this.Nil, subtrees: Seq[DocumentTree] = immutable.this.Nil, config: Option[Config] = scala.None, docNumber: List[Int] = immutable.this.Nil, navigationOrder: Option[Seq[Navigatable]] = scala.None)

    path

    the full, absolute path of this (virtual) document tree

    documents

    all markup documents on this level of the tree hierarchy

    templates

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

    dynamicTemplates

    all dynamic documents that need to get processed before rendering on this level of the tree hierarchy

    dynamicDocuments

    all documents that were created by processing a dynamic template

    staticDocuments

    all static documents that need to be copied to the output

    config

    the configuration associated with this tree

    docNumber

    the number of this tree inside a document tree hierarchy, expressed as a list of Ints

    navigationOrder

    the markup documents and subtrees merged into a specific order, used for generating tables of contexts and autonumbering

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val documents: Seq[Document]

    all markup documents on this level of the tree hierarchy

  9. val dynamicDocuments: Seq[Document]

    all documents that were created by processing a dynamic template

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. val name: String

    The local name of this tree.

  17. lazy val navigatables: Seq[Navigatable]

    Markup documents and subtrees in a specific order based on the configuration for this tree.

    Markup documents and subtrees in a specific order based on the configuration for this tree. Before rewriting the configuration is not fully accessible yet and this list will be empty.

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val path: Path

    the full, absolute path of this (virtual) document tree

    the full, absolute path of this (virtual) document tree

    Definition Classes
    DocumentTree → Navigatable

  22. def rewrite(customRules: Seq[(DocumentContext) ⇒ PartialFunction[Element, Option[Element]]], autonumbering: AutonumberContext): DocumentTree

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

  23. def rewrite(customRule: (DocumentContext) ⇒ PartialFunction[Element, Option[Element]], autonumbering: AutonumberContext): DocumentTree

    Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rule and autonumbering context.

  24. def rewrite(customRule: (DocumentContext) ⇒ PartialFunction[Element, Option[Element]]): DocumentTree

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

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

    If the specified partial function is not defined for a specific element the old element remains in the tree unchanged. If it returns None then the node gets removed from the tree, if it returns an element it will replace the old one. Of course the function may also return the old element.

    The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, 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 a partial function that represents the rewrite rules for that particular document.

  25. def rewrite(autonumbering: AutonumberContext): DocumentTree

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

  26. def rewrite: DocumentTree

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

  27. def selectDocument(path: Path): Option[Document]

    Selects a document from this tree or one of its subtrees by the specified path.

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

  28. def selectDocument(path: String): Option[Document]

    Selects a document from this tree or one of its subtrees by the specified path.

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

  29. def selectSubtree(path: Path): Option[DocumentTree]

    Selects a subtree of this tree by the specified path.

    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.

  30. def selectSubtree(path: String): Option[DocumentTree]

    Selects a subtree of this tree by the specified path.

    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.

  31. def selectTarget(selector: Selector): Option[TargetResolver]

    Selects a link target by the specified selector if it is defined somewhere in a document inside this document tree.

  32. def selectTemplate(path: Path): Option[TemplateDocument]

    Selects a template from this tree or one of its subtrees by the specified path.

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

  33. def selectTemplate(path: String): Option[TemplateDocument]

    Selects a template from this tree or one of its subtrees by the specified path.

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

  34. val staticDocuments: Seq[Input]

    all static documents that need to be copied to the output

  35. val subtrees: Seq[DocumentTree]

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  37. lazy val title: Seq[Span]

    The title of this tree, obtained from configuration.

  38. def toString(): String

    Definition Classes
    AnyRef → Any

  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Navigatable

Inherited from AnyRef

Inherited from Any

Ungrouped