This is a type used in Stencila Schema for admonition or callout blocks.

It exists to represent semantically distinct callouts such as notes, warnings, tips, and cautions as structured document content rather than as presentation-only containers. This supports consistent rendering, folding, and transformation across authoring and publishing formats.

Key properties include admonitionType, title, isFolded, and content.

Analogues

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

HTML <aside>: Closest HTML sectioning analogue, though HTML <aside> is broader and does not itself encode admonition type or folding behavior.

JATS <boxed-text>: Closest JATS analogue for boxed callout content, but JATS does not standardize the same admonition type vocabulary.

Pandoc Div: Pandoc admonitions are usually represented as divisions with classes and attributes rather than a dedicated node type.

MyST directive admonition

Properties

The Admonition type has these properties:

Name	Description	Type	Inherited from
`admonitionType`	The type of admonition.	`AdmonitionType`	-
`title`	The title of the admonition.	`Inline`*	-
`isFolded`	Whether the admonition is folded.	`Boolean`	-
`content`	The content within the section.	`Block`*	-
`authors`	The authors of the admonition.	`Author`*	-
`provenance`	A summary of the provenance of the content within the admonition.	`ProvenanceCount`*	-
`id`	The identifier for this item.	`String`	`Entity`

The Admonition type is related to these types:

Parents: Entity

Children: none

Bindings

The Admonition type is represented in:

JSON-LD

JSON Schema

Python class Admonition

Rust struct Admonition

TypeScript class Admonition

Testing

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

Property	Complexity	Description	Strategy
`admonitionType`	Min+	Fixed admonition type.	`AdmonitionType::Info`
	Low+	Generate an arbitrary admonition type.	`AdmonitionType::arbitrary()`
`title`	Min+	No title.	`None`
	Low+	Generate up to two arbitrary, non-recursive, inline nodes.	`option::of(vec_inlines_non_recursive(2))`
	High+	Generate up to four arbitrary, non-recursive, inline nodes.	`option::of(vec_inlines_non_recursive(4))`
`isFolded`	Min+	Not foldable.	`None`
	Low+	Arbitrarily, un-foldable, folded, or unfolded.	`option::of(bool::arbitrary())`
`content`	Min+	A single, simple paragraph.	`vec![p([t("Admonition content")])]`
	Low+	Generate up to two arbitrary paragraphs.	`vec_paragraphs(2)`
	High+	Generate up to four arbitrary, non-recursive, block nodes.	`vec_blocks_non_recursive(4)`

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

Analogues

Properties

Related

Bindings

Testing