schema

CodeBlock

A code block.

Properties

Name	@id	Type	Description	Inherited from
text	schema:text	string	The text of the code.	Code
exportFrom	stencila:exportFrom	string	A compilation directive giving the name of the variable to export into the content of the code block.	CodeBlock
format	schema:encodingFormat	string	Media type, typically expressed using a MIME format, of the code. See note 1.	Code
id	schema:id	string	The identifier for this item.	Entity
importTo	stencila:importTo	string	A compilation directive giving the name of the variable to import the content of the code block as.	CodeBlock
meta	stencila:meta	object	Metadata associated with this item.	Entity
programmingLanguage	schema:programmingLanguage	string	The programming language of the code.	Code

Related

• Parent: Code
• Descendants: CodeChunk

Notes

1. format : This property allows the differentiation of formats using the same programming language or variants of a programming language. An example is using programmingLanguage “json” and encodingFormat “application/ld+json” for JSON-LD code examples.

Available as

• JSON-LD
• JSON Schema
• Python class
• TypeScript class
• R class

Source

This documentation was generated from CodeBlock.schema.yaml.

This site is open source. Improve this page.