@stencila/schema/dist/Heading.schema.json

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

{
  "title": "Heading",
  "@id": "stencila:Heading",
  "extends": "Entity",
  "role": "secondary",
  "status": "stable",
  "category": "text",
  "description": "A heading.",
  "$comment": "Analogues of `Delete` in other schema include:\n  - HTML [`<h1>` to `<h6>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h1)\n  - JATS XML [`<title>`](https://jats.nlm.nih.gov/archiving/tag-library/1.1/element/title.html)\n  - Pandoc [`Header`](https://github.com/jgm/pandoc-types/blob/1.17.5.4/Text/Pandoc/Definition.hs#L233)\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "Heading"
      ],
      "default": "Heading",
      "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"
    },
    "depth": {
      "@id": "stencila:depth",
      "description": "The depth of the heading.",
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "maximum": 6,
      "from": "Heading"
    },
    "content": {
      "@id": "stencila:content",
      "description": "Content of the heading.",
      "type": "array",
      "items": {
        "$ref": "InlineContent.schema.json"
      },
      "from": "Heading",
      "isArray": true
    }
  },
  "required": [
    "type",
    "content"
  ],
  "examples": [
    {
      "type": "Heading",
      "depth": 2,
      "content": [
        "Secondary Heading"
      ]
    }
  ],
  "file": "Heading.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/Heading.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/Heading.schema.yaml",
  "type": "object",
  "additionalProperties": false,
  "propertyAliases": {}
}