TIDO merge requestshttps://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests2021-04-23T09:36:48Zhttps://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/137Support/svg icons2021-04-23T09:36:48Zschneider210Support/svg icons# Feature
## Summary
This MR provides SVG icons for the text entities, css classes for the (text) highlighting and refactoring addressing perfomance issues
## Does the result of the MR comply to our "definition of done"?
* [ ] Unit t...# Feature
## Summary
This MR provides SVG icons for the text entities, css classes for the (text) highlighting and refactoring addressing perfomance issues
## Does the result of the MR comply to our "definition of done"?
* [ ] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Documentation
* [x] I updated the README (if applicable)
* [ ] I provided my functions with appropriate documentation
* [ ] I adjusted other parts of the documentation (if applicable)
## 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.
## Related Tickets
Add all related issues and especially those to be closed.
### Related
### Closes
## Logs and Screenshots
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)schneider210schneider210https://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/132feat: annotations2021-04-26T09:06:18Zschneider210feat: annotations# Feature
## Summary
This MR enables TIDO to display annotations.
## Does the result of the MR comply to our "definition of done"?
* [ ] Unit tests passed
* [ ] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passe...# Feature
## Summary
This MR enables TIDO to display annotations.
## 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
* [x] Product Owner accepts the User Story
## Documentation
* [x] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [ ] I adjusted other parts of the documentation (if applicable)
## Tests
Are we able to test this new feature?
* [ ] Yes, everything can be done via unit tests.
* [x] Yes, you can test by following these steps:
**prerequisites**:
- checkout the branch: `git checkout feature/#41-annotations`
- update your local modules once: `npm i`
- open the **index.template.html** file:
- set an entrypoint: **https://ahikar-dev.sub.uni-goettingen.de/api/textapi/ahikar/arabic-karshuni/collection.json**
- start your dev environment: `npm run dev`
**feature tests**:
- **action**
- navigate to **Cod. Arab. 236 Copenhagen => Sheet 2a**
- **expectation**
- data toggles in the anno panel are selected (according to the content types available in the text)
- the list below shows all the annotations highlighted
- the text counterparts are underlined and have an icon attached to it (according to the type given)
- **action**
- click on the names toggle at the top
- **expectation**
- names toggle turns inactive
- the list gets reduced by all the annotations that correspond to names
- text counterparts (names) aren't underlined and haven't an icon attached to it
- **action**
- click on the names toggle at the top again
- **expectation**
- pls refer to the step above; this time the behaviour is the other way around: toggle gets active, names are back in list (in sorted order, taking the remaining / shown data types into account) and text is highlighted again
- **action**
- click a single annotation in the annotation list
- **expectation**
- the item gets dehighlighted as it's text counterpart in the text panel does and the "none" button is highlighted, since now there aren't all of the annotations selected
- **action**
- reverse the last step: click the dehighlighted text entity in the in the text panel
- **expectation**
- the text gets highlighted again as it's list counterpart in the annotation panel does and the "all" button is highlighted again (pls take a look at the lower third of the anno panel => options)
- **action**
- click on **none** in the "options section" (see above)
- **expectation**
- all the annotations get dehighlighted at once but are still shown. this applies to the text entities as well
- **action**
- hover over the comment toggle
- **expectation**
- since the current item doesn't contain any comment, the cursor turns into a "disabled state" and the toggle isn't clickable
- **action**
- click all active data type toggles one after another
- **expectation**
- the toggles turn inactive
- all the text entities get dehighlighted
- there is no list of annotations in the anno panel anymore
- instead there is a notification that addresses the user to interact: **Toggle at least one data type to show annotations**
- **action**
- from here (referring to the last step) click an arbitray text entity in the text panel
- **expectation**
- the appropriate text entity gets highlighted (underlined and icon attached)
- the data type toggle gets active (according to the type you clicked on) and every corrseponding type is shown
- only the annotation that matches it's text counterpart is highlighted. All the others are shown, but are dehighlighted
- **action**
- select the "next" item: e.g. click on **next sheet** or select it in the tree => **Sheet 2b**
- **expectation**
- this item doesn't contain any annotation at all, hence a user notification is displayed: => **no annotations available**
- **action**
- navigate to **Sheet 4a**
- **expectation**
- the annotations get updated according to the current item shown
- the places toggle gets inactive (no places here)
- the comments toggle turns active (the item contains a single comment)
- **action**
- click the names toggle
- **expectation**
- the annotation list shows only the single comment
- since there is a single item in the annotation list only, the sorting buttons completely disappear
**Different text types**
- **action**
- navigate to **Mingana Syriac 133 ff.82v-103r => Sheet 82a**
- click on **TRANSLITERATION** at the top of the text panel to switch the text
- **expectation**
- the annotations update according to the text type selected
**Configuration**
**Pls note**: (just as a reminder) since it's about config, you have to reload your page everytime you are about change sth in the **index.template.html** file
- **action**
- open the **index-template.html** file
- find the section for the **annotations** to be configured (at the top of the config object)
- toggle the **show** key to `false` and reload your page
- **expectation**
- all the data type toggles are inactive
- a user notification shows up
- nothing is highlighted
- **action**
- change an icon (**config => types**): e.g. for the persons:
`"css": "fa-user"` => `"css": "fa-search"`
`"icon": "fasUser"` => `"icon": "fasSearch"`
refresh your page
- **expectation**
- all the icons (according to the data type you changed) change to the newly configured icon face
- **action**
- repeat the last step, but this time provide a nonsense name for the SVG, or rather force a typo: e.g.
`"icon": "fasUser"` => `"icon": "fasBla"`
- **expectation**
- since **fasBla** doesn't exist, a fallback icon is shown in the annotation panel (data toggles and list alike). For the time being this fallback point to **fasTimes**, but this might need an improvement from a semantical perspective
- **action**
- change a label: e.g. **"label": "Places"** to **"label": "Orte"**
- **expectation**
- the label of the appropriate data type toggle (top of the anno panel) changes according to your configuration
- **action**
- **add** a completely new **object** to the **types array**:
`
{
"content-type": "TestIt",
"css": "fa-search",
"icon": "fasSearch",
"label": "ABC123"
},
`
- **expectation**
- your recently created additional content type gets rendered as an additional data type toggle.
**Pls note**: As long as the API doesn't provide a type called **TestIt** and / or the current item you are displaying doesn't contain an equaling content type, the data toggle is disabled
Please take a look at the [README section](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/blob/feature/%2341-annotations/README.md#the-keys-in-detail) as well. Thank you!
* [ ] No, it is not possible.
## Changelog
* [ ] I added a statement to the CHANGELOG.
## Related Tickets
Add all related issues and especially those to be closed.
### Related
#41
#158
#159
#161
#162
#169
#170
#179
#180
#190
#225
### Closes
Closes
#41
#158
#159
#161
#162
#169
#170
#179
#180
#190
#225
## Logs and Screenshots
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)schneider210schneider210https://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/168feat: fab with highlight all/none2021-06-03T14:06:43ZMathias Goebelfeat: fab with highlight all/none# Feature
## Summary
This MR provides a floating action button for changing highlighting on the annotations. it offers two states: all and none.
The code behind uses boolean wherever possible and is independent of the initial boolean v...# Feature
## Summary
This MR provides a floating action button for changing highlighting on the annotations. it offers two states: all and none.
The code behind uses boolean wherever possible and is independent of the initial boolean value to prepare for configurable initial setting.
## Does the result of the MR comply to our "definition of done"?
* [ ] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [ ] Product Owner accepts the User Story
## Documentation
* [ ] I updated the README (if applicable)
* [ ] I provided my functions with appropriate documentation
* [ ] I adjusted other parts of the documentation (if applicable)
## 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.
## Related Tickets
Add all related issues and especially those to be closed.
### Related
### Closes
closes #158
## Logs and Screenshots
![image](/uploads/f1541f94e0180e87b93e32243105c12d/image.png)
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)https://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/170Lean annotation template due to modularization2021-06-15T10:45:56Zschneider210Lean annotation template due to modularization# Feature
## Summary
Follow up from !168
This MR provides the modularization of the annotation component.
Three new components are introduced (annotationtoggles, annotationlist and annotationoptions) to keep the template lean and main...# Feature
## Summary
Follow up from !168
This MR provides the modularization of the annotation component.
Three new components are introduced (annotationtoggles, annotationlist and annotationoptions) to keep the template lean and maintainable and to separate the logic from the markup.
## 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
## Documentation
* [ ] I updated the README (if applicable)
* [ ] I provided my functions with appropriate documentation
* [ ] I adjusted other parts of the documentation (if applicable)
## 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.
## Related Tickets
Add all related issues and especially those to be closed.
related to #158 and #274
### Related
### Closes
closes ${274}
## Logs and Screenshots
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)schneider210schneider210https://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/183Annotation list has to be scrollable2021-06-16T14:14:32Zschneider210Annotation list has to be scrollable# Bug fix
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
- use the same styles (classes **item** and **item-content**) used in all the o...# Bug fix
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
- use the same styles (classes **item** and **item-content**) used in all the other panels
- reintroduce styles for the annotations that got lost during prior merge
## How to test
**entrypoint => https://ahikar-dev.sub.uni-goettingen.de/api/textapi/ahikar/syriac/collection.json**
select manuscript **Brit. Libr. Or. 2313 / Sheet 173v** and scroll the list
## 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
* [x] Product Owner accepts the User Story
### Related
#283
### Closes
Closes #283
## Changelog
* [ ] I added a statement to the CHANGELOG.
## Documentation
* [ ] I updated the README (if applicable)
* [ ] I provided my functions with appropriate documentation
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Mathias Goebelschneider210Mathias Goebelhttps://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/180Annotation list has to be scrollable2021-06-14T10:45:12Zschneider210Annotation list has to be scrollable# Bug fix
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
- use the same styles (classes **item** and **item-content**) used in all the o...# Bug fix
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
- use the same styles (classes **item** and **item-content**) used in all the other panels
- reintroduce styles for the annotations that got lost during prior merge
## How to test
**entrypoint => https://ahikar-dev.sub.uni-goettingen.de/api/textapi/ahikar/syriac/collection.json**
select manuscript **Brit. Libr. Or. 2313 / Sheet 173v** and scroll the list
## 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
### Related
#283
### Closes
Closes #283
## Changelog
* [ ] I added a statement to the CHANGELOG.
## Documentation
* [ ] I updated the README (if applicable)
* [ ] I provided my functions with appropriate documentation
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)schneider210schneider210https://gitlab.gwdg.de/subugoe/emo/tido/-/merge_requests/175Draft: Resolve "Floating Action Button: Behavior when switching pages"2021-06-07T09:05:50ZMathias GoebelDraft: Resolve "Floating Action Button: Behavior when switching pages"Closes #275Closes #275Mathias GoebelMathias Goebel