This is an executable control-flow block used in Stencila Schema for repetition.

It extends CodeExecutable so a document can repeat block content for each item in an array while preserving structured execution semantics. This brings loop-like behavior into the document model for dynamic and parameterized content generation.

Key properties include the iteration source, loop variable binding, repeated content, and inherited execution properties.

This type is marked as unstable and is subject to change.

Analogues

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

Jinja for block: Close template-language analogue for repeating content over an iterable, though Stencila models the loop as an executable document node.

Properties

The ForBlock type has these properties:

Name	Description	Type	Inherited from
`variable`	The name to give to the variable representing each item in the iterated array	`String`	-
`content`	The content to repeat for each item	`Block`*	-
`otherwise`	The content to render if there are no items	`Block`*	-
`iterations`	The content repeated for each iteration	`Block`*	-
`code`	The code.	`Cord`	`CodeExecutable`
`programmingLanguage`	The programming language of the code.	`String`	`CodeExecutable`
`executionBounds`	The environment in which code should be executed.	`ExecutionBounds`	`CodeExecutable`
`executionBounded`	The execution bounds, if any, on the last execution.	`ExecutionBounds`	`CodeExecutable`
`authors`	The authors of the executable code.	`Author`*	`CodeExecutable`
`provenance`	A summary of the provenance of the code.	`ProvenanceCount`*	`CodeExecutable`
`executionMode`	Under which circumstances the node should be executed.	`ExecutionMode`	`Executable`
`compilationDigest`	A digest of the content, semantics and dependencies of the node.	`CompilationDigest`	`Executable`
`compilationMessages`	Messages generated while compiling the code.	`CompilationMessage`*	`Executable`
`executionDigest`	The `compilationDigest` of the node when it was last executed.	`CompilationDigest`	`Executable`
`executionDependencies`	The upstream dependencies of this node.	`ExecutionDependency`*	`Executable`
`executionDependants`	The downstream dependants of this node.	`ExecutionDependant`*	`Executable`
`executionTags`	Tags in the code which affect its execution.	`ExecutionTag`*	`Executable`
`executionCount`	A count of the number of times that the node has been executed.	`Integer`	`Executable`
`executionRequired`	Whether, and why, the code requires execution or re-execution.	`ExecutionRequired`	`Executable`
`executionStatus`	Status of the most recent, including any current, execution.	`ExecutionStatus`	`Executable`
`executionInstance`	The id of the kernel instance that performed the last execution.	`String`	`Executable`
`executionEnded`	The timestamp when the last execution ended.	`Timestamp`	`Executable`
`executionDuration`	Duration of the last execution.	`Duration`	`Executable`
`executionMessages`	Messages emitted while executing the node.	`ExecutionMessage`*	`Executable`
`id`	The identifier for this item.	`String`	`Entity`

The ForBlock type is related to these types:

Parents: CodeExecutable

Children: none

Bindings

The ForBlock type is represented in:

JSON-LD

JSON Schema

Python class ForBlock

Rust struct ForBlock

TypeScript class ForBlock

Testing

During property-based (a.k.a generative) testing, the properties of the ForBlock 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 (excludes 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+	Generate a simple fixed string.	`Some(String::from("lang"))`
	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())`
`variable`	Min+	Generate a fixed variable name.	`String::from("item")`
	Low+	Generate a random string of up to 10 alphanumeric characters (and at most one underscore to avoida clash with Markdown emphasis).	Regex `[a-zA-Z_][a-zA-Z0-9]{0,9}`
	High+	Generate a random string of up to 100 characters (excluding control characters).	Regex `[^\p{C}]{1,100}`
	Max	Generate an arbitrary string.	`String::arbitrary()`
`content`	Min+	A single simple paragraph.	`vec![p([t("For content")])]`
	Low+	Generate up to four arbitrary, non-recursive, block nodes.	`vec_blocks_non_recursive(4)`
	Max	Generate up to eight arbitrary, non-recursive, block nodes.	`vec_blocks_non_recursive(8)`
`otherwise`	Min+	No otherwise clause.	`None`
	Low+	Generate up to two arbitrary, non-recursive, block nodes.	`option::of(vec_blocks_non_recursive(2))`
	Max	Generate up to four arbitrary, non-recursive, block nodes.	`option::of(vec_blocks_non_recursive(4))`

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

Analogues

Properties

Related

Bindings

Testing