quarkdown-core/com.quarkdown.core.document.sub/Subdocument/Root

Root

data object Root : Subdocument

The root Subdocument, which is the main document of the Quarkdown pipeline. This is always the entry point of the compilation process, as it is the input content that is supplied to the pipeline.

It is not bound to a file or resource, since it may be provided as a string or from other sources that do not have a file representation.

The root subdocument is the starting point of the subdocument graph, available via com.quarkdown.core.context.Context.subdocumentGraph.

Properties

Link copied to clipboard
open override val name: String

The name of the subdocument, without any file extension.

Link copied to clipboard
open val uniqueName: String

A unique name for the subdocument, which reduces the risk of name collisions. This is a suitable name for output resources.

Functions

Link copied to clipboard
fun Subdocument.getOutputFileName(context: Context): String

Returns the output file name for the subdocument, based on the context's options. If the pipeline enforces minimal subdocument collisions (com.quarkdown.core.pipeline.PipelineOptions.minimizeSubdocumentCollisions), Subdocument.uniqueName is returned, otherwise just Subdocument.name, which is more human-readable but prone to collisions.