quarkdown-core/com.quarkdown.core.ast.attributes

Package-level declarations

Types

Additional information about the node tree, produced by the parsing stage and stored in a com.quarkdown.core.context.Context.

CaptionableNode

interface CaptionableNode : Node

A node that may have a caption, such as a com.quarkdown.core.ast.base.block.Table or a com.quarkdown.core.ast.quarkdown.block.ImageFigure. The caption is a plain text string, which does not accept further inline formatting.

LocationTrackableNode

interface LocationTrackableNode : Node

A node that requests its location to be tracked within the document's hierarchy. By location, it is meant the section indices (SectionLocation) the node is located in.

MutableAstAttributes

data class MutableAstAttributes(var root: NestableNode? = null, val positionalLabels: MutableMap<Node, String> = mutableMapOf(), val locations: MutableMap<LocationTrackableNode, SectionLocation> = mutableMapOf(), val linkDefinitions: MutableList<LinkDefinition> = mutableListOf(), val functionCalls: MutableList<FunctionCallNode> = mutableListOf(), var hasCode: Boolean = false, var hasMath: Boolean = false, var hasMermaidDiagram: Boolean = false, var tableOfContents: TableOfContents? = null) : AstAttributes

Writeable attributes that are modified during the parsing process, and carry useful information for the next stages of the pipeline. Storing these attributes while parsing prevents a further visit of the final tree.

SectionLocation

data class SectionLocation(val levels: List<Int>)

The location of a node within the document, in terms of section indices. Example:

Functions

formatLocation

fun LocationTrackableNode.formatLocation(context: Context, format: (DocumentNumbering) -> NumberingFormat?): String?

getLocation

fun LocationTrackableNode.getLocation(context: Context): SectionLocation?