quarkdown-core/com.quarkdown.core.document/DocumentType

DocumentType

enum DocumentType : Enum<DocumentType>

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

Parameters

preferredOrientation

the preferred orientation of the document, to apply if not overridden by the user

preferredAutoPageBreakHeadingMaxDepth

the preferred maximum heading depth to force a page break, to apply if not overridden by the user. If null, no page break is forced by default

defaultPageFormat

the default page format to apply, if not overridden by the user

defaultNumbering

the default numbering formats to apply, if not overridden by the user

Entries

A document whose rendered content is not altered by the post-rendering stage. Plain Markdown is often used as plain (e.g. READMEs).

A document that is split into pages of mostly text content: books, articles, papers, etc.

A slides-based document for presentations.

A document optimized for documentation, knowledge bases, and wikis.

Properties

defaultNumbering

val defaultNumbering: DocumentNumbering?

defaultPageFormat

val defaultPageFormat: PageFormatInfo?

val entries: EnumEntries<DocumentType>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val Enum<*>.kebabCaseName: String

Name of the enum in kebab-case. Example: TOP_LEFT_CORNER ->top-left-corner

val name: String

val ordinal: Int

preferredAutoPageBreakHeadingMaxDepth

val preferredAutoPageBreakHeadingMaxDepth: Int?

preferredOrientation

val preferredOrientation: PageOrientation

val Enum<*>.quarkdownName: String

Functions

fun valueOf(value: String): DocumentType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<DocumentType>

Returns an array containing the constants of this enum type, in the order they're declared.

fun Enum<*>.wrappedAsValue(): EnumValue