Ftr/dynamic annotation classification

[bwbohl]

Description, Context and related Issue

Add support for dynamic mei:taxonomy usage in mei annot

Refs #57

How Has This Been Tested?

• Klarinettenquintett dataset
• BAZ-GA dataset

Types of changes

• New feature (non-breaking change which adds functionality)
• Documentation Update
• Improvement
• Refactoring

Overview

• I have updated the inline documentation accordingly.
• I have performed a self-review of my code, according to the style guide
• I have read the CONTRIBUTING document.

[bwbohl]

Please be aware that this has to be tested in combination with: Edirom/Edirom-Online-Backend#83

[bwbohl]

blocked by #101 at least for best results ;-)

[bwbohl]

I could offer a video-session for an interactive review

[daniel-jettka]

see Edirom/Edirom-Online-Backend#83 (comment) :-)

[daniel-jettka]

Built with:

export BE_REPO=https://github.com/baz-ga/Edirom-Online-Backend.git FE_REPO=https://github.com/baz-ga/Edirom-Online-Frontend.git BE_BRANCH=ftr/dynamic-annotation-classification FE_BRANCH=ftr/dynamic-annotation-classification && docker compose down --volumes --remove-orphans && docker compose build --no-cache && docker compose up

I have some observations:

(1) Annotation view display
❌ When I open an annotation (click on annotation marker) in local Klarinettenquintett, the whole annotation list opens and I can't switch to single annotation view. In comparison, online Klarinettenquintett displays single annotation view by default.

(2) Annotation view meta info box
❌ Titles of annotation classes are not shown in single annotation view, and newly added class (I have set up an ediromType category for testing) does not show up here:

(3) Annotation menu
❌ Newly added annotation category does not show up in menu:

(4) Annotation list
✔️ Newly added annotation category shows up in complete annotation list with translation:

(5) Translation injection
And one more side-note: Is it possible to inject translations from edition xar into backend? That would be really good for this feature.

[bwbohl]

@daniel-jettka thanks for the thorough review and the crucial observations!

(1) Annotation view display
❌ When I open an annotation (click on annotation marker) in local Klarinettenquintett, the whole annotation list opens and I can't switch to single annotation view. In comparison, online Klarinettenquintett displays single annotation view by default.

Will investigate. This definitely has something to do with handling the "internal ID", so it could either have to do with:

• LinkController, or
• AnnotaitionView

(2) Annotation view meta info box
❌ Titles of annotation classes are not shown in single annotation view, and newly added class (I have set up an ediromType category for testing) does not show up here:

It did work out here, though, when I tested before committing. I’ll test again and check if the branch is rebased on develop, including the changes to missing values for language codes.

(3) Annotation menu
❌ Newly added annotation category does not show up in menu:

That’s an oversight from my part, thanks for spotting!

(4) Annotation list
✔️ Newly added annotation category shows up in complete annotation list with translation:

(5) Translation injection
And one more side-note: Is it possible to inject translations from edition xar into backend? That would be really good for this feature.

Yes, of course that’s failry easy and a way to provide new language codes and override any of those used in Edirom Online. All you have to do is creating an XML file like the ones in the Edirom-Online-Backend, get it included in the edition XAR and reference it from the edition xml file with, e.g.:

<edition xmlns="http://www.edirom.de/ns/1.3" xml:id="edirom-edition_SOME-ID">
   <editionName>SOME NAME</editionName>
   <languages>
      <language xmlns:xlink="http://www.w3.org/1999/xlink" xml:lang="de" complete="[true|false]" xlink:href="xmldb:exist:///db/apps/bazga/Z1B008X/locale/edirom-lang-de.xml"/>
   </languages>
   …

[daniel-jettka]

Hi @bwbohl Any news on this? :-)

[bwbohl]

Will try to get my hands on it this or next week