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

Package-level declarations

Types

Link copied to clipboard
data class CitationLabelProperty(val value: String) : Property<String>

Pre-computed citation label for a BibliographyCitation node.

Link copied to clipboard
interface ReferenceNode<R, D> : Node

Represents a node that may reference some definition that is generated by elsewhere in the document.

Link copied to clipboard
typealias ResolvedReference<R, D> = Pair<R, D>

A pair of a referenced linked to its resolved definition.

Link copied to clipboard
data class ResolvedReferenceProperty<R, D>(val value: ResolvedReference<R, D>) : Property<ResolvedReference<R, D>>

Property that can be assigned to each ReferenceNode. It contains the definition that the reference refers to.

Functions

Link copied to clipboard
fun BibliographyCitation.getCitationLabel(context: Context): String?

Retrieves the pre-computed citation label for this node.

Link copied to clipboard
fun <R, D> ReferenceNode<R, D>.getDefinition(context: Context): D?
Link copied to clipboard
fun BibliographyCitation.setCitationLabel(context: MutableContext, label: String)

Stores a pre-computed citation label on this node.

Link copied to clipboard
fun <R, D> ReferenceNode<R, D>.setDefinition(context: MutableContext, definition: D)

Registers the given definition as the definition associated with this reference within the document handled by context.