laika.rst.ast
Members list
Type members
Classlikes
A classifier for a term in a definition list.
A classifier for a term in a definition list.
Attributes
- Graph
- Supertypes
- trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Generates a table of contents element inside a topic.
Generates a table of contents element inside a topic.
Attributes
- Graph
- Supertypes
- trait BlockResolvertrait Unresolvedtrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Temporary element to represent a customized text role that can be applied
to spans of interpreted text. The apply
function can then be applied
to spans of interpreted text referring to the name of this role and passing
the text as the argument to the function.
Temporary element to represent a customized text role that can be applied
to spans of interpreted text. The apply
function can then be applied
to spans of interpreted text referring to the name of this role and passing
the text as the argument to the function.
Attributes
- Graph
- Supertypes
- trait Hiddentrait Definitiontrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Represents an interactive Python session. Somewhat unlikely to be used in the context of this library, but included for the sake of completeness.
Represents an interactive Python session. Somewhat unlikely to be used in the context of this library, but included for the sake of completeness.
Attributes
- Graph
- Supertypes
- trait TextContainertrait Container[String]trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
A single entry in a field list consisting of name and body.
A single entry in a field list consisting of name and body.
Attributes
- Graph
- Supertypes
- trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait ListItemclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
A two-column table-like structure used for bibliographic fields or directive options.
A two-column table-like structure used for bibliographic fields or directive options.
Attributes
- Graph
- Supertypes
- trait RewritableContainertrait ListContainertrait ElementContainer[ListItem]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Temporary element representing a file inclusion. The path is interpreted as relative to the path of the processed document if it is not an absolute path.
Temporary element representing a file inclusion. The path is interpreted as relative to the path of the processed document if it is not an absolute path.
Attributes
- Graph
- Supertypes
- trait BlockResolvertrait Unresolvedtrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Temporary element to represent interpreted text with its associated role name. In a post-processing step this text will be replaced by the result of calling the corresponding role function.
Temporary element to represent interpreted text with its associated role name. In a post-processing step this text will be replaced by the result of calling the corresponding role function.
Attributes
- Graph
- Supertypes
- trait TextContainertrait Container[String]trait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
A single line inside a line block.
A single line inside a line block.
Attributes
- Companion:
- object
- Graph
- Supertypes
- trait SpanContainertrait ElementContainer[Span]trait ElementTraversalclass LineBlockItemtrait RewritableContainertrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
A block containing lines which preserve line breaks and optionally nested line blocks.
A block containing lines which preserve line breaks and optionally nested line blocks.
Attributes
- Companion:
- object
- Graph
- Supertypes
- trait ElementTraversalclass LineBlockItemtrait RewritableContainertrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
A single item inside a line block.
A single item inside a line block.
Attributes
- Graph
- Supertypes
- trait RewritableContainertrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
- Known subtypes
A single option argument.
A single option argument.
Attributes
- Graph
- Supertypes
A list of command line options and descriptions.
A list of command line options and descriptions.
Attributes
- Graph
- Supertypes
- trait RewritableContainertrait ListContainertrait ElementContainer[ListItem]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
A single item in an option list. The content property serves as the description of the option.
A single item in an option list. The content property serves as the description of the option.
Attributes
- Graph
- Supertypes
- trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait ListItemclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Header decoration consisting of both an overline and an underline.
Header decoration consisting of both an overline and an underline.
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait HeaderDecorationclass Objecttrait Matchableclass Any
A single option, including its name and all arguments, but not the description.
A single option, including its name and all arguments, but not the description.
Attributes
- Graph
- Supertypes
Represent a reference name. When resolving references whitespace needs to be normalized and the name converted to lower case.
Represent a reference name. When resolving references whitespace needs to be normalized and the name converted to lower case.
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Constants for style names wrapped in Options instances which are commonly used by Laika's reStructuredText parsers and rewrite rules.
Constants for style names wrapped in Options instances which are commonly used by Laika's reStructuredText parsers and rewrite rules.
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- RstStyle.type
A substitution definition with its span content that will be inserted wherever this substitution is referenced in flow content.
A substitution definition with its span content that will be inserted wherever this substitution is referenced in flow content.
Attributes
- Graph
- Supertypes
- trait Hiddentrait Definitiontrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Refers to a substitution definition with the same name. This type of element will only temporarily be part of the document tree and replaced by the content of the substitution definition in a rewrite step.
Refers to a substitution definition with the same name. This type of element will only temporarily be part of the document tree and replaced by the content of the substitution definition in a rewrite step.
Attributes
- Graph
- Supertypes
- trait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Header decoration consisting of an underline only.
Header decoration consisting of an underline only.
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait HeaderDecorationclass Objecttrait Matchableclass Any