{"route":"/en-US-v0.14.1/reference/model/outline/","title":"Outline","description":"Documentation for the `outline` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"alternative-outlines","name":"Alternative outlines","children":[]},{"id":"styling-the-outline","name":"Styling the outline","children":[{"id":"entry-spacing","name":"Entry Spacing","children":[]},{"id":"building-an-entry","name":"Building An Entry","children":[]}]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-title","name":"title","children":[]},{"id":"parameters-target","name":"target","children":[]},{"id":"parameters-depth","name":"depth","children":[]},{"id":"parameters-indent","name":"indent","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-entry","name":"Outline Entry","children":[{"id":"definitions-entry-level","name":"level","children":[]},{"id":"definitions-entry-element","name":"element","children":[]},{"id":"definitions-entry-fill","name":"fill","children":[]},{"id":"definitions-entry-definitions","name":"Definitions","children":[{"id":"definitions-entry-definitions-indented","name":"Indented","children":[{"id":"definitions-entry-definitions-indented-prefix","name":"prefix","children":[]},{"id":"definitions-entry-definitions-indented-inner","name":"inner","children":[]},{"id":"definitions-entry-definitions-indented-gap","name":"gap","children":[]}]},{"id":"definitions-entry-definitions-prefix","name":"Prefix","children":[]},{"id":"definitions-entry-definitions-inner","name":"Inner","children":[]},{"id":"definitions-entry-definitions-body","name":"Body","children":[]},{"id":"definitions-entry-definitions-page","name":"Page","children":[]}]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"outline","title":"Outline","keywords":["Table of Contents","toc"],"oneliner":"A table of contents, figures, or other elements.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A table of contents, figures, or other elements.

\n

This function generates a list of all occurrences of an element in the\ndocument, up to a given depth. The element's numbering\nand page number will be displayed in the outline alongside its title or\ncaption.

\n

Example

\n
#set heading(numbering: "1.")\n#outline()\n\n= Introduction\n#lorem(5)\n\n= Methods\n== Setup\n#lorem(10)\n
\"Preview\"
\n

Alternative outlines

\n

In its default configuration, this function generates a table of contents.\nBy setting the target parameter, the outline can be used to generate a\nlist of other kinds of elements than headings.

\n

In the example below, we list all figures containing images by setting\ntarget to figure.where(kind: image). Just the same, we could have set\nit to figure.where(kind: table) to generate a list of tables.

\n

We could also set it to just figure, without using a where\nselector, but then the list would contain all figures, be it ones\ncontaining images, tables, or other material.

\n
#outline(\n  title: [List of Figures],\n  target: figure.where(kind: image),\n)\n\n#figure(\n  image("tiger.jpg"),\n  caption: [A nice figure!],\n)\n
\"Preview\"
\n

Styling the outline

\n

At the most basic level, you can style the outline by setting properties on\nit and its entries. This way, you can customize the outline's\ntitle, how outline entries are\nindented, and how the space between an entry's text and\nits page number should be filled.

\n

Richer customization is possible through configuration of the outline's\nentries. The outline generates one entry for each outlined\nelement.

\n

Spacing the entries

\n

Outline entries are blocks, so you can adjust the spacing between\nthem with normal block-spacing rules:

\n
#show outline.entry.where(\n  level: 1\n): set block(above: 1.2em)\n\n#outline()\n\n= About ACME Corp.\n== History\n=== Origins\n= Products\n== ACME Tools\n
\"Preview\"
\n

Building an outline entry from its parts

\n

For full control, you can also write a transformational show rule on\noutline.entry. However, the logic for properly formatting and indenting\noutline entries is quite complex and the outline entry itself only contains\ntwo fields: The level and the outlined element.

\n

For this reason, various helper functions are provided. You can mix and\nmatch these to compose an entry from just the parts you like.

\n

The default show rule for an outline entry looks like this1:

\n
#show outline.entry: it => link(\n  it.element.location(),\n  it.indented(it.prefix(), it.inner()),\n)\n
\n\n

You can use these individual functions to format the outline entry in\ndifferent ways. Let's say, you'd like to fully remove the filler and page\nnumbers. To achieve this, you could write a show rule like this:

\n
#show outline.entry: it => link(\n  it.element.location(),\n  // Keep just the body, dropping\n  // the fill and the page.\n  it.indented(it.prefix(), it.body()),\n)\n\n#outline()\n\n= About ACME Corp.\n== History\n
\"Preview\"
\n
1\n

The outline of equations is the exception to this rule as it does not\nhave a body and thus does not use indented layout.

\n
"}],"self":false,"params":[{"name":"title","details":[{"kind":"html","content":"

The title of the outline.

\n\n

The outline's heading will not be numbered by default, but you can\nforce it to be with a show-set rule:\nshow outline: set heading(numbering: "1.")

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

The type of element to include in the outline.

\n

To list figures containing a specific kind of element, like an image or\na table, you can specify the desired kind in a where\nselector. See the section on alternative outlines\nfor more details.

"},{"kind":"example","content":{"body":"
#outline(\n  title: [List of Tables],\n  target: figure.where(kind: table),\n)\n\n#figure(\n  table(\n    columns: 4,\n    [t], [1], [2], [3],\n    [y], [0.3], [0.7], [0.5],\n  ),\n  caption: [Experiment results],\n)\n
\"Preview\"
","title":null}}],"types":["label","selector","location","function"],"strings":[],"default":"heading","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"depth","details":[{"kind":"html","content":"

The maximum level up to which elements are included in the outline. When\nthis argument is none, all elements are included.

"},{"kind":"example","content":{"body":"
#set heading(numbering: "1.")\n#outline(depth: 2)\n\n= Yes\nTop-level section.\n\n== Still\nSubsection.\n\n=== Nope\nNot included.\n
\"Preview\"
","title":null}}],"types":["none","int"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"indent","details":[{"kind":"html","content":"

How to indent the outline's entries.

\n"},{"kind":"example","content":{"body":"
#set heading(numbering: "I-I.")\n#set outline(title: none)\n\n#outline()\n#line(length: 100%)\n#outline(indent: 3em)\n\n= Software engineering technologies\n== Requirements\n== Tools and technologies\n=== Code editors\n== Analyzing alternatives\n= Designing software components\n= Testing and integration\n
\"Preview\"
","title":null}}],"types":["auto","relative","function"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[{"path":["outline"],"name":"entry","title":"Outline Entry","keywords":[],"oneliner":"Represents an entry line in an outline.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Represents an entry line in an outline.

\n

With show-set and show rules on outline entries, you can richly customize\nthe outline's appearance. See the\nsection on styling the outline for details.

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

The nesting level of this outline entry. Starts at 1 for top-level\nentries.

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

The element this entry refers to. Its location will be available\nthrough the location method on the content\nand can be linked to.

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

Content to fill the space between the title and the page number. Can be\nset to none to disable filling.

\n

The fill will be placed into a fractionally sized box that spans the\nspace between the entry's body and the page number. When using show\nrules to override outline entries, it is thus recommended to wrap the\nfill in a box with fractional width, i.e.\nbox(width: 1fr, it.fill).

\n

When using repeat, the gap property can be useful\nto tweak the visual weight of the fill.

"},{"kind":"example","content":{"body":"
#set outline.entry(fill: line(length: 100%))\n#outline()\n\n= A New Beginning\n
\"Preview\"
","title":null}}],"types":["none","content"],"strings":[],"default":"repeat(body: [.], gap: 0.15em)","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[{"path":["entry"],"name":"indented","title":"Indented","keywords":[],"oneliner":"A helper function for producing an indented entry layout: Lays out a prefix and the rest of the entry in an indent-aware way.","element":false,"contextual":true,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A helper function for producing an indented entry layout: Lays out a\nprefix and the rest of the entry in an indent-aware way.

\n

If the parent outline's indent is auto, the\ninner content of all entries at level N is aligned with the prefix of\nall entries at level N + 1, leaving at least gap space between the\nprefix and inner parts. Furthermore, the inner contents of all entries\nat the same level are aligned.

\n

If the outline's indent is a fixed value or a function, the prefixes are\nindented, but the inner contents are simply offset from the prefix by\nthe specified gap, rather than aligning outline-wide. For a visual\nexplanation, see outline.indent.

"}],"self":true,"params":[{"name":"prefix","details":[{"kind":"html","content":"

The prefix is aligned with the inner content of entries that\nhave level one less.

\n

In the default show rule, this is just it.prefix(), but it can be\nfreely customized.

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

The formatted inner content of the entry.

\n

In the default show rule, this is just it.inner(), but it can be\nfreely customized.

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

The gap between the prefix and the inner content.

"}],"types":["length"],"strings":[],"default":"0.5em","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["content"],"scope":[]},{"path":["entry"],"name":"prefix","title":"Prefix","keywords":[],"oneliner":"Formats the element's numbering (if any).","element":false,"contextual":true,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Formats the element's numbering (if any).

\n

This also appends the element's supplement in case of figures or\nequations. For instance, it would output 1.1 for a heading, but\nFigure 1 for a figure, as is usual for outlines.

"}],"self":true,"params":[],"returns":["none","content"],"scope":[]},{"path":["entry"],"name":"inner","title":"Inner","keywords":[],"oneliner":"Creates the default inner content of the entry.","element":false,"contextual":true,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Creates the default inner content of the entry.

\n

This includes the body, the fill, and page number.

"}],"self":true,"params":[],"returns":["content"],"scope":[]},{"path":["entry"],"name":"body","title":"Body","keywords":[],"oneliner":"The content which is displayed in place of the referred element at its entry in the outline.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

The content which is displayed in place of the referred element at its\nentry in the outline. For a heading, this is its\nbody; for a figure a caption and for equations, it is\nempty.

"}],"self":true,"params":[],"returns":["content"],"scope":[]},{"path":["entry"],"name":"page","title":"Page","keywords":[],"oneliner":"The page number of this entry's element, formatted with the numbering set for the referenced page.","element":false,"contextual":true,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

The page number of this entry's element, formatted with the numbering\nset for the referenced page.

"}],"self":true,"params":[],"returns":["content"],"scope":[]}]}]}}}