A note is usually associated with a word or paragraph using a number or other symbol. It can be displayed as a footnote, endnote, or side note, or in interactive elements. For analogues, see

• JATS <fn>
• Pandoc footnotes
• HTML <aside>

Properties

The Note type has these properties:

Name	Description	Type	Inherited from	JSON-LD @id	Aliases
id	The identifier for this item.	String	Entity	schema:id	-
noteType	Determines where the note content is displayed within the document.	NoteType	-	stencila:noteType	note-type, note_type
content	Content of the note, usually a paragraph.	Block*	-	stencila:content	-

Related

The Note type is related to these types:

• Parents: Entity
• Children: none

Formats

The Note type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🔷 Low loss
JATS	🟢 No loss	🟢 No loss	Encoded as <fn>
Markdown	🔷 Low loss	🔷 Low loss	Encoded using implemented function
Stencila Markdown	🔷 Low loss	🔷 Low loss
Quarto Markdown	🔷 Low loss	🔷 Low loss
MyST Markdown	🔷 Low loss	🔷 Low loss
LLM Markdown	🔷 Low loss	🔷 Low loss
LaTeX	🔷 Low loss	🔷 Low loss
PDF	🔷 Low loss
Plain text	⚠️ High loss
IPYNB	🔷 Low loss	🔷 Low loss
Microsoft Word DOCX	🔷 Low loss	🔷 Low loss
OpenDocument ODT	🔷 Low loss	🔷 Low loss
TeX	🔷 Low loss	🔷 Low loss
JSON	🟢 No loss	🟢 No loss
JSON+Zip	🟢 No loss	🟢 No loss
JSON5	🟢 No loss	🟢 No loss
JSON-LD	🟢 No loss	🟢 No loss
CBOR	🟢 No loss	🟢 No loss
CBOR+Zstandard	🟢 No loss	🟢 No loss
YAML	🟢 No loss	🟢 No loss
Lexical JSON	🔷 Low loss	🔷 Low loss
Koenig JSON	🔷 Low loss	🔷 Low loss
Pandoc AST	🔷 Low loss	🔷 Low loss
Directory
Stencila Web Bundle
Debug	🔷 Low loss

Bindings

The Note type is represented in:

• JSON-LD
• JSON Schema
• Python class Note
• Rust struct Note
• TypeScript class Note

Testing

During property-based (a.k.a generative) testing, the properties of the Note type are generated using the following strategies for each complexity level. Any optional properties that are not in this table are set to None.

Property	Complexity	Description	Strategy
noteType	Min+	Fixed footnote type.	NoteType::Footnote
	High+	Generate an arbitrary note type.	NoteType::arbitrary()
content	Min+	Generate a single paragraph (with no Note to avoid recursion).	vec![p([t("Note paragraph")])]

Source

This documentation was generated from Note.yaml by docs_types.rs.