# pub.chive.site.citationLink

> Published by [lexicons.governance.chive.pub](https://lexicon.garden/identity/did:plc:egjghlwgts2hlcer2txilxeh)

✓ This is the authoritative definition for this NSID.

## Description

A typed link from a standard.site document to a work it cites. Written into the reserved `links` union of `site.standard.document`, which the standard.site lexicon leaves open for extensions like this one. The relation vocabulary follows CiTO (the Citation Typing Ontology), so a consumer that knows CiTO can read these without knowing anything about Chive.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.site.citationLink)
- [Documentation](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.site.citationLink/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.site.citationLink/examples)

## Definitions

### `pub.chive.site.citationLink`

**Type**: `object`

A typed citation from the containing document to another work.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `context` | `string` | No | Where in the document the citation occurs, or a short quotation of the citing sentence. |
| `relation` | `string` | Yes | 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. |
| `target` | `ref` → `#target` | Yes | The work being cited. |

### `pub.chive.site.citationLink#target`

**Type**: `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.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `authors` | `array` | No |  |
| `doi` | `string` | No | DOI, without a resolver prefix. |
| `title` | `string` | Yes |  |
| `uri` | `string` (at-uri) | No | AT-URI of the cited work, when it lives on the network. |
| `url` | `string` (uri) | No |  |
| `venue` | `string` | No |  |
| `year` | `integer` | No |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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": {
      "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"
    }
  },
  "description": "A typed link from a standard.site document to a work it cites. Written into the reserved `links` union of `site.standard.document`, which the standard.site lexicon leaves open for extensions like this one. The relation vocabulary follows CiTO (the Citation Typing Ontology), so a consumer that knows CiTO can read these without knowing anything about Chive.",
  "id": "pub.chive.site.citationLink",
  "lexicon": 1,
  "revision": 1
}
```