This is a block representation used in Stencila Schema for non-executable code.

It extends CodeStatic for code that should be displayed and preserved as document content without normal execution semantics. Stencila also adds optional demo compilation behavior so some static code blocks can render derived content while remaining distinct from executable code chunks.

Key properties are inherited from CodeStatic, with Stencila Schema behavior centered on isDemo, content, and the associated compilation properties.

Analogues

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

HTML <pre>

JATS <code>

Pandoc CodeBlock

MDAST Code: Closest MDAST analogue for fenced or indented code blocks.

Properties

The CodeBlock type has these properties:

Name	Description	Type	Inherited from
`isDemo`	Whether the code block is a demo that should also be rendered.	`Boolean`	-
`compilationDigest`	A digest of the `code` and `programmingLanguage`.	`CompilationDigest`	-
`compilationMessages`	Messages generated while compiling the demo content.	`CompilationMessage`*	-
`content`	The content rendered from the code when `isDemo` is true.	`Block`*	-
`code`	The code.	`Cord`	`CodeStatic`
`programmingLanguage`	The programming language of the code.	`String`	`CodeStatic`
`authors`	The authors of the code.	`Author`*	`CodeStatic`
`provenance`	A summary of the provenance of the code.	`ProvenanceCount`*	`CodeStatic`
`id`	The identifier for this item.	`String`	`Entity`

The CodeBlock type is related to these types:

Parents: CodeStatic

Children: none

Bindings

The CodeBlock type is represented in:

JSON-LD

JSON Schema

Python class CodeBlock

Rust struct CodeBlock

TypeScript class CodeBlock

Testing

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

Property	Complexity	Description	Strategy
`code`	Min+	Generate a simple fixed string of code.	`Cord::from("code")`
	Low+	Generate a random string of up to 10 alphanumeric characters (exclude whitespace whichcan be problematic in 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)`
`programmingLanguage`	Min+	Do not generate a programming language.	`None`
	Low+	Generate one of the well known programming language short names.	`option::of(r"(cpp)\|(js)\|(py)\|(r)\|(ts)")`
	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 CodeBlock.yaml by docs_types.rs.

Analogues

Properties

Related

Bindings

Testing