laika-core/laika.ast/DocumentNavigation

DocumentNavigation

trait DocumentNavigation extends Navigatable

Represents a document structure with sections that can be turned into a navigation structure.

class Object
trait Matchable
class Any
class Document

Value members

Abstract methods

def sections: Seq[SectionInfo]

The section structure of this document based on the hierarchy of headers found in the original text markup.

The section structure of this document based on the hierarchy of headers found in the original text markup.

def targetFormats: TargetFormats

The formats this document should be rendered to.

The formats this document should be rendered to.

def title: Option[SpanSequence]

The title of this document, obtained from the document structure or from the configuration. In case no title is defined in either of the two places the result will be None.

The title of this document, obtained from the document structure or from the configuration. In case no title is defined in either of the two places the result will be None.

Concrete methods

def asNavigationItem(context: NavigationBuilderContext): NavigationItem

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

Returns:

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

Inherited methods

def path: Path
Inherited from:
Navigatable

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Inherited from:
Navigatable