Struct FootnoteElem 

pub struct FootnoteElem {
    pub numbering: Settable<Self, 0u8>,
    pub body: FootnoteBody,
}

A footnote.

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

To customize the appearance of the entry in the footnote listing, see [footnote.entry]. The footnote itself is realized as a normal superscript, so you can use a set rule on the super function to customize it. You can also apply a show rule to customize only the footnote marker (superscript number) in the running text.

Example

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

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

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

You can edit Typst documents online.
#footnote[https://typst.app/app] <fn>
Checkout Typst's website. @fn
And the online app. #footnote(<fn>)

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

Accessibility

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

Fields

numbering: Settable<Self, 0u8>

body: FootnoteBody

Implementations

impl FootnoteElem

pub fn new(body: FootnoteBody) -> Self

Create a new instance of the element.

pub fn with_numbering(self, numbering: Numbering) -> Self

Builder-style setter for the numbering field.

impl FootnoteElem

pub const numbering: Field<Self, 0u8>

pub const body: Field<Self, 1u8>

impl FootnoteElem

pub fn alt_text(styles: StyleChain<'_>, num: &str) -> EcoString

pub fn with_content(content: Content) -> Self

Creates a new footnote that the passed content as its body.

pub fn with_label(label: Label) -> Self

Creates a new footnote referencing the footnote with the specified label.

pub fn into_ref(&self, label: Label) -> Self

Creates a new footnote referencing the footnote with the specified label, with the other fields from the current footnote cloned.

pub fn is_ref(&self) -> bool

Tests if this footnote is a reference to another footnote.

pub fn body_content(&self) -> Option<&Content>

Returns the content of the body of this footnote if it is not a ref.

Trait Implementations

impl Clone for FootnoteElem

fn clone(&self) -> FootnoteElem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Construct for FootnoteElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for FootnoteElem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromValue for FootnoteElem

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for FootnoteElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NativeElement for FootnoteElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl NativeScope for FootnoteElem

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl Reflect for FootnoteElem

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl RequiredField<1> for FootnoteElem

const FIELD: RequiredFieldData<Self, 1u8>

type Type = FootnoteBody

impl Set for FootnoteElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableField<0> for FootnoteElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = Numbering

impl RefableProperty<0> for FootnoteElem