quarkdown-core/com.quarkdown.core.document

Package-level declarations

Types

data class DocumentAuthor(val name: String, val info: Map<String, String> = emptyMap())

An author of a document.

data class DocumentInfo(var type: DocumentType = DocumentType.PLAIN, var name: String? = null, val authors: MutableList<DocumentAuthor> = mutableListOf(), var locale: Locale? = null, var numbering: DocumentNumbering? = null, var theme: DocumentTheme? = null, val pageFormat: PageFormatInfo = PageFormatInfo(), val tex: TexInfo = TexInfo())

Mutable information about the final artifact. This data is mutated by library functions .docname, .docauthor, etc.

DocumentTheme

data class DocumentTheme(val color: String?, val layout: String?)

The theme of a document. A theme is defined by different components, hence allowing different combinations. Components can also be not specified by setting them to null, and are hence ignored.

DocumentType

enum DocumentType : Enum<DocumentType>

Type of produced document, which affects its post-rendering stage.

Functions

orDefault

fun DocumentTheme?.orDefault(default: DocumentTheme): DocumentTheme

Given this theme with nullable components, merges it with a default theme in order to fill in the missing components. If this is null itself, the default theme is returned.