quarkdown-core/com.quarkdown.core.document.numbering

Package-level declarations

Types

AlphaNumberingSymbol

data class AlphaNumberingSymbol(val case: StringCase) : NumberingCounterSymbol

A numbering strategy that counts items as letters of the latin alphabet: 0, A, B, C, ...

DecimalNumberingSymbol

data object DecimalNumberingSymbol : NumberingCounterSymbol

A numbering strategy that counts items as integers: 0, 1, 2, 3, ...

DocumentNumbering

data class DocumentNumbering(val headings: NumberingFormat? = null, val figures: NumberingFormat? = null, val tables: NumberingFormat? = null, val extra: Map<String, NumberingFormat> = emptyMap())

An immutable group of NumberingFormats for different types of elements (Nodes) in a document.

NumberingCounterSymbol

interface NumberingCounterSymbol : NumberingSymbol

Represents a NumberingSymbol within a NumberingFormat with the responsibility of counting items (e.g. headings) according to a specific rule (strategy).

NumberingFixedSymbol

data class NumberingFixedSymbol(val value: Char) : NumberingSymbol

A NumberingSymbol that represents a fixed character in a numbering format, such as the dots ., in the format 1.A.a.

NumberingFormat

data class NumberingFormat(val symbols: List<NumberingSymbol>)

Represents a format that defines how items (e.g. headings) are numbered in a document, depending on their relative position and level of nesting. For example, a format 1.A.a would result in the following numbering:

NumberingSymbol

sealed interface NumberingSymbol

Any symbol that appears in a numbering format. For example, in the format 1.A.a:

RomanNumberingSymbol

data class RomanNumberingSymbol(val case: StringCase) : NumberingCounterSymbol

A numbering strategy that counts items as Roman numerals: 0, I, II, III, ...