{"route":"/en-US-v0.14.1/reference/model/footnote/","title":"Footnote","description":"Documentation for the `footnote` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"accessibility","name":"Accessibility","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-numbering","name":"numbering","children":[]},{"id":"parameters-body","name":"body","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-entry","name":"Footnote Entry","children":[{"id":"definitions-entry-note","name":"note","children":[]},{"id":"definitions-entry-separator","name":"separator","children":[]},{"id":"definitions-entry-clearance","name":"clearance","children":[]},{"id":"definitions-entry-gap","name":"gap","children":[]},{"id":"definitions-entry-indent","name":"indent","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"footnote","title":"Footnote","keywords":[],"oneliner":"A footnote.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A footnote.

\n

Includes additional remarks and references on the same page with footnotes.\nA footnote will insert a superscript number that links to the note at the\nbottom of the page. Notes are numbered sequentially throughout your document\nand can break across multiple pages.

\n

To customize the appearance of the entry in the footnote listing, see\nfootnote.entry. The footnote itself is realized as a normal superscript,\nso you can use a set rule on the super function to customize it. You can\nalso apply a show rule to customize only the footnote marker (superscript\nnumber) in the running text.

\n

Example

\n
Check the docs for more details.\n#footnote[https://typst.app/docs]\n
\"Preview\"
\n

The footnote automatically attaches itself to the preceding word, even if\nthere is a space before it in the markup. To force space, you can use the\nstring #" " or explicit horizontal spacing.

\n

By giving a label to a footnote, you can have multiple references to it.

\n
You can edit Typst documents online.\n#footnote[https://typst.app/app] <fn>\nCheckout Typst's website. @fn\nAnd the online app. #footnote(<fn>)\n
\"Preview\"
\n

Note: Set and show rules in the scope where footnote is called may not\napply to the footnote's content. See here for more information.

\n

Accessibility

\n

Footnotes will be read by Assistive Technology (AT) immediately after the\nspot in the text where they are referenced, just like how they appear in\nmarkup.

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

How to number footnotes. Accepts a\nnumbering pattern or function taking a single number.

\n

By default, the footnote numbering continues throughout your document.\nIf you prefer per-page footnote numbering, you can reset the footnote\ncounter in the page header. In the future, there might\nbe a simpler way to achieve this.

"},{"kind":"example","content":{"body":"
#set footnote(numbering: "*")\n\nFootnotes:\n#footnote[Star],\n#footnote[Dagger]\n
\"Preview\"
","title":null}}],"types":["str","function"],"strings":[],"default":""1"","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":[{"kind":"html","content":"

The content to put into the footnote. Can also be the label of another\nfootnote this one should point to.

"}],"types":["label","content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[{"path":["footnote"],"name":"entry","title":"Footnote Entry","keywords":[],"oneliner":"An entry in a footnote list.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

An entry in a footnote list.

\n

This function is not intended to be called directly. Instead, it is used in\nset and show rules to customize footnote listings.

"},{"kind":"example","content":{"body":"
#show footnote.entry: set text(red)\n\nMy footnote listing\n#footnote[It's down here]\nhas red text!\n
\"Preview\"
","title":null}},{"kind":"html","content":"

Note: Footnote entry properties must be uniform across each page run (a\npage run is a sequence of pages without an explicit pagebreak in between).\nFor this reason, set and show rules for footnote entries should be defined\nbefore any page content, typically at the very start of the document.

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

The footnote for this entry. Its location can be used to determine\nthe footnote counter state.

"},{"kind":"example","content":{"body":"
#show footnote.entry: it => {\n  let loc = it.note.location()\n  numbering(\n    "1: ",\n    ..counter(footnote).at(loc),\n  )\n  it.note.body\n}\n\nCustomized #footnote[Hello]\nlisting #footnote[World! 🌏]\n
\"Preview\"
","title":null}}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"separator","details":[{"kind":"html","content":"

The separator between the document body and the footnote listing.

"},{"kind":"example","content":{"body":"
#set footnote.entry(\n  separator: repeat[.]\n)\n\nTesting a different separator.\n#footnote[\n  Unconventional, but maybe\n  not that bad?\n]\n
\"Preview\"
","title":null}}],"types":["content"],"strings":[],"default":"line(length: 30% + 0pt, stroke: 0.5pt)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"clearance","details":[{"kind":"html","content":"

The amount of clearance between the document body and the separator.

"},{"kind":"example","content":{"body":"
#set footnote.entry(clearance: 3em)\n\nFootnotes also need ...\n#footnote[\n  ... some space to breathe.\n]\n
\"Preview\"
","title":null}}],"types":["length"],"strings":[],"default":"1em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"gap","details":[{"kind":"html","content":"

The gap between footnote entries.

"},{"kind":"example","content":{"body":"
#set footnote.entry(gap: 0.8em)\n\nFootnotes:\n#footnote[Spaced],\n#footnote[Apart]\n
\"Preview\"
","title":null}}],"types":["length"],"strings":[],"default":"0.5em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"indent","details":[{"kind":"html","content":"

The indent of each footnote entry.

"},{"kind":"example","content":{"body":"
#set footnote.entry(indent: 0em)\n\nFootnotes:\n#footnote[No],\n#footnote[Indent]\n
\"Preview\"
","title":null}}],"types":["length"],"strings":[],"default":"1em","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}]}}}