outline
ShowableShowable functions can be customized with show
rules.
Showable functions can be customized with
show
rules.A section outline / table of contents.
This function generates a list of all headings in the document, up to a given depth. The heading numbering will be reproduced within the outline.
Example
#outline()
= Introduction
#lorem(5)
= Prior work
#lorem(10)

ParametersParameters are the inputs to a function. They are specified in parentheses after the function name.
Parameters are the inputs to a function. They are specified in parentheses after the function name.
outline()
title
The title of the outline.
- When set to
auto
, an appropriate title for the text language will be used. This is the default. - When set to
none
, the outline will not have a title. - A custom title can be set by passing content.
depth
The maximum depth up to which headings are included in the outline. When
this argument is none
, all headings are included.
indent
booleanSettableSettable parameters can be customized for all following uses of the function with a set
rule.
Settable parameters can be customized for all following uses of the function with a
set
rule.Whether to indent the subheadings to align the start of their numbering with the title of their parents. This will only have an effect if a heading numbering is set.
#set heading(numbering: "1.a.")
#outline(indent: true)
= About ACME Corp.
== History
#lorem(10)
== Products
#lorem(10)

fill
The symbol used to fill the space between the title and the page
number. Can be set to none
to disable filling. The default is a
single dot.
#outline(
fill: pad(x: -1.5pt)[―]
)
= A New Beginning
