@stencila/schema/dist/MathFragment.schema.json

Extensions to schema.org to support semantic, composable, parameterize-able and executable documents

{
  "title": "MathFragment",
  "@id": "stencila:MathFragment",
  "extends": "Math",
  "role": "secondary",
  "status": "stable",
  "category": "math",
  "description": "A fragment of math, e.g a variable name, to be treated as inline content.",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "MathFragment"
      ],
      "default": "MathFragment",
      "from": "Entity"
    },
    "id": {
      "@id": "schema:id",
      "description": "The identifier for this item.",
      "type": "string",
      "from": "Entity"
    },
    "meta": {
      "@id": "stencila:meta",
      "description": "Metadata associated with this item.",
      "type": "object",
      "from": "Entity"
    },
    "errors": {
      "@id": "stencila:errors",
      "description": "Errors that occurred when parsing the math equation.",
      "$comment": "This property is an array of strings. Compare this to `CodeChunk.errors`\nwhich is an array of `CodeError` nodes. Strings are considered to\nbe sufficient for math parsing errors which usually won't have stack traces,\nline numbers etc.\n",
      "type": "array",
      "items": {
        "type": "string"
      },
      "from": "Math",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "error"
      ]
    },
    "mathLanguage": {
      "@id": "stencila:mathLanguage",
      "description": "The language used for the equation e.g tex, mathml, asciimath.",
      "type": "string",
      "default": "tex",
      "from": "Math"
    },
    "text": {
      "@id": "schema:text",
      "description": "The text of the equation in the language.",
      "type": "string",
      "from": "Math"
    }
  },
  "file": "MathFragment.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/MathFragment.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/MathFragment.schema.yaml",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "text"
  ],
  "propertyAliases": {
    "error": "errors"
  }
}