pub.chive.site.citationLink

lexicons.governance.chive.pub

Documentation

A typed citation from the containing document to another work.

main object

A typed citation from the containing document to another work.

Properties

context string Optional

Where in the document the citation occurs, or a short quotation of the citing sentence.

maxLength: 2000 bytes
relation string Required

How the document relates to the cited work. Open by design: `knownValues` names the relations Chive emits, and a consumer meeting an unfamiliar one should treat it as a plain citation rather than discard the link.

maxLength: 128 bytes
Known values: cites, extends, disputes, replicates, usesDataFrom, usesMethodIn, reviews
target ref #target Required

The work being cited.

View raw schema
{
  "description": "A typed citation from the containing document to another work.",
  "properties": {
    "context": {
      "description": "Where in the document the citation occurs, or a short quotation of the citing sentence.",
      "maxLength": 2000,
      "type": "string"
    },
    "relation": {
      "description": "How the document relates to the cited work. Open by design: `knownValues` names the relations Chive emits, and a consumer meeting an unfamiliar one should treat it as a plain citation rather than discard the link.",
      "knownValues": [
        "cites",
        "extends",
        "disputes",
        "replicates",
        "usesDataFrom",
        "usesMethodIn",
        "reviews"
      ],
      "maxLength": 128,
      "type": "string"
    },
    "target": {
      "description": "The work being cited.",
      "ref": "#target",
      "type": "ref"
    }
  },
  "required": [
    "relation",
    "target"
  ],
  "type": "object"
}
target object

Identification of a cited work. At least one identifier should be present; `title` alone identifies a work no machine can resolve, which is why it is not sufficient on its own.

Properties

authors array of string Optional

No description available.

maxLength: 50 items
doi string Optional

DOI, without a resolver prefix.

maxLength: 200 bytes
title string Required

No description available.

maxLength: 1000 bytes
uri string at-uri Optional

AT-URI of the cited work, when it lives on the network.

url string uri Optional

A valid URI.

maxLength: 1000 bytes
venue string Optional

No description available.

maxLength: 500 bytes
year integer Optional

No description available.

minimum: 1000maximum: 3000
View raw schema
{
  "description": "Identification of a cited work. At least one identifier should be present; `title` alone identifies a work no machine can resolve, which is why it is not sufficient on its own.",
  "properties": {
    "authors": {
      "items": {
        "maxLength": 200,
        "type": "string"
      },
      "maxLength": 50,
      "type": "array"
    },
    "doi": {
      "description": "DOI, without a resolver prefix.",
      "maxLength": 200,
      "type": "string"
    },
    "title": {
      "maxLength": 1000,
      "type": "string"
    },
    "uri": {
      "description": "AT-URI of the cited work, when it lives on the network.",
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "format": "uri",
      "maxLength": 1000,
      "type": "string"
    },
    "venue": {
      "maxLength": 500,
      "type": "string"
    },
    "year": {
      "maximum": 3000,
      "minimum": 1000,
      "type": "integer"
    }
  },
  "required": [
    "title"
  ],
  "type": "object"
}

Lexicon Garden

@