• 
• 
• Reference
• 
• Meta
• 
• Metadata

metadataElement

Element functions can be customized with set and show rules.

Exposes a value to the query system without producing visible content.

This element can be retrieved with the query function and from the command with typst query. Its purpose is to expose an arbitrary value to the introspection system. To identify a metadata value among others, you can attach a label to it and query for that label.

The metadata element is especially useful for command line queries because it allows you to expose arbitrary values to the outside world.

// Put metadata somewhere.
#metadata("This is a note") <note>

// And find it from anywhere else.
#locate(loc => {
  query(<note>, loc).first().value
})

Parameters

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

value

any

RequiredPositional

Positional parameters are specified in order, without names.

The value to embed into the document.

LocationPrevious page

NumberingNext page