Development: Document exam exercise update notifications (#7294)

docs/user/exams/instructors_guide.rst

@@ -345,9 +345,18 @@ During the exam creation and configuration, you can create your exam and configu
 
 2. **Conduction**
 -----------------
-The exam conduction starts when the exam becomes visible to the students and ends when the latest working time is over. When the exam conduction begins, you cannot make any changes anymore to the :ref:`exam configuration <exam_creation_and_configuration>` or individual :ref:`student exams <student_exams>`. When the conduction starts, the students can access and start their exam. They can submit their solutions to the exercises within the given individual working time. When a student submits the exam, they cannot make any changes anymore to his exercise submissions. For more information, see :ref:`participating in the online exam <participation_guide>`.
+The exam conduction starts when the exam becomes visible to the students and ends when the latest working time is over. When the exam conduction begins, you cannot change the :ref:`exam configuration <exam_creation_and_configuration>` or individual :ref:`student exams <student_exams>`. When the conduction starts, the students can access and start their exam. They can submit their solutions to the exercises within the given individual working time. After a student submits the exam, they cannot change their exercise submissions. For more information, see :ref:`participating in the online exam <participation_guide>`.
 
-    .. _exam_assessment:
+Updating an Exercise during the Exam
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+In case you have to update the exercise during an exam for programming, modeling, text, or file-upload exercises, you can go to the exercise details page and click on |edit| to edit the exercise. At the bottom of the exercise edit page, you can enter a notification text that is shown to the students in the exam mode. The screenshot below shows an example notification. You can see how the updated problem statement looks for the student in :ref:`Updated Problem Statement during the Exam <updated_problem_statement>`.
+
+.. figure:: instructor/exercise-notification.png
+    :alt: Exercise Notification
+
+    Field to enter a notification text
+
+.. _exam_assessment:
 
 3. **Assessment**
 -----------------

docs/user/exams/students_guide.rst

@@ -275,7 +275,27 @@ Participating in Programming Exercises
 
     If you work in the online code editor and a merge conflict occurs, the file browser will display the conflict state |conflict_state|.
     You can use the |resolve_conflict| button, which is then displayed instead of the submit button, to resolve the conflict within the online code editor.
-    This will reset your changes to the latest commit. Manual merging is not possible with the online code editor.
+    This will reset your changes to the latest commit.
+
+    .. warning::
+       Manual merging is not possible with the online code editor.
+
+.. _updated_problem_statement:
+
+Updated Problem Statement during the Exam
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If your instructor updates the problem statement for an exercise during the exam, you will receive a notification, as seen in the screenshot below, and can switch between a diff view and the new problem statement, as shown in the second and third screenshot.
+
+.. figure:: student/student-notification.png
+   :alt: Problem Statement Update Notification
+
+.. figure:: student/problem-statement-normal-view.png
+   :alt: Updated Problem Statement in the Normal View
+
+.. figure:: student/problem-statement-diff-view.png
+    :alt: Updated Problem Statement in the Diff View
+
+
 
 End Screen
 ^^^^^^^^^^

src/main/webapp/app/feature-overview/feature-overview.component.ts

@@ -2,6 +2,7 @@ import { Component, OnInit } from '@angular/core';
 import { ActivatedRoute } from '@angular/router';
 import { IconProp } from '@fortawesome/fontawesome-svg-core';
 import {
+    faBell,
     faChartPie,
     faCheckSquare,
     faClipboardCheck,
@@ -30,6 +31,7 @@ import {
     faTasks,
     faThList,
     faUserSecret,
+    faWrench,
 } from '@fortawesome/free-solid-svg-icons';
 import { ProfileService } from 'app/shared/layouts/profiles/profile.service';
 
@@ -192,6 +194,16 @@ export class FeatureOverviewComponent implements OnInit {
             '/content/images/feature-overview/students/student_grade_key.png',
         );
 
+        const featureExerciseUpdateNotification = new Feature(
+            'featureOverview.students.feature.exerciseUpdateNotification.title',
+            'featureOverview.students.feature.exerciseUpdateNotification.shortDescription',
+            'featureOverview.students.feature.exerciseUpdateNotification.descriptionTextOne',
+            faBell,
+            undefined,
+            '/content/images/feature-overview/students/exercise_update_notification.png',
+            '/content/images/feature-overview/students/exercise_diff_view.png',
+        );
+
         this.features = [
             featureConduction,
             featureExamMode,
@@ -202,6 +214,7 @@ export class FeatureOverviewComponent implements OnInit {
             featureApollonEditor,
             featureTextEditor,
             featureQuizExercises,
+            featureExerciseUpdateNotification,
             featureSummary,
             featureQualityAndFair,
             featureOnlineReview,
@@ -369,14 +382,22 @@ export class FeatureOverviewComponent implements OnInit {
             undefined,
             '/content/images/feature-overview/instructors/grade_key_editor.png',
         );
-
+        const featureExamExerciseUpdates = new Feature(
+            'featureOverview.instructor.feature.examExerciseUpdates.title',
+            'featureOverview.instructor.feature.examExerciseUpdates.shortDescription',
+            'featureOverview.instructor.feature.examExerciseUpdates.descriptionTextOne',
+            faWrench,
+            undefined,
+            '/content/images/feature-overview/instructors/exam_exercise_update_notification.png',
+        );
         this.features = [
             featureCreateConductAssess,
             featureConfiguration,
             featureExamMode,
             featureExerciseTypes,
             featureExerciseVariants,
             featureTestRuns,
+            featureExamExerciseUpdates,
             featureSessionMonitoring,
             featurePlagiarismDetection,
             featureAnonymousAssessment,

src/main/webapp/i18n/de/featureOverview.json

@@ -85,6 +85,11 @@
                     "title": "Notenschlüssel Erstellen",
                     "shortDescription": "Erstelle einen Notenschlüssel mit benutzerdefinierten oder vorgegebenen Notenstufen für einen Kurs oder eine Prüfung.",
                     "descriptionTextOne": "Punkte sind hilfreich, um einzelne Übungen zu bewerten, aber am Ende eines Semesters möchten du und die Studierenden eine Note erhalten. Auf der Notenschlüssel-Seite kannst du für jeden Kurs und jede Prüfung einen Notenschlüssel festlegen und die Notenstufen definieren, indem du die Intervalle, die Mindestnote und die untere/obere Grenze angibst. Der Standard-Notenschlüssel kann auch mit einem einzigen Klick erstellt werden. Artemis kümmert sich dann automatisch um die Zuordnung von Noten zu Notenstufen oder Bonuspunkten und um die Berechnung der Ergebnisstatistik auf der Grundlage der Notenstufen."
+                },
+                "examExerciseUpdates": {
+                    "title": "Aufgabenänderungen während einer Klausur",
+                    "shortDescription": "Ändere die Aufgabenstellung während der Klausur und benachrichtige die Studierenden darüber.",
+                    "descriptionTextOne": "Während einer Klausur kann es vorkommen, dass Änderungen an der Aufgabenstellung vorgenommen werden müssen. Artemis bietet die Möglichkeit, die Aufgabenstellung während der Klausur auf der Bearbeitungsseite der Aufgabe zu aktualisieren und die Studierenden darüber zu benachrichtigen. Die Studierenden werden über die Änderungen informiert und können die aktualisierte Aufgabenstellung einsehen."
                 }
             }
         },
@@ -167,6 +172,11 @@
                     "title": "Notenschlüssel Anzeigen",
                     "shortDescription": "Sieh dir deine Endnote und die erreichte Note für einen Kurs oder eine Prüfung an, sobald eine neue Aufgabe benotet wurde.",
                     "descriptionTextOne": "Wenn ein Notenschlüssel für einen Kurs oder eine Prüfung definiert ist, kannst du ihn überprüfen und den Punkteschnitt für jede Bewertungsstufe sowie die zum Bestehen erforderliche Mindestpunktzahl einsehen. Notenschlüssel haben auch einen Bonuspunkte-Modus, der die erreichte Punktzahl in einen Bonus umwandelt. Du musst nicht bis zum Ende des Semesters warten, um den Notenschlüssel zu benutzen, sondern kannst jederzeit deine erreichte Note anhand der bisher durchgeführten und bewerteten Übungen überprüfen."
+                },
+                "exerciseUpdateNotification": {
+                    "title": "Benachrichtigung über Aufgabenänderungen",
+                    "shortDescription": "Wenn Änderungen an der Aufgabenstellung während einer Klausur notwendig sind, wirst du darüber benachrichtigt.",
+                    "descriptionTextOne": "Während einer Klausur kann es vorkommen, dass Änderungen an der Aufgabenstellung vorgenommen werden müssen. Du wirst über die Änderungen informiert und kannst die aktualisierte Aufgabenstellung einsehen. Es ist möglich zwischen der der Ansicht der aktualisierten Aufgabenstellung und einer Ansicht, die die Änderungen hervorhebt, zu wechseln."
                 }
             }
         }

src/main/webapp/i18n/en/featureOverview.json

@@ -85,6 +85,11 @@
                     "title": "Create Grading Keys",
                     "shortDescription": "Create a grading key with custom or default grade steps for a course or an exam.",
                     "descriptionTextOne": "Scores are helpful to assess individual exercises but at the end of a semester you and your students would like to see a standard grade. On the grading key page, you can have a grading key for each course and exam, define the grade steps by specifying intervals, the minimum passing grade and the lower/upper bound inclusivity. The default grading key can also be generated with a single click. Artemis then automatically handles mapping scores to grade steps or bonus points, as well as calculating student result statistics based on grade steps."
+                },
+                "examExerciseUpdates": {
+                    "title": "Exercise Update during an Exam",
+                    "shortDescription": "Update exercises during an exam and notify the students about the changes.",
+                    "descriptionTextOne": "When you have to update the problem statement of an exercise during the exam, you can do this on the exercise edit page and notify the students about it and they will be able to see the updated problem statement."
                 }
             }
         },
@@ -167,6 +172,11 @@
                     "title": "View Grading Keys",
                     "shortDescription": "See your final and attained grade for a course or an exam as soon as you have a new assignment graded.",
                     "descriptionTextOne": "When a grading key for a course or an exam is defined, you can examine it and see the score interval corresponding to each grading step and the minimum grade needed to pass. Grading keys also have a bonus points mode which converts the obtained score to a bonus. You don't have to wait until the end of the semester to use the grading key, you can always check out your attained grade based on the exercises conducted and assessed so far."
+                },
+                "exerciseUpdateNotification": {
+                    "title": "Exercise Update Notification",
+                    "shortDescription": "If the instructor of your course has to update the problem statement you will receive a notification.",
+                    "descriptionTextOne": "If the instructor updates the problem statement of an exercise during the exam, you will be notified about it and you will be able to see the updated problem statement. You can switch between the updated version and a view highlighting the changes."
                 }
             }
         }