Update information about custom submit

DigiKlausur · Mar 14, 2024 · 7868e60 · 7868e60
1 parent c72f25b
commit 7868e60
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/docs/source/user_docs/exchange/submit.rst b/docs/source/user_docs/exchange/submit.rst
@@ -1,3 +1,6 @@
+.. _custom_submit_exchange:
+
+======================
 Custom Submit Exchange
 ======================
 

diff --git a/docs/source/user_docs/img/submit.png b/docs/source/user_docs/img/submit.png
diff --git a/docs/source/user_docs/modes.rst b/docs/source/user_docs/modes.rst
@@ -67,13 +67,27 @@ The exam toolbar is displayed in student exam mode. It contains all the resource
 
 The exam toolbar contains a submit button, where students can submit from within the notebook.
 It autosaves the notebook and submits the assignment. If used with the :ref:`custom exchange <custom_exchange>`, the timestamp of the submission is displayed.
-If the assignment only contains a single notebook with the same name as the assignment, a hashcode will be generated.
-The point of the hashcode is to create a checksum over an exam s.t. students can always check the integrity of their exam.
+Additionally, all files in the notebook directory are hashed and the hashes are stored in a file called `SHA1SUM.txt` in the same directory as the notebook.
+The point of the hashcode is to create a checksum over an exam such that students can always check the integrity of their exam.
+Then all notebooks are converted to html files for students to check their submission.
+The name of each html file is the same as the notebook file with the extension `_hashcode.html`.
 
 .. figure:: img/submit.png
     :alt: Submit confirmation
 
     Dialog displayed after submit is clicked.
 
-There is also a link where students can verify their submission. When they click on it, they will see an HTML version of their submitted exam. This way students can make sure all their answers are in the submitted version.
-The HTML version also contains the hashcode and timestamp.
+Students have the option to continue working on the notebook after submitting or exiting the exam.
+When the exam is exited, the student is redirected to the html version of the current notebook.
+
+Here they can check the integrity of their submission.
+
+A cell is added to the top of the html file with the hashcode and timestamp of the notebook.
+The hashcode displayed is truncated to 12 characters.
+
+More information about the custom submit exchange can be found in the :ref:`custom submit <custom_submit_exchange>` section.
+
+.. figure:: exchange/img/submitted_html.png
+   :align: center
+
+   Example of the html file generated by the exam exchange.