Home

Note

This is a type used in Stencila Schema for notes attached to document content.

It exists to represent note content structurally so it can be rendered as a footnote, endnote, sidenote, or similar document note, depending on the target format and note type. This preserves note semantics across transformations rather than reducing them to plain text markers.

Key properties include noteType and content.

Analogues

The following external types, elements, or nodes are similar to a Note:

  • HTML <aside>: Approximate HTML analogue for note content, though HTML has no dedicated footnote or endnote element and placement semantics are not built in.

  • JATS <fn>: Closest JATS analogue for document notes, particularly footnotes.

  • Pandoc Note: Closest Pandoc analogue for inline-referenced notes; Stencila additionally records note placement semantics explicitly via noteType.

  • MDAST FootnoteDefinition: Close MDAST analogue for defined footnote content, although MDAST models note references and definitions separately and does not cover sidenotes directly.

Properties

The Note type has these properties:

NameDescriptionTypeInherited from
noteTypeDetermines where the note content is displayed within the document.NoteType-
contentContent of the note, usually a paragraph.Block*-
idThe identifier for this item.StringEntity

Related

The Note type is related to these types:

Bindings

The Note type is represented in:

Testing

During property-based (a.k.a generative) testing, the properties of the Note type are generated using the following strategies.

PropertyComplexityDescriptionStrategy
noteTypeMin+Fixed footnote type.NoteType::Footnote
High+Generate an arbitrary note type.NoteType::arbitrary()
contentMin+Generate a single paragraph (with no Note to avoid recursion).vec![p([t("Note paragraph")])]

This documentation was generated from Note.yaml by docs_types.rs.
Edit on GitHub
© 2026 Stencila