quarkdown-core/com.quarkdown.core.context/MutableContextOptions

MutableContextOptions

data class MutableContextOptions(var autoPageBreakHeadingMaxDepth: Int = 1, var enableAutomaticIdentifiers: Boolean = true, var enableLocationAwareness: Boolean = true, var enableRemoteMediaStorage: Boolean = false, var enableLocalMediaStorage: Boolean = false) : ContextOptions

Mutable ContextOptions implementation.

Constructors

constructor(autoPageBreakHeadingMaxDepth: Int = 1, enableAutomaticIdentifiers: Boolean = true, enableLocationAwareness: Boolean = true, enableRemoteMediaStorage: Boolean = false, enableLocalMediaStorage: Boolean = false)

Properties

autoPageBreakHeadingMaxDepth

open override var autoPageBreakHeadingMaxDepth: Int

When a Heading node has a depth equals or less than this value, a page break is forced.

enableAutomaticIdentifiers

open override var enableAutomaticIdentifiers: Boolean

Whether automatic identifiers should be generated for elements that do not have an explicit one. For example, a heading element (# Hello world) automatically generates an identifier (hello-world) that can be referenced by other elements.

enableLocalMediaStorage

open override var enableLocalMediaStorage: Boolean

Whether local media should be stored locally in the output directory. If enabled, the media is copied to the output directory and the element that references the media is updated to reference the new path. If null, the preference is determined by the active renderer.

enableLocationAwareness

open override var enableLocationAwareness: Boolean

Whether certain nodes can be aware of their location within the document in order to display it, for example in headings.

enableRemoteMediaStorage

open override var enableRemoteMediaStorage: Boolean

Whether remote media associated to a URL should be stored locally. If enabled, the media is downloaded, stored in the output directory and the element that references the media is updated to reference the new local path. If null, the preference is determined by the active renderer.

Functions

mergeMediaStorageOptions

fun mergeMediaStorageOptions(options: MediaStorageOptions)

Mutates this instance by merging the current media storage rules with the given options. An option is overridden and merged only if its value from options is set, i.e. not null.