laika.ast

Extractors for pattern matching against absolute and relative paths.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: /.type

Represents a target defined by an absolute path.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InternalTarget

trait Target

class Object

trait Matchable

class Any
Show all

Label with automatic numbering.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class FootnoteLabel

class Object

trait Matchable

class Any
Show all
Self type: Autonumber.type

Label using automatic numbering and explicit label names together.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class FootnoteLabel

class Object

trait Matchable

class Any
Show all

Label with automatic symbol assignment.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class FootnoteLabel

class Object

trait Matchable

class Any
Show all
Self type: Autosymbol.type

The base type for all block level elements.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait BlockResolver

class BreadcrumbBuilder

class NavigationBuilderConfig

class DirectiveInstance

class SeparatorInstance

class Contents

class Include

class BlockScope

class BlockSequence

class BulletList

class Citation

class CodeBlock

class Comment

class DecoratedHeader

trait Definition

class FootnoteDefinition

class LinkAlias

class LinkDefinition

class CustomizedTextRole

class SubstitutionDefinition

class DefinitionList

class DocumentFragment

class EmbeddedConfigValue

class EnumList

class Figure

class Footnote

class ForcedParagraph

class Header

class InternalLinkTarget

class InvalidBlock

trait LinkTarget

class LiteralBlock

class NavigationItem

class NavigationList

class PageBreak

class Paragraph

class ParsedLiteralBlock

class QuotedBlock

class RawContent

class RootElement

class Rule

class RuntimeMessage

class Section

class Selection

class SpanSequence

class Table

class TargetFormat

class TemplateRoot

class Title

class TitledBlock

class HTMLBlock

class HTMLComment

class HTMLEmptyElement

class HTMLStartTag

class BookmarkTitle

class ContentWrapper

class FootnoteBody

class ListItemBody

class ListItemLabel

class Preamble

class DoctestBlock

class FieldList

class LineBlockItem

class Line

class LineBlock

class OptionList
Show all

A container of other Block elements. Such a container is usually also a Block itself.

Attributes

Supertypes: trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class BlockSequence

class BulletListItem

class Cell

class Choice

class Citation

class DefinitionListItem

class EmbeddedRoot

class EnumListItem

class Figure

class Footnote

class FootnoteDefinition

class QuotedBlock

class RootElement

class Section

class TitledBlock

class FootnoteBody

class ListItemBody

class Field

class OptionListItem
Show all

Common methods for simple block containers (without additional parameters).

Attributes

Supertypes: trait SpanContainerCompanion

class Object

trait Matchable

class Any
Known subtypes: object BlockSequence.type

object BodyCell.type

trait BulletListCompanion

object BulletList.type

object EmbeddedRoot.type

trait EnumListCompanion

object EnumList.type

object HeadCell.type

object QuotedBlock.type

object RootElement.type
Show all

Represents a placeholder block element that needs to be resolved in a rewrite step. Useful for elements that need access to the document, structure, title or configuration before being fully resolved.

Attributes

Supertypes: trait Unresolved

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class BreadcrumbBuilder

class NavigationBuilderConfig

class DirectiveInstance

class SeparatorInstance

class Contents

class Include
Show all

Represents a block element that introduces new context that can be used in substitution references in any child element.

Usually used in directive implementations and not contributing to the rendered output itself.

Attributes

Supertypes: trait Block

trait ElementScope[Block]

trait Unresolved

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A generic container element containing a list of blocks. Can be used where a sequence of blocks must be inserted in a place where a single element is required by the API. Usually renderers do not treat the container as a special element and render its children as s sub flow of the parent container.

Attributes

Companion: object
Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: BlockSequence.type

A cell in the body part of the table.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait BlockContainerCompanion

trait SpanContainerCompanion

class CellType

class Object

trait Matchable

class Any
Show all
Self type: BodyCell.type

The format of a bullet list item.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class StringBullet

A bullet list that may contain nested lists.

Attributes

Companion: object
Supertypes: trait RewritableContainer

trait ListContainer

trait ElementContainer[ListItem]

trait ElementTraversal

trait Container[Seq[ListItem]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion for creating BulletList instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait BulletListCompanion

trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: BulletList.type

Base trait for companions that create BulletList instances.

Attributes

Supertypes: trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Known subtypes: object BulletList.type

A single bullet list item consisting of one or more block elements.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait ListItem

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The table caption.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Caption.type

A single span inside a code block that has been categorized by a syntax highlighter.

Attributes

Supertypes: trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class CodeSpan

class CodeSpanSequence

A single cell, potentially spanning multiple rows or columns, containing one or more block elements.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The cell type specifies which part of the table the cell belongs to.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object BodyCell.type

object HeadCell.type

Represents a single choice in a ChoiceGroup.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A citation that can be referred to by a CitationLink by id.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait LinkTarget

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A resolved link to a citation.

Attributes

Supertypes: trait LocalLink

trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A reference to a citation with a matching label. Only part of the raw document tree and then removed by the rewrite rule that resolves link and image references.

Attributes

Supertypes: trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A block of program code. The content is a sequence of spans to support the integration of syntax highlighting systems. For unsupported languages the sequence will only consist of a single Text element.

Attributes

Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A span of code associated with zero or more code categories.

Attributes

Companion: object
Supertypes: trait TextContainer

trait Container[String]

trait CategorizedCode

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: CodeSpan.type

A sequence of code spans where most of them are usually associated with zero or more code categories.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait CategorizedCode

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: CodeSpanSequence.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: CodeSpans.type

The options (like styles) for a column table.

Attributes

Supertypes: trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Contains the (optional) column specification of a table.

Attributes

Companion: object
Supertypes: trait TableContainer

trait ElementContainer[TableElement]

trait ElementTraversal

trait Container[Seq[TableElement]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Convenient factory for creating a Columns instance based on the options for the individual columns.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Columns.type

A comment that may be omitted by renderers.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A generic container. Usually not mixed in directly, instead one of the sub-traits TextContainer, ListContainer, SpanContainer or BlockContainer should be used.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait ElementContainer[E]

trait BlockContainer

class BlockSequence

class BulletListItem

class Cell

class Choice

class Citation

class DefinitionListItem

class EmbeddedRoot

class EnumListItem

class Figure

class Footnote

class FootnoteDefinition

class QuotedBlock

class RootElement

class Section

class TitledBlock

class FootnoteBody

class ListItemBody

class Field

class OptionListItem

trait ListContainer

class BulletList

class DefinitionList

class EnumList

class NavigationItem

class NavigationList

class FieldList

class OptionList

class SectionInfo

trait SpanContainer

class Caption

class CodeBlock

class CodeSpanSequence

class DecoratedHeader

class Deleted

class Emphasized

class ForcedParagraph

class Header

class InlineCode

class Inserted

class LinkIdReference

class LinkPathReference

class Paragraph

class ParsedLiteralBlock

class SpanLink

class SpanSequence

class Strong

class Title

class HTMLElement

class Classifier

class Line

trait TableContainer

class Columns

class Row

class TableBody

class TableHead

trait TemplateSpanContainer

class TemplateRoot

class TemplateSpanSequence

trait TextContainer

class CodeSpan

class Comment

class Literal

class LiteralBlock

class RawContent

class RuntimeMessage

class SectionNumber

class TemplateString

class Text

class HTMLCharacterReference

class HTMLComment

class HTMLScriptElement

class BookmarkTitle

class DoctestBlock

class InterpretedText
Show all

Represents a reference to a value from the context of the current document. The ref attribute is a simple path expression in dot notation for accessing properties of an object (or keys of a Map).

The root elements accessible to such a reference are:

document: the current document with all of its public properties
parent: the parent tree of the current document
root: the root tree
config: all configuration values for the current document, including those inherited from parent trees

Attributes

Supertypes: trait SpanResolver

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class MarkupContextReference

class TemplateContextReference

A cursor provides the necessary context during a rewrite operation. The stateless document tree cannot provide access to parent or sibling nodes in the tree, therefore a temporary cursor instance is created during a rewrite operation for this purpose.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class DocumentCursor

class TreeCursor

A decorated header where the level gets determined in the rewrite phase based on the decoration used and the order they appear in the document. The first decoration type encountered is used for level 1, the second for level 2, and so on.

Attributes

Companion: object
Supertypes: trait Unresolved

trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: DecoratedHeader.type

Represents a definition that can be used to resolve references.

Only part of the raw document tree and then removed or replaced by a rewrite rule before rendering.

Attributes

Supertypes: trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class FootnoteDefinition

class LinkAlias

class LinkDefinition

class CustomizedTextRole

class SubstitutionDefinition

A list of terms and their definitions. Not related to the Definition base trait.

Attributes

Companion: object
Supertypes: trait RewritableContainer

trait ListContainer

trait ElementContainer[ListItem]

trait ElementTraversal

trait Container[Seq[ListItem]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: DefinitionList.type

A single definition item, containing the term and definition (as the content property).

Attributes

Companion: object
Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait ListItem

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: DefinitionListItem.type

A span representing deleted inline elements that may contain nested spans.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Deleted.type

Represents a single document and provides access to the document content and structure as well as hooks for triggering rewrite operations.

Value parameters

config: the configuration for this document
content: the tree model obtained from parsing the markup document
fragments: separate named fragments that had been extracted from the content
path: the full, absolute path of this document in the (virtual) document tree
position: the position of this document inside a document tree hierarchy, expressed as a list of Ints

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait TreeContent

trait DocumentStructure

trait DocumentNavigation

trait Navigatable

class Object

trait Matchable

class Any
Show all

Cursor for a single document, its parent, siblings and root directories, its associated template and other context information that is required during a rewrite operation.

Value parameters

config: the configuration associated with the target document
parent: the parent document tree of the referred document
position: the position of the target document inside a tree hierarchy
resolver: the resolver for references in templates
target: the document this cursor points to
templatePath: the path of the template that has been applied to this document

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Cursor

class Object

trait Matchable

class Any
Show all
Self type: DocumentCursor

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: DocumentCursor.type

A named document fragment that usually gets rendered separately from the main root element

Attributes

Supertypes: trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Metadata associated with a document.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: DocumentMetadata.type

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

Attributes

Supertypes: trait Navigatable

class Object

trait Matchable

class Any
Known subtypes: trait DocumentStructure

class Document

The structure of a markup document.

Attributes

Supertypes: trait DocumentNavigation

trait Navigatable

class Object

trait Matchable

class Any
Known subtypes: class Document
Self type: TreeContent

Represents a tree with all its documents, templates, configurations and subtrees.

Value parameters

config: the configuration associated with this tree
content: the markup documents and subtrees
path: the full, absolute path of this (virtual) document tree
position: the position of this tree inside a document ast hierarchy, expressed as a list of Ints
templates: all templates on this level of the tree hierarchy that might get applied to a document when it gets rendered
titleDocument: the optional title document of this tree

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait TreeContent

trait Navigatable

trait TreeStructure

class Object

trait Matchable

class Any
Show all

Represents the root of a tree of documents. In addition to the recursive structure of documents, usually obtained by parsing text markup, it holds additional items like styles and static documents, which may contribute to the rendering of a site or an e-book.

The styles property of this type is currently only populated and processed when rendering PDF or XSL-FO. Styles for HTML or EPUB documents are part of the staticDocuments property instead and will be integrated into the final output, but not interpreted.

Value parameters

coverDocument: the cover document (usually used with e-book formats like EPUB and PDF)
includes: the map of configuration includes that may be needed when resolving template configuration
staticDocuments: the descriptors for documents that were neither identified as text markup, config or templates, and will be copied as is to the final output
styles: the styles to apply when rendering this tree, only populated for PDF or XSL-FO output
tree: the recursive structure of documents, usually obtained from parsing text markup

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Base type for all document type descriptors.

Attributes

Companion: object
Supertypes: trait Product

trait Equals

class Object

trait Matchable

class Any
Known subtypes: object Ignored.type

class Static

class TextDocumentType

object Config.type

object Markup.type

class StyleSheet

object Template.type
Show all

Provides all available DocumentTypes.

Attributes

Companion: class
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: DocumentType.type

The base class for all Elements forming the document tree. Usually not extended directly, instead either Span or Block should be picked as the base type for new element types.

All node types have an optional id and zero or more associated styles serving as render hints.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait Block

trait BlockResolver

class BreadcrumbBuilder

class NavigationBuilderConfig

class DirectiveInstance

class SeparatorInstance

class Contents

class Include

class BlockScope

class BlockSequence

class BulletList

class Citation

class CodeBlock

class Comment

class DecoratedHeader

trait Definition

class FootnoteDefinition

class LinkAlias

class LinkDefinition

class CustomizedTextRole

class SubstitutionDefinition

class DefinitionList

class DocumentFragment

class EmbeddedConfigValue

class EnumList

class Figure

class Footnote

class ForcedParagraph

class Header

class InternalLinkTarget

class InvalidBlock

trait LinkTarget

class LiteralBlock

class NavigationItem

class NavigationList

class PageBreak

class Paragraph

class ParsedLiteralBlock

class QuotedBlock

class RawContent

class RootElement

class Rule

class RuntimeMessage

class Section

class Selection

class SpanSequence

class Table

class TargetFormat

class TemplateRoot

class Title

class TitledBlock

class HTMLBlock

class HTMLComment

class HTMLEmptyElement

class HTMLStartTag

class BookmarkTitle

class ContentWrapper

class FootnoteBody

class ListItemBody

class ListItemLabel

class Preamble

class DoctestBlock

class FieldList

class LineBlockItem

class Line

class LineBlock

class OptionList

trait Container[T]

trait ElementContainer[E]

trait BlockContainer

class BulletListItem

class Cell

class Choice

class DefinitionListItem

class EmbeddedRoot

class EnumListItem

class Field

class OptionListItem

trait ListContainer

class SectionInfo

trait SpanContainer

class Caption

class CodeSpanSequence

class Deleted

class Emphasized

class InlineCode

class Inserted

class LinkIdReference

class LinkPathReference

class SpanLink

class Strong

class HTMLElement

class Classifier

trait TableContainer

class Columns

class Row

class TableBody

class TableHead

trait TemplateSpanContainer

class TemplateSpanSequence

trait TextContainer

class CodeSpan

class Literal

class SectionNumber

class TemplateString

class Text

class HTMLCharacterReference

class HTMLScriptElement

class InterpretedText

trait Hidden

trait Invalid

class InvalidSpan

trait ListItem

trait RewritableContainer

class TemplateElement

class DirectiveInstance

trait Span

trait CategorizedCode

trait Icon

class IconGlyph

class IconStyle

class InlineSVGIcon

class SVGSymbolIcon

class LineBreak

trait Link

trait GlobalLink

class Image

class RawLink

trait LocalLink

class CitationLink

class FootnoteLink

trait Reference

class CitationReference

class FootnoteReference

class IconReference

class ImageIdReference

trait PathReference

class ImagePathReference

class SubstitutionReference

class Reverse

trait SpanResolver

class ContextReference[T]

class MarkupContextReference

class TemplateContextReference

class LinkDirectiveResolver

class SeparatorInstance

class DirectiveInstance

class SeparatorInstance

class ImageResolver

class SpanScope

trait TemplateSpan

class TemplateScope

class HTMLSpan

class HTMLEndTag

class Leader

class PageNumberCitation

trait TableElement

class Column

trait Unresolved

trait ElementScope[E]

class OptionArgument

class ProgramOption
Show all

A generic container of other elements. Provides means to traverse, select and rewrite children of this container.

Usually not mixed in directly, instead one of the sub-traits ListContainer, SpanContainer or BlockContainer should be used.

Attributes

Supertypes: trait ElementTraversal

trait Container[Seq[E]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait BlockContainer

class BlockSequence

class BulletListItem

class Cell

class Choice

class Citation

class DefinitionListItem

class EmbeddedRoot

class EnumListItem

class Figure

class Footnote

class FootnoteDefinition

class QuotedBlock

class RootElement

class Section

class TitledBlock

class FootnoteBody

class ListItemBody

class Field

class OptionListItem

trait ListContainer

class BulletList

class DefinitionList

class EnumList

class NavigationItem

class NavigationList

class FieldList

class OptionList

class SectionInfo

trait SpanContainer

class Caption

class CodeBlock

class CodeSpanSequence

class DecoratedHeader

class Deleted

class Emphasized

class ForcedParagraph

class Header

class InlineCode

class Inserted

class LinkIdReference

class LinkPathReference

class Paragraph

class ParsedLiteralBlock

class SpanLink

class SpanSequence

class Strong

class Title

class HTMLElement

class Classifier

class Line

trait TableContainer

class Columns

class Row

class TableBody

class TableHead

trait TemplateSpanContainer

class TemplateRoot

class TemplateSpanSequence
Show all

Represents an element that introduces new context that can be used in substitution references in any child element.

Usually used in directive implementations and not contributing to the rendered output itself.

Attributes

Supertypes: trait Unresolved

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class BlockScope

class SpanScope

class TemplateScope

Provides means to traverse and select elements of a document tree. This trait can get mixed in by any element node, not just the root Document class, therefore providing traversal for any kind of sub-tree, too.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait ElementContainer[E]

trait BlockContainer

class BlockSequence

class BulletListItem

class Cell

class Choice

class Citation

class DefinitionListItem

class EmbeddedRoot

class EnumListItem

class Figure

class Footnote

class FootnoteDefinition

class QuotedBlock

class RootElement

class Section

class TitledBlock

class FootnoteBody

class ListItemBody

class Field

class OptionListItem

trait ListContainer

class BulletList

class DefinitionList

class EnumList

class NavigationItem

class NavigationList

class FieldList

class OptionList

class SectionInfo

trait SpanContainer

class Caption

class CodeBlock

class CodeSpanSequence

class DecoratedHeader

class Deleted

class Emphasized

class ForcedParagraph

class Header

class InlineCode

class Inserted

class LinkIdReference

class LinkPathReference

class Paragraph

class ParsedLiteralBlock

class SpanLink

class SpanSequence

class Strong

class Title

class HTMLElement

class Classifier

class Line

trait TableContainer

class Columns

class Row

class TableBody

class TableHead

trait TemplateSpanContainer

class TemplateRoot

class TemplateSpanSequence

class Table

class TemplateElement

class LineBlock
Show all
Self type: Element

A single configuration value to be merged with the top document config. This is particularly useful for directive implementations that need to contribute to the configuration of the document. During rendering these embedded configuration values will be discarded.

Attributes

Companion: object
Supertypes: trait Hidden

trait Span

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: EmbeddedConfigValue.type

The root element of a document tree (originating from text markup) inside a template. Usually created by a template reference like ${cursor.currentDocument.content}.

Attributes

Companion: object
Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait TemplateSpan

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: EmbeddedRoot.type

A span of emphasized inline elements that may contain nested spans.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Emphasized.type

The format of enumerated list items.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An enumerated list that may contain nested lists.

Attributes

Companion: object
Supertypes: trait RewritableContainer

trait ListContainer

trait ElementContainer[ListItem]

trait ElementTraversal

trait Container[Seq[ListItem]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion for creating BulletList instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait EnumListCompanion

trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: EnumList.type

Base trait for companions that create EnumList instances.

Attributes

Supertypes: trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Known subtypes: object EnumList.type

A single enum list item consisting of one or more block elements.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait ListItem

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents the type of an ordered list.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Arabic.type

object LowerAlpha.type

object LowerRoman.type

object UpperAlpha.type

object UpperRoman.type

Enumeration of supported enum types.

Attributes

Companion: class
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: EnumType.type

An external link, outside of the virtual tree of the current transformation.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait Target

class Object

trait Matchable

class Any
Show all

Provides a fallback for elements the renderer does not know how to deal with.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ForcedParagraph

trait Invalid

class InvalidBlock

class InvalidSpan

A figure consists of an image, an optional caption, and an optional legend as the content property. The image property is of type Span as the image might be wrapped inside a link reference.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A footnote with resolved id and label that can be referred to by a FootnoteLink by id.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait LinkTarget

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A footnote definition that needs to be resolved to a final footnote by a rewrite rule based on the label type.

Attributes

Supertypes: trait Unresolved

trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Definition

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Base type for all types of footnote labels.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Autonumber.type

class AutonumberLabel

object Autosymbol.type

class NumericLabel

A resolved link to a footnote.

Attributes

Supertypes: trait LocalLink

trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A reference to a footnote with a matching label. Only part of the raw document tree and then removed by the rewrite rule that resolves link and image references.

Attributes

Supertypes: trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A special type of paragraph that serves as a render hint. Some renderers simplify the rendering of block elements containing only a single paragraph and render the span content inline (e.g. a <li> tag without a nested <p> tag for the paragraph). Using this element as mandated by some edge cases in both the Markdown and reStructuredText markup definitions prevents this.

Attributes

Supertypes: trait Fallback

trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Generic base trait for all path abstractions in Laika.

The most commonly used sub-type is VirtualPath which is used to assign paths to trees and documents within a Laika transformation.

This trait is the only one within the Path API that is not sealed, to allow for implementations in other modules (e.g. FilePath in laika-io).

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait VirtualPath

trait Path

object Root.type

class SegmentedPath

trait RelativePath

class CurrentDocument

object CurrentTree.type

class Parent

class SegmentedRelativePath

trait SegmentedVirtualPath
Show all

A global link that can point to any document within the input tree or to an external target.

Attributes

Supertypes: trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Image

class RawLink

class SpanLink

A cell in the head part of the table.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait BlockContainerCompanion

trait SpanContainerCompanion

class CellType

class Object

trait Matchable

class Any
Show all
Self type: HeadCell.type

A header element with a level, with 1 being the top level of the document.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Header.type

Represents the decoration of a header. Concrete implementations need to be provided by the parser.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class OverlineAndUnderline

class Underline

Represents a hidden element that will be ignored by renderers.

These kind of nodes usually provide information that will be extracted from the tree before AST transformations and renderers get applied.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class EmbeddedConfigValue

class LinkAlias

class LinkDefinition

class CustomizedTextRole

class SubstitutionDefinition

Base trait for all supported icon types.

Attributes

Supertypes: trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class IconGlyph

class IconStyle

class InlineSVGIcon

class SVGSymbolIcon

Represents a font-based icon, identified by its code point. Ideally theme authors provide constants for icons provided out of the box, so that the user does not have to look up or memorize the hex code point.

This avoids the indirection of common approaches where the rendered HTML contains an empty tag with a class which specifies the code point with a :before pseudo-class. This approach would currently not work well with Laika's PDF support which is not based on an interim HTML renderer.

Attributes

Supertypes: trait Icon

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A reference to an icon by key.

The icon must have been registered with the global configuration to be accessible by this node type. The indirection provided by this key allows to more easily swap entire icon sets without touching any code.

Attributes

Supertypes: trait Reference

trait SpanResolver

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An icon defined in a style sheet, usually defining a glyph from an icon font. This icon type is not supported for PDF output, when using font icons with PDF use IconGlyph instead.

Attributes

Supertypes: trait Icon

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Factory and extractor for an Options instance with an id.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: Id.type

An inline image optional title, alt and size properties.

Attributes

Companion: object
Supertypes: trait GlobalLink

trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Image.type

An image reference, the id pointing to the id of a LinkTarget. Only part of the raw document tree and then removed by the rewrite rule that resolves link and image references.

Attributes

Supertypes: trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An image reference to content within the virtual input tree, the path pointing to the source path. Only part of the unresolved document tree and then removed by the rewrite rule that replace the source path with the final target path of the output document, resolving any relative path references in the process.

Attributes

Supertypes: trait PathReference

trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A span of program code. The content is a sequence of spans to support the integration of syntax highlighting systems. Without this support the sequence will only consist of a single Text element.

Attributes

Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An SVG icon that will render inline, supported for all output formats.

Attributes

Supertypes: trait Icon

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A span representing inserted inline elements that may contain nested spans.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Inserted.type

Points to the following block or span element, making it a target for links.

Attributes

Supertypes: trait LinkTarget

trait Span

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a target within the virtual tree that can be referred to by links.

Attributes

Companion: object
Supertypes: trait Target

class Object

trait Matchable

class Any
Known subtypes: class AbsoluteInternalTarget

class RelativeInternalTarget

class ResolvedInternalTarget

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: InternalTarget.type

Represents an invalid element. Renderers can choose to either render the fallback or the runtime message or both, depending on the configuration of the transformer or renderer.

Attributes

Supertypes: trait Fallback

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class InvalidBlock

class InvalidSpan

Groups a block that could not be successfully parsed with a runtime message. Renderers may then choose to just render the fallback, the message or both.

Attributes

Companion: object
Supertypes: trait Invalid

trait Fallback

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: InvalidBlock.type

Groups a span that could not be successfully parsed with a runtime message. Renderers may then choose to just render the fallback, the message or both.

Attributes

Companion: object
Supertypes: trait Invalid

trait Fallback

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: InvalidSpan.type

Encapsulates size information with a CSS-compatible length unit.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A base for builder of CSS-compatible length units.

Attributes

Companion: object
Supertypes: trait Double => Length

class Object

trait Matchable

class Any
Known subtypes: object ch.type

object cm.type

object em.type

object ex.type

object in.type

object mm.type

object pc.type

object percent.type

object pt.type

object px.type

object rem.type

object vh.type

object vmax.type

object vmin.type

object vw.type
Show all

Attributes

Companion: class
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: LengthUnit.type

An explicit hard line break.

Attributes

Supertypes: trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The base type for all link elements.

In contrast to the reference type, it is only mixed in by elements representing resolved links that can be dealt with by renderers.

Attributes

Supertypes: trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait GlobalLink

class Image

class RawLink

class SpanLink

trait LocalLink

class CitationLink

class FootnoteLink
Show all

A link target pointing to another link target, acting like an alias.

Attributes

Supertypes: trait Hidden

trait Span

trait Definition

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An internal or external link target that can be referenced by id, usually only part of the raw document tree and then removed by the rewrite rule that resolves link and image references.

Attributes

Companion: object
Supertypes: trait Span

trait Hidden

trait Definition

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: LinkDefinition.type

A reference to any kind of referencable object, e.g. a link definition or an internal target.

The reference can be local, in the same document, or anywhere else in the input tree, as long as the id is not ambiguous. Search for a matching target happens recursively, from the current document, to the current tree (directory) upwards to the root tree.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion for creating LinkIdReference instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: LinkIdReference.type

A reference to content within the virtual input tree, the path pointing to the source path. Only part of the unresolved document tree and then removed by the rewrite rule that replace the source path with the final target path of the output document, which might differ in more than just the file suffix, depending on configuration.

Attributes

Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait PathReference

trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The base type for all link targets. The id has to be unique for the whole document across all types of LinkTarget implementations.

Attributes

Supertypes: trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Citation

class Footnote

class InternalLinkTarget

A container of list items. Such a container is usually a Block itself.

Attributes

Supertypes: trait ElementContainer[ListItem]

trait ElementTraversal

trait Container[Seq[ListItem]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class BulletList

class DefinitionList

class EnumList

class NavigationItem

class NavigationList

class FieldList

class OptionList
Show all

The base type for all list items.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class BulletListItem

class DefinitionListItem

class EnumListItem

class NavigationItem

class Field

class OptionListItem
Show all

A span containing plain, unparsed text.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A literal block with unparsed text content.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A local link that always points to a target within the same document.

Attributes

Supertypes: trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class CitationLink

class FootnoteLink

A context reference specifically for use in markup documents.

Attributes

Supertypes: class ContextReference[Span]

trait SpanResolver

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A filter for runtime messages that meet a specified minimum message level.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object None.type

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: MessageFilter.type

Signals the severity of a runtime message.

Attributes

Companion: object
Supertypes: trait Product

trait Equals

trait Ordered[MessageLevel]

trait Comparable[MessageLevel]

class Object

trait Matchable

class Any
Show all
Known subtypes: object Debug.type

object Error.type

object Fatal.type

object Info.type

object Warning.type

Enumeration of available message levels.

The library's internal parsers and AST transformation only use the Error level for recoverable issues encountered during transformations. All other levels are available for user code.

Attributes

Companion: class
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: MessageLevel.type

A navigatable object is anything that has an associated path.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait DocumentNavigation

trait DocumentStructure

class Document

class TemplateDocument

trait TreeContent

class DocumentTree
Show all

The context of a navigation builder that can get passed down in recursive calls to the various types that have an asNavigationItem method.

Value parameters

currentLevel: the current level of the navigation tree being built
excludeSections: indicates whether the recursion should exclude sections of documents even when maxLevels has not been reached yet
itemStyles: the styles to assign to each navigation item as a render hint
maxLevels: the number of levels of sub-trees, documents or sections to create navigation info for
refPath: the path of document from which this document will be linked (for creating a corresponding relative path)

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a navigation entry with an optional target link and optional child items. When the target link is not present, this item only serves as a navigation header for its children.

Attributes

Supertypes: trait ListContainer

trait RewritableContainer

trait ElementContainer[NavigationItem]

trait ElementTraversal

trait Container[Seq[NavigationItem]]

trait ListItem

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a book navigation entry that links to content in the document tree.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The root node of a navigation structure

Attributes

Companion: object
Supertypes: trait RewritableContainer

trait ListContainer

trait ElementContainer[ListItem]

trait ElementTraversal

trait Container[Seq[ListItem]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: NavigationList.type

Empty Options implementation.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Options

class Object

trait Matchable

class Any
Show all
Self type: NoOpt.type

Explicit numeric label.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class FootnoteLabel

class Object

trait Matchable

class Any
Show all

Options for customizable elements.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object NoOpt.type

class SomeOpt

Companion for the Options trait.

Attributes

Companion: class
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Options.type

An explicit hard page break.

Attributes

Supertypes: trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A paragraph consisting of span elements.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Paragraph.type

Represents a parent selector and indicates whether it is an immediate parent or an ancestor anywhere in the hierarchy.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A literal block with parsed text content.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: ParsedLiteralBlock.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: ParsedTarget.type

Represents an absolute path inside a virtual tree of documents.

Since this is the most commonly used path abstraction in Laika it received a conveniently short type name. The full, accurate name of this type would be AbsoluteVirtualPath.

Attributes

Companion: object
Supertypes: trait VirtualPath

trait Serializable

trait Product

trait Equals

trait GenericPath

class Object

trait Matchable

class Any
Show all
Known subtypes: object Root.type

class SegmentedPath

Factory methods for creating path instances.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Path.type

A reference to content within the virtual input tree, the path pointing to the source path. Only part of the unresolved document tree and then removed by the rewrite rule that replace the source path with the final target path of the output document, which might differ in more than just the file suffix, depending on configuration.

Attributes

Supertypes: trait Reference

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class ImagePathReference

class LinkPathReference

A quoted block consisting of a list of blocks that may contain other nested quoted blocks and an attribution which may be empty.

Attributes

Companion: object
Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: QuotedBlock.type

Raw content that is usually specific to the specified output formats. Can be used as both block and inline element. If supported by a parser it usually has to be explicitly enabled due to security concerns.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Span

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A raw link element without associated content (text or image).

One potential use case is to insert AST nodes that are only responsible for rendering a single tag attribute as opposed to rendering the full tag like all other link node types.

Raw links participate in path translation (e.g. for versioning) like all other link node types.

Attributes

Companion: object
Supertypes: trait GlobalLink

trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion for creating RawLink instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: RawLink.type

The base type for all reference elements.

A reference points to some other node in the document tree and needs to be resolved and replaced by a rewrite rule before rendering. Therefore none of the available renderers include logic for dealing with references.

Attributes

Supertypes: trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class CitationReference

class FootnoteReference

class IconReference

class ImageIdReference

class LinkIdReference

trait PathReference

class ImagePathReference

class LinkPathReference

class InterpretedText

class SubstitutionReference
Show all

Represents a target defined by a relative path; the absolute path of such a target needs to be resolved later in the context of the containing document and its path.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InternalTarget

trait Target

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: trait VirtualPath

trait Serializable

trait Product

trait Equals

trait GenericPath

class Object

trait Matchable

class Any
Show all
Known subtypes: class CurrentDocument

object CurrentTree.type

class Parent

class SegmentedRelativePath

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: RelativePath.type

Indicates that the element a rewrite rule had been applied to should be removed from the document AST.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait RewriteAction[Nothing]

class Object

trait Matchable

class Any
Show all
Self type: Remove.type

Indicates that the element a rewrite rule had been applied to should be replaced with this new value.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RewriteAction[T]

class Object

trait Matchable

class Any
Show all

Represents a resolved internal target where both the absolute and relative path are known, the latter relative to the document that referred to the target.

The internalFormats property describes which of the output formats treat this as an internal link. For other formats the link gets translated to an external target based on the siteBaseURL setting. This might be useful for cases where some pages get rendered to a site, but not included in an e-book format like EPUB and PDF.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InternalTarget

trait Target

class Object

trait Matchable

class Any
Show all

Indicates that the element a rewrite rule had been applied to should be kept in the document AST unchanged.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait RewriteAction[Nothing]

class Object

trait Matchable

class Any
Show all
Self type: Retain.type

Attributes

Supertypes: trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A generic container of child elements which can have rewrite rules applied to them in recursive tree rewriting.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait BlockContainer

class BlockSequence

class BulletListItem

class Cell

class Choice

class Citation

class DefinitionListItem

class EmbeddedRoot

class EnumListItem

class Figure

class Footnote

class FootnoteDefinition

class QuotedBlock

class RootElement

class Section

class TitledBlock

class FootnoteBody

class ListItemBody

class Field

class OptionListItem

class BulletList

class DefinitionList

class EnumList

class NavigationItem

class NavigationList

class Row

class Selection

trait SpanContainer

class Caption

class CodeBlock

class CodeSpanSequence

class DecoratedHeader

class Deleted

class Emphasized

class ForcedParagraph

class Header

class InlineCode

class Inserted

class LinkIdReference

class LinkPathReference

class Paragraph

class ParsedLiteralBlock

class SpanLink

class SpanSequence

class Strong

class Title

class HTMLElement

class Classifier

class Line

class Table

class TableBody

class TableHead

class TemplateElement

trait TemplateSpanContainer

class TemplateRoot

class TemplateSpanSequence

class DirectiveInstance

class DirectiveInstance

class FieldList

class LineBlock

class LineBlockItem

class OptionList
Show all

Describes the action to be performed for a particular node in the document AST.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Remove.type

class Replace[T]

object Retain.type

Represents one of the rewrite phases for document AST transformations.

These transformations are performed between parsing and rendering and deal with tasks like link validation, resolving substitution variables, directive processing or other tasks.

A phased model allows to separate rules that contribute new nodes to the AST from nodes that analyze the existing AST, e.g. for producing navigation artifacts. Running them all in one phase would create a chicken-and-egg scenario that would usually lead to undesired or unexpected results.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Build.type

class Render

object Resolve.type

Attributes

Companion: trait
Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: RewritePhase.type

A set of rewrite rules describing a set of modifications to be applied to an AST of a document.

For reasons of type-safety the major element type blocks and spans (in markup documents) and template spans (in template documents) have their separate set of rules, as an element in a block position for example can usually only be replaced by another block and not by any other element type.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Factory methods and utilities for dealing with rewrite rules.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: RewriteRules.type

Converts Roman numerals to integers and vice versa. Since there never have been universally accepted rules for Roman numerals, the conversion functions do not apply strict error checking, so some unusual or illegal constructs may be supported, too. They do not prevent using the same symbol more than three times in a row for example.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: RomanNumerals.type

Cursor for the root node of a document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.

Value parameters

target: the root of the document tree this cursor points to

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: RootCursor.type

The root element of a document tree.

Attributes

Companion: object
Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait BlockContainerCompanion

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: RootElement.type

A single table row. In case some of the previous rows contain cells with a colspan greater than 1, this row may contain fewer cells than the number of columns in the table.

Attributes

Companion: object
Supertypes: trait RewritableContainer

trait TableContainer

trait ElementContainer[TableElement]

trait ElementTraversal

trait Container[Seq[TableElement]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Row.type

A horizontal rule.

Attributes

Supertypes: trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Message generated by the parser, a directive or a rewrite rule.

They usually get inserted immediately after the block or span that caused the problem. It mixes in both the Span and Block trait so that it can appear in sequences of both types. By default messages are ignored by most renderers (apart from AST), but they can be explicitly activated for a particular level.

A message of level MessageLevel.Error will cause a transformation to fail, unless the user has configured with the renderErrors method to debug in a visual mode in which case the errors will get rendered in-place in the output.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Block

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An icon referencing an SVG shape defined in an external file or embedded SVG element. This icon type is not supported for PDF output, when using SVG icons with PDF use InlineSVGIcon instead.

Attributes

Companion: object
Supertypes: trait Icon

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion for creating SVGSymbolIcon instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: SVGSymbolIcon.type

A section of the document, consisting of a header and content in the form of a list of Block elements. Sections may be nested inside other sections, they are arranged in a hierarchy based on the level of their header element.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Captures information about a document section, without its content.

Attributes

Supertypes: trait ElementContainer[SectionInfo]

trait ElementTraversal

trait Container[Seq[SectionInfo]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a section number, usually used in header elements when autonumbering is applied.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait SegmentedVirtualPath

trait Path

trait VirtualPath

trait Serializable

trait Product

trait Equals

trait GenericPath

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait SegmentedVirtualPath

trait RelativePath

trait VirtualPath

trait Serializable

trait Product

trait Equals

trait GenericPath

class Object

trait Matchable

class Any
Show all

The common base for absolute and relative paths that contain one or more path segments.

Attributes

Companion: object
Supertypes: trait VirtualPath

trait Serializable

trait Product

trait Equals

trait GenericPath

class Object

trait Matchable

class Any
Show all
Known subtypes: class SegmentedPath

class SegmentedRelativePath

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: SegmentedVirtualPath.type

Represents a selection of choices (alternatives) that represent the same content in different ways, e.g. a code sample in Scala or Java or a build setup in sbt vs. Maven. In the final output these will usually be rendered in a way to allow for a convenient selection.

Attributes

Supertypes: trait RewritableContainer

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Options implementation for non-empty instances.

For creating new instances it is usually more convenient to use the various factory objects. Example for creating an instance with an id and two styles applied:

val options = Id("myId") + Styles("style1","style2")

Likewise it is also often more convenient to use the corresponding extractors for pattern matching.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Options

class Object

trait Matchable

class Any
Show all

The base type for all inline elements.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait CategorizedCode

class CodeSpan

class CodeSpanSequence

class Deleted

class EmbeddedConfigValue

class Emphasized

trait Icon

class IconGlyph

class IconStyle

class InlineSVGIcon

class SVGSymbolIcon

class InlineCode

class Inserted

class InternalLinkTarget

class InvalidSpan

class LineBreak

trait Link

trait GlobalLink

class Image

class RawLink

class SpanLink

trait LocalLink

class CitationLink

class FootnoteLink

class LinkAlias

class LinkDefinition

class Literal

class RawContent

trait Reference

class CitationReference

class FootnoteReference

class IconReference

class ImageIdReference

class LinkIdReference

trait PathReference

class ImagePathReference

class LinkPathReference

class InterpretedText

class SubstitutionReference

class Reverse

class RuntimeMessage

class SectionNumber

trait SpanResolver

class ContextReference[T]

class MarkupContextReference

class TemplateContextReference

class LinkDirectiveResolver

class DirectiveInstance

class SeparatorInstance

class DirectiveInstance

class SeparatorInstance

class ImageResolver

class SpanScope

class SpanSequence

class Strong

trait TemplateSpan

class EmbeddedRoot

class TemplateElement

class TemplateRoot

class TemplateScope

class TemplateSpanSequence

class TemplateString

class Text

class HTMLSpan

class HTMLCharacterReference

class HTMLComment

class HTMLElement

class HTMLEmptyElement

class HTMLEndTag

class HTMLScriptElement

class HTMLStartTag

class Leader

class PageNumberCitation

class Classifier
Show all

A container of other Span elements. Such a container may be a Block or a Span itself.

Attributes

Supertypes: trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Caption

class CodeBlock

class CodeSpanSequence

class DecoratedHeader

class Deleted

class Emphasized

class ForcedParagraph

class Header

class InlineCode

class Inserted

class LinkIdReference

class LinkPathReference

class Paragraph

class ParsedLiteralBlock

class SpanLink

class SpanSequence

class Strong

class Title

class HTMLElement

class Classifier

class Line
Show all

Common methods for simple span containers (without additional parameters).

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait BlockContainerCompanion

object BlockSequence.type

object BodyCell.type

trait BulletListCompanion

object BulletList.type

object EmbeddedRoot.type

trait EnumListCompanion

object EnumList.type

object HeadCell.type

object QuotedBlock.type

object RootElement.type

object Caption.type

object CodeSpanSequence.type

object Deleted.type

object Emphasized.type

object Inserted.type

trait Companion

object Paragraph.type

object ParsedLiteralBlock.type

trait Companion

object SpanSequence.type

object Strong.type

object Title.type

object Line.type
Show all

An link element, with the span content representing the text (description) of the link.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait GlobalLink

trait Link

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion for creating SpanLink instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: SpanLink.type

Represents a placeholder inline element that needs to be resolved in a rewrite step. Useful for elements that need access to the document, structure, title or configuration before being fully resolved.

Attributes

Supertypes: trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class ContextReference[T]

class MarkupContextReference

class TemplateContextReference

class IconReference

class LinkDirectiveResolver

class DirectiveInstance

class SeparatorInstance

class DirectiveInstance

class SeparatorInstance

class ImageResolver
Show all

Represents a span element that introduces new context that can be used in substitution references in any child element.

Usually used in directive implementations and not contributing to the rendered output itself.

Attributes

Supertypes: trait Span

trait ElementScope[Span]

trait Unresolved

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A generic container element containing a list of spans. Can be used where a sequence of spans must be inserted in a place where a single element is required by the API. Usually renderers do not treat the container as a special element and render its children as s sub flow of the parent container. A span sequence is special in that in can be used as both a span and a block.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Span

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: SpanSequence.type

Represents the specificity of a style selector or predicate. This is modeled after the precedence rules of the CSS standard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait Ordered[Specificity]

trait Comparable[Specificity]

class Object

trait Matchable

class Any
Show all

A pure descriptor for a static document, without the actual bytes. Used for evaluating links and other AST transformation phases.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: StaticDocument.type

Bullet format based on a simple string.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait BulletFormat

class Object

trait Matchable

class Any
Show all

A span of strong inline elements that may contain nested spans.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Strong.type

Constants for style names wrapped in Options instances which are commonly used by Laika's core parsers and rewrite rules.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: Style.type

Represents a single style declaration.

Value parameters

selector: the selector to determine which elements this declaration applies to
styles: the styles themselves in a map representing the names and values of each style

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion providing factory methods for the StyleDeclaration class.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait (StyleSelector, Map[String, String]) => StyleDeclaration

class Object

trait Matchable

class Any
Show all
Self type: StyleDeclaration.type

Represents a set of one or more style declarations.

Value parameters

paths: the paths the style declarations have been obtained from
precedence: the precedence of this set compared to other provided sets
styles: the style declarations that belong to this set

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion providing factory methods for the StyleDeclaration class.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait (Set[Path], Set[StyleDeclaration], Precedence) => StyleDeclarationSet

class Object

trait Matchable

class Any
Show all
Self type: StyleDeclarationSet.type

Represents a single predicate which is part of the selector for a style declaration.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ElementType

class Id

class StyleName

Contains the available predicate types.

The available selector types represent a subset of the full CSS standard, picking those features which are reasonably suited in the context of the Laika document model. It includes type, class and id selectors, but no attribute selectors as most Laika tree elements primarily contain a sequence of children and not many other properties to match against.

It also supports the CSS syntax to declare selectors for child elements (e.g. Paragraph .intro) or immediate children (e.g. Paragraph > .intro).

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: StylePredicate.type

Responsible for determining whether a style declaration should be applied to a target element, basing its decision on a set of predicates.

Value parameters

order: the index of the style declaration this selector belongs to
parent: the optional parent selector
predicates: the set of predicates that need to hold for this selector to be applicable to a target element

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Factory and extractor for an Options instance with style names.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: Styles.type

A table consisting of a head and a body part and optional caption and column specification.

Attributes

Companion: object
Supertypes: trait RewritableContainer

trait ElementTraversal

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Table.type

Contains the body rows of a table.

Attributes

Supertypes: trait RewritableContainer

trait TableContainer

trait ElementContainer[TableElement]

trait ElementTraversal

trait Container[Seq[TableElement]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A container of table elements.

Attributes

Supertypes: trait ElementContainer[TableElement]

trait ElementTraversal

trait Container[Seq[TableElement]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Columns

class Row

class TableBody

class TableHead

A table element, like a row, cell or column.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Caption

class Cell

class Column

class Columns

class Row

class TableBody

trait TableContainer

class TableHead
Show all

Contains the header rows of a table.

Attributes

Supertypes: trait RewritableContainer

trait TableContainer

trait ElementContainer[TableElement]

trait ElementTraversal

trait Container[Seq[TableElement]]

trait TableElement

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a target that can be referred to by links, either within the virtual tree or external.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ExternalTarget

trait InternalTarget

class AbsoluteInternalTarget

class RelativeInternalTarget

class ResolvedInternalTarget

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: Target.type

An element that only gets rendered for a specific output format.

Attributes

Supertypes: trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A context reference specifically for use in template documents.

Attributes

Supertypes: trait TemplateSpan

class ContextReference[TemplateSpan]

trait SpanResolver

trait Unresolved

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A template document containing the element tree of a parsed template and its extracted configuration section (if present).

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait Navigatable

class Object

trait Matchable

class Any
Show all

Wraps a generic element that otherwise could not be placed directly into a template document tree. Useful when custom tags which are placed inside a template produce non-template tree elements.

Attributes

Supertypes: trait RewritableContainer

trait ElementTraversal

trait TemplateSpan

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The root element of a template document tree.

Attributes

Companion: object
Supertypes: trait TemplateSpanContainer

trait RewritableContainer

trait ElementContainer[TemplateSpan]

trait ElementTraversal

trait Container[Seq[TemplateSpan]]

trait TemplateSpan

trait Span

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion with a fallback instance for setups without a default template

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait TemplateSpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: TemplateRoot.type

Represents a template span element that introduces new context that can be used in substitution references in any child element.

Usually used in directive implementations and not contributing to the rendered output itself.

Attributes

Supertypes: trait TemplateSpan

trait Span

trait ElementScope[TemplateSpan]

trait Unresolved

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The base type for all inline elements that can be found in a template.

Attributes

Supertypes: trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class EmbeddedRoot

class TemplateContextReference

class TemplateElement

class TemplateRoot

class TemplateScope

class TemplateSpanSequence

class TemplateString

class DirectiveInstance

class SeparatorInstance
Show all

A container of other TemplateSpan elements.

Attributes

Supertypes: trait RewritableContainer

trait ElementContainer[TemplateSpan]

trait ElementTraversal

trait Container[Seq[TemplateSpan]]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class TemplateRoot

class TemplateSpanSequence

Common methods for simple template span containers (without additional parameters).

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object TemplateRoot.type

object TemplateSpanSequence.type

A generic container element containing a list of template spans. Can be used where a sequence of spans must be inserted in a place where a single element is required by the API. Usually renderers do not treat the container as a special element and render its children as s sub flow of the parent container.

Attributes

Companion: object
Supertypes: trait TemplateSpanContainer

trait RewritableContainer

trait ElementContainer[TemplateSpan]

trait ElementTraversal

trait Container[Seq[TemplateSpan]]

trait TemplateSpan

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait TemplateSpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: TemplateSpanSequence.type

A simple string element, representing the parts of a template that are not detected as special markup constructs and treated as raw text.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait TemplateSpan

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A simple text element.

Attributes

Supertypes: trait TextContainer

trait Container[String]

trait Span

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A container for plain text.

Attributes

Supertypes: trait Container[String]

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class CodeSpan

class Comment

class Literal

class LiteralBlock

class RawContent

class RuntimeMessage

class SectionNumber

class TemplateString

class Text

class HTMLCharacterReference

class HTMLComment

class HTMLScriptElement

class BookmarkTitle

class DoctestBlock

class InterpretedText
Show all

Base type for all document type descriptors for text input.

Attributes

Supertypes: class DocumentType

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: object Config.type

object Markup.type

class StyleSheet

object Template.type

The (optional) title of the document.

Attributes

Companion: object
Supertypes: trait SpanContainer

trait RewritableContainer

trait ElementContainer[Span]

trait ElementTraversal

trait Container[Seq[Span]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait SpanContainerCompanion

class Object

trait Matchable

class Any
Show all
Self type: Title.type

Generic block element with a title. Often combined with the the styles attribute of the options parameter to provide additional render hints.

Attributes

Supertypes: trait BlockContainer

trait RewritableContainer

trait ElementContainer[Block]

trait ElementTraversal

trait Container[Seq[Block]]

trait Block

class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Generically builds a tree structure out of a flat sequence of elements with a Path property that signifies the position in the tree. Essentially factors recursion out of the tree building process.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: TreeBuilder.type

A titled, positional element in the document tree.

Attributes

Supertypes: trait Navigatable

class Object

trait Matchable

class Any
Known subtypes: class Document

class DocumentTree

Cursor for an entire document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.

Value parameters

config: the configuration associated with this tree
parent: the immediate parent of this tree or None if this is the root
position: the position of this tree within the document tree
root: the root of this tree
target: the document tree this cursor points to

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Cursor

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: TreeCursor.type

The position of an element within a document tree.

Attributes

Companion: object
Supertypes: trait Ordered[TreePosition]

trait Comparable[TreePosition]

class Object

trait Matchable

class Any

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: TreePosition.type

The structure of a document tree.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class DocumentTree
Self type: TreeContent

Represents an element that needs to be resolved in an AST transformation step.

Passing documents that still contain elements of this kind to a renderer will usually be treated as errors.

Attributes

Supertypes: class Element

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: trait BlockResolver

class BreadcrumbBuilder

class NavigationBuilderConfig

class DirectiveInstance

class SeparatorInstance

class Contents

class Include

class DecoratedHeader

trait ElementScope[E]

class BlockScope

class SpanScope

class TemplateScope

class FootnoteDefinition

trait Reference

class CitationReference

class FootnoteReference

class IconReference

class ImageIdReference

class LinkIdReference

trait PathReference

class ImagePathReference

class LinkPathReference

class InterpretedText

class SubstitutionReference

trait SpanResolver

class ContextReference[T]

class MarkupContextReference

class TemplateContextReference

class LinkDirectiveResolver

class DirectiveInstance

class SeparatorInstance

class DirectiveInstance

class SeparatorInstance

class ImageResolver
Show all

A temporary structure usually not exposed to user code. It holds a document with an empty Config instance and its actual config (obtained from a header section if present) in unresolved form, as it needs to be resolved based on a fallback configuration later.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The abstract base for absolute and relative paths within Laika's virtual path abstraction.

A path in Laika is always virtual and not pointing to a path in the file system, even if the data was obtained by scanning a directory. This is because in Laika transformation input can come from different sources, e.g. from two different directories merged into a single virtual tree in memory with some additional documents added programmatically without any file system reference.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait GenericPath

class Object

trait Matchable

class Any
Show all
Known subtypes: trait Path

object Root.type

class SegmentedPath

trait RelativePath

class CurrentDocument

object CurrentTree.type

class Parent

class SegmentedRelativePath

trait SegmentedVirtualPath
Show all

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: VirtualPath.type

A wrapper for two result values.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

laika.ast

Attributes

Members list

Type members

Classlikes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes