This is a block representation used in Stencila Schema for mathematical content.

It extends Math for displayed equations and other block-level mathematical expressions. This allows block math to share common math semantics while being rendered and serialized appropriately for block contexts.

Key properties are inherited from Math, especially the source math code, language or format, and compilation-related metadata.

Analogues

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

JATS <disp-formula>

Pandoc Math: Close Pandoc analogue for display math, though Pandoc distinguishes display mode via a subkind rather than a separate node type.

MDAST Math

Properties

The MathBlock type has these properties:

Name	Description	Type	Inherited from
`label`	A short label for the math block.	`String`	-
`labelAutomatically`	Whether the label should be automatically updated.	`Boolean`	-
`code`	The code of the equation in the `mathLanguage`.	`Cord`	`Math`
`mathLanguage`	The language used for the equation e.g tex, mathml, asciimath.	`String`	`Math`
`authors`	The authors of the math.	`Author`*	`Math`
`provenance`	A summary of the provenance of the math.	`ProvenanceCount`*	`Math`
`compilationDigest`	A digest of the `code` and `mathLanguage`.	`CompilationDigest`	`Math`
`compilationMessages`	Messages generated while parsing and compiling the math expression.	`CompilationMessage`*	`Math`
`mathml`	The MathML transpiled from the `code`.	`String`	`Math`
`images`	Images of the math.	`ImageObject`*	`Math`
`id`	The identifier for this item.	`String`	`Entity`

The MathBlock type is related to these types:

Parents: Math

Children: none

Bindings

The MathBlock type is represented in:

JSON-LD

JSON Schema

Python class MathBlock

Rust struct MathBlock

TypeScript class MathBlock

Testing

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

Property	Complexity	Description	Strategy
`code`	Min+	Generate a simple fixed string of math.	`Cord::from("math")`
	Low+	Generate a random string of up to 10 alphanumeric characters (exclude whitespace which when leading or trailing causes issues for Markdown).	`r"[a-zA-Z0-9]{1,10}".prop_map(Cord::from)`
	High+	Generate a random string of up to 100 characters (excluding control characters).	`r"[^\p{C}]{1,100}".prop_map(Cord::from)`
	Max	Generate an arbitrary string.	`String::arbitrary().prop_map(Cord::from)`
`mathLanguage`	Min+	Fixed as TeX (for testing with Markdown which uses dollars to delimit TeX by default)	`Some(String::from("tex"))`
	High+	Generate a random string of up to 10 alphanumeric characters.	`option::of(r"[a-zA-Z0-9]{1,10}")`
	Max	Generate an arbitrary string.	`option::of(String::arbitrary())`

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

Analogues

Properties

Related

Bindings

Testing