laika.rst.ast

package laika.rst.ast

Members list

Type members

Classlikes

case class Classifier(content: Seq[Span], options: Options) extends Span, SpanContainer

A classifier for a term in a definition list.

A classifier for a term in a definition list.

Attributes

Supertypes
trait Container[Seq[Span]]
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Contents(title: String, source: SourceFragment, depth: Int, local: Boolean, options: Options) extends Block, BlockResolver

Generates a table of contents element inside a topic.

Generates a table of contents element inside a topic.

Attributes

Supertypes
trait Unresolved
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class CustomizedTextRole(name: String, apply: String => Span, options: Options) extends Definition, Hidden

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

Supertypes
trait Hidden
trait Definition
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DoctestBlock(content: String, options: Options) extends Block, TextContainer

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

Supertypes
trait Container[String]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Field(name: Seq[Span], content: Seq[Block], options: Options) extends ListItem, BlockContainer

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

Supertypes
trait Container[Seq[Block]]
trait ListItem
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FieldList(content: Seq[Field], options: Options) extends Block, ListContainer, RewritableContainer

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

Supertypes
trait Container[Seq[ListItem]]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Include(path: String, source: SourceFragment, options: Options) extends Block, BlockResolver

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

Supertypes
trait Unresolved
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InterpretedText(role: String, content: String, source: SourceFragment, options: Options) extends Reference, TextContainer

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

Supertypes
trait Container[String]
trait Reference
trait Unresolved
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Line(content: Seq[Span], options: Options) extends LineBlockItem, SpanContainer

A single line inside a line block.

A single line inside a line block.

Attributes

Companion
object
Supertypes
trait Container[Seq[Span]]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Line extends SpanContainerCompanion

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
Line.type
case class LineBlock(content: Seq[LineBlockItem], options: Options) extends LineBlockItem, ElementTraversal, RewritableContainer

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
Supertypes
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LineBlock

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
LineBlock.type
abstract class LineBlockItem extends Block, RewritableContainer

A single item inside a line block.

A single item inside a line block.

Attributes

Supertypes
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Line
class LineBlock
case class OptionArgument(value: String, delimiter: String, options: Options) extends Element

A single option argument.

A single option argument.

Attributes

Supertypes
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OptionList(content: Seq[OptionListItem], options: Options) extends Block, ListContainer, RewritableContainer

A list of command line options and descriptions.

A list of command line options and descriptions.

Attributes

Supertypes
trait Container[Seq[ListItem]]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OptionListItem(programOptions: Seq[ProgramOption], content: Seq[Block], options: Options) extends ListItem, BlockContainer

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

Supertypes
trait Container[Seq[Block]]
trait ListItem
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OverlineAndUnderline(char: Char) extends HeaderDecoration

Header decoration consisting of both an overline and an underline.

Header decoration consisting of both an overline and an underline.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ProgramOption(name: String, argument: Option[OptionArgument], options: Options) extends Element

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

Supertypes
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ReferenceName(original: String)

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

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RstStyle

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

Supertypes
class Object
trait Matchable
class Any
Self type
RstStyle.type
case class SubstitutionDefinition(name: String, content: Span, options: Options) extends Definition, Hidden

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

Supertypes
trait Hidden
trait Definition
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SubstitutionReference(name: String, source: SourceFragment, options: Options) extends Reference

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

Supertypes
trait Reference
trait Unresolved
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Underline(char: Char) extends HeaderDecoration

Header decoration consisting of an underline only.

Header decoration consisting of an underline only.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all