DocumentStructure
The structure of a markup document.
Attributes
- Graph
-
- Supertypes
- Known subtypes
-
class Document
- Self type
Members list
Value members
Abstract methods
The tree model obtained from parsing the markup document.
The tree model obtained from parsing the markup document.
Attributes
Concrete methods
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.
Attributes
Inherited methods
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
Attributes
- Returns
-
a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections
- Inherited from:
- DocumentNavigation
Attributes
- Inherited from:
- Navigatable
The formats this document should be rendered to.
Concrete fields
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
Inherited fields
The local name of this navigatable.