TreeContent

laika.ast.TreeContent
sealed trait TreeContent extends Navigatable

A titled, positional element in the document tree.

Attributes

Graph
Supertypes
trait Navigatable
class Object
trait Matchable
class Any
Known subtypes
class Document
class DocumentTree

Members list

Value members

Abstract methods

Creates the navigation structure for this instance 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.

Creates the navigation structure for this instance 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.

Value parameters

context

captures the navigation depth, reference path and styles for the navigation tree being built

Attributes

Returns

a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections

def config: Config

The configuration associated with this element.

The configuration associated with this element.

Attributes

protected def configScope: Scope

Extracts all invalid elements with the specified minimum message level from this tree content.

Extracts all invalid elements with the specified minimum message level from this tree content.

Attributes

The position of this element within the document tree.

The position of this element within the document tree.

Attributes

Extracts all runtime messages with the specified minimum level from this tree content.

Extracts all runtime messages with the specified minimum level from this tree content.

Attributes

def title: Option[SpanSequence]

The title of this element which can originate from the first header of a markup file or from configuration.

The title of this element which can originate from the first header of a markup file or from configuration.

Attributes

Concrete methods

The formats this tree content should be rendered to.

The formats this tree content should be rendered to.

Attributes

protected def titleFromConfig: Option[SpanSequence]

Inherited methods

def path: Path

Attributes

Inherited from:
Navigatable

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Attributes

Inherited from:
Navigatable