laika.ast
Attributes
Members list
Type members
Classlikes
Extractors for pattern matching against absolute and relative paths.
Extractors for pattern matching against absolute and relative paths.
Attributes
- Source
- paths.scala
- Supertypes
- Self type
-
/.type
The base type for all block level elements.
The base type for all block level elements.
Attributes
- Source
- base.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HTMLBlockclass HTMLCommentclass HTMLEmptyElementclass HTMLStartTagtrait BlockResolverclass BlockScopeclass BlockSequenceclass BulletListclass Citationclass CodeBlockclass Commentclass DecoratedHeadertrait Definitionclass FootnoteDefinitionclass LinkAliasclass LinkDefinitionclass DefinitionListclass DocumentFragmentclass EmbeddedConfigValueclass EnumListclass Figureclass Footnoteclass ForcedParagraphclass Headerclass InternalLinkTargetclass InvalidBlocktrait LinkTargetclass LiteralBlockclass NavigationItemclass NavigationListclass PageBreakclass Paragraphclass ParsedLiteralBlockclass QuotedBlockclass RawContentclass RootElementclass Ruleclass RuntimeMessageclass Sectionclass Selectionclass SpanSequenceclass Tableclass TargetFormatclass TemplateRootclass Titleclass TitledBlockShow all
A container of other Block elements.
A container of other Block elements. Such a container is usually also a Block itself.
Attributes
- Source
- containers.scala
- Supertypes
-
trait RewritableContainertrait ElementContainer[Block]trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class BlockSequenceclass BulletListItemclass Cellclass Choiceclass Citationclass DefinitionListItemclass EmbeddedRootclass EnumListItemclass Figureclass Footnoteclass FootnoteDefinitionclass QuotedBlockclass RootElementclass Sectionclass TitledBlockShow all
Common methods for simple block containers (without additional parameters).
Common methods for simple block containers (without additional parameters).
Attributes
- Source
- containers.scala
- Supertypes
- Known subtypes
-
object BlockSequence.typetrait BulletListCompanionobject BulletList.typeobject BodyCell.typeobject HeadCell.typeobject EmbeddedRoot.typetrait EnumListCompanionobject EnumList.typeobject QuotedBlock.typeobject RootElement.typeShow all
Represents a placeholder block element that needs to be resolved in a rewrite step.
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
- Source
- resolvers.scala
- Supertypes
-
trait Unresolvedtrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a block element that introduces new context that can be used in substitution references in any child element.
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
- Source
- resolvers.scala
- Supertypes
-
trait Blocktrait ElementScope[Block]trait Unresolvedclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A generic container element containing a list of blocks.
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
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
-
trait Producttrait Mirrortrait BlockContainerCompaniontrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
BlockSequence.type
The format of a bullet list item.
The format of a bullet list item.
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
- Known subtypes
-
class StringBullet
Attributes
- Companion
- trait
- Source
- lists.scala
- Supertypes
- Self type
-
BulletFormat.type
A bullet list that may contain nested lists.
A bullet list that may contain nested lists.
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
-
trait RewritableContainertrait ListContainertrait ElementContainer[ListItem]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion for creating BulletList instances.
Companion for creating BulletList instances.
Attributes
- Companion
- class
- Source
- lists.scala
- Supertypes
-
trait Producttrait Mirrortrait BulletListCompaniontrait BlockContainerCompaniontrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
BulletList.type
Base trait for companions that create BulletList instances.
Base trait for companions that create BulletList instances.
Attributes
- Source
- lists.scala
- Supertypes
- Known subtypes
-
object BulletList.type
A single bullet list item consisting of one or more block elements.
A single bullet list item consisting of one or more block elements.
Attributes
- Source
- lists.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait ListItemclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The table caption.
The table caption.
Attributes
- Companion
- object
- Source
- Table.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- Table.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
Caption.type
A single span inside a code block that has been categorized by a syntax highlighter.
A single span inside a code block that has been categorized by a syntax highlighter.
Attributes
- Source
- spans.scala
- Supertypes
-
trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class CodeSpanclass CodeSpanSequence
A single cell, potentially spanning multiple rows or columns, containing one or more block elements.
A single cell, potentially spanning multiple rows or columns, containing one or more block elements.
Attributes
- Source
- Table.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The cell type specifies which part of the table the cell belongs to.
The cell type specifies which part of the table the cell belongs to.
Attributes
- Companion
- object
- Source
- Table.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- class
- Source
- Table.scala
- Supertypes
- Self type
-
CellType.type
Represents a single choice in a ChoiceGroup
.
Represents a single choice in a ChoiceGroup
.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A citation that can be referred to by a CitationLink
by id.
A citation that can be referred to by a CitationLink
by id.
Attributes
- Source
- links.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait LinkTargettrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A resolved link to a citation.
A reference to a citation with a matching label.
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
- Source
- links.scala
- Supertypes
-
trait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A block of program code.
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
- Source
- blocks.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A span of code associated with zero or more code categories.
A span of code associated with zero or more code categories.
Attributes
- Companion
- object
- Source
- spans.scala
- Supertypes
-
trait TextContainertrait Container[String]trait CategorizedCodetrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
- Self type
-
CodeSpan.type
A sequence of code spans where most of them are usually associated with zero or more code categories.
A sequence of code spans where most of them are usually associated with zero or more code categories.
Attributes
- Companion
- object
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait CategorizedCodetrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
CodeSpanSequence.type
Attributes
- Source
- spans.scala
- Supertypes
- Self type
-
CodeSpans.type
The options (like styles) for a column table.
The options (like styles) for a column table.
Attributes
- Source
- Table.scala
- Supertypes
-
trait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Contains the (optional) column specification of a table.
Contains the (optional) column specification of a table.
Attributes
- Companion
- object
- Source
- Table.scala
- Supertypes
-
trait TableContainertrait ElementContainer[TableElement]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Convenient factory for creating a Columns
instance based on the options for the individual columns.
Convenient factory for creating a Columns
instance based on the options for the individual columns.
Attributes
- Companion
- class
- Source
- Table.scala
- Supertypes
- Self type
-
Columns.type
A comment that may be omitted by renderers.
A comment that may be omitted by renderers.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A generic container.
A generic container. Usually not mixed in directly, instead one of the sub-traits TextContainer
, ListContainer
, SpanContainer
or BlockContainer
should be used.
Attributes
- Source
- containers.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait ElementContainer[E]trait BlockContainerclass BlockSequenceclass BulletListItemclass Cellclass Choiceclass Citationclass DefinitionListItemclass EmbeddedRootclass EnumListItemclass Figureclass Footnoteclass FootnoteDefinitionclass QuotedBlockclass RootElementclass Sectionclass TitledBlocktrait ListContainerclass BulletListclass DefinitionListclass EnumListclass NavigationItemclass NavigationListclass SectionInfotrait SpanContainerclass HTMLElementclass Captionclass CodeBlockclass CodeSpanSequenceclass DecoratedHeaderclass Deletedclass Emphasizedclass ForcedParagraphclass Headerclass InlineCodeclass Insertedclass LinkIdReferenceclass LinkPathReferenceclass Paragraphclass ParsedLiteralBlockclass SpanLinkclass SpanSequenceclass Strongclass Titletrait TableContainerclass Columnsclass Rowclass TableBodyclass TableHeadtrait TemplateSpanContainerclass TemplateRootclass TemplateSpanSequencetrait TextContainerclass HTMLCharacterReferenceclass HTMLCommentclass HTMLScriptElementclass CodeSpanclass Commentclass Literalclass LiteralBlockclass RawContentclass RuntimeMessageclass SectionNumberclass TemplateStringclass TextShow all
Represents a reference to a value from the context of the current document.
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
- Source
- resolvers.scala
- Supertypes
-
trait SpanResolvertrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class MarkupContextReferenceclass TemplateContextReference
A cursor provides the necessary context during a rewrite operation.
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
- Source
- Cursor.scala
- Supertypes
- Known subtypes
-
class DocumentCursorclass 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.
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
- Source
- blocks.scala
- Supertypes
-
trait Unresolvedtrait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
- Self type
-
DecoratedHeader.type
Provides the paths for default templates for all formats.
Provides the paths for default templates for all formats.
Attributes
- Source
- DefaultTemplatePath.scala
- Supertypes
- Self type
-
DefaultTemplatePath.type
Represents a definition that can be used to resolve references.
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
- Source
- base.scala
- Supertypes
-
trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
A list of terms and their definitions.
A list of terms and their definitions. Not related to the Definition
base trait.
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
-
trait RewritableContainertrait ListContainertrait ElementContainer[ListItem]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- lists.scala
- Supertypes
- Self type
-
DefinitionList.type
A single definition item, containing the term and definition (as the content property).
A single definition item, containing the term and definition (as the content property).
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait ListItemclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- lists.scala
- Supertypes
- Self type
-
DefinitionListItem.type
A span representing deleted inline elements that may contain nested spans.
A span representing deleted inline elements that may contain nested spans.
Attributes
- Companion
- object
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow 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.
Represents a single document and provides access to the document content and structure as well as hooks for triggering rewrite operations.
Value parameters
- content
-
the tree model obtained from parsing the markup document
- fragments
-
separate named fragments that had been extracted from the content
Attributes
- Companion
- object
- Source
- documents.scala
- Supertypes
-
trait TreeContenttrait DocumentNavigationtrait Navigatableclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- documents.scala
- Supertypes
- Self type
-
Document.type
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.
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
- parent
-
the parent document tree of the referred document
- 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
- Source
- Cursor.scala
- Supertypes
- Self type
Attributes
- Companion
- class
- Source
- Cursor.scala
- Supertypes
- Self type
-
DocumentCursor.type
A named document fragment that usually gets rendered separately from the main root element
A named document fragment that usually gets rendered separately from the main root element
Attributes
- Source
- blocks.scala
- Supertypes
-
trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a document structure with sections that can be turned into a navigation structure.
Represents a document structure with sections that can be turned into a navigation structure.
Attributes
- Source
- DocumentNavigation.scala
- Supertypes
- Known subtypes
-
class Document
Represents a virtual tree with all its documents, templates, configurations and subtrees.
Represents a virtual tree with all its documents, templates, configurations and subtrees.
Value parameters
- content
-
the markup documents and subtrees except for the (optional) title document
- 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
- Companion
- object
- Source
- documents.scala
- Supertypes
Attributes
- Companion
- class
- Source
- documents.scala
- Supertypes
- Self type
-
DocumentTree.type
API for a safe and concise way of constructing a DocumentTree
.
API for a safe and concise way of constructing a DocumentTree
.
The hierarchy of the tree will be constructed based on the provided Path
instances while also ensuring that document configuration is wired up correctly (inheriting the configuration from directories).
Attributes
- Source
- DocumentTreeBuilder.scala
- Supertypes
Represents the root of a tree of documents.
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)
- 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
- Companion
- object
- Source
- documents.scala
- Supertypes
Attributes
- Companion
- class
- Source
- documents.scala
- Supertypes
- Self type
-
DocumentTreeRoot.type
Base type for all document type descriptors.
Base type for all document type descriptors.
Attributes
- Companion
- object
- Source
- DocumentType.scala
- Supertypes
- Known subtypes
-
object Ignored.typeclass Staticclass TextDocumentTypeobject Config.typeobject Markup.typeclass StyleSheetobject Template.typeShow all
Provides all available DocumentTypes.
Provides all available DocumentTypes.
Attributes
- Companion
- class
- Source
- DocumentType.scala
- Supertypes
- Self type
-
DocumentType.type
The base class for all Elements forming the document tree.
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
- Source
- base.scala
- Supertypes
- Known subtypes
-
trait Blockclass HTMLBlockclass HTMLCommentclass HTMLEmptyElementclass HTMLStartTagtrait BlockResolverclass BlockScopeclass BlockSequenceclass BulletListclass Citationclass CodeBlockclass Commentclass DecoratedHeadertrait Definitionclass FootnoteDefinitionclass LinkAliasclass LinkDefinitionclass DefinitionListclass DocumentFragmentclass EmbeddedConfigValueclass EnumListclass Figureclass Footnoteclass ForcedParagraphclass Headerclass InternalLinkTargetclass InvalidBlocktrait LinkTargetclass LiteralBlockclass NavigationItemclass NavigationListclass PageBreakclass Paragraphclass ParsedLiteralBlockclass QuotedBlockclass RawContentclass RootElementclass Ruleclass RuntimeMessageclass Sectionclass Selectionclass SpanSequenceclass Tableclass TargetFormatclass TemplateRootclass Titleclass TitledBlocktrait Container[T]trait ElementContainer[E]trait BlockContainerclass BulletListItemclass Cellclass Choiceclass DefinitionListItemclass EmbeddedRootclass EnumListItemtrait ListContainerclass SectionInfotrait SpanContainerclass HTMLElementclass Captionclass CodeSpanSequenceclass Deletedclass Emphasizedclass InlineCodeclass Insertedclass LinkIdReferenceclass LinkPathReferenceclass SpanLinkclass Strongtrait TableContainerclass Columnsclass Rowclass TableBodyclass TableHeadtrait TemplateSpanContainerclass TemplateSpanSequencetrait TextContainerclass HTMLCharacterReferenceclass HTMLScriptElementclass CodeSpanclass Literalclass SectionNumberclass TemplateStringclass Texttrait Hiddentrait Invalidclass InvalidSpantrait ListItemtrait RewritableContainerclass TemplateElementtrait Spanclass HTMLSpanclass HTMLEndTagtrait CategorizedCodetrait Iconclass IconGlyphclass IconStyleclass InlineSVGIconclass SVGSymbolIconclass LineBreaktrait Linktrait GlobalLinkclass Imageclass RawLinktrait LocalLinkclass CitationLinkclass FootnoteLinktrait Referenceclass CitationReferenceclass FootnoteReferenceclass IconReferenceclass ImageIdReferencetrait PathReferenceclass ImagePathReferenceclass Reversetrait SpanResolverclass ContextReference[T]class MarkupContextReferenceclass TemplateContextReferenceclass SpanScopetrait TemplateSpanclass TemplateScopetrait TableElementclass Columntrait Unresolvedtrait ElementScope[E]Show all
A generic container of other elements.
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
- Source
- containers.scala
- Supertypes
-
trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait BlockContainerclass BlockSequenceclass BulletListItemclass Cellclass Choiceclass Citationclass DefinitionListItemclass EmbeddedRootclass EnumListItemclass Figureclass Footnoteclass FootnoteDefinitionclass QuotedBlockclass RootElementclass Sectionclass TitledBlocktrait ListContainerclass BulletListclass DefinitionListclass EnumListclass NavigationItemclass NavigationListclass SectionInfotrait SpanContainerclass HTMLElementclass Captionclass CodeBlockclass CodeSpanSequenceclass DecoratedHeaderclass Deletedclass Emphasizedclass ForcedParagraphclass Headerclass InlineCodeclass Insertedclass LinkIdReferenceclass LinkPathReferenceclass Paragraphclass ParsedLiteralBlockclass SpanLinkclass SpanSequenceclass Strongclass Titletrait TableContainerclass Columnsclass Rowclass TableBodyclass TableHeadtrait TemplateSpanContainerclass TemplateRootclass TemplateSpanSequenceShow all
Represents an element that introduces new context that can be used in substitution references in any child element.
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
- Source
- resolvers.scala
- Supertypes
-
trait Unresolvedclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Provides means to traverse and select elements of a document tree.
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
- Source
- ElementTraversal.scala
- Supertypes
- Known subtypes
-
trait ElementContainer[E]trait BlockContainerclass BlockSequenceclass BulletListItemclass Cellclass Choiceclass Citationclass DefinitionListItemclass EmbeddedRootclass EnumListItemclass Figureclass Footnoteclass FootnoteDefinitionclass QuotedBlockclass RootElementclass Sectionclass TitledBlocktrait ListContainerclass BulletListclass DefinitionListclass EnumListclass NavigationItemclass NavigationListclass SectionInfotrait SpanContainerclass HTMLElementclass Captionclass CodeBlockclass CodeSpanSequenceclass DecoratedHeaderclass Deletedclass Emphasizedclass ForcedParagraphclass Headerclass InlineCodeclass Insertedclass LinkIdReferenceclass LinkPathReferenceclass Paragraphclass ParsedLiteralBlockclass SpanLinkclass SpanSequenceclass Strongclass Titletrait TableContainerclass Columnsclass Rowclass TableBodyclass TableHeadtrait TemplateSpanContainerclass TemplateRootclass TemplateSpanSequenceclass Tableclass TemplateElementShow all
- Self type
A single configuration value to be merged with the top document config.
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
- Source
- blocks.scala
- Supertypes
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
- Self type
-
EmbeddedConfigValue.type
The root element of a document tree (originating from text markup) inside a template.
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
- Source
- templates.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait TemplateSpantrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- templates.scala
- Supertypes
-
trait Producttrait Mirrortrait BlockContainerCompaniontrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
EmbeddedRoot.type
A span of emphasized inline elements that may contain nested spans.
A span of emphasized inline elements that may contain nested spans.
Attributes
- Companion
- object
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
Emphasized.type
The format of enumerated list items.
An enumerated list that may contain nested lists.
An enumerated list that may contain nested lists.
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
-
trait RewritableContainertrait ListContainertrait ElementContainer[ListItem]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion for creating BulletList instances.
Companion for creating BulletList instances.
Attributes
- Companion
- class
- Source
- lists.scala
- Supertypes
-
trait Producttrait Mirrortrait EnumListCompaniontrait BlockContainerCompaniontrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
EnumList.type
Base trait for companions that create EnumList instances.
Base trait for companions that create EnumList instances.
Attributes
- Source
- lists.scala
- Supertypes
- Known subtypes
-
object EnumList.type
A single enum list item consisting of one or more block elements.
A single enum list item consisting of one or more block elements.
Attributes
- Source
- lists.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait ListItemclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents the type of an ordered list.
Represents the type of an ordered list.
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
- Known subtypes
-
object Arabic.typeobject LowerAlpha.typeobject LowerRoman.typeobject UpperAlpha.typeobject UpperRoman.type
Enumeration of supported enum types.
Enumeration of supported enum types.
Attributes
- Companion
- class
- Source
- lists.scala
- Supertypes
- Self type
-
EnumType.type
An external link, outside of the virtual tree of the current transformation.
An external link, outside of the virtual tree of the current transformation.
Attributes
- Source
- Target.scala
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait Targetclass Objecttrait Matchableclass AnyShow all
Provides a fallback for elements the renderer does not know how to deal with.
Provides a fallback for elements the renderer does not know how to deal with.
Attributes
- Source
- base.scala
- Supertypes
- Known subtypes
A figure consists of an image, an optional caption, and an optional legend as the content
property.
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
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A footnote with resolved id and label that can be referred to by a FootnoteLink
by id.
A footnote with resolved id and label that can be referred to by a FootnoteLink
by id.
Attributes
- Source
- links.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait LinkTargettrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A footnote definition that needs to be resolved to a final footnote by a rewrite rule based on the label type.
A footnote definition that needs to be resolved to a final footnote by a rewrite rule based on the label type.
Attributes
- Source
- links.scala
- Supertypes
-
trait Unresolvedtrait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Definitiontrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Base type for all types of footnote labels.
Base type for all types of footnote labels.
Attributes
- Companion
- object
- Source
- links.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- links.scala
- Supertypes
- Self type
-
FootnoteLabel.type
A resolved link to a footnote.
A reference to a footnote with a matching label.
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
- Source
- links.scala
- Supertypes
-
trait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A special type of paragraph that serves as a render hint.
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
- Source
- blocks.scala
- Supertypes
-
trait Fallbacktrait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Generic base trait for all path abstractions in Laika.
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
- Source
- paths.scala
- Supertypes
- Known subtypes
-
trait VirtualPathtrait Pathobject Root.typeclass Segmentstrait RelativePathclass CurrentDocumentobject CurrentTree.typeclass Parentclass Segmentstrait SegmentsShow all
A global link that can point to any document within the input tree or to an external target.
A global link that can point to any document within the input tree or to an external target.
Attributes
- Source
- base.scala
- Supertypes
-
trait Linktrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
A header element with a level, with 1 being the top level of the document.
A header element with a level, with 1 being the top level of the document.
Attributes
- Companion
- object
- Source
- blocks.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
- Self type
-
Header.type
Represents the decoration of a header.
Represents the decoration of a header. Concrete implementations need to be provided by the parser.
Attributes
- Source
- blocks.scala
- Supertypes
Represents a hidden element that will be ignored by renderers.
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
- Source
- base.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Base trait for all supported icon types.
Base trait for all supported icon types.
Attributes
- Source
- links.scala
- Supertypes
-
trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Represents a font-based icon, identified by its code point.
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
- Source
- links.scala
- Supertypes
-
trait Icontrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A reference to an icon by key.
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
- Source
- links.scala
- Supertypes
-
trait Referencetrait SpanResolvertrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
An icon defined in a style sheet, usually defining a glyph from an icon font.
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
- Source
- links.scala
- Supertypes
-
trait Icontrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Factory and extractor for an Options
instance with an id.
Factory and extractor for an Options
instance with an id.
Attributes
- Source
- Options.scala
- Supertypes
- Self type
-
Id.type
An inline image optional title, alt and size properties.
An inline image optional title, alt and size properties.
Attributes
- Companion
- object
- Source
- links.scala
- Supertypes
-
trait GlobalLinktrait Linktrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- links.scala
- Supertypes
- Self type
-
Image.type
An image reference, the id pointing to the id of a LinkTarget
.
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
- Source
- links.scala
- Supertypes
-
trait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
An image reference to content within the virtual input tree, the path pointing to the source path.
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
- Source
- links.scala
- Supertypes
-
trait PathReferencetrait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A span of program code.
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
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
An SVG icon that will render inline, supported for all output formats.
An SVG icon that will render inline, supported for all output formats.
Attributes
- Source
- links.scala
- Supertypes
-
trait Icontrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A span representing inserted inline elements that may contain nested spans.
A span representing inserted inline elements that may contain nested spans.
Attributes
- Companion
- object
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
Inserted.type
Points to the following block or span element, making it a target for links.
Points to the following block or span element, making it a target for links.
Attributes
- Source
- links.scala
- Supertypes
-
trait LinkTargettrait Spantrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a target within the virtual tree that can be referred to by links.
Attributes
- Companion
- trait
- Source
- Target.scala
- Supertypes
- Self type
-
InternalTarget.type
Represents an invalid element.
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
- Source
- base.scala
- Supertypes
-
trait Fallbackclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class InvalidBlockclass InvalidSpan
Groups a block that could not be successfully parsed with a runtime message.
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
- Source
- InvalidElement.scala
- Supertypes
Attributes
- Companion
- class
- Source
- InvalidElement.scala
- Supertypes
- Self type
-
InvalidBlock.type
Groups a span that could not be successfully parsed with a runtime message.
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
- Source
- InvalidElement.scala
- Supertypes
Attributes
- Companion
- class
- Source
- InvalidElement.scala
- Supertypes
- Self type
-
InvalidSpan.type
Encapsulates size information with a CSS-compatible length unit.
Encapsulates size information with a CSS-compatible length unit.
Attributes
- Source
- Length.scala
- Supertypes
A base for builder of CSS-compatible length units.
A base for builder of CSS-compatible length units.
Attributes
- Companion
- object
- Source
- Length.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- class
- Source
- Length.scala
- Supertypes
- Self type
-
LengthUnit.type
An explicit hard line break.
An explicit hard line break.
Attributes
- Source
- spans.scala
- Supertypes
-
trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The base type for all link elements.
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
- Source
- base.scala
- Supertypes
-
trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait GlobalLinkclass Imageclass RawLinkclass SpanLinktrait LocalLinkclass CitationLinkclass FootnoteLinkShow all
A link target pointing to another link target, acting like an alias.
A link target pointing to another link target, acting like an alias.
Attributes
- Source
- links.scala
- Supertypes
-
trait Hiddentrait Spantrait Definitiontrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow 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.
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
- Source
- links.scala
- Supertypes
-
trait Spantrait Hiddentrait Definitiontrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- links.scala
- Supertypes
- Self type
-
LinkDefinition.type
A reference to any kind of referencable object, e.g.
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
- Source
- links.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion for creating LinkIdReference instances.
Companion for creating LinkIdReference instances.
Attributes
- Companion
- class
- Source
- links.scala
- Supertypes
- Self type
-
LinkIdReference.type
A reference to content within the virtual input tree, the path pointing to the source path.
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
- Source
- links.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait PathReferencetrait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The base type for all link targets.
The base type for all link targets. The id has to be unique for the whole document across all types of LinkTarget
implementations.
Attributes
- Source
- base.scala
- Supertypes
-
trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
A container of list items.
A container of list items. Such a container is usually a Block itself.
Attributes
- Source
- containers.scala
- Supertypes
-
trait ElementContainer[ListItem]trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
The base type for all list items.
The base type for all list items.
Attributes
- Source
- base.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
A span containing plain, unparsed text.
A span containing plain, unparsed text.
Attributes
- Source
- spans.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A literal block with unparsed text content.
A literal block with unparsed text content.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A local link that always points to a target within the same document.
A local link that always points to a target within the same document.
Attributes
- Source
- base.scala
- Supertypes
-
trait Linktrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class CitationLinkclass FootnoteLink
A context reference specifically for use in markup documents.
A context reference specifically for use in markup documents.
Attributes
- Source
- resolvers.scala
- Supertypes
-
class ContextReference[Span]trait SpanResolvertrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Signals the severity of a runtime message.
Signals the severity of a runtime message.
Attributes
- Companion
- object
- Source
- InvalidElement.scala
- Supertypes
-
trait Producttrait Equalstrait Ordered[MessageLevel]trait Comparable[MessageLevel]class Objecttrait Matchableclass AnyShow all
- Known subtypes
Enumeration of available message levels.
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
- Source
- InvalidElement.scala
- Supertypes
- Self type
-
MessageLevel.type
A navigatable object is anything that has an associated path.
A navigatable object is anything that has an associated path.
Attributes
- Source
- documents.scala
- Supertypes
- Known subtypes
The context of a navigation builder that can get passed down in recursive calls to the various types that have an asNavigationItem method.
The context of a navigation builder that can get passed down in recursive calls to the various types that have an asNavigationItem method.
Attributes
- Companion
- object
- Source
- DocumentNavigation.scala
- Supertypes
- Known subtypes
-
class Impl
Attributes
- Companion
- class
- Source
- DocumentNavigation.scala
- Supertypes
- Self type
Represents a navigation entry with an optional target link and optional child items.
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
- Source
- lists.scala
- Supertypes
-
trait ListContainertrait RewritableContainertrait ElementContainer[NavigationItem]trait ElementTraversaltrait ListItemtrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a book navigation entry that links to content in the document tree.
Represents a book navigation entry that links to content in the document tree.
Attributes
- Source
- lists.scala
- Supertypes
The root node of a navigation structure
The root node of a navigation structure
Attributes
- Companion
- object
- Source
- lists.scala
- Supertypes
-
trait RewritableContainertrait ListContainertrait ElementContainer[ListItem]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- lists.scala
- Supertypes
- Self type
-
NavigationList.type
Options for customizable elements.
Options for customizable elements.
For creating new instances you can 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
- Companion
- object
- Source
- Options.scala
- Supertypes
Companion for the Options trait.
Companion for the Options trait.
Attributes
- Companion
- class
- Source
- Options.scala
- Supertypes
- Self type
-
Options.type
Describes the output for a render operation.
Describes the output for a render operation.
The format selector is used by any configuration elements that allows to restrict the output of documents to certain target formats. It is not always identical to the fileSuffix used for the specific format.
Attributes
- Companion
- object
- Source
- OutputContext.scala
- Supertypes
Attributes
- Companion
- class
- Source
- OutputContext.scala
- Supertypes
- Self type
-
OutputContext.type
An explicit hard page break.
An explicit hard page break.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A paragraph consisting of span elements.
A paragraph consisting of span elements.
Attributes
- Companion
- object
- Source
- blocks.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
Paragraph.type
A literal block with parsed text content.
A literal block with parsed text content.
Attributes
- Companion
- object
- Source
- blocks.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
ParsedLiteralBlock.type
Attributes
- Source
- links.scala
- Supertypes
- Self type
-
ParsedTarget.type
Represents an absolute path inside a virtual tree of documents.
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
- Source
- paths.scala
- Supertypes
-
trait VirtualPathtrait Serializabletrait Producttrait Equalstrait GenericPathclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Factory methods for creating path instances.
Factory methods for creating path instances.
Attributes
- Companion
- trait
- Source
- paths.scala
- Supertypes
- Self type
-
Path.type
A reference to content within the virtual input tree, the path pointing to the source path.
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
- Source
- links.scala
- Supertypes
-
trait Referencetrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class ImagePathReferenceclass LinkPathReference
A quoted block consisting of a list of blocks that may contain other nested quoted blocks and an attribution which may be empty.
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
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
-
trait Producttrait Mirrortrait BlockContainerCompaniontrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
QuotedBlock.type
Raw content that is usually specific to the specified output formats.
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
- Source
- blocks.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Spantrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A raw link element without associated content (text or image).
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
- Source
- links.scala
- Supertypes
-
trait GlobalLinktrait Linktrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion for creating RawLink instances.
Companion for creating RawLink instances.
Attributes
- Companion
- class
- Source
- links.scala
- Supertypes
- Self type
-
RawLink.type
The base type for all reference elements.
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
- Source
- base.scala
- Supertypes
-
trait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class CitationReferenceclass FootnoteReferenceclass IconReferenceclass ImageIdReferenceclass LinkIdReferencetrait PathReferenceclass ImagePathReferenceclass LinkPathReferenceShow all
Attributes
- Companion
- object
- Source
- paths.scala
- Supertypes
-
trait VirtualPathtrait Serializabletrait Producttrait Equalstrait GenericPathclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Attributes
- Companion
- trait
- Source
- paths.scala
- Supertypes
- Self type
-
RelativePath.type
Attributes
- Source
- spans.scala
- Supertypes
-
trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A generic container of child elements which can have rewrite rules applied to them in recursive tree rewriting.
A generic container of child elements which can have rewrite rules applied to them in recursive tree rewriting.
Attributes
- Source
- containers.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait BlockContainerclass BlockSequenceclass BulletListItemclass Cellclass Choiceclass Citationclass DefinitionListItemclass EmbeddedRootclass EnumListItemclass Figureclass Footnoteclass FootnoteDefinitionclass QuotedBlockclass RootElementclass Sectionclass TitledBlockclass BulletListclass DefinitionListclass EnumListclass NavigationItemclass NavigationListclass Rowclass Selectiontrait SpanContainerclass HTMLElementclass Captionclass CodeBlockclass CodeSpanSequenceclass DecoratedHeaderclass Deletedclass Emphasizedclass ForcedParagraphclass Headerclass InlineCodeclass Insertedclass LinkIdReferenceclass LinkPathReferenceclass Paragraphclass ParsedLiteralBlockclass SpanLinkclass SpanSequenceclass Strongclass Titleclass Tableclass TableBodyclass TableHeadclass TemplateElementtrait TemplateSpanContainerclass TemplateRootclass TemplateSpanSequenceShow all
Describes the action to be performed for a particular node in the document AST.
Attributes
- Companion
- trait
- Source
- RewriteRules.scala
- Supertypes
- Self type
-
RewriteAction.type
Represents one of the rewrite phases for document AST transformations.
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
- Source
- RewriteRules.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- RewriteRules.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Self type
-
RewritePhase.type
A set of rewrite rules describing a set of modifications to be applied to an AST of a document.
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
- Source
- RewriteRules.scala
- Supertypes
Factory methods and utilities for dealing with rewrite rules.
Factory methods and utilities for dealing with rewrite rules.
Attributes
- Companion
- class
- Source
- RewriteRules.scala
- Supertypes
- Self type
-
RewriteRules.type
Converts Roman numerals to integers and vice versa.
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
- Source
- RomanNumerals.scala
- Supertypes
- 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.
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
- Source
- Cursor.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Cursor.scala
- Supertypes
- Self type
-
RootCursor.type
The root element of a document tree.
The root element of a document tree.
Attributes
- Companion
- object
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
-
trait Producttrait Mirrortrait BlockContainerCompaniontrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
RootElement.type
A single table row.
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
- Source
- Table.scala
- Supertypes
-
trait RewritableContainertrait TableContainertrait ElementContainer[TableElement]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- Table.scala
- Supertypes
- Self type
-
Row.type
A horizontal rule.
A horizontal rule.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Message generated by the parser, a directive or a rewrite rule.
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
- Source
- InvalidElement.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Blocktrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
An icon referencing an SVG shape defined in an external file or embedded SVG element.
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
- Source
- links.scala
- Supertypes
-
trait Icontrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion for creating SVGSymbolIcon instances.
Companion for creating SVGSymbolIcon instances.
Attributes
- Companion
- class
- Source
- links.scala
- Supertypes
- Self type
-
SVGSymbolIcon.type
A section of the document, consisting of a header and content in the form of a list of Block elements.
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
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Captures information about a document section, without its content.
Captures information about a document section, without its content.
Attributes
- Source
- documents.scala
- Supertypes
-
trait ElementContainer[SectionInfo]trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a section number, usually used in header elements when autonumbering is applied.
Represents a section number, usually used in header elements when autonumbering is applied.
Attributes
- Source
- spans.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a selection of choices (alternatives) that represent the same content in different ways, e.g.
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
- Source
- blocks.scala
- Supertypes
-
trait RewritableContainertrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The base type for all inline elements.
The base type for all inline elements.
Attributes
- Source
- base.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HTMLSpanclass HTMLCharacterReferenceclass HTMLCommentclass HTMLElementclass HTMLEmptyElementclass HTMLEndTagclass HTMLScriptElementclass HTMLStartTagtrait CategorizedCodeclass CodeSpanclass CodeSpanSequenceclass Deletedclass EmbeddedConfigValueclass Emphasizedtrait Iconclass IconGlyphclass IconStyleclass InlineSVGIconclass SVGSymbolIconclass InlineCodeclass Insertedclass InternalLinkTargetclass InvalidSpanclass LineBreaktrait Linktrait GlobalLinkclass Imageclass RawLinkclass SpanLinktrait LocalLinkclass CitationLinkclass FootnoteLinkclass LinkAliasclass LinkDefinitionclass Literalclass RawContenttrait Referenceclass CitationReferenceclass FootnoteReferenceclass IconReferenceclass ImageIdReferenceclass LinkIdReferencetrait PathReferenceclass ImagePathReferenceclass LinkPathReferenceclass Reverseclass RuntimeMessageclass SectionNumbertrait SpanResolverclass ContextReference[T]class MarkupContextReferenceclass TemplateContextReferenceclass SpanScopeclass SpanSequenceclass Strongtrait TemplateSpanclass EmbeddedRootclass TemplateElementclass TemplateRootclass TemplateScopeclass TemplateSpanSequenceclass TemplateStringclass TextShow all
A container of other Span elements.
A container of other Span elements. Such a container may be a Block or a Span itself.
Attributes
- Source
- containers.scala
- Supertypes
-
trait RewritableContainertrait ElementContainer[Span]trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HTMLElementclass Captionclass CodeBlockclass CodeSpanSequenceclass DecoratedHeaderclass Deletedclass Emphasizedclass ForcedParagraphclass Headerclass InlineCodeclass Insertedclass LinkIdReferenceclass LinkPathReferenceclass Paragraphclass ParsedLiteralBlockclass SpanLinkclass SpanSequenceclass Strongclass TitleShow all
Common methods for simple span containers (without additional parameters).
Common methods for simple span containers (without additional parameters).
Attributes
- Source
- containers.scala
- Supertypes
- Known subtypes
-
trait BlockContainerCompanionobject BlockSequence.typetrait BulletListCompanionobject BulletList.typeobject BodyCell.typeobject HeadCell.typeobject EmbeddedRoot.typetrait EnumListCompanionobject EnumList.typeobject QuotedBlock.typeobject RootElement.typeobject Caption.typeobject CodeSpanSequence.typeobject Deleted.typeobject Emphasized.typeobject Inserted.typetrait Companionobject Paragraph.typeobject ParsedLiteralBlock.typetrait Companionobject SpanSequence.typeobject Strong.typeobject Title.typeShow all
An link element, with the span content representing the text (description) of the link.
An link element, with the span content representing the text (description) of the link.
Attributes
- Companion
- object
- Source
- links.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait GlobalLinktrait Linktrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion for creating SpanLink instances.
Companion for creating SpanLink instances.
Attributes
- Companion
- class
- Source
- links.scala
- Supertypes
- Self type
-
SpanLink.type
Represents a placeholder inline element that needs to be resolved in a rewrite step.
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
- Source
- resolvers.scala
- Supertypes
-
trait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class ContextReference[T]class MarkupContextReferenceclass TemplateContextReferenceclass IconReference
Represents a span element that introduces new context that can be used in substitution references in any child element.
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
- Source
- resolvers.scala
- Supertypes
-
trait Spantrait ElementScope[Span]trait Unresolvedclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A generic container element containing a list of spans.
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
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spantrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
SpanSequence.type
A pure descriptor for a static document, without the actual bytes.
A pure descriptor for a static document, without the actual bytes. Used for evaluating links and other AST transformation phases.
Attributes
- Companion
- object
- Source
- documents.scala
- Supertypes
Attributes
- Companion
- class
- Source
- documents.scala
- Supertypes
- Self type
-
StaticDocument.type
A span of strong inline elements that may contain nested spans.
A span of strong inline elements that may contain nested spans.
Attributes
- Companion
- object
- Source
- spans.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- spans.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow 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.
Constants for style names wrapped in Options instances which are commonly used by Laika's core parsers and rewrite rules.
Attributes
- Source
- Options.scala
- Supertypes
- Self type
-
Style.type
Factory and extractor for an Options
instance with style names.
Factory and extractor for an Options
instance with style names.
Attributes
- Source
- Options.scala
- Supertypes
- Self type
-
Styles.type
A table consisting of a head and a body part and optional caption and column specification.
A table consisting of a head and a body part and optional caption and column specification.
Attributes
- Companion
- object
- Source
- Table.scala
- Supertypes
-
trait RewritableContainertrait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- Table.scala
- Supertypes
- Self type
-
Table.type
Contains the body rows of a table.
Contains the body rows of a table.
Attributes
- Source
- Table.scala
- Supertypes
-
trait RewritableContainertrait TableContainertrait ElementContainer[TableElement]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A container of table elements.
A container of table elements.
Attributes
- Source
- Table.scala
- Supertypes
-
trait ElementContainer[TableElement]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
A table element, like a row, cell or column.
A table element, like a row, cell or column.
Attributes
- Source
- Table.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Contains the header rows of a table.
Contains the header rows of a table.
Attributes
- Source
- Table.scala
- Supertypes
-
trait RewritableContainertrait TableContainertrait ElementContainer[TableElement]trait ElementTraversaltrait TableElementclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Represents a target that can be referred to by links, either within the virtual tree or external.
Represents a target that can be referred to by links, either within the virtual tree or external.
Attributes
- Companion
- object
- Source
- Target.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- Target.scala
- Supertypes
- Self type
-
Target.type
An element that only gets rendered for a specific output format.
An element that only gets rendered for a specific output format.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Source
- TargetValidation.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- TargetValidation.scala
- Supertypes
- Self type
-
TargetValidation.type
A context reference specifically for use in template documents.
A context reference specifically for use in template documents.
Attributes
- Source
- resolvers.scala
- Supertypes
-
trait TemplateSpanclass ContextReference[TemplateSpan]trait SpanResolvertrait Unresolvedtrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A template document containing the element tree of a parsed template and its extracted configuration section (if present).
A template document containing the element tree of a parsed template and its extracted configuration section (if present).
Attributes
- Companion
- object
- Source
- documents.scala
- Supertypes
Attributes
- Companion
- class
- Source
- documents.scala
- Supertypes
- Self type
-
TemplateDocument.type
Wraps a generic element that otherwise could not be placed directly into a template document tree.
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
- Source
- templates.scala
- Supertypes
-
trait RewritableContainertrait ElementTraversaltrait TemplateSpantrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The root element of a template document tree.
The root element of a template document tree.
Attributes
- Companion
- object
- Source
- templates.scala
- Supertypes
-
trait TemplateSpanContainertrait RewritableContainertrait ElementContainer[TemplateSpan]trait ElementTraversaltrait TemplateSpantrait Spantrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Companion with a fallback instance for setups without a default template
Companion with a fallback instance for setups without a default template
Attributes
- Companion
- class
- Source
- templates.scala
- Supertypes
- Self type
-
TemplateRoot.type
Represents a template span element that introduces new context that can be used in substitution references in any child element.
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
- Source
- resolvers.scala
- Supertypes
-
trait TemplateSpantrait Spantrait ElementScope[TemplateSpan]trait Unresolvedclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The base type for all inline elements that can be found in a template.
The base type for all inline elements that can be found in a template.
Attributes
- Source
- templates.scala
- Supertypes
-
trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class EmbeddedRootclass TemplateContextReferenceclass TemplateElementclass TemplateRootclass TemplateScopeclass TemplateSpanSequenceclass TemplateStringShow all
A container of other TemplateSpan elements.
A container of other TemplateSpan elements.
Attributes
- Source
- templates.scala
- Supertypes
-
trait RewritableContainertrait ElementContainer[TemplateSpan]trait ElementTraversalclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class TemplateRootclass TemplateSpanSequence
Common methods for simple template span containers (without additional parameters).
Common methods for simple template span containers (without additional parameters).
Attributes
- Source
- templates.scala
- Supertypes
- Known subtypes
-
object TemplateRoot.typeobject TemplateSpanSequence.type
A generic container element containing a list of template spans.
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
- Source
- templates.scala
- Supertypes
-
trait TemplateSpanContainertrait RewritableContainertrait ElementContainer[TemplateSpan]trait ElementTraversaltrait TemplateSpantrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- templates.scala
- Supertypes
- 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.
A simple string element, representing the parts of a template that are not detected as special markup constructs and treated as raw text.
Attributes
- Source
- templates.scala
- Supertypes
-
trait TextContainertrait Container[String]trait TemplateSpantrait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A simple text element.
A simple text element.
Attributes
- Source
- spans.scala
- Supertypes
-
trait TextContainertrait Container[String]trait Spanclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A container for plain text.
A container for plain text.
Attributes
- Source
- containers.scala
- Supertypes
-
trait Container[String]class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HTMLCharacterReferenceclass HTMLCommentclass HTMLScriptElementclass CodeSpanclass Commentclass Literalclass LiteralBlockclass RawContentclass RuntimeMessageclass SectionNumberclass TemplateStringclass TextShow all
Base type for all document type descriptors for text input.
Base type for all document type descriptors for text input.
Attributes
- Source
- DocumentType.scala
- Supertypes
- Known subtypes
The (optional) title of the document.
The (optional) title of the document.
Attributes
- Companion
- object
- Source
- blocks.scala
- Supertypes
-
trait SpanContainertrait RewritableContainertrait ElementContainer[Span]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- blocks.scala
- Supertypes
-
trait Producttrait Mirrortrait SpanContainerCompanionclass Objecttrait Matchableclass AnyShow all
- Self type
-
Title.type
Generic block element with a title.
Generic block element with a title. Often combined with the the styles
attribute of the options
parameter to provide additional render hints.
Attributes
- Source
- blocks.scala
- Supertypes
-
trait BlockContainertrait RewritableContainertrait ElementContainer[Block]trait ElementTraversaltrait Blockclass Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Generically builds a tree structure out of a flat sequence of elements with a Path
property that signifies the position in the tree.
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
- Source
- TreeBuilder.scala
- Supertypes
- Self type
-
TreeBuilder.type
A titled, positional element in the document tree.
A titled, positional element in the document tree.
Attributes
- Source
- documents.scala
- Supertypes
- Known subtypes
-
class Documentclass DocumentTree
Cursor for an entire document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.
Cursor for an entire document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.
Value parameters
- parent
-
the immediate parent of this tree or
None
if this is the root - root
-
the root of this tree
- target
-
the document tree this cursor points to
Attributes
- Companion
- object
- Source
- Cursor.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Cursor.scala
- Supertypes
- Self type
-
TreeCursor.type
The position of an element within a document tree.
The position of an element within a document tree.
Attributes
- Companion
- object
- Source
- TreePosition.scala
- Supertypes
Attributes
- Companion
- class
- Source
- TreePosition.scala
- Supertypes
- Self type
-
TreePosition.type
Represents an element that needs to be resolved in an AST transformation step.
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
- Source
- base.scala
- Supertypes
-
class Elementtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait BlockResolverclass DecoratedHeadertrait ElementScope[E]class BlockScopeclass SpanScopeclass TemplateScopeclass FootnoteDefinitiontrait Referenceclass CitationReferenceclass FootnoteReferenceclass IconReferenceclass ImageIdReferenceclass LinkIdReferencetrait PathReferenceclass ImagePathReferenceclass LinkPathReferencetrait SpanResolverclass ContextReference[T]class MarkupContextReferenceclass TemplateContextReferenceShow all
A temporary structure usually not exposed to user code.
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
- Source
- documents.scala
- Supertypes
The abstract base for absolute and relative paths within Laika's virtual path abstraction.
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
- Source
- paths.scala
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait GenericPathclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait Pathobject Root.typeclass Segmentstrait RelativePathclass CurrentDocumentobject CurrentTree.typeclass Parentclass Segmentstrait SegmentsShow all
Attributes
- Companion
- trait
- Source
- paths.scala
- Supertypes
- Self type
-
VirtualPath.type
Types
Specifies a custom render function that may override the rendered output for one or more node types.
Specifies a custom render function that may override the rendered output for one or more node types. For elements this function is not defined the renderer will fall back to the default renderer (or the next custom renderer, in case there are multiple).
Attributes
- Source
- package.scala
Specifies how a particular element, document or document tree should be rewritten.
Specifies how a particular element, document or document tree should be rewritten.
If the rule is not defined for a specific element or the rule returns a Retain
action as a result the old element remains in the tree unchanged.
If it returns Remove
then the node gets removed from the ast, if it returns Replace
with a new element it will replace the old one.
Attributes
- Source
- package.scala