External libraries that can be loaded by the user into libraries. These libraries are, for instance, fetched from the library directory (--libs option) and can be loaded via the .include {name} function.

localizationTables

open override val localizationTables: MutableMap<String, LocalizationTable>

Tables that store key-value localization pairs for each supported locale. Each table is identified by a unique name.

mediaStorage

open override val mediaStorage: MutableMediaStorage

Media storage that contains all the media files that are referenced within the document. For example, if an image node references a local image file "image.png", the local file needs to be exported to the output directory in order for a browser to look it up. This storage is used to keep track of all the media files that may need to be exported.

options

open override val options: MutableContextOptions

Global properties that affect several behaviors and that can be altered through function calls.

parent

val parent: Context

Functions

dequeueAllFunctionCalls

fun dequeueAllFunctionCalls(): List<FunctionCallNode>

Returns a copy of the queue containing registered function calls and clears the original one.

fork

open override fun fork(): ScopeContext

getFunctionByName

open override fun getFunctionByName(name: String): Function<*>?

If no matching function is found among this ScopeContext's own libraries, parent's libraries are scanned.

lastParentOrNull

fun lastParentOrNull(predicate: (Context) -> Boolean): Context?

loadLibrary

fun loadLibrary(name: String): Library?

Loads a loadable library by name and registers it in the context. After a successful load, the library is removed from loadableLibraries and added to libraries, with its Library.onLoad action executed.

localize

open override fun localize(tableName: String, key: String): String

Localizes a string to this context's language (the locale set in documentInfo) by looking up a key in a localization table.

localizeOrNull

fun Context.localizeOrNull(key: String): String?

Localizes a key from the stdlib table.

fun Context.localizeOrNull(tableName: String, key: String): String?

Localizes a key from a table.

lockFunctionCallEnqueuing

fun <T> lockFunctionCallEnqueuing(block: MutableContext.() -> T): T

Performs an action locking the enqueuing of function calls. This causes register to do nothing until the action is completed. Any function call enqueued during the action is discarded and won't be expanded by the pipeline.

open fun register(linkDefinition: LinkDefinition)

Registers a new LinkDefinition, which can be later looked up via resolve to produce a concrete link from a reference.

open override fun register(functionCall: FunctionCallNode)

Enqueues a function call to the parent's queue if it is a MutableContext, or to this context otherwise. This lets the registration go up the context tree so that it can be expanded from the root context in the next stage of the pipeline.

resolve

open override fun resolve(reference: ReferenceLink): LinkNode?

Tries to resolve a reference link to an actual link. If the resolution succeeds, ReferenceLink.onResolve callbacks are executed.

open override fun resolve(call: FunctionCallNode): FunctionCall<*>?

resolveOrFallback

fun Context.resolveOrFallback(reference: ReferenceImage): Node

fun Context.resolveOrFallback(reference: ReferenceLink): Node

resolveUnchecked

open override fun resolveUnchecked(call: FunctionCallNode): UncheckedFunctionCall<*>

shouldAutoPageBreak

fun Context.shouldAutoPageBreak(heading: Heading): Boolean