progressive-outline

This package provides a Typst function, progressive-outline, to generate a dynamic table of contents, similar to what is found in some LaTeX's Beamer presentations.

Context and Ultimate Goal

This function was developed to meet a need within the Typst community for displaying partial or progressive outlines, especially in presentations. It is inspired by the following discussions:

The ultimate goal would be to integrate this functionality directly into a presentation package like polylux, touying, or presentate. This would allow for the creation of "Beamer-like" presentations where the outline unfolds flexibly as you progress through the slides. Feel free to draw inspiration from this code to contribute to these projects!

Function Usage

To use the function, import the package and call progressive-outline where you want the outline to appear.

#import "@preview/progressive-layout:1.0.0": progressive-outline

#progressive-outline(
  h1-style: "all",
  h2-style: "current-and-grayed",
  h3-style: "current",
  show-numbering: true,
)

Example: The `progressive-layout` Template

This package also contains a simple template, progressive-layout, which shows an example of how to use the function. Here is a minimal code example to test it:

// Import the template
#import "@preview/progressive-layout:1.0.0": progressive-layout, progressive-outline

// Apply the template to your document
#show: doc => progressive-layout(doc)

// Your headings...
= Chapter 1
== Section 1.1
= Chapter 2

Examples

This package includes two files to demonstrate its usage:

example.typ: This file shows how the progressive-outline function works with different options.
demo.typ: This file provides an example of how to use the progressive-layout template.