quarkdown-stdlib/com.quarkdown.stdlib.module.Document

Package-level declarations

Functions

.autopagebreak maxdepth:{Int} -> Void

Sets a new automatic page break threshold when a heading is found: if a heading's depth value (the amount of leading #s) is equals or less than maxdepth, a page break is forced before the heading.

currentpage

.currentpage -> Node

Displays the index (beginning from 1) of the page this element lies in. In case the current document type does not support page counting (e.g. plain document), a placeholder is used.

docauthor

.docauthor author:{String? = null} -> Any

If author is not null, it sets the document author to its value. If it's null, the current document author is returned.

docauthors

.docauthors authors:{Map<String, Dictionary<Any>>? = null} -> Any

If authors is not null, it sets the document authors to its value. If it's null, the current document authors are returned.

doclang

.doclang locale:{String? = null} -> Any

If locale is not null, it sets the document locale to its value. If it's null, the localized name of the current document locale is returned.

docname

.docname name:{String? = null} -> Any

If name is not null, it sets the document name to its value. If it's null, the current document name is returned.

doctype

.doctype type:{DocumentType? = null} -> Any

If type is not null, it sets the document type to its value. The document type affects its final output style. If it's null, the name of the current document type is returned.

footer

.footer content:{MarkdownContent} -> Node

Displays text content on the bottom center of each page of a document. Shortcut for pagemargin with PageMarginPosition.BOTTOM_CENTER as its position.

marker

.marker name:{InlineMarkdownContent} -> Node

Creates an invisible marker that points to a specific location in the document, and can be referenced by other elements as would happen with a regular heading. It can be particularly useful when using a table of contents.

noautopagebreak

.noautopagebreak -> Void

Disables automatic page breaks when a heading is found.

nonumbering

.nonumbering -> Void

Disables numbering across the document, in case a default numbering is set.

numbering

.numbering formats:{Map<String, Any>} -> Void

Sets the global numbering format across the document. Numbering is applied to elements that support it, such as headings and figures.

pageformat

.pageformat size:{PageSizeFormat? = null}
     orientation:{PageOrientation = context.documentInfo.type.preferredOrientation}
           width:{Size? = null}
          height:{Size? = null}
          margin:{Sizes? = null}
         columns:{Int? = null}
       alignment:{Container.Alignment? = null}
-> Void

Sets the format of the document. If a value is null, the default value supplied by the underlying renderer is used. If neither size nor width or height are null, the latter override the former. If both size and width or height are null, the default value is used.

pagemargin

.pagemargin position:{PageMarginPosition = PageMarginPosition.TOP_CENTER} content:{MarkdownContent} -> Node

Displays text content on each page of a document.

tableofcontents

.tableofcontents title:{InlineMarkdownContent? = null}
              maxdepth:{Int = 3}
                 focus:{InlineMarkdownContent? = null}
-> Node

Generates a table of contents for the document.

texmacro

.texmacro name:{String} macro:{String} -> Void

theme

.theme color:{String? = null} layout:{String? = null} -> Void

Sets the global document theme.

totalpages

.totalpages -> Node

Displays the total amount of pages in the document. In case the current document type does not support page counting (e.g. plain document), a placeholder is used.