typst / typst/typst

Plain-text reference to footnote

Open
#2,054 10 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request model
Dominant language
Rust
Stars
56.1k
Forks
1.7k
Avg merge
3d 10h
Merged PRs (30d)
22

Description

Description

Typst allows attaching labels to footnotes, as in #footnote[This is a test]<myfn>, and then referencing: See footnote @myfn. However, this results in the footnote being typeset as a superscript. It would be useful to have the option to show the reference as regular text. This is the default behavior in LaTeX, and may be a stumbling block for people moving over (it is for me).

Use Case

While footnotes should be used sparingly, they are useful to, for instance, elaborate on possible extensions of a result. In this case, sequences of footnotes arise quite naturally. Example:

Main text says: if X, then Y. Footnote 1 says: if X' instead of X, then we still get Y, provided we also assume Z.

Later, main text says: if X and W, then Q. Footnote 2 says: as in Footnote 1, if X' and W instead of X and W, we can still get Q provided we also assume Z.

The point is that it is useful to refer back to an earlier footnote, and it does not make sense for the label to appear as a superscript.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by locating the footnote-reference rendering implementation and related tests, then clarify the intended option and syntax from the discussion. Done means references can be rendered as regular text while the existing superscript behavior remains the default.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.