Merge branch 'master' of https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/moodledta

README.md

@@ -45,7 +45,7 @@ After approval, install the plugin directly from the Moodle Plugins Directory vi
 
 Before that or alternatively: zip the plugin code from https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/moodledta (here). The readily-zipped current version also sits in the repository’s main directory. Then install the plugin from zip via Site Administration/Plugins/Install Plugins, or by extracting the plugin archive to {Moodle_Root}/mod/assign/submission/dta and visiting the admins notifications page. 
 
-Visit Site Administration/Plugins/Plugin Overview and select Configure next to the Moodle Dockerized Test Agent (MoDTA) entry to enter the URI of your backend. Finally, configure via Site Administration/Security/HTTP Security settings permitting communication with the backend URI and port. The plugin requires the external DTA REST webservice backend.
+Visit Site Administration/Plugins/Plugin Overview and select Settings next to the Moodle Dockerized Test Agent (MoDTA) entry to enter the URI of your backend as shown in Fig. 1. ![Fig. 1: Plugin List](doc/install_conf_1.png) Finally, configure via Site Administration/Security/HTTP Security settings permitting communication with the backend URI and port as seen in Fig. 2. ![Fig. 2: DTA Configuration Dialog](doc/install_conf_2.png) The plugin requires the external DTA REST webservice backend.
 
 Notes: 
 
@@ -59,7 +59,7 @@ With the MoDTA plugin installed and configured backend URI (including Moodle Sec
 
 ### Teacher
 
-When creating an assignment, a teacher can select the MoDTA exercise as a new assignment type via an additional checkbox on the assignment creation page. A new standard file upload field appears and the teacher must upload a text file with the git repository URI containing the tests. The text file has to adhere to the following format also given in the example repository:
+When creating an assignment, a teacher can select the MoDTA exercise as a new assignment type via an additional checkbox on the assignment creation page as shown at the bottom of Fig. 3. ![Fig. 3: Moodle DTA Activation Checkbox](doc/usage_teacher_1.png) A new standard file upload field appears  as indicated in Fig. 4. ![Fig. 4: Moodle DTA Upload File Area](doc/usage_teacher_2.png). There, the teacher must upload a text file with the git repository URI containing the tests  as shown in Fig. 5. ![Fig. 5: Moodle DTA Teacher Text File Upload](doc/usage_teacher_3.png) The text file has to adhere to the following format also given in the example repository:
 
 The text file has to contain the following, each separated by ::
 -	dtt as the URI-type
@@ -76,11 +76,11 @@ Students use the same format, just without the runner part at the end.
 
 ### Student
 
-Students use an additional MoDTA standard file upload field in the standard submission processs in Moodle where they place either a zip archive or a text file adhering to the same format as the teacher’s file with their code repository URI and optionally credentials and/or a ticketing system URI. 
+Students use an additional MoDTA standard file upload field in the standard submission processs in Moodle like in Fig. 6. [Fig. 6: Moodle DTA Student File Upload](doc/usage_student_1.png) There, they place either a zip archive or a text file adhering to the same format as the teacher’s file with their code repository URI and optionally credentials and/or a ticketing system URI as shown in Fig. 7. ![Fig. 7: Moodle DTA Student Text File Upload](doc/usage_student_2.png) 
 
-Upon completion, students see a summarized overview of their test results in an additional column of the submission feedback table. Clicking on a new expansion icon in that column, they reach a detailed feedback dialog including stack traces of compile errors and test failures. Optionally, the MoDTA backend creates tickets for compile failures in the ticketing system under the URI provided by the student upon hand-in.
+Upon completion, students see a summarized overview of their test results in an additional column of the submission feedback table like in Fig. 8. ![Fig. 8: Moodle DTA Submission Result Summay](doc/usage_student_3.png) Clicking on a new expansion icon in that column, they reach a detailed feedback dialog including stack traces of compile errors and test failures as in Fig. 9. ![Fig. 9: Moodle DTA Student Detail Result View](doc/usage_student_4.png) Optionally, the MoDTA backend creates tickets for compile failures in the ticketing system under the URI provided by the student upon hand-in.
 
-Note: Teachers have access to the same Moodle submission view to assess student results. However, teacher control and grading are not the focus of MoDTA.
+Note: Teachers have access to the Moodle submission result view to assess student results. However, teacher control and grading are not the focus of MoDTA.
 
 ### Technical Workflow