DocumentNavigation
Represents a document structure with sections that can be turned into a navigation structure.
Attributes
- Source
- DocumentNavigation.scala
- Graph
-
- Supertypes
- Known subtypes
-
class Document
Members list
Value members
Abstract methods
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.
Attributes
- Source
- DocumentNavigation.scala
The formats this document should be rendered to.
The title of this document, obtained from the document structure or from the configuration.
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.
Attributes
- Source
- DocumentNavigation.scala
Concrete methods
Creates the navigation structure for this document up to the specified depth.
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
Attributes
- Returns
-
a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections
- Source
- DocumentNavigation.scala
Inherited methods
Attributes
- Inherited from:
- Navigatable
- Source
- documents.scala
Inherited fields
The local name of this navigatable.