@stencila/schema/dist/Note.schema.json

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

{
  "title": "Note",
  "@id": "stencila:Note",
  "extends": "Entity",
  "category": "text",
  "role": "secondary",
  "status": "unstable",
  "description": "Additional content which is not part of the main content of a document.",
  "$comment": "A note is usually associated with a word or paragraph using a number or other symbol. \nIt can be displayed as a footnote, endnote, or side note, or in interactive elements.\nFor analogues, see \n- [JATS `<fn>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/fn.html)\n- [Pandoc footnotes](https://pandoc.org/MANUAL.html#footnotes)\n- [HTML `<aside>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside)\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "Note"
      ],
      "default": "Note",
      "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"
    },
    "noteType": {
      "@id": "stencila:noteType",
      "description": "Determines where the note content is displayed within the document.",
      "type": "string",
      "enum": [
        "Footnote",
        "Endnote",
        "Sidenote"
      ],
      "from": "Note"
    },
    "content": {
      "@id": "stencila:content",
      "description": "Content of the note, usually a paragraph.",
      "type": "array",
      "items": {
        "$ref": "BlockContent.schema.json"
      },
      "$comment": "Most notes will have a single paragraph but could have multiple\nparagraphs, tables and even figures.\n",
      "from": "Note",
      "isArray": true
    }
  },
  "required": [
    "type",
    "content"
  ],
  "file": "Note.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/Note.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/Note.schema.yaml",
  "type": "object",
  "additionalProperties": false,
  "propertyAliases": {}
}