• 
• 
• Reference
• 
• Model
• 
• Document

documentElement

Element functions can be customized with set and show rules.

The root element of a document and its metadata.

All documents are automatically wrapped in a document element. You cannot create a document element yourself. This function is only used with set rules to specify document metadata. Such a set rule must not occur inside of any layout container.

#set document(title: [Hello])

This has no visible output, but
embeds metadata into the PDF!

Note that metadata set with this function is not rendered within the document. Instead, it is embedded in the compiled PDF file.

Parameters

Parameters are the inputs to a function. They are specified in parentheses after the function name.

title

none or content

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

The document's title. This is often rendered as the title of the PDF viewer window.

While this can be arbitrary content, PDF viewers only support plain text titles, so the conversion might be lossy.

Default: none

author

str or array

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

The document's authors.

Default: ()

keywords

str or array

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

The document's keywords.

Default: ()

date

none or auto or datetime

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

The document's creation date.

If this is auto (default), Typst uses the current date and time. Setting it to none prevents Typst from embedding any creation date into the PDF metadata.

The year component must be at least zero in order to be embedded into a PDF.

If you want to create byte-by-byte reproducible PDFs, set this to something other than auto.

Default: auto

CitePrevious page

EmphasisNext page