@stencila/schema/dist/Cite.schema.json

Stencila schema and other specifications

{
  "title": "Cite",
  "@id": "stencila:Cite",
  "extends": "Entity",
  "role": "secondary",
  "status": "unstable",
  "description": "A reference to a CreativeWork that is cited in another CreativeWork.\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "Cite"
      ],
      "default": "Cite",
      "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"
    },
    "citationMode": {
      "@id": "stencila:citationMode",
      "description": "How the cite is rendered in the surrounding text.",
      "type": "string",
      "enum": [
        "normal",
        "suppressAuthor"
      ],
      "from": "Cite"
    },
    "content": {
      "@id": "stencila:content",
      "description": "Optional structured content/text of this citation.",
      "type": "array",
      "items": {
        "$ref": "InlineContent.schema.json"
      },
      "from": "Cite"
    },
    "pageStart": {
      "@id": "schema:pageStart",
      "description": "The page on which the work starts; for example \"135\" or \"xiii\".",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        }
      ],
      "from": "Cite"
    },
    "pageEnd": {
      "@id": "schema:pageEnd",
      "description": "The page on which the work ends; for example \"138\" or \"xvi\".",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        }
      ],
      "from": "Cite"
    },
    "pagination": {
      "@id": "schema:pagination",
      "description": "Any description of pages that is not separated into pageStart and pageEnd;\nfor example, \"1-6, 9, 55\".\n",
      "type": "string",
      "from": "Cite"
    },
    "prefix": {
      "@id": "stencila:citationPrefix",
      "description": "A prefix to show before the citation.",
      "type": "string",
      "from": "Cite"
    },
    "suffix": {
      "@id": "stencila:citationSuffix",
      "description": "A suffix to show after the citation.",
      "type": "string",
      "from": "Cite"
    },
    "target": {
      "@id": "stencila:target",
      "description": "The target of the citation (URL or reference ID).",
      "type": "string",
      "from": "Cite"
    }
  },
  "required": [
    "type",
    "target"
  ],
  "file": "Cite.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v0/Cite.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/Cite.schema.yaml",
  "type": "object",
  "additionalProperties": false,
  "propertyAliases": {}
}