FootnoteDefinition

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

Parameters

label

inline content of the referenceable label, which should match that of the com.quarkdown.core.ast.base.inline.ReferenceFootnotes

text

inline content of the footnote

index

index of the footnote in the document, in order of reference, or null if not linked to any reference

Constructors

Link copied to clipboard
constructor(label: String, text: InlineContent)

Properties

Link copied to clipboard
open override val children: List<Node>
Link copied to clipboard
Link copied to clipboard
open override val text: InlineContent

Functions

Link copied to clipboard
open override fun <T> accept(visitor: IdentifierProvider<T>): T

Accepts an IdentifierProvider to generate an identifier for this element.

open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

Link copied to clipboard

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

Link copied to clipboard

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).

Link copied to clipboard
Link copied to clipboard

Retrieves the stored media associated with this node, if any.

Link copied to clipboard

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.

Link copied to clipboard