Files
paperspec/schemas/annotation.schema.json
T
alexmandClaude 76d76353d9 feat: rename to paperspec and add the website
- Rename manuspec to paperspec everywhere outside pixi.toml: prose, the
  tools, provenance tool names and the fixture key derivations, so every
  fixture and vector is rebuilt.
- Move the namespace addresses under the site, mirroring the repository:
  schema $id https://paperspec.scient.ing/schemas/<file>, the JSON-LD
  context https://paperspec.scient.ing/context/scienting-1.jsonld, and
  term IRIs https://paperspec.scient.ing/vocab#<term>. Format
  identifiers (scienting-*) and URNs (urn:scienting:) are unchanged.
- tools/site.py (standard library only) builds _site/: every file of the
  repository at its own path, each Markdown file rendered as a page with
  sidebar navigation, heading anchors matching the forge's, folder
  listings, a vocabulary page for the context's IRIs, a heading search
  and a 404 page; light and dark themes.
- check.py builds the site and checks that every Markdown file has a
  page, every internal link and fragment resolves, no Markdown is left
  unrendered, and every $id, the context address and the vocabulary IRIs
  are files of the site.
- deploy/: a Caddyfile with the media types and CORS the data needs, and
  a guide; .gitea/workflows/site.yml builds on main and publishes with
  rsync when the SITE_* secrets are set.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 21:27:21 -04:00

745 lines
19 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.",
"type": "object",
"properties": {
"@context": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 2
},
"id": {
"type": "string",
"pattern": "^urn:scienting: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": "^urn:scienting: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": {
"type": "string",
"minLength": 1
},
"kind": {
"const": "claim-link"
},
"pin": {
"type": "string",
"minLength": 1
},
"role": {
"enum": [
"states",
"uses",
"disputes"
]
}
},
"required": [
"type",
"kind",
"source",
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"minLength": 1
},
"kind": {
"const": "symbol"
},
"pin": {
"type": "string",
"minLength": 1
},
"symbol": {
"type": "string",
"minLength": 1
}
},
"required": [
"type",
"kind",
"source"
],
"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"
}
},
"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"
}
},
"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"
]
}
},
"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": "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": {
"type": "string",
"minLength": 1
},
"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": "^urn:scienting:doc:[a-z0-9][a-z0-9._-]*/[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": "^urn:scienting: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": "^urn:scienting:doc:[a-z0-9][a-z0-9._-]*/[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": "^urn:scienting: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"
]
}
}
]
}