Analogues of Heading in other schemas include:

• HTML <h1> to <h6>
• JATS XML <title>
• Pandoc Header

Properties

The Heading type has these properties:

Name	Description	Type	Inherited from	JSON-LD @id	Aliases
id	The identifier for this item.	String	Entity	schema:id	-
level	The level of the heading.	Integer	-	stencila:level	-
content	Content of the heading.	Inline*	-	stencila:content	-
authors	The authors of the heading.	Author*	-	schema:author	author
provenance	A summary of the provenance of the content within the heading.	ProvenanceCount*	-	stencila:provenance	-

Related

The Heading type is related to these types:

• Parents: Entity
• Children: none

Formats

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

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🟢 No loss		Encoded using special function
JATS	🟢 No loss	🟢 No loss	Encoded as <title> using special function
Markdown	🟢 No loss	🟢 No loss	Encoded using implemented function
Stencila Markdown	🟢 No loss	🟢 No loss
Quarto Markdown	🟢 No loss	🟢 No loss
MyST Markdown	🟢 No loss	🟢 No loss
LLM Markdown	🟢 No loss	🟢 No 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 Heading type is represented in:

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

Testing

During property-based (a.k.a generative) testing, the properties of the Heading 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
level	Min+	Fixed value of 1	1
	Low+	Generate values between 1 and 6	1..=6i64
	High+	Generate values between 0 and 6	0..=6i64
	Max	Generate an arbitrary value	i64::arbitrary()
content	Min+	Generate a single arbitrary inline node	vec_inlines(1)
	Low+	Generate up to two arbitrary inline nodes	vec_inlines(2)
	High+	Generate up to four arbitrary inline nodes	vec_inlines(4)
	Max	Generate up to eight arbitrary inline nodes without restrictions on their order	vec(Inline::arbitrary(), size_range(0..=8))

Source

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