OPF
SpecDefinition referenceView source

Reference

A source that runs cite with 'cite'. Cited references are listed in the footnote area of the slides that cite them, numbered per deck in order of first use; referencesSlide() builds an ordinary list slide of them.

Metadata

Definition
#/$defs/Reference
Form
object
Source
spec/schemas/opf.schema.json

Field index

FieldTypeReq.Description
idstringyesIdentifier runs cite. Unique within the references list.
textstring | array<ref:TextRun>yesThe reference as it is listed: a string or TextRun[] for inline rich text.
urlstring—Optional link for the reference; a references slide links its entry to it.

id

typestringrequiredyesdefault—

Identifier runs cite. Unique within the references list.

Field fragment · id.json
{
  "id": "gartner-2026"
}

text

typestring | array<ref:TextRun>requiredyesdefault—

The reference as it is listed: a string or TextRun[] for inline rich text.

url

typestringrequirednodefault—

Optional link for the reference; a references slide links its entry to it.

Field fragment · url.json
{
  "url": "https://acme.com/reports/2026"
}
Complete definition constraints
Exact schema constraints
{
  "type": "object",
  "description": "A source that runs cite with 'cite'. Cited references are listed in the footnote area of the slides that cite them, numbered per deck in order of first use; referencesSlide() builds an ordinary list slide of them.",
  "additionalProperties": false,
  "required": [
    "id",
    "text"
  ],
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Identifier runs cite. Unique within the references list.",
      "examples": [
        "gartner-2026",
        "annual-report"
      ]
    },
    "text": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TextRun"
          }
        }
      ],
      "description": "The reference as it is listed: a string or TextRun[] for inline rich text."
    },
    "url": {
      "type": "string",
      "description": "Optional link for the reference; a references slide links its entry to it.",
      "examples": [
        "https://acme.com/reports/2026"
      ]
    }
  }
}