OpenAtlas

h1. Text annotation

Issue #2079

Text annotation will be about linking entities (actors, places, ...) to specific parts of a text, instead of just linking them to the whole text like it is possible currently.

h2. Scope (for the first version)

* It would be used at *Source* (E33) and their translations 

* Only already linked entities are offered

* Only one entity can be linked per annotation

* No overlapping annotations

* An annotation needs at least a linked entity or a text 

h2. User interface

We need a tool for users to annotate. Although difficult, ideally text changes and annotations can be done in one form element. 

*Advantages*

* Easy to use

* It's not possible for users to "break" things

* Concurrent changes can be avoided with already implemented functionality

* Maybe take a look at APIS implementation: https://github.com/acdh-oeaw/apis-highlighter-ng

*Meeting 2024-09-12* (Alex, Bernhard, Christoph, Olivia)

We will try to go for the all in one UI element approach. It would be implemented using markup which the backend would provide to fill the element and process it again after submitting.

h2. Information storing

We will save the information in an extra database table **model.annotation_text**, similar to web.annotation_image. Fields:

* *id* (int, required) generic internal database identifier 

* *source_id* (int, required)

* *entity_id* - (int, required) the entity is linked in the annotation, e.g. actor, place, artifact, ... 

* *link_start* (int, required)

* *link_end* - (int, required) or maybe the length?

* *text* - (text, not required) a kind of description field for text information, maybe think about the name, e.g. annotation, description, text, ... 

* *created* - timestamp of creation (set automatically at creation)

* *modified* - timestamp of modification (triggered automatically on change)

*Advantages*

* We can guarantee that there are no orphaned links

* It can than be used to e.g. be presented as HTML, TEI, "Web Annotation Data Model":https://www.w3.org/TR/annotation-model/, ...

We will also need to log changes, e.g. to be able to display the creator of an annotation. Most likely this will be an additional table in the web schema but has still to be specified. 

h2. Time frame

Ideally we have a working basic version at the end of 2024 and can refine it in 2025.

h2. Ideas for future versions

* Offer links to external reference systems (e.g. GeoNames) which we would use to create new entities on the fly (using available meta information, creating links to reference system, ...). Interesting but a lot of work.

* A tool to find possible annotation candidates providing a result list to annotate multiple occurrences in one go