Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Init new annotation tool #512

Closed
wants to merge 52 commits into from
Closed

Init new annotation tool #512

wants to merge 52 commits into from

Conversation

Splines
Copy link
Member

@Splines Splines commented May 25, 2023

See feature overview in this comment down below.

… term 'annotations_status' and added default value 0.
…bject and the annotation categories have been replaced.
…bug concerning the color calculation for the annotations. Improved heatmap.
…rance in the feedback player. Switched colors of content and presentation annotations.
… creating an annotation. Rearranged the heatmap toggles horizontally and added tooltip text.
…iction for editing annotations such that only the user who created the annotation has the ability to edit/delete it.
…tion of which he isn't the owner. Fixed problem that public annotations of other users are not shown in the feedback player.
@Splines Splines changed the title Add annotation tool as new feature Init new annotation tool May 25, 2023
@fosterfarrell9
Copy link
Collaborator

Where do all these new files in the cypress folder come from? They seem unrelated to the PR.

Frodo161 added 7 commits June 23, 2023 10:24
…player, if one clicks the iaButton and then click on an annotation.
…ue on reload (time to 0, volume to 1). This still doesn't solve the bug which causes the ranges to be white (instead of blue) until the user manually changes their values.
…a CSS paragraph which caused all radio buttons to disappear. Fixed a bug in the annotation form which caused unwanted behavior of the publish-button.
@Frodo161
Copy link
Collaborator

Frodo161 commented Jul 9, 2023

This branch adds the feature to add annotations to the video timeline. They can be used for giving feedback to the teacher, for getting help, for publishing something directly in the video comments or - simply - to make personal notes.

By default students can create annotations on the video timeline. Click on the button next to the speed control to open a dialogue.

Bildschirmfoto vom 2023-07-09 09-17-27

Enter the text for your annotation (you can use Latex!), choose a color and select the category. You can publish the content directly as a comment and - if the teacher enabled this feature - make your annotation visible for the teacher. If the teacher entered an "emergency-link" (see below) and if you choose "content" as category and then "definition" the dialogue will give you a link for further help.

Markers will appear on the video timeline once you click on "Save". If you click on one of them their content will be shown in the interactive area on the right.

Bildschirmfoto vom 2023-07-09 09-16-24

To see the annotations of students (which are marked as "visible for teacher") the teacher has to activate the emergency button on the lecture edit page (comments).

Bildschirmfoto vom 2023-07-09 09-07-24

If it is (not) activated there is still the posibility to (de)activate it for each single video. By default the option "inherit from lecture" is selected.

Bildschirmfoto vom 2023-07-09 09-07-54

Go again to the lecture edit page (preferences this time). There you can enter links (or select a lecture) which is shown to the students as "emergency-link", if they have problems with understanding a definition.

Bildschirmfoto vom 2023-07-09 09-07-14

To see the feedback of the student, teachers now have the "feedback player" which can be accessed on the media edit page (where the video was uploaded). In this very simple player, the teacher sees all the annotations (that are marked as "visible for teacher") together with a heatmap. The teacher can (de)select the categories of annotations that are shown to him at the bottom of the video.

Mistake annotations are slightly bigger than other annotations and are not included in the calculation of the heatmap!

Bildschirmfoto vom 2023-07-09 15-48-10

@fosterfarrell9 fosterfarrell9 self-requested a review July 10, 2023 15:05
@codecov
Copy link

codecov bot commented Aug 9, 2023

Codecov Report

Merging #512 (c2d26f3) into mampf-next (883417c) will decrease coverage by 0.07%.
The diff coverage is 48.27%.

@@              Coverage Diff               @@
##           mampf-next     #512      +/-   ##
==============================================
- Coverage       66.48%   66.42%   -0.07%     
==============================================
  Files             311      312       +1     
  Lines            9417     9444      +27     
==============================================
+ Hits             6261     6273      +12     
- Misses           3156     3171      +15     
Files Changed Coverage Δ
app/models/time_stamp.rb 91.30% <ø> (ø)
app/models/medium.rb 54.32% <20.00%> (-0.54%) ⬇️
app/controllers/media_controller.rb 25.91% <28.57%> (+0.04%) ⬆️
app/helpers/annotations_helper.rb 50.00% <50.00%> (ø)
app/abilities/medium_ability.rb 60.86% <100.00%> (ø)
app/models/lecture.rb 53.67% <100.00%> (+0.11%) ⬆️
config/routes.rb 100.00% <100.00%> (ø)

@Splines Splines marked this pull request as ready for review August 23, 2023 11:07
Copy link
Member Author

@Splines Splines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty cool to play around with the new feature. Some first remarks referring to the UI.

config/locales/en.yml Show resolved Hide resolved
config/locales/de.yml Show resolved Hide resolved
app/assets/stylesheets/thyme.scss Show resolved Hide resolved
app/views/annotations/_form.html.erb Show resolved Hide resolved
@Splines Splines closed this Aug 23, 2023
@Splines
Copy link
Member Author

Splines commented Aug 23, 2023

Closed in favor of #annotation #533.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants