alexmandClaude
7890fa1ad7
A trace follows one citation of a sentence of a citing paper to a passage of the cited paper (spec/18 section 18.5). Minor change: a new body kind, optional properties and two rules, with no valid file made invalid. - annotation schema branch (source, selector, reference, note, verdict, proposer; proposer required for a Software creator); body_kind in sql/store.sql; the note and proposer terms of the JSON-LD context; rules layer.trace.source and layer.trace.target. - paperspec.traces: resolve(annotation, citing_state, cited_state, same_as) gives current, changed, stale, unlinked or misresolved with open and cites; problems, disputes, disputed. - fixtures/records/traces/ on writer2027fixed-ynr7.v3 and vectors/traces.jsonl (29 cases); check.py runs the record checks over both layers; counts, glossary, examples and CHANGELOG updated. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Uy4ZYbWRoCdUtWLEfigysY
927 lines
24 KiB
JSON
927 lines
24 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://paperspec.scient.ing/schemas/annotation.schema.json",
|
|
"title": "Annotation",
|
|
"description": "One line of annotations.jsonl in scienting-layer/1: a W3C Web Annotation; spec/18-layers.md.",
|
|
"$defs": {
|
|
"category": {
|
|
"description": "What a comment, caveat or question is about (spec/18 §18.4).",
|
|
"enum": [
|
|
"comment",
|
|
"context",
|
|
"critique",
|
|
"question",
|
|
"correction",
|
|
"feedback",
|
|
"resource"
|
|
]
|
|
},
|
|
"selector": {
|
|
"description": "A selector of a passage: the AnchorSelector, or the standard TextQuoteSelector that repeats the anchor's plain quote for tools that do not know ours (spec/18 §18.3).",
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "AnchorSelector"
|
|
},
|
|
"anchor": {
|
|
"$ref": "anchor.schema.json"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"anchor"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextQuoteSelector"
|
|
},
|
|
"exact": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"prefix": {
|
|
"type": "string"
|
|
},
|
|
"suffix": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"exact"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"properties": {
|
|
"@context": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"minItems": 2
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:annotation:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
|
|
},
|
|
"type": {
|
|
"const": "Annotation"
|
|
},
|
|
"layer": {
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:layer:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
|
|
},
|
|
"motivation": {
|
|
"enum": [
|
|
"commenting",
|
|
"describing",
|
|
"linking",
|
|
"questioning",
|
|
"assessing",
|
|
"tagging",
|
|
"classifying",
|
|
"identifying",
|
|
"editing",
|
|
"highlighting",
|
|
"bookmarking",
|
|
"replying",
|
|
"moderating"
|
|
]
|
|
},
|
|
"creator": {
|
|
"$ref": "common.schema.json#/$defs/agent"
|
|
},
|
|
"created": {
|
|
"$ref": "common.schema.json#/$defs/time"
|
|
},
|
|
"modified": {
|
|
"$ref": "common.schema.json#/$defs/time"
|
|
},
|
|
"body": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "gloss"
|
|
},
|
|
"audience": {
|
|
"enum": [
|
|
"novice",
|
|
"student",
|
|
"expert"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value",
|
|
"audience"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"$ref": "common.schema.json#/$defs/claimRef"
|
|
},
|
|
"kind": {
|
|
"const": "claim-link"
|
|
},
|
|
"pin": {
|
|
"$ref": "common.schema.json#/$defs/claimPin"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"states",
|
|
"uses",
|
|
"disputes"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"source",
|
|
"role"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"$ref": "common.schema.json#/$defs/claimRef"
|
|
},
|
|
"kind": {
|
|
"const": "symbol"
|
|
},
|
|
"pin": {
|
|
"$ref": "common.schema.json#/$defs/claimPin"
|
|
},
|
|
"key": {
|
|
"description": "The symbol's scienting-math/1 key, which the symbol claim's notation has too (spec/09 §9.4, spec/18 §18.4).",
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"symbol": {
|
|
"description": "The symbol as the span writes it.",
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"source",
|
|
"key"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "comment"
|
|
},
|
|
"category": {
|
|
"$ref": "#/$defs/category"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "caveat"
|
|
},
|
|
"category": {
|
|
"$ref": "#/$defs/category"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "question"
|
|
},
|
|
"for": {
|
|
"enum": [
|
|
"reader",
|
|
"group",
|
|
"authors"
|
|
]
|
|
},
|
|
"category": {
|
|
"$ref": "#/$defs/category"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "exercise"
|
|
},
|
|
"exercise": {
|
|
"$ref": "exercise.schema.json"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value",
|
|
"exercise"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "citation-context"
|
|
},
|
|
"reference": {
|
|
"$ref": "common.schema.json#/$defs/nodeId"
|
|
},
|
|
"verdict": {
|
|
"enum": [
|
|
"supports",
|
|
"partly",
|
|
"does-not",
|
|
"cannot-tell"
|
|
]
|
|
},
|
|
"reason": {
|
|
"enum": [
|
|
"method",
|
|
"value",
|
|
"background",
|
|
"contrast",
|
|
"other"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value",
|
|
"reference"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"kind": {
|
|
"const": "prerequisite"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"source"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"kind": {
|
|
"const": "crosslink"
|
|
},
|
|
"selector": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "AnchorSelector"
|
|
},
|
|
"anchor": {
|
|
"$ref": "anchor.schema.json"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"anchor"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"minItems": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"source",
|
|
"selector"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"kind": {
|
|
"const": "trace"
|
|
},
|
|
"source": {
|
|
"description": "The cited document, as a target's source names a document.",
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:doc:[a-z0-9][a-z0-9._-]*/[a-z][a-z0-9]*-[0-9a-hjkmnp-tv-z]{4,51}(\\.[a-z0-9][a-z0-9-]*)*$"
|
|
},
|
|
"selector": {
|
|
"description": "The passage of the cited document: an AnchorSelector, then a TextQuoteSelector when the anchor's quote is plain.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/selector"
|
|
},
|
|
"minItems": 1
|
|
},
|
|
"reference": {
|
|
"description": "The reference node of the citing document that the target's sentence cites and the trace is about.",
|
|
"$ref": "common.schema.json#/$defs/nodeId"
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"verdict": {
|
|
"enum": [
|
|
"supports",
|
|
"partly",
|
|
"does-not",
|
|
"cannot-tell"
|
|
]
|
|
},
|
|
"proposer": {
|
|
"description": "The tool that proposed the trace, required when the annotation's creator is Software (spec/18 §18.4).",
|
|
"type": "object",
|
|
"properties": {
|
|
"model": {
|
|
"$ref": "common.schema.json#/$defs/model"
|
|
},
|
|
"run": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"score": {
|
|
"$ref": "common.schema.json#/$defs/decimal"
|
|
},
|
|
"rank": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"model",
|
|
"run"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"source",
|
|
"selector",
|
|
"reference"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "translation"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value",
|
|
"language"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "description"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"alt",
|
|
"long"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value",
|
|
"role"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextualBody"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"format": {
|
|
"enum": [
|
|
"text/plain",
|
|
"text/markdown"
|
|
]
|
|
},
|
|
"language": {
|
|
"$ref": "common.schema.json#/$defs/language"
|
|
},
|
|
"kind": {
|
|
"const": "generated"
|
|
},
|
|
"generator": {
|
|
"type": "object",
|
|
"properties": {
|
|
"model": {
|
|
"$ref": "common.schema.json#/$defs/model"
|
|
},
|
|
"run": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"model",
|
|
"run"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"kind",
|
|
"value",
|
|
"generator"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
]
|
|
},
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:doc:[a-z0-9][a-z0-9._-]*/[a-z][a-z0-9]*-[0-9a-hjkmnp-tv-z]{4,51}(\\.[a-z0-9][a-z0-9-]*)*$"
|
|
},
|
|
"selector": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "AnchorSelector"
|
|
},
|
|
"anchor": {
|
|
"$ref": "anchor.schema.json"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"anchor"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextQuoteSelector"
|
|
},
|
|
"exact": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"prefix": {
|
|
"type": "string"
|
|
},
|
|
"suffix": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"exact"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
]
|
|
},
|
|
"minItems": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"source",
|
|
"selector"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:annotation:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"source"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:doc:[a-z0-9][a-z0-9._-]*/[a-z][a-z0-9]*-[0-9a-hjkmnp-tv-z]{4,51}(\\.[a-z0-9][a-z0-9-]*)*$"
|
|
},
|
|
"selector": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "AnchorSelector"
|
|
},
|
|
"anchor": {
|
|
"$ref": "anchor.schema.json"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"anchor"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "TextQuoteSelector"
|
|
},
|
|
"exact": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"prefix": {
|
|
"type": "string"
|
|
},
|
|
"suffix": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"exact"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
]
|
|
},
|
|
"minItems": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"source",
|
|
"selector"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"const": "SpecificResource"
|
|
},
|
|
"source": {
|
|
"type": "string",
|
|
"pattern": "^tag:scient\\.ing,2026:annotation:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"source"
|
|
],
|
|
"additionalProperties": false
|
|
}
|
|
]
|
|
},
|
|
"minItems": 1
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"proposed",
|
|
"confirmed",
|
|
"rejected",
|
|
"withdrawn"
|
|
]
|
|
},
|
|
"receipt": {
|
|
"$ref": "common.schema.json#/$defs/recordId"
|
|
},
|
|
"rights_use": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"@context",
|
|
"id",
|
|
"type",
|
|
"layer",
|
|
"motivation",
|
|
"creator",
|
|
"created",
|
|
"body",
|
|
"target",
|
|
"status"
|
|
],
|
|
"additionalProperties": false,
|
|
"allOf": [
|
|
{
|
|
"if": {
|
|
"properties": {
|
|
"status": {
|
|
"const": "confirmed"
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"required": [
|
|
"receipt"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "A tool's trace names the tool and the run that proposed it (spec/18 §18.4).",
|
|
"if": {
|
|
"properties": {
|
|
"creator": {
|
|
"properties": {
|
|
"type": {
|
|
"const": "Software"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
"body": {
|
|
"properties": {
|
|
"kind": {
|
|
"const": "trace"
|
|
}
|
|
},
|
|
"required": [
|
|
"kind"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"creator",
|
|
"body"
|
|
]
|
|
},
|
|
"then": {
|
|
"properties": {
|
|
"body": {
|
|
"required": [
|
|
"proposer"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|