Skip to main content

Node

Union type for all schema nodes, including primitives and entities

The entity types in this union are automatically inserted during the build. The order of these types is important because it determines the order of attempted coercion (ie. parsing and reshaping to arrays). Array should come last to avoid single items (e.g. a single string) being coerced into an array.

This schema type is marked as unstable ⚠️ and is subject to change.

Members

@idTypeDescription
stencila:EntityEntityThe most simple compound (ie. non-atomic like number, string etc) type.
stencila:ArrayValidatorArrayValidatorA validator specifying constraints on an array node.
schema:ArticleArticleAn article, including news and scholarly articles.
schema:AudioObjectAudioObjectAn audio file
stencila:BooleanValidatorBooleanValidatorA schema specifying that a node must be a boolean value.
schema:BrandBrandA brand used by an organization or person for labeling a product,

product group, or similar.

stencila:CitationIntentEnumeration | CitationIntentEnumeration | The type or nature of a citation, both factually and rhetorically. stencila:Cite | Cite | A reference to a CreativeWork that is cited in another CreativeWork. stencila:CiteGroup | CiteGroup | A group of Cite nodes. schema:Claim | Claim | A claim represents specific reviewable facts or statements. stencila:Code | Code | Base type for non-executable (e.g. CodeBlock) and executable (e.g. CodeExpression) code nodes. stencila:CodeBlock | CodeBlock | A code block. stencila:CodeChunk | CodeChunk | A executable chunk of code. stencila:CodeError | CodeError | An error that occurred when parsing, compiling or executing a Code node. stencila:CodeExecutable | CodeExecutable | Base type for executable code nodes (i.e. CodeChunk and CodeExpression). stencila:CodeExpression | CodeExpression | An executable programming code expression. stencila:CodeFragment | CodeFragment | Inline code. schema:Collection | Collection | A collection of CreativeWorks or other artifacts. schema:Comment | Comment | A comment on an item, e.g on a Article, or SoftwareSourceCode. stencila:ConstantValidator | ConstantValidator | A validator specifying a constant value that a node must have. schema:ContactPoint | ContactPoint | A contact point, usually within an organization. schema:CreativeWork | CreativeWork | A creative work, including books, movies, photographs, software programs, etc.

stencila:Datatable | Datatable | A table of data. stencila:DatatableColumn | DatatableColumn | A column of data within a Datatable. schema:Date | Date | A date encoded as a ISO 8601 string. schema:DefinedTerm | DefinedTerm | A word, name, acronym, phrase, etc. with a formal definition. stencila:Delete | Delete | Content that is marked for deletion stencila:Emphasis | Emphasis | Emphasised content. stencila:EnumValidator | EnumValidator | A schema specifying that a node must be one of several values. schema:Enumeration | Enumeration | Lists or enumerations, for example, a list of cuisines or music genres, etc. stencila:Figure | Figure | Encapsulates one or more images, videos, tables, etc, and provides captions and labels for them. stencila:Function | Function | A function with a name, which might take Parameters and return a value of a certain type. schema:Grant | Grant | A grant, typically financial or otherwise quantifiable, of resources. stencila:Heading | Heading | A heading. schema:ImageObject | ImageObject | An image file. stencila:Include | Include | Include content from an external source (e.g. file, URL). stencila:IntegerValidator | IntegerValidator | A validator specifying the constraints on an integer node. stencila:Link | Link | A hyperlink to other pages, sections within the same document, resources, or any URL. schema:ItemList | List | A list of items. schema:ListItem | ListItem | A single item in a list. stencila:Mark | Mark | A base class for nodes that mark some other inline content in some way (e.g. as being emphasised, or quoted).

stencila:Math | Math | A mathematical variable or equation. stencila:MathBlock | MathBlock | A block of math, e.g an equation, to be treated as block content. stencila:MathFragment | MathFragment | A fragment of math, e.g a variable name, to be treated as inline content. schema:MediaObject | MediaObject | A media object, such as an image, video, or audio object embedded in a web page or a downloadable dataset.

schema:MonetaryGrant | MonetaryGrant | A monetary grant. stencila:NontextualAnnotation | NontextualAnnotation | Inline text that has a non-textual annotation. stencila:Note | Note | Additional content which is not part of the main content of a document. stencila:NumberValidator | NumberValidator | A validator specifying the constraints on a numeric node. schema:Organization | Organization | An organization such as a school, NGO, corporation, club, etc. stencila:Paragraph | Paragraph | Paragraph stencila:Parameter | Parameter | A parameter of a document or function. schema:Periodical | Periodical | A periodical publication. schema:Person | Person | A person (alive, dead, undead, or fictional). schema:PostalAddress | PostalAddress | A physical mailing address. schema:Product | Product | Any offered product or service. For example, a pair of shoes; a haircut; or an episode of a TV show streamed online.

schema:PropertyValue | PropertyValue | A property-value pair. schema:PublicationIssue | PublicationIssue | A part of a successively published publication such as a periodical or publication volume, often numbered.

schema:PublicationVolume | PublicationVolume | A part of a successively published publication such as a periodical or multi-volume work.

stencila:Quote | Quote | Inline, quoted content. stencila:QuoteBlock | QuoteBlock | A section quoted from somewhere else.

schema:Review | Review | A review of an item, e.g of an Article, or SoftwareSourceCode. schema:SoftwareApplication | SoftwareApplication | A software application.

stencila:SoftwareEnvironment | SoftwareEnvironment | A computational environment. stencila:SoftwareSession | SoftwareSession | Definition of a compute session, including its software and compute resource requirements and status.

schema:SoftwareSourceCode | SoftwareSourceCode | Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.

stencila:StringValidator | StringValidator | A schema specifying constraints on a string node. stencila:Strong | Strong | Strongly emphasised content. stencila:Subscript | Subscript | Subscripted content. stencila:Superscript | Superscript | Superscripted content. schema:Table | Table | A table. stencila:TableCell | TableCell | A cell within a Table.

stencila:TableRow | TableRow | A row within a Table. stencila:ThematicBreak | ThematicBreak | A thematic break, such as a scene change in a story, a transition to another topic, or a new document.

schema:Thing | Thing | The most generic type of item. stencila:TupleValidator | TupleValidator | A validator specifying constraints on an array of heterogeneous items. stencila:Validator | Validator | A base for all validator types. stencila:Variable | Variable | A variable representing a name / value pair. schema:VideoObject | VideoObject | A video file. stencila:VolumeMount | VolumeMount | Describes a volume mount from a host to container.

stencila:Null | Null | The null value schema:Boolean | Boolean | A value that is either true or false schema:Integer | Integer | A value that is a integer schema:Number | Number | A value that is a number schema:Text | String | A value comprised of a string of characters stencila:Object | Object | A value comprised of keyed values. stencila:Array | Array | A value comprised of several other values.

Available as

Source

This documentation was generated from Node.schema.yaml.