{"route":"/en-US-v0.13.1/reference/model/enum/","title":"Numbered List","description":"Documentation for the `enum` 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-numbering","name":"numbering","children":[]},{"id":"parameters-start","name":"start","children":[]},{"id":"parameters-full","name":"full","children":[]},{"id":"parameters-reversed","name":"reversed","children":[]},{"id":"parameters-indent","name":"indent","children":[]},{"id":"parameters-body-indent","name":"body-indent","children":[]},{"id":"parameters-spacing","name":"spacing","children":[]},{"id":"parameters-number-align","name":"number-align","children":[]},{"id":"parameters-children","name":"children","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-item","name":"Numbered List Item","children":[{"id":"definitions-item-number","name":"number","children":[]},{"id":"definitions-item-body","name":"body","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"enum","title":"Numbered List","keywords":[],"oneliner":"A numbered list.","element":true,"contextual":false,"deprecation":null,"details":"

A numbered list.

\n

Displays a sequence of items vertically and numbers them consecutively.

\n

Example

\n
Automatically numbered:\n+ Preparations\n+ Analysis\n+ Conclusions\n\nManually numbered:\n2. What is the first step?\n5. I am confused.\n+  Moving on ...\n\nMultiple lines:\n+ This enum item has multiple\n  lines because the next line\n  is indented.\n\nFunction call.\n#enum[First][Second]\n
\"Preview\"
\n

You can easily switch all your enumerations to a different numbering style\nwith a set rule.

\n
#set enum(numbering: "a)")\n\n+ Starting off ...\n+ Don't forget step two\n
\"Preview\"
\n

You can also use enum.item to programmatically customize the\nnumber of each item in the enumeration:

\n
#enum(\n  enum.item(1)[First step],\n  enum.item(5)[Fifth step],\n  enum.item(10)[Tenth step]\n)\n
\"Preview\"
\n

Syntax

\n

This functions also has dedicated syntax:

\n\n

Enumeration items can contain multiple paragraphs and other block-level\ncontent. All content that is indented more than an item's marker becomes\npart of that item.

","example":null,"self":false,"params":[{"name":"tight","details":"

Defines the default spacing of the enumeration. If it\nis false, 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.

","example":"
+ If an enum has a lot of text, and\n  maybe other inline content, it\n  should not be tight anymore.\n\n+ To make an enum wide, simply\n  insert a blank line between the\n  items.\n
\"Preview\"
","types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"numbering","details":"

How to number the enumeration. Accepts a\nnumbering pattern or function.

\n

If the numbering pattern contains multiple counting symbols, they apply\nto nested enums. If given a function, the function receives one argument\nif full is false and multiple arguments if full is true.

","example":"
#set enum(numbering: "1.a)")\n+ Different\n+ Numbering\n  + Nested\n  + Items\n+ Style\n\n#set enum(numbering: n => super[#n])\n+ Superscript\n+ Numbering!\n
\"Preview\"
","types":["str","function"],"strings":[],"default":""1."","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"start","details":"

Which number to start the enumeration with.

","example":"
#enum(\n  start: 3,\n  [Skipping],\n  [Ahead],\n)\n
\"Preview\"
","types":["auto","int"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"full","details":"

Whether to display the full numbering, including the numbers of\nall parent enumerations.

","example":"
#set enum(numbering: "1.a)", full: true)\n+ Cook\n  + Heat water\n  + Add ingredients\n+ Eat\n
\"Preview\"
","types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"reversed","details":"

Whether to reverse the numbering for this enumeration.

","example":"
#set enum(reversed: true)\n+ Coffee\n+ Tea\n+ Milk\n
\"Preview\"
","types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"indent","details":"

The indentation of each item.

","example":null,"types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body-indent","details":"

The space between the numbering and the body of each item.

","example":null,"types":["length"],"strings":[],"default":"0.5em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"spacing","details":"

The spacing between the items of the enumeration.

\n

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

","example":null,"types":["auto","length"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"number-align","details":"

The alignment that enum numbers should have.

\n

By default, this is set to end + top, which aligns enum numbers\ntowards end of the current text direction (in left-to-right script,\nfor example, this is the same as right) and at the top of the line.\nThe choice of end for horizontal alignment of enum numbers is\nusually preferred over start, as numbers then grow away from the\ntext instead of towards it, avoiding certain visual issues. This option\nlets you override this behaviour, however. (Also to note is that the\nunordered list uses a different method for this, by giving the\nmarker content an alignment directly.).

","example":"
#set enum(number-align: start + bottom)\n\nHere are some powers of two:\n1. One\n2. Two\n4. Four\n8. Eight\n16. Sixteen\n32. Thirty two\n
\"Preview\"
","types":["alignment"],"strings":[],"default":"end + top","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":"

The numbered list's items.

\n

When using the enum syntax, adjacent items are automatically collected\ninto enumerations, even through constructs like for loops.

","example":"
#for phase in (\n   "Launch",\n   "Orbit",\n   "Descent",\n) [+ #phase]\n
\"Preview\"
","types":["content","array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[{"path":["enum"],"name":"item","title":"Numbered List Item","keywords":[],"oneliner":"An enumeration item.","element":true,"contextual":false,"deprecation":null,"details":"

An enumeration item.

","example":null,"self":false,"params":[{"name":"number","details":"

The item's number.

","example":null,"types":["none","int"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The item's body.

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