This is a union type used in Stencila Schema for inline content.

It brings together the node types that can appear within prose content, analogous to inline-content unions in HTML, Markdown ASTs, and other document models. The union allows Stencila to mix text, marks, citations, code, math, media, and executable inline elements within a single typed model.

Use this type to understand what can appear in inline content arrays such as those on Paragraph, Heading, and other prose nodes.

Analogues

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

HTML phrasing content: Broadly analogous to HTML inline-capable content, though Stencila's union is a typed AST union rather than a DOM content category.

Pandoc Inline: Closest Pandoc union analogue for inline content.

MDAST phrasing content: Closest MDAST analogue for reusable inline-content positions.

Members

The Inline type has these members:

Bindings

The Inline type is represented in:

JSON-LD

JSON Schema

Python type Inline

Rust type Inline

TypeScript type Inline

Testing

During property-based (a.k.a generative) testing, the variants of the Inline type are generated using the following strategies. Any variant not shown is generated using the default strategy for the corresponding type and complexity level.

Variant	Complexity	Description	Strategy
`Annotation`	Min+	Do not generate `Annotation` nodes in inline content.	-
`Boundary`	Min+	Do not generate `Boundary` nodes in inline content.	-
	Low+	Do not generate `Boundary` nodes in inline content.	-
`AudioObject`	Min+	Do not generate `AudioObject` nodes in inline content.	-
	High+	Generate `AudioObject` nodes in inline content.	Default for level
`Button`	Min+	Do not generate `Button` nodes in inline content.	-
`Citation`	Min+	Do not generate `Citation` nodes in inline content.	-
`CitationGroup`	Min+	Do not generate `CitationGroup` nodes in inline content.	-
`CodeExpression`	Min+	Do not generate `CodeExpression` nodes in inline content.	-
	Low+	Generate `CodeExpression` nodes in inline content.	Default for level
`Date`	Min+	Do not generate `Date` nodes in inline content.	-
	High+	Generate `Date` nodes in inline content.	Default for level
`DateTime`	Min+	Do not generate `DateTime` nodes in inline content.	-
	High+	Generate `DateTime` nodes in inline content.	Default for level
`Duration`	Min+	Do not generate `Duration` nodes in inline content.	-
	High+	Generate `Duration` nodes in inline content.	Default for level
`Icon`	Min+	Do not generate `Icon` nodes in inline content.	-
`InstructionInline`	Min+	Do not generate `InstructionInline` nodes in inline content.	-
	Max	Generate `InstructionInline` nodes in inline content.	Default for level
`MediaObject`	Min+	Do not generate `MediaObject` nodes in inline content.	-
`Note`	Min+	Do not generate `Note` nodes in inline content.	-
	Low+	Generate `Note` nodes in inline content.	Default for level
`Parameter`	Min+	Do not generate `Parameter` nodes in inline content.	-
	Low+	Generate `Parameter` nodes in inline content.	Default for level
`Sentence`	Min+	Do not generate `Sentence` nodes in inline content.	-
`SuggestionInline`	Min+	Do not generate `SuggestionInline` nodes in inline content.	-
`Time`	Min+	Do not generate `Time` nodes in inline content.	-
	High+	Generate `Time` nodes in inline content.	Default for level
`Timestamp`	Min+	Do not generate `Timestamp` nodes in inline content.	-
	High+	Generate `Timestamp` nodes in inline content.	Default for level
`VideoObject`	Min+	Do not generate `VideoObject` nodes in inline content.	-
	High+	Generate `VideoObject` nodes in inline content.	Default for level
`Null`	Min+	Do not generate `Null` nodes in inline content.	-
	Max	Generate a null value.	`Inline::Null(Null)`
`Boolean`	Min+	Do not generate `Boolean` nodes in inline content.	-
	Max	Generate an arbitrary boolean value.	`Boolean::arbitrary().prop_map(Inline::Boolean)`
`Integer`	Min+	Do not generate `Integer` nodes in inline content.	-
	Max	Generate an arbitrary integer value.	`Integer::arbitrary().prop_map(Inline::Integer)`
`UnsignedInteger`	Min+	Do not generate `UnsignedInteger` nodes in inline content (since roundtripconversion can not differentiate it from an `Integer`).	-
`Number`	Min+	Do not generate `Number` nodes in inline content.	-
	Max	Generate a fixed number. Used at all levels because even with JSON (and other data serialization formats)round trip conversions can fail in the last significant digit of random numbers.	`Inline::Number(1.23)`

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