Stencila Schema

• Documentation
• Language Specific Packages
• JSON Schema definitions
• JSON-LD context
• Typescript type definitions

This repository aims to document, and provide reference implementations for, the schemas, protocols and other specifications used in Stencila.

As much as possible, we use existing specifications, and avoid defining any new ones. External specifications that we currently use, or plan to use, include Apache Avro, JSON-LD, JSON-RPC, JSON-Schema, Schema.org, BioSchemas, CodeMeta and OpenSchemas. In many ways, this repository simply documents how these existing standards are utilised within Stencila.

Documentation

Documentation is available at https://schema.stenci.la/.

Language Specific Packages

Stencila Schema supports Python, R, and TypeScript with their respective packages. Depending on the language capabilities, these packages expose type definitions as well as utility functions for constructing valid Stencila Schema nodes. Each packages has its own documentation auto-generated, and they can be found at:

• Python
• R
• Typescript

JSON Schema definitions

JSON Schemas are defined in the schema directory.

JSON-LD context

A JSON-LD @context is generated from the JSON Schema sources is available at https://schema.stenci.la/stencila.jsonld.

Typescript type definitions

Typescript type definitions are generated from the JSON Schema sources and can be used by installing the Node.js package:

npm install @stencila/schema --save

Available types

Schemas marked with “^U” are considered unstable and have a higher likelihood of changes.

• Prose
  • Delete
  • Emphasis
  • Heading
  • List Item
  • Mark
  • Paragraph
  • Quote
  • Quote Block
  • Strong
  • Subscript
  • Superscript
  • Thematic Break
  • Figure^U
  • Link^U
  • List^U
  • Math^U
  • Math Block^U
  • Math Fragment^U
  • Table^U
  • Table Cell^U
  • Table Row^U
  • Block Content
  • Inline Content
• Code
  • Code
  • Code Block
  • Code Expression
  • Code Fragment
  • Code Chunk^U
  • Code Error^U
  • Function^U
  • Parameter^U
  • Software Application^U
  • Software Environment^U
  • Software Session^U
  • Software Source Code^U
  • Variable^U
  • Volume Mount^U
• Data
  • Audio Object
  • Image Object
  • Media Object
  • Video Object
  • Array Validator^U
  • Boolean Validator^U
  • Constant Validator^U
  • Datatable^U
  • Datatable Column^U
  • Enum Validator^U
  • Integer Validator^U
  • Number Validator^U
  • String Validator^U
  • Tuple Validator^U
• Validation
  • Validator Types
• Metadata
  • Collection
  • Creative Work
  • Date
  • Entity
  • Person
  • Postal Address
  • Product
  • Property Value
  • Thing
  • Article^U
  • Brand^U
  • Contact Point^U
  • Grant^U
  • Include^U
  • Monetary Grant^U
  • Organization^U
  • Periodical^U
  • Publication Issue^U
  • Publication Volume^U
  • Node
• Miscellaneous
  • Cite^U
  • Cite Group^U
  • Array
  • Boolean
  • Code Block Types
  • Code Fragment Types
  • Code Types
  • Contact Point Types
  • Creative Work Types
  • Entity Types
  • Grant Types
  • Mark Types
  • Math Types
  • Media Object Types
  • Null
  • Number
  • Number Validator Types
  • Object
  • Text
  • Thing Types
  • Variable Types