TypstDocumentation

termsElement
Question mark

A list of terms and their descriptions.

Displays a sequence of terms and their descriptions vertically. When the descriptions span over multiple lines, they use hanging indent to communicate the visual hierarchy.

Example

/ Ligature: A merged glyph.
/ Kerning: A spacing adjustment
  between two adjacent letters.
Preview

Syntax

This function also has dedicated syntax: Starting a line with a slash, followed by a term, a colon and a description creates a term list item.

Parameters
Question mark

tight
boolean
Settable
Question mark

If this is false, the items are spaced apart with term list spacing. If it is true, they use normal leading instead. This makes the term list more compact, which can look better if the items are short.

Default: true

/ Fact: If a term list has a lot
  of text, and maybe other inline
  content, it should not be tight
  anymore.

/ Tip: To make it wide, simply
  insert a blank line between the
  items.
Preview

separator
content
Settable
Question mark

The separator between the item and the description.

If you want to just separate them with a certain amount of space, use h(2cm, weak: true) as the separator and replace 2cm with your desired amount of space.

Default: h(amount: 0.6em, weak: true)

#set terms(separator: [: ])

/ Colon: A nice separator symbol.
Preview

indent
length
Settable
Question mark

The indentation of each item.

Default: 0pt

hanging-indent
length
Settable
Question mark

The hanging indent of the description.

This is in addition to the whole item's indent.

Default: 2em

#set terms(hanging-indent: 0pt)
/ Term: This term list does not
  make use of hanging indents.
Preview

spacing
auto or relative length or fraction
Settable
Question mark

The spacing between the items of a wide (non-tight) term list.

If set to auto, uses the spacing below blocks.

Default: auto

children
content or array
RequiredPositional
Question mark
Variadic
Question mark

The term list's children.

When using the term list syntax, adjacent items are automatically collected into term lists, even through constructs like for loops.

#for (year, product) in (
  "1978": "TeX",
  "1984": "LaTeX",
  "2019": "Typst",
) [/ #product: Born in #year.]
Preview

terms.item functionElement
Question mark

A term list item.

Parameters
Question mark

terms.item() -> content

term
content
RequiredPositional
Question mark

The term described by the list item.

description
content
RequiredPositional
Question mark

The description of the term.