Skip to content

Feature/#28 tei to annotations

Michelle Weidling requested to merge feature/#28-tei-to-annotations into develop

Feature

Summary

This MR provides a first draft for the AnnotationAPI. An overview of its architecture is given in the README.

Instead of completely rewriting the TEI XSLTs in XQuery, we decided to simply enhance the XSLTs for now in such a way that they keep the original TEI node IDs. This won't be our final solution, but enables the front end developers to work under "real" conditions while we refactor the transformation.

Does the result of the MR comply to our "definition of done"?

  • Unit tests passed
  • Code reviewed
  • Acceptance criteria met
  • Functional tests passed
  • Non-Functional requirements met
  • Product Owner accepts the User Story

Use Cases

For providing annotations like person/place names or other encoding (motifs) that should be parsed by the viewer.

Documentation

Shall we add your feature to the documentation?

  • I've already did it!
  • At least I added a headline to the documentation.

Function Documentation

  • Of course I provided all my functions with an appropriate documentation.

Are there parts of the documentation we have to adjust

  • No.
  • Yes, but I'd like someone else to do it.
  • Yes, and I already did!

Tests

Are we able to test this new feature?

  • Yes, everything can be done via unit tests.
  • Yes, you can test by following these steps: …
  • No, it is not possible.

Changelog

  • I added a statement to the CHANGELOG.

Version number

  • I bumped the version number in build.properties.

Related Tickets

Closes

#28 (closed)

Logs and Screenshots

/cc Mathias Göbel, Frank Schneider, Michelle Weidling

Edited by Michelle Weidling

Merge request reports