Skip to content

Document metadata

Giorgio Garofalo edited this page Oct 5, 2024 · 6 revisions

Information about the document can be set via functions. These functions should conventionally be called at the beginning of a Quarkdown source.

Name Accepts Default
.docname The name of the document. Untitled Quarkdown Document
.docauthor The author(s) of the document. (none)
.doctype Type of output document: plain, slides, paged. plain
.doclang Language of the document: either a case-insensitive English full name (e.g. English, Italian, French (Canada)) or a IETF BCP 47 language tag (e.g. en, it, fr-CA).
This defines the target locale to localize strings to, and also sets HTML's lang attribute, which enhances accessibility.
See Localization for more.
(none)

All these functions have a 'modify or echo' behavior: if the value is not passed as an argument, then they return the previously set value. Example:

.docname {Quarkdown}

This document is called **.docname**!

This document is called Quarkdown!

Clone this wiki locally