+
+<% if user_signed_in? %>
+ <%= render partial: "annotations/annotation_modal" %>
+ <%= render partial: "annotations/annotation_locales" %>
+<% end %>
\ No newline at end of file
diff --git a/app/views/media/show_comments.html.erb b/app/views/media/show_comments.html.erb
index 013b4c680..239e6edc7 100644
--- a/app/views/media/show_comments.html.erb
+++ b/app/views/media/show_comments.html.erb
@@ -13,4 +13,4 @@
<%= commontator_thread(@medium) %>
-
\ No newline at end of file
+
diff --git a/config/application.rb b/config/application.rb
index b5e4e0f1e..85776e7ff 100644
--- a/config/application.rb
+++ b/config/application.rb
@@ -11,6 +11,19 @@ class Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
config.load_defaults(7.0)
config.autoloader = :zeitwerk
+
+ # Autoload lib extensions path (ignore all other subdirectories of lib/)
+ lib_path = Rails.root.join("lib")
+ config.autoload_paths << lib_path
+ config.eager_load_paths << lib_path
+ Rails.autoloaders.main.ignore(
+ lib_path.join("assets"),
+ lib_path.join("collectors"),
+ lib_path.join("core_ext"),
+ lib_path.join("scrapers"),
+ lib_path.join("tasks")
+ )
+
config.i18n.default_locale = :de
config.i18n.fallbacks = [:en]
config.i18n.available_locales = [:de, :en]
diff --git a/config/initializers/commontator.rb b/config/initializers/commontator.rb
index 78a775e9d..bc76ad318 100644
--- a/config/initializers/commontator.rb
+++ b/config/initializers/commontator.rb
@@ -314,3 +314,17 @@
# Default: false
config.mentions_enabled = false
end
+
+Rails.application.config.to_prepare do
+ # Load the Commontator extensions only if we are not in the assets:precompile
+ # step where no db connection is available. See the production Dockerfile.
+ db_adapter = ENV.fetch("DB_ADAPTER", nil)
+ if db_adapter == "nulldb"
+ Rails.logger.info("DB_ADAPTER env var is #{db_adapter}. Skipping Commontator extensions.")
+ next
+ end
+
+ if ActiveRecord::Base.connection.table_exists?(:thredded_topics)
+ Commontator::Comment.include(Extensions::Commontator::Comment)
+ end
+end
diff --git a/config/locales/de.yml b/config/locales/de.yml
index 13ae67031..75f7e2cc6 100644
--- a/config/locales/de.yml
+++ b/config/locales/de.yml
@@ -322,6 +322,90 @@ de:
title: 'Titel'
teacher: 'DozentIn'
editors: 'EditorInnen'
+ annotation:
+ annotations: 'Annotationen'
+ annotation_modal_head_create_annotation: 'Annotation anlegen'
+ annotation_modal_head_edit_annotation: 'Annotation bearbeiten'
+ inherit_from_lecture: 'von Vorlesung erben'
+ time: 'Zeit:'
+ comment: 'Kommentar'
+ color: 'Farbe'
+ category: 'Kategorie'
+ category_tooltip: >
+ Verwende "Notiz" für persönliche Notizen, "Inhalt" wenn Du den Inhalt
+ des Videos an dieser Stelle nicht verstehst, "Fehler" wenn Du einen
+ Fehler entdeckt hast, und "Darstellung" wenn Dir die Darstellung im
+ Video Probleme bereitet, z.B. falls Du die Schrift nicht lesen kannst
+ oder der Ton unverständlich ist.
+ note: 'Notiz'
+ note_tooltip: >
+ Wähle diese Kategorie aus, wenn Du Deine Annotation als
+ persönliche Notiz anlegen möchtest.
+ content: 'Inhalt'
+ content_tooltip: >
+ Wähle diese Kategorie aus, wenn Du den Inhalt des Videos an dieser
+ Stelle nicht verstehst.
+ mistake: 'Fehler'
+ mistake_tooltip: >
+ Wähle diese Kategorie aus, wenn Du der Meinung bist, an dieser
+ Stelle im Video wurde ein inhaltlicher Fehler gemacht.
+ presentation: 'Darstellung'
+ presentation_tooltip: >
+ Wähle diese Kategorie aus, wenn Dir die Darstellung im Video
+ an dieser Stelle Probleme bereitet, z.B. falls Du die Schrift
+ nicht lesen kannst oder falls der Ton unverständlich ist.
+ whats_the_problem: >
+ Wo liegt das Problem?
+ definition: 'Definition'
+ definition_tooltip: >
+ Wähle diese Unterkategorie aus, wenn Du Probleme mit einer Definition hast.
+ argument: 'Argument'
+ argument_tooltip: >
+ Wähle diese Unterkategorie aus, wenn Du Probleme mit einem Argument
+ (z.B. in einem Beweis) hast.
+ strategy: 'Beweisstrategie'
+ strategy_tooltip: >
+ Wähle diese Unterkategorie aus, wenn Du Probleme mit der allgemeinen
+ (Beweis-)Strategie hast.
+ previous_annotation: 'vorherige Annotation'
+ annotation_position: 'zur Annotation springen'
+ edit_annotation: 'Annotation editieren'
+ close_annotation_area: 'Feld schließen'
+ next_annotation: 'nächste Annotation'
+ further_help: 'Du brauchst weitere Hilfe? Dann klicke auf:'
+ warning_message:
+ publishing: >
+ Jeder, der diese Vorlesung abonniert hat, wird Deinen Kommentar
+ lesen können, sobald Du auf "Speichern" klickst.
+ Falls Du das nicht möchtest, entferne bitte wieder den Haken
+ bei "Als Kommentar veröffentlichen?".
+ mistake: >
+ Bevor Du diesen Kommentar abschickst, überprüfe außerdem bitte,
+ ob bereits ein Kommentar zu dem von Dir gefundenen Fehler existiert.
+ one_close_annotation: >
+ Beachte: in der Nähe Deiner Annotation gibt es bereits eine veröffentlichte
+ Fehler-Annotation.
+ multiple_close_annotations_1: "Beachte: in der Nähe Deiner Annotation gibt es bereits "
+ multiple_close_annotations_2: " veröffentlichte Fehler-Annotationen."
+ permission: "Dir fehlen die Rechte, um diese Annotation zu bearbeiten."
+ double_posted: >
+ Es wurde bereits eine Annotation mit dem gleichen Inhalt zu diesem Medium
+ veröffentlicht.
+ sure_to_delete: >
+ Diese Annotation wirklich löschen?
+ visible_for_teacher: 'Für DozentIn sichtbar?'
+ visible_for_teacher_helpdesk: >
+ Falls diese Checkbox ausgewählt ist, kann Dein(e) Dozent(in) diese Annotation
+ in ihrem/seinem Thyme-Player (ohne Deinen Namen) sehen.
+ post_as_comment: 'Als Kommentar veröffentlichen?'
+ post_as_comment_helpdesk: >
+ Falls diese Checkbox ausgewählt ist, wird diese Annotation automatisch
+ als Kommentar zu diesem Video veröffentlicht.
+ toggle:
+ note: "Notiz-Annotationen ein-/ausblenden"
+ content: "Inhalt-Annotationen ein-/ausblenden"
+ mistake: "Fehler-Annotationen ein-/ausblenden"
+ presentation: "Darstellung-Annotationen ein-/ausblenden"
announcement:
help: >
Hier kannst Du den Text eingeben. Du kannst LaTeX benutzen
@@ -371,6 +455,16 @@ de:
no_imported_media: 'Es sind keine importierten Medien vorhanden.'
comments_disabled: >
Kommentare für neu veröffentlichte Medien sind standardmäßig deaktiviert
+ enable_annotation_button: 'Dürfen Studierende Annotationen für Sie sichtbar machen?'
+ enable_annotation_button_helpdesk: >
+ Wenn Sie "ja" anwählen, dann haben Studierende die Möglichkeit,
+ ihre Annotationen für den/die Dozent*in bzw. alle Editor*innen
+ der Vorlesung sichtbar machen. Sie können diese dann entweder
+ im normalen Thyme-Player oder im Thyme-Feedback-Player einsehen
+ und dadurch Rückmeldung zu Ihren Vorlesungsvideos erhalten.
+ enable_annotation_button_inherit_helpdesk: >
+ Ist die Option "von Vorlesung erben" ausgewählt, dann wird die
+ globale Option aus den Vorlesungseinstellungen (Kommentare) übernommen.
new_notifications: 'neue Benachrichtigungen'
new_media: 'neue Medien'
new_posts: 'neue Forenbeiträge'
@@ -620,6 +714,12 @@ de:
script_based: >
unter Verwendung eines Veranstaltungsskriptes, das mit dem MaMpf
LaTeX-Paket erstellt wurde
+ emergency_link: 'Link für den Emergency-Button'
+ emergency_link_no_link: 'kein Link'
+ emergency_link_lecture_link: 'Vorlesungslink'
+ emergency_link_direct_link: 'direkter Link'
+ enter_emergency_link: 'Emergency-Link eingeben:'
+ select_helpdesk: 'Helpdesk auswählen:'
no_chapters: 'Es sind noch keine Kapitel vorhanden.'
no_talks: Es sind noch keine Vorträge vorhanden.
orphaned_lessons: 'Verwaiste Sitzungen'
diff --git a/config/locales/en.yml b/config/locales/en.yml
index 0f738f912..b7a7ca624 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -323,6 +323,87 @@ en:
title: 'Title'
teacher: 'Teacher'
editors: 'Editors'
+ annotation:
+ annotations: 'Annotations'
+ annotation_modal_head_create_annotation: 'Create annotation'
+ annotation_modal_head_edit_annotation: 'Edit annotation'
+ inherit_from_lecture: 'inherit from lecture'
+ time: 'Time:'
+ comment: 'Comment'
+ color: 'Color'
+ category: 'Category'
+ category_tooltip: >
+ Use "note" for personal notes, "content" if you don't understand the
+ content of the video at this position, "mistake" if you've spot a mistake,
+ and "presentation" if you have problems with the presentation,
+ e.g. you cannot read the handwriting or cannot understand the audio.
+ note: 'note'
+ note_tooltip: >
+ Select this category if you want to create your annotation
+ as a personal note.
+ content: 'content'
+ content_tooltip: >
+ Select this category if you don't understand the content
+ of the video at this position.
+ mistake: 'mistake'
+ mistake_tooltip: >
+ Select this category if you think there has been made a mistake
+ in the content of the video at this position.
+ presentation: 'presentation'
+ presentation_tooltip: >
+ Select this category if you have problems with the presentation
+ in the video at this position, e.g. if you cannot read the
+ handwriting or if you cannot understand the audio.
+ whats_the_problem: >
+ What's the problem?
+ definition: 'definition'
+ definition_tooltip: >
+ Select this subcategory if you have problems with a definition.
+ argument: 'argument'
+ argument_tooltip: >
+ Select this subcategory if you have problems with an argument
+ (e.g. in a proof).
+ strategy: 'proof strategy'
+ strategy_tooltip: >
+ Select this subcategory if you have problems with the general
+ (proof) strategy.
+ previous_annotation: 'previous annotation'
+ annotation_position: 'go to annotation'
+ edit_annotation: 'edit annotation'
+ close_annotation_area: 'close area'
+ next_annotation: 'next annotation'
+ further_help: 'You need further help? Then click on:'
+ warning_message:
+ publishing: >
+ Everyone who subscribed this lecture will be able to read
+ your comment once you click "Save".
+ If this is not what you intended to do,
+ please unselect "Post as comment?".
+ mistake: >
+ Before submitting, please also check, if someone already posted
+ a comment concerning this mistake.
+ one_close_annotation: >
+ Note there is already a mistake annotation around this timestamp.
+ multiple_close_annotations_1: "Note there are already "
+ multiple_close_annotations_2: " mistake annotations close to yours."
+ permission: "You don't have the permission to edit this annotation."
+ double_posted: >
+ An annotation with the same content has already been published.
+ sure_to_delete: >
+ Really delete this annotation?
+ visible_for_teacher: 'Visible for teacher?'
+ visible_for_teacher_helpdesk: >
+ If this checkbox is selected your teacher can see this annotation
+ (without your name!) in their own thyme player.
+ post_as_comment: 'Post as comment?'
+ post_as_comment_helpdesk: >
+ If this checkbox is selected, this annotation will be published as
+ comment for this video.
+ toggle:
+ note: "toggle note annotations"
+ content: "toggle content annotations"
+ mistake: "toggle mistake annotations"
+ presentation: "toggle presentation annotations"
announcement:
help: >
Here you can enter a text. You may use LaTeX (by putting the
@@ -372,6 +453,16 @@ en:
close_comments: 'Close all threads for related media'
comments_disabled: >
Comments for newly published media are disabled by default
+ enable_annotation_button: 'Are students allowed to make annotations visible for you?'
+ enable_annotation_button_helpdesk: >
+ If you select "yes", students have the possibility to make
+ their annotations visible for the teacher resp. all editors
+ of the lecture. You can then see them either in the normal
+ thyme player or in the thyme feedback player to get feedback
+ for your lecture videos.
+ enable_annotation_button_inherit_helpdesk: >
+ If the option "inherit from lecture" is selected, the global
+ option of the lecture preferences (comments) is taken.
new_notifications: 'new notifications'
new_media: 'new media'
new_posts: 'new forum posts'
@@ -590,6 +681,12 @@ en:
content_mode: 'Content determination'
video_based: 'media based'
script_based: 'using a manuscript generated by the MaMpf LaTeX package'
+ emergency_link: 'Link for the emergency button'
+ emergency_link_no_link: 'no link'
+ emergency_link_lecture_link: 'lecture link'
+ emergency_link_direct_link: 'direct link'
+ enter_emergency_link: 'Enter emergency link:'
+ select_helpdesk: 'Select helpdesk:'
no_chapters: 'There are no chapters yet.'
no_talks: 'There are no talks yet.'
orphaned_lessons: 'Orphaned Sessions'
diff --git a/config/routes.rb b/config/routes.rb
index 470168970..cb0b1c763 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -38,6 +38,18 @@
to: "administration#classification",
as: "classification"
+ # annotation routes
+
+ get "annotations/update_annotations",
+ to: "annotations#update_annotations",
+ as: "update_annotations"
+
+ get "annotations/num_nearby_posted_mistake_annotations",
+ to: "annotations#num_nearby_posted_mistake_annotations",
+ as: "num_nearby_posted_mistake_annotations"
+
+ resources :annotations, only: [:new, :create, :edit, :update, :destroy]
+
# announcements routes
post "announcements/:id/propagate",
@@ -283,6 +295,10 @@
to: "media#inspect",
as: "inspect_medium"
+ get "media/:id/feedback",
+ to: "media#feedback",
+ as: "feedback_medium"
+
get "media/:id/enrich",
to: "media#enrich",
as: "enrich_medium"
@@ -393,6 +409,10 @@
to: "media#fill_reassign_modal",
as: "fill_reassign_modal"
+ get "media/:id/check_annotation_visibility",
+ to: "media#check_annotation_visibility",
+ as: "check_annotation_visibility"
+
resources :media
# notifications controller
diff --git a/db/migrate/20240329230000_create_annotations.rb b/db/migrate/20240329230000_create_annotations.rb
new file mode 100644
index 000000000..af851eb71
--- /dev/null
+++ b/db/migrate/20240329230000_create_annotations.rb
@@ -0,0 +1,17 @@
+class CreateAnnotations < ActiveRecord::Migration[7.0]
+ def change
+ create_table :annotations do |t|
+ t.references :medium, null: false, foreign_key: true
+ t.references :user, null: false, foreign_key: true
+ t.text :timestamp, null: false
+ t.text :comment
+ t.string :color, null: false
+ t.integer :category, null: false
+ t.integer :subcategory
+ t.boolean :visible_for_teacher, default: false, null: false
+ t.integer :public_comment_id
+
+ t.timestamps
+ end
+ end
+end
diff --git a/db/migrate/20240329230010_add_annotation_related_fields.rb b/db/migrate/20240329230010_add_annotation_related_fields.rb
new file mode 100644
index 000000000..ac846bdc0
--- /dev/null
+++ b/db/migrate/20240329230010_add_annotation_related_fields.rb
@@ -0,0 +1,15 @@
+class AddAnnotationRelatedFields < ActiveRecord::Migration[7.0]
+ def change
+ # Annotations status
+ # Media inherits annotation status from lecture by default
+ add_column :media, :annotations_status, :integer, default: -1, null: false
+ # Lecture: activate "share annotation with lecturer" feature by default
+ add_column :lectures, :annotations_status, :integer, default: 1, null: false
+
+ # Emergency Link
+ change_table :lectures, bulk: true do |t|
+ t.integer :emergency_link_status, default: 0, null: false
+ t.text :emergency_link
+ end
+ end
+end
diff --git a/db/schema.rb b/db/schema.rb
index d17bf4c82..70e865353 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -10,11 +10,27 @@
#
# It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema[7.0].define(version: 2024_03_19_130000) do
+ActiveRecord::Schema[7.0].define(version: 2024_03_29_230010) do
# These are extensions that must be enabled in order to support this database
enable_extension "pgcrypto"
enable_extension "plpgsql"
+ create_table "annotations", force: :cascade do |t|
+ t.bigint "medium_id", null: false
+ t.bigint "user_id", null: false
+ t.text "timestamp", null: false
+ t.text "comment"
+ t.string "color", null: false
+ t.integer "category", null: false
+ t.integer "subcategory"
+ t.boolean "visible_for_teacher", default: false, null: false
+ t.integer "public_comment_id"
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ t.index ["medium_id"], name: "index_annotations_on_medium_id"
+ t.index ["user_id"], name: "index_annotations_on_user_id"
+ end
+
create_table "announcements", force: :cascade do |t|
t.bigint "lecture_id"
t.bigint "announcer_id"
@@ -282,6 +298,9 @@
t.integer "submission_max_team_size"
t.integer "submission_grace_period", default: 15
t.boolean "legacy_seminar", default: false
+ t.integer "annotations_status", default: 1, null: false
+ t.integer "emergency_link_status", default: 0, null: false
+ t.text "emergency_link"
t.index ["teacher_id"], name: "index_lectures_on_teacher_id"
t.index ["term_id"], name: "index_lectures_on_term_id"
end
@@ -361,6 +380,7 @@
t.text "publisher"
t.datetime "file_last_edited", precision: nil
t.text "external_link_description"
+ t.integer "annotations_status", default: -1, null: false
t.index ["quizzable_type", "quizzable_id"], name: "index_media_on_quizzable_type_and_quizzable_id"
t.index ["teachable_type", "teachable_id"], name: "index_media_on_teachable_type_and_teachable_id"
end
@@ -413,7 +433,7 @@
t.index ["subject_id"], name: "index_programs_on_subject_id"
end
- create_table "quiz_certificates", id: :uuid, default: -> { "public.gen_random_uuid()" }, force: :cascade do |t|
+ create_table "quiz_certificates", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
t.bigint "quiz_id", null: false
t.bigint "user_id"
t.text "code"
@@ -499,7 +519,7 @@
t.datetime "updated_at", null: false
end
- create_table "submissions", id: :uuid, default: -> { "public.gen_random_uuid()" }, force: :cascade do |t|
+ create_table "submissions", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
t.bigint "tutorial_id", null: false
t.bigint "assignment_id", null: false
t.text "token"
@@ -913,6 +933,8 @@
t.index ["watchlist_entry_id"], name: "index_watchlists_on_watchlist_entry_id"
end
+ add_foreign_key "annotations", "media"
+ add_foreign_key "annotations", "users"
add_foreign_key "announcements", "lectures"
add_foreign_key "announcements", "users", column: "announcer_id"
add_foreign_key "assignments", "lectures"
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 38122f670..0d2ada414 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -33,6 +33,59 @@ const customGlobals = {
// Common global methods
initBootstrapPopovers: "readable",
+
+ // Thyme & Annotation tool globals
+ // TODO: This is a "hack" right now to get rid of "xy is not defined" error
+ // messages in ESLint.
+ // In an ideal world, we would use the new ES6 module syntax, but that is a
+ // bigger undertaking as we have to get rid of rails webpacker and use
+ // webpack itself or even better try to use the new import maps.
+ // See the links in this issue: https://github.com/MaMpf-HD/mampf/issues/454
+ thyme: "readable",
+ video: "readable",
+ thymeAttributes: "readable",
+ thymeKeyShortcuts: "readable",
+ thymeUtility: "readable",
+ Resizer: "readable",
+
+ ControlBarHider: "readable",
+
+ ChapterManager: "readable",
+ DisplayManager: "readable",
+ MetadataManager: "readable",
+
+ Component: "readable",
+ Category: "readable",
+ CategoryEnum: "readable",
+ Subcategory: "readable",
+ VolumeBar: "readable",
+ TimeButton: "readable",
+ MuteButton: "readable",
+ PlayButton: "readable",
+ SeekBar: "readable",
+ FullScreenButton: "readable",
+ NextChapterButton: "readable",
+ PreviousChapterButton: "readable",
+ SpeedSelector: "readable",
+ AddItemButton: "readable",
+ AddReferenceButton: "readable",
+ AddScreenshotButton: "readable",
+ IaBackButton: "readable",
+ IaButton: "readable",
+ IaCloseButton: "readable",
+
+ seekBar: "writable",
+
+ Annotation: "readable",
+ AnnotationManager: "readable",
+ AnnotationArea: "readable",
+ AnnotationsToggle: "readable",
+ AnnotationCategoryToggle: "readable",
+ AnnotationButton: "readable",
+ Heatmap: "readable",
+
+ // KaTeX
+ renderMathInElement: "readable",
};
// We don't have cypress linting yet, as the Cypress ESLint plugin
diff --git a/lib/extensions/commontator/comment.rb b/lib/extensions/commontator/comment.rb
new file mode 100644
index 000000000..3da558ce4
--- /dev/null
+++ b/lib/extensions/commontator/comment.rb
@@ -0,0 +1,15 @@
+module Extensions
+ module Commontator
+ module Comment
+ extend ActiveSupport::Concern
+
+ included do
+ has_one :annotation, foreign_key: :public_comment_id
+
+ def medium
+ thread.commontable
+ end
+ end
+ end
+ end
+end