Skip to content

GitLab

Commit 6c63a941 authored by mrodzis's avatar mrodzis 🌿
Browse files

Merge branch '11-annotation-types' into 'main' 

Resolve "Annotation types"

Closes #11

See merge request !10
parents 0b150c8f 172a2bba
Hide whitespace changes
Inline Side-by-side
content/page/annotation-api-specs.md
View file @ 6c63a941
......@@ -153,11 +153,22 @@ A sequence of annotations belonging to an Annotation Page.
| Field Name | Cardinality | Type | Description |
|----|----|----|----|
| bodyValue | 1 | string | the content of the annotation |
| target | 1 | \[[Target Object](#target-object)\] | information about the target of the annotation |
| body | 1 | \[[Body Object](#body-object)\] | the content of the annotation |
| target | 1 | [Target Object](#target-object) | information about the target of the annotation |
| type | 1 | string | MUST be `Annotation`|
| id | 1 | URI | a unique identifier for the annotation in the form of `http://ahikar.sub.uni-goettingen.de/ns/annotations/{$resource-URI}/{$node-ID}`. `{$node-ID}` refers to the ID of the TEI node from which the annotation has been extracted |
### Body Object
The content of the annotation.
| Field Name | Cardinality | Type | Description |
|----|----|----|----|
| type | 1 | string | MUST be `TextualBody` |
| value | 1 | string | the content of the annotation |
| format | 1 | MIME type | MUST be `text/plain` since we only provide a string as the annotation content |
| x-content-type | 1 | string | the semantic type of the annotation. MUST be one of the following: `Person`, `Place`, `Motif`. |
### Target Object
Provides information about the target node or text the annotation refers to.
......@@ -193,15 +204,18 @@ Provides information about the target node or text the annotation refers to.
// objects
[PartOf|-id 1; -label 1; -total 1]
[Annotation Item| -bodyValue 1; -@context 1; -target 1; -type 1; -id 1]
[Annotation Item| -body 1; -@context 1; -target 1; -type 1; -id 1]
[Target| -format 1; -language 1; -id 1]
[Body| -type 1; -value 1; -format 1; -x-content-type 1]
// imports
[Annotation Page]-[PartOf]
[Annotation Page]-[Annotation Item]
[Annotation Item]-[Target]
[Annotation Item]-[Body]
```
### Examples
......@@ -268,36 +282,34 @@ Provides information about the target node or text the annotation refers to.
```json
{
"annotationPage" : {
"items" : [ {
"bodyValue" : "A place's name.",
"target" : {
"format" : "text/xml",
"language" : "karshuni",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/N4.4.2.6.4.12.2"
},
"type" : "Annotation",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/annotation-N4.4.2.6.4.12.2"
}, {
"bodyValue" : "A person's name.",
"target" : {
"format" : "text/xml",
"language" : "karshuni",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/N4.4.2.6.4.8.2"
},
"type" : "Annotation",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/annotation-N4.4.2.6.4.8.2"
}],
"partOf" : {
"total" : 7460,
"label" : "Ahikar annotations for arabic-karshuni",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/annotationCollection/arabic-karshuni"
"annotationPage": {
"items": [
{
"body": {
"type": "TextualBody",
"value": "A person's name.",
"format": "text/plain",
"x-content-type": "Person"
},
"target": {
"format": "text/xml",
"language": "ara",
"id": "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/N4.4.2.6.4.12.2"
},
"type": "Annotation",
"id": "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/annotation-N4.4.2.6.4.12.2"
}
],
"partOf": {
"total": 7460,
"label": "Ahikar annotations for arabic-karshuni",
"id": "http://ahikar.sub.uni-goettingen.de/ns/annotations/annotationCollection/3r9ps"
},
"@context" : "http://www.w3.org/ns/anno.jsonld",
"startIndex" : 2075,
"prev" : null,
"next" : "https://ahikar-dev.sub.uni-goettingen.de/api/annotations/ahikar/arabic-karshuni/3r7p9/annotationPage.json",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/annotationPage/arabic-karshuni/3r7nv"
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/annotationPage/arabic-karshuni/3r7nt"
}
}
```
......@@ -308,30 +320,28 @@ Provides information about the target node or text the annotation refers to.
```json
{
"annotationPage" : {
"items" : [ {
"bodyValue" : "A place's name.",
"target" : {
"format" : "text/xml",
"language" : "karshuni",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/N4.4.2.6.4.18.2"
},
"type" : "Annotation",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/annotation-N4.4.2.6.4.18.2"
}, {
"bodyValue" : "A person's name.",
"target" : {
"format" : "text/xml",
"language" : "karshuni",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/N4.4.2.6.4.8.2"
},
"type" : "Annotation",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/annotation-N4.4.2.6.4.8.2"
}],
"partOf" : {
"total" : 395,
"label" : "Ahikar annotations for textgrid:3r7nv: Vat. Syriac 199",
"id" : "http://ahikar.sub.uni-goettingen.de/ns/annotations/annotationCollection/3r7nv"
"annotationPage": {
"items": [
{
"body": {
"type": "TextualBody",
"value": "A person's name.",
"format": "text/plain",
"x-content-type": "Person"
},
"target": {
"format": "text/xml",
"language": "ara",
"id": "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/N4.4.2.6.4.18.2"
},
"type": "Annotation",
"id": "http://ahikar.sub.uni-goettingen.de/ns/annotations/3r7nt/annotation-N4.4.2.6.4.18.2"
}
],
"partOf": {
"total": 395,
"label": "Ahikar annotations for textgrid:3r7nv: Vat. Syriac 199",
"id": "http://ahikar.sub.uni-goettingen.de/ns/annotations/annotationCollection/3r7nv"
},
"@context" : "http://www.w3.org/ns/anno.jsonld",
"startIndex" : 0,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment