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

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.

Parameters

depth

importance (depth=1 for H1, depth=6 for H6)

customId

optional custom ID. If null, the ID is automatically generated. If not null, the ID is used for cross-referencing.

canBreakPage

whether this heading can trigger an automatic page break. Decorative headings and auto-generated section headings typically disable this.

canTrackLocation

whether this heading's position in the document hierarchy is tracked and displayed. When false, the heading is not numbered.

excludeFromTableOfContents

if true, this heading is never included in the table of contents, even if its location is trackable. Useful for headings generated by functions such as .tableofcontents and .bibliography to prevent self-referencing.

Constructors

Heading

constructor(depth: Int, text: InlineContent, customId: String? = null, canBreakPage: Boolean = true, canTrackLocation: Boolean = true, excludeFromTableOfContents: Boolean = false)

Types

Companion

object Companion

Properties

canBreakPage

val canBreakPage: Boolean = true

canTrackLocation

open override val canTrackLocation: Boolean = true

children

open override val children: List<Node>

customId

val customId: String? = null

depth

val depth: Int

excludeFromTableOfContents

val excludeFromTableOfContents: Boolean = false

isDecorative

val isDecorative: Boolean

Whether this heading is decorative, i.e. it cannot trigger page breaks and its location is not tracked.

isMarker

val Heading.isMarker: Boolean

Whether this heading is a marker.

kindLocalizationKey

open override val kindLocalizationKey: String

Key for localization of the kind of this node, used to look up localized strings in the default com.quarkdown.core.localization.LocalizationTable.

referenceId

open override val referenceId: String?

If the heading has a custom ID, it can be used for cross-referencing.

text

open override val text: InlineContent

The text of the node as processed inline content.

Functions

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.

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

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.

formatLocation

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

getLocation

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

getLocationLabel

fun LocationTrackableNode.getLocationLabel(context: Context): String?

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

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

setLocation

fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

Registers the location of this node within the document handled by context.

setLocationLabel

fun LocationTrackableNode.setLocationLabel(context: MutableContext, label: String)

Registers the formatted location of this node within the document handled by context, according to this node's NumberingFormat.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue