quarkdown-core/com.quarkdown.core.ast.base.block

Package-level declarations

Types

Any unknown node type (should not happen).

class BlockQuote(val type: BlockQuote.Type? = null, val attribution: InlineContent? = null, val content: List<Node>) : NestableNode

A block quote.

Code

class Code(val content: String, val language: String?, val showLineNumbers: Boolean = true, val highlight: Boolean = true, val focusedLines: Range? = null, val caption: InlineContent? = null, val referenceId: String? = null) : LocationTrackableNode, CrossReferenceableNode, CaptionableNode, LocalizedKind

A code block.

FootnoteDefinition

class FootnoteDefinition(val label: String, val text: InlineContent) : TextNode, Identifiable

Creation of a footnote definition, referenceable by a com.quarkdown.core.ast.base.inline.ReferenceFootnote.

Heading

class Heading(val depth: Int, val text: InlineContent, val customId: String? = null, val canBreakPage: Boolean = true, val canTrackLocation: Boolean = true, val excludeFromTableOfContents: Boolean = false) : TextNode, Identifiable, LocationTrackableNode, CrossReferenceableNode, LocalizedKind

A heading defined via prefix symbols. A heading is identifiable, as it can be looked up in the document and can be referenced. It is also location trackable, meaning its position in the document hierarchy is determined, and possibly displayed.

HorizontalRule

object HorizontalRule : Node

A horizontal line (thematic break).

Html

class Html(val content: String) : Node

An HTML block.

LinkDefinition

class LinkDefinition(val label: InlineContent, val url: String, val title: InlineContent?, val fileSystem: FileSystem? = null) : LinkNode, TextNode

Creation of a referenceable link definition.

Newline

object Newline : Node

A blank line.

Paragraph

class Paragraph(val text: InlineContent) : TextNode

A general paragraph.

Table

class Table(val columns: List<Table.Column>, val caption: InlineContent? = null, val referenceId: String? = null) : NestableNode, LocationTrackableNode, CaptionableNode, CrossReferenceableNode, LocalizedKind

A table, consisting of columns, each of which has a header and multiple cells. A table is location-trackable since, if requested by the user, it may show a caption displaying its location-based label.

Properties

isMarker

val Heading.isMarker: Boolean

Whether this heading is a marker.

Functions

createSectionHeading

fun Heading.Companion.createSectionHeading(title: InlineContent?, localizationKey: String, context: Context, depth: Int = 1, customId: String? = null, canBreakPage: Boolean = true, canTrackLocation: Boolean = false, includeInTableOfContents: Boolean = false): Heading?

Creates an auto-generated Heading for a structural section of the document (e.g. table of contents, bibliography).

getFormattedIndex

fun FootnoteDefinition.getFormattedIndex(context: Context): String?

Formats the index of this footnote definition according to the numbering format defined in the document, or a default numbering format if none is defined. The default format is 1, 2, 3, ... (decimal numbering).

getIndex

fun FootnoteDefinition.getIndex(context: Context): Int?

marker

fun Heading.Companion.marker(name: InlineContent): Heading

Creates an invisible Heading that acts as a marker that can be referenced by other elements in the document. A useful use case would be, for example, in combination with a com.quarkdown.core.context.toc.TableOfContents. Depth 0 cannot be achieved with plain Markdown, but it can be supplied by the Quarkdown function .marker.

setIndex

fun FootnoteDefinition.setIndex(context: MutableContext, index: Int)

Registers the footnote index of this node within the document handled by context, according to the order of references to it. It is not updated if an index is already set.