{"route":"/en-US-v0.13.1/reference/model/numbering/","title":"Numbering","description":"Documentation for the `numbering` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"numbering-patterns-and-numbering-functions","name":"Numbering patterns and numbering functions","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-numbering","name":"numbering","children":[]},{"id":"parameters-numbers","name":"numbers","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"numbering","title":"Numbering","keywords":[],"oneliner":"Applies a numbering to a sequence of numbers.","element":false,"contextual":false,"deprecation":null,"details":"

Applies a numbering to a sequence of numbers.

\n

A numbering defines how a sequence of numbers should be displayed as\ncontent. It is defined either through a pattern string or an arbitrary\nfunction.

\n

A numbering pattern consists of counting symbols, for which the actual\nnumber is substituted, their prefixes, and one suffix. The prefixes and the\nsuffix are repeated as-is.

\n

Example

\n
#numbering("1.1)", 1, 2, 3) \\\n#numbering("1.a.i", 1, 2) \\\n#numbering("I – 1", 12, 2) \\\n#numbering(\n  (..nums) => nums\n    .pos()\n    .map(str)\n    .join(".") + ")",\n  1, 2, 3,\n)\n
\"Preview\"
\n

Numbering patterns and numbering functions

\n

There are multiple instances where you can provide a numbering pattern or\nfunction in Typst. For example, when defining how to number\nheadings or figures. Every time, the expected format\nis the same as the one described below for the\nnumbering parameter.

\n

The following example illustrates that a numbering function is just a\nregular function that accepts numbers and returns content.

\n
#let unary(.., last) = "|" * last\n#set heading(numbering: unary)\n= First heading\n= Second heading\n= Third heading\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"numbering","details":"

Defines how the numbering works.

\n

Counting symbols are 1, a, A, i, I, α, Α, 一, 壹,\nあ, い, ア, イ, א, 가, ㄱ, *, ١, ۱, १, ১, ক,\n①, and ⓵. They are replaced by the number in the sequence,\npreserving the original case.

\n

The * character means that symbols should be used to count, in the\norder of *, †, ‡, §, , ‖. If there are more than six\nitems, the number is represented using repeated symbols.

\n

Suffixes are all characters after the last counting symbol. They are\nrepeated as-is at the end of any rendered number.

\n

Prefixes are all characters that are neither counting symbols nor\nsuffixes. They are repeated as-is at in front of their rendered\nequivalent of their counting symbol.

\n

This parameter can also be an arbitrary function that gets each number\nas an individual argument. When given a function, the numbering\nfunction just forwards the arguments to that function. While this is not\nparticularly useful in itself, it means that you can just give arbitrary\nnumberings to the numbering function without caring whether they are\ndefined as a pattern or function.

","example":null,"types":["str","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"numbers","details":"

The numbers to apply the numbering to. Must be positive.

\n

If numbering is a pattern and more numbers than counting symbols are\ngiven, the last counting symbol with its prefix is repeated.

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