{"route":"/en-US-v0.14.1/reference/model/terms/","title":"Term List","description":"Documentation for the `terms` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-tight","name":"tight","children":[]},{"id":"parameters-separator","name":"separator","children":[]},{"id":"parameters-indent","name":"indent","children":[]},{"id":"parameters-hanging-indent","name":"hanging-indent","children":[]},{"id":"parameters-spacing","name":"spacing","children":[]},{"id":"parameters-children","name":"children","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-item","name":"Term List Item","children":[{"id":"definitions-item-term","name":"term","children":[]},{"id":"definitions-item-description","name":"description","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"terms","title":"Term List","keywords":[],"oneliner":"A list of terms and their descriptions.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A list of terms and their descriptions.

\n

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

\n

Example

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

Syntax

\n

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

"}],"self":false,"params":[{"name":"tight","details":[{"kind":"html","content":"

Defines the default spacing of the term list. If it is\nfalse, the items are spaced apart with\nparagraph spacing. If it is true, they use\nparagraph leading instead. This makes the list more\ncompact, which can look better if the items are short.

\n

In markup mode, the value of this parameter is determined based on\nwhether items are separated with a blank line. If items directly follow\neach other, this is set to true; if items are separated by a blank\nline, this is set to false. The markup-defined tightness cannot be\noverridden with set rules.

"},{"kind":"example","content":{"body":"
/ Fact: If a term list has a lot\n  of text, and maybe other inline\n  content, it should not be tight\n  anymore.\n\n/ Tip: To make it wide, simply\n  insert a blank line between the\n  items.\n
\"Preview\"
","title":null}}],"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"separator","details":[{"kind":"html","content":"

The separator between the item and the description.

\n

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

"},{"kind":"example","content":{"body":"
#set terms(separator: [: ])\n\n/ Colon: A nice separator symbol.\n
\"Preview\"
","title":null}}],"types":["content"],"strings":[],"default":"h(amount: 0.6em, weak: true)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"indent","details":[{"kind":"html","content":"

The indentation of each item.

"}],"types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"hanging-indent","details":[{"kind":"html","content":"

The hanging indent of the description.

\n

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

"},{"kind":"example","content":{"body":"
#set terms(hanging-indent: 0pt)\n/ Term: This term list does not\n  make use of hanging indents.\n
\"Preview\"
","title":null}}],"types":["length"],"strings":[],"default":"2em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"spacing","details":[{"kind":"html","content":"

The spacing between the items of the term list.

\n

If set to auto, uses paragraph leading for tight\nterm lists and paragraph spacing for wide\n(non-tight) term lists.

"}],"types":["auto","length"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":[{"kind":"html","content":"

The term list's children.

\n

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

"},{"kind":"example","content":{"body":"
#for (year, product) in (\n  "1978": "TeX",\n  "1984": "LaTeX",\n  "2019": "Typst",\n) [/ #product: Born in #year.]\n
\"Preview\"
","title":null}}],"types":["content","array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[{"path":["terms"],"name":"item","title":"Term List Item","keywords":[],"oneliner":"A term list item.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A term list item.

"}],"self":false,"params":[{"name":"term","details":[{"kind":"html","content":"

The term described by the list item.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"description","details":[{"kind":"html","content":"

The description of the term.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}]}}}