ChronicleSchema
Used on
Quotation and their subclasses
Expected type
Text
Values
At most one value
Required
No

Examples

Highlighting a passage in a PDF

A QuoteAction for a highlight made in Zotero's PDF reader.

{
  "@type": "QuoteAction",
  "@key": ["@type", "source", "result.sourceId", "result.inRealm.handle"],
  "source": "zotero",
  "timestamp": "2025-01-11T09:00:00.000Z",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "sourceId"],
    "source": "zotero",
    "sourceId": "LuK3xAmp",
    "sameAs": ["@me"]
  },
  "result": {
    "@type": "Quotation",
    "@key": ["@type", "source", "sourceId", "inRealm.handle"],
    "source": "zotero",
    "sourceId": "ANNOPDF1",
    "inRealm": {
      "@type": "Realm",
      "@key": ["@type", "source", "handle"],
      "source": "zotero",
      "handle": "7654321"
    },
    "body": "Erosion doubles on wet days.",
    "color": "#ffd400",
    "annotationStyle": "highlight",
    "isPartOf": [
      {
        "@type": "DocumentObject",
        "@key": ["source", "sourceId", "inRealm.handle"],
        "source": "zotero",
        "sourceId": "ATTPDF01",
        "inRealm": {
          "@type": "Realm",
          "@key": ["@type", "source", "handle"],
          "source": "zotero",
          "handle": "7654321"
        },
        "sameAs": [
          {
            "@type": "Article",
            "@key": ["source", "sourceId", "inRealm.handle"],
            "source": "zotero",
            "sourceId": "WORKAAAA",
            "inRealm": {
              "@type": "Realm",
              "@key": ["@type", "source", "handle"],
              "source": "zotero",
              "handle": "7654321"
            },
            "name": "Trail Erosion in Alpine Meadows"
          }
        ]
      }
    ],
    "selector": [
      {
        "@type": "PageSelector",
        "@key": ["@type", "selectorValue"],
        "selectorValue": "12",
        "selectorLabel": "12"
      }
    ]
  }
}

Underlining a passage in an EPUB

A QuoteAction for an underline in an EPUB.

{
  "@type": "QuoteAction",
  "@key": ["@type", "source", "result.sourceId", "result.inRealm.handle"],
  "source": "zotero",
  "timestamp": "2025-01-22T07:30:00.000Z",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "sourceId"],
    "source": "zotero",
    "sourceId": "LuK3xAmp",
    "sameAs": ["@me"]
  },
  "result": {
    "@type": "Quotation",
    "@key": ["@type", "source", "sourceId", "inRealm.handle"],
    "source": "zotero",
    "sourceId": "ANNOEPUB",
    "inRealm": {
      "@type": "Realm",
      "@key": ["@type", "source", "handle"],
      "source": "zotero",
      "handle": "7654321"
    },
    "body": "Carry more water than you think.",
    "annotationStyle": "underline",
    "isPartOf": [
      {
        "@type": "DocumentObject",
        "@key": ["source", "sourceId", "inRealm.handle"],
        "source": "zotero",
        "sourceId": "ORPHAN01",
        "inRealm": {
          "@type": "Realm",
          "@key": ["@type", "source", "handle"],
          "source": "zotero",
          "handle": "7654321"
        },
        "name": "field-guide.epub"
      }
    ],
    "selector": [
      {
        "@type": "EpubCfiSelector",
        "@key": ["@type", "selectorValue"],
        "selectorValue": "epubcfi(/6/4!/4/2/1:0)"
      }
    ]
  }
}

URI https://schema.chronicle.app/annotationStyle · Suggest a change

Esc

↑↓ to move↵ to open/ or ⌘K to search