@stencila/schema/dist/CiteGroup.schema.json

{
  "title": "CiteGroup",
  "@id": "stencila:CiteGroup",
  "extends": "Entity",
  "category": "text",
  "role": "secondary",
  "status": "unstable",
  "description": "A group of Cite nodes.",
  "$comment": "This type allows you to group associated citations together.\nWhen some content in a [`Creative Work`](./CreativeWork) cites more than one\nreference for a particular piece of text, use a `CiteGroup` to encapsulate\nmultiple [`Cite`](./Cite) nodes.\n\nAt present we do not give a `citationMode` property to a `CiteGroup` since\nthey will almost always be parenthetical as opposed to narrative.\nIn other words, it usually only makes sense for individual `Cite` nodes to be\nnarrative (although they may be connected together within `content` using words\nsuch as \"and\").\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "CiteGroup"
      ],
      "default": "CiteGroup",
      "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"
    },
    "items": {
      "@id": "schema:itemListElement",
      "type": "array",
      "description": "One or more `Cite`s to be referenced in the same surrounding text.",
      "items": {
        "$ref": "Cite.schema.json"
      },
      "from": "CiteGroup",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "item"
      ]
    }
  },
  "required": [
    "type",
    "items"
  ],
  "examples": [
    {
      "type": "Article",
      "title": "An example of using the CiteGroup node type",
      "authors": [
        {
          "type": "Person",
          "givenNames": [
            "Joe"
          ],
          "familyNames": [
            "Bloggs"
          ]
        }
      ],
      "content": [
        {
          "type": "Paragraph",
          "content": [
            "Citing two articles ",
            {
              "type": "CiteGroup",
              "items": [
                {
                  "type": "Cite",
                  "target": "some-one-else-1991"
                },
                {
                  "type": "Cite",
                  "target": "updated-works-2009"
                }
              ]
            },
            "."
          ]
        }
      ],
      "references": [
        {
          "type": "Article",
          "id": "some-one-else-1991",
          "title": "Another article by someone else",
          "authors": [
            {
              "type": "Person",
              "givenNames": [
                "Some",
                "One"
              ],
              "familyNames": [
                "Else"
              ]
            }
          ],
          "datePublished": "1991"
        },
        {
          "type": "Article",
          "id": "update-works-2009",
          "title": "A Better Updated Work",
          "authors": [
            {
              "type": "Person",
              "givenNames": [
                "Some",
                "Better"
              ],
              "familyNames": [
                "Person"
              ]
            }
          ],
          "datePublished": "2009"
        }
      ]
    }
  ],
  "file": "CiteGroup.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/CiteGroup.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/CiteGroup.schema.yaml",
  "type": "object",
  "propertyAliases": {
    "item": "items"
  },
  "additionalProperties": false
}