AnnotationAPI

Migration Guide to TextAPI 2.0.0 Annotations

Changes Properties

On the Annotation Page:

body.annotationType: An application-specific type (e.g. "Variant"). This value is arbitrary and can be customised by the user. Used for all annotations.
body.source.collection: The IRI of a TextAPI Collection Object. Used for the cross referencing and synopsis feature.
body.source.manifest: The IRI of a TextAPI Manifest Object. Used for the cross referencing and synopsis feature.
body.source.item: The IRI of a TextAPI Item Object. Used for the cross referencing and synopsis feature.
body-witnesses: A list of witness identifiers (e.g. manuscript sigla). Used for the variants feature.

On the Annotation Collection:

refs: A list of references (e.g. witnesses, manuscripts). Used for the variants feature.
refs.idno: A machine-readable identifier. Used for the variants feature.
refs.idnoAlt: An alternative identifier. Used for the variants feature.
refs.title: A human-readable title. Used for the variants feature.

AnnotationAPI

On the Annotation Page:

body.annotationType: An application-specific type (e.g. "Variant"). This value is arbitrary and can be customised by the user. Used for all annotations.
body.source.collection: The IRI of a TextAPI Collection Object. Used for the cross referencing and synopsis feature.
body.source.manifest: The IRI of a TextAPI Manifest Object. Used for the cross referencing and synopsis feature.
body.source.item: The IRI of a TextAPI Item Object. Used for the cross referencing and synopsis feature.
body-witnesses: A list of witness identifiers (e.g. manuscript sigla). Used for the variants feature.

On the Annotation Collection:

refs: A list of references (e.g. witnesses, manuscripts). Used for the variants feature.
refs.idno: A machine-readable identifier. Used for the variants feature.
refs.idnoAlt: An alternative identifier. Used for the variants feature.
refs.title: A human-readable title. Used for the variants feature.