Skip to main content

Code

Base type for non-executable (e.g. CodeBlock) and executable (e.g. CodeExpression) code nodes.

The most important, and only required, property of a Code node is text, a string of the source code. There are no restrictions on the length or content of text and it is possible for it to be syntactically invalid for the specified programmingLanguage.

Properties

Name@idTypeDescriptionInherited from
textschema:textstringThe text of the code.Code
idschema:idstringThe identifier for this item.Entity
mediaTypeschema:encodingFormatstringMedia type, typically expressed using a MIME format, of the code. See note 1.Code
metastencila:metaobjectMetadata associated with this item.Entity
programmingLanguageschema:programmingLanguagestringThe programming language of the code.Code

Notes

  1. mediaType : 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

Source

This documentation was generated from Code.schema.yaml.