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 equal to or less than maxdepth, a page break is forced before the heading.

captionposition

.captionposition default:{CaptionPosition? = null} \
                 figures:{CaptionPosition? = null} \
                  tables:{CaptionPosition? = null} \
                    code:{CaptionPosition? = null}
-> Void

Sets the position of captions, relative to the content they describe.

currentpage

.currentpage -> <Error class: unknown class>

Displays the index (starting from 1) of the page this element lies in.

docauthor

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

If author is specified, sets the document author to that value. This is a shortcut for docauthors when there's only one author without additional information.

docauthors

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

If authors is specified, sets the document authors to that value. Compared to docauthor, this function allows for multiple authors and additional information.

docdescription

.docdescription description:{String? = null} -> Any

If description is specified, sets the document description to that value.

dockeywords

.dockeywords keywords:{Iterable<Dynamic>? = null} -> Any

If keywords is specified, sets the document keywords to those values. In HTML, keywords are exported to SEO-friendly meta tags.

doclang

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

If locale is specified, sets the document language to that value. The document language affects localization (localization, localize), hyphenation and other locale-specific properties.

docname

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

If name is specified, sets the document name to that value. The document name affects the name of the output file.

doctype

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

If type is specified, sets the document type to that value. The document type affects its final output style, numbering format and several other properties.

font

.font main:{String? = null} \
   heading:{String? = null} \
      code:{String? = null} \
      size:{Size? = null}
-> Void

Updates the global font configuration of the document.

footer

.footer content:{MarkdownContent} -> Node

Displays content on the bottom center of each page of a document.

formatpagenumber

.formatpagenumber format:{String} -> Node

Sets a new page number format from the page where this function appears.

lastheading

.lastheading depth:{Int} -> <Error class: unknown class>

Displays the last heading, of the given depth, encountered in the current page.

marker

.marker name:{InlineMarkdownContent} -> <Error class: unknown class>

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.

navigation

.navigation role:{NavigationContainer.Role? = null} content:{MarkdownContent} -> Node

Creates a navigation container, which marks its content as a navigable section.

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 by either numbering or the document type default.

numbering

.numbering merge:{Boolean = true} 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 side:{PageSide? = null} \
           pages:{Range? = null} \
            size:{PageSizeFormat? = null} \
     orientation:{PageOrientation = context.documentInfo.type.preferredOrientation} \
           width:{Size? = null} \
          height:{Size? = null} \
          margin:{Sizes? = null} \
       bordertop:{Size? = null} \
     borderright:{Size? = null} \
    borderbottom:{Size? = null} \
      borderleft:{Size? = null} \
     bordercolor:{Color? = null} \
         columns:{Int? = null} \
       alignment:{Container.TextAlignment? = null}
-> Void

Sets the page layout format of the document. If a value is unset, the default value supplied by the underlying renderer is used.

pagemargin

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

Displays content on each page of a document.

paragraphstyle

.paragraphstyle lineheight:{Number? = null} \
             letterspacing:{Number? = null} \
                   spacing:{Number? = null} \
                    indent:{Number? = null}
-> Void

Sets the global style of paragraphs in the document. If a value is unset, the default value supplied by the underlying renderer is used.

resetpagenumber

.resetpagenumber start:{Int = 1} -> Node

Resets the logical page number counter.

tableofcontents

.tableofcontents title:{InlineMarkdownContent? = null} \
              maxdepth:{Int = 3} \
             breakpage:{Boolean = true} \
          headingdepth:{Int? = null} \
         numberheading:{Boolean = false} \
          indexheading:{Boolean = false} \
                 focus:{InlineMarkdownContent? = null}
-> Node

Generates a table of contents, based on the headings in the document, organized in a hierarchical structure defined by each heading's depth.

texmacro

.texmacro name:{String} macro:{String} -> <Error class: unknown class>

Creates a new global TeX macro that can be accessed within math blocks.

theme

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

Sets the document theme.

totalpages

.totalpages -> <Error class: unknown class>

Displays the total amount of pages in the document.