diff --git a/Dokumentation_TestOverview.pdf b/Dokumentation_TestOverview.pdf new file mode 100644 index 0000000..92d7afc Binary files /dev/null and b/Dokumentation_TestOverview.pdf differ diff --git a/LuceneObjectDefinition.xml b/LuceneObjectDefinition.xml deleted file mode 100755 index a663736..0000000 --- a/LuceneObjectDefinition.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 593d61a..504de98 --- a/README.md +++ b/README.md @@ -1,14 +1,78 @@ # TestOverview -The main goal is to make accumulating test results from multiple tests in arbitrary locations a lot more convenient. These test should be configurable in the test overview object; RBAC should be applied in the usual way, ie. a lecturer can only select his own tests/tests he or she has access to for inclusion in the overview. (The test overview should not be "hierarchical" object that has to "contain" the test it accumulates like a folder or category.) +The main goal is to make accumulating results from multiple tests and exercises in arbitrary locations a lot more convenient. These test should be configurable in the test overview object; RBAC should be applied in the usual way, ie. a lecturer can only select his own tests/tests he or she has access to for inclusion in the overview. (The test overview should not be "hierarchical" object that has to "contain" the test it accumulates like a folder or category.) -The overview itself should present a table matrix of users (rows), test (end) results (percentages; columns) and a final mean value column. The matrix fields should have different background colors for passed (green), not passed (red) and perhaps not finished (yellow) retaining white for no results (yet). +The overview itself should present a table matrix of users (rows), test/exercise (end) results (percentages; columns) and a final mean value column. The matrix fields should have different background colors for passed (green), not passed (red). It remains white if no grade is given. TestOverview also presents a graphic view of the test and exercise results in form of column diagram. For exporting the results into another program TestOverview is able to generate a comma-separated values file which covers all results from added tests and exercises. ## Installation Instructions 1. Clone this repository to /Customizing/global/plugins/Services/Repository/RepositoryObject/TestOverview + + 1.1 Go to ilias root directory: + + ```bash + 1.2 mkdir -p Customizing/global/plugins/Services/Repository/RepositoryObject/ + 1.3 cd Customizing/global/plugins/Services/Repository/RepositoryObject/ + 1.4 git clone https://github.com/Ilias-fmi/TestOverview.git + ``` + 2. Login to ILIAS with an administrator account (e.g. root) 3. Select **Plugins** from the **Administration** main menu drop down. -4. Search the **TestOverview** plugin in the list of plugin and choose **Activate** from the **Actions** drop down. +4. Search the **TestOverview** plugin in the list of plugin and choose **Update** and **Activate** from the **Actions** drop down. + +## Manual + +This manual shows the main functions of the plugin and explains how to use them. + +### Importing Test/Exercieses +Go to the tab **Test Administration** and click on **Add tests to Overview** + +![Picture not available](https://raw.githubusercontent.com/Ilias-fmi/TestOverview/ReadMe_update-1/readMe/TestImport.png) + +Select your tests and click **Select** + +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_update-1/readMe/TestImport2.png) + +The results are now visible in the subtab **TestOverview**. + +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_update-1/readMe/TO_table.png) +### Test/Exercise Diagrams + +With TestOverview it's possible to create diagrams of the average results. For a test-diagram go to the subtab **Diagram** in the tab **TestOverview**. + +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_update-1/readMe/TestDiagram_mit_pfeil.png) + +For an exercise-diagram you have to enter a granularity. If the granularity is too small the diagramm is set to 100 buckets as a maximum size. Click on **Make my Diagram** to render it. + +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_update-1/readMe/exerciseDiagram.png) +### Export + +The export window of TestOverview looks like this. +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_update-1/readMe/export.png) +It provides two generic ways to export the results of added tests and exercises; *reduced* and *extended*. + +The first entries of the resulting comma-seperated values file contain in each case the **names of the students** (lastname, firstname), their **matriculation number** (this is a field especially for the usage at University of Stuttgart), the **groups** they are members in (in the course the TestOverview object lies in), their **email-address** and **gender**. + +The first case, the **Reduced Format** lets the user export the *final* test- and exercise results of all users that participated in the added tests and exercises. + +The second case, the **Extended Format** additionally exports the results for all **subquestions** from tests and **assignments** from exercises. + +### Permissions Management +Course administators maybe need the right to **Create a new TestOverview Object**. +Repository>>Course>>Permissions->Create new Objects->TestOverview. +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_Bene/readMe/AdminTestOverviewPermissons.png) +To use the full range of functions, you need to make sure to manage the permissions for the users. +People that should be able to see the course results should be granted **Write Permissions**. +The people that should only have insights in their own summarized results should be granted **Read Permissions**. + +This can be done in the TestOverview Object under Permissions>>Course Administrator/Member/Tutor + +![Picture not available](https://github.com/Ilias-fmi/TestOverview/blob/ReadMe_Bene/readMe/Permissions.png) + +### User Panel +The user panel is for students to lookup their results. The window shows total and average results of tests and exercises and the total rank of the student. It also gives a list of every test and exercise and the related result. By marking the results with color it shows if the exercise/test is passed or failed (green = passed / red = failed). + + +![Picture not available](https://raw.githubusercontent.com/Ilias-fmi/TestOverview/ReadMe_Bene/readMe/studView.png) ### More Information -[Ilias Feature Wiki Entry](http://www.ilias.de/docu/goto_docu_wiki_1357_Test_Overview.html) \ No newline at end of file +[Ilias Feature Wiki Entry](http://www.ilias.de/docu/goto_docu_wiki_1357_Test_Overview.html) diff --git a/README.php b/README.php new file mode 100755 index 0000000..80c0565 --- /dev/null +++ b/README.php @@ -0,0 +1,75 @@ +This directory holds all customized files for this ilias installation. + +On the top level two directories may be created: /Customizing/global for global +changes and /Customizing/clients for changes that should be applied to clients. +The clients directory holds a subdirectory for each client: +/Customizing/clients/ +At the time being, only user agreements can be offered for clients! Customized skins and languages are only supported globally. + + +1. User Agreements + +User agreement texts are stored within html files. They can be defined globally +for all clients or on a client level. + +Global user agreements: +/global/agreement/agreement_.html +E.g. /global/agreement/agreement_fr.html + +Client specific user agreements: +/clients//agreement/agreement_.html +E.g. /clients/default/agreement/agreement_fr.html + + +2. System Language Changes + +You may change terms used in the user interface of ILIAS. To do this, use the +same format as is used in the language files in directory /lang. Store the +values to be overwritten in files ending with ".lang.local" and put them into +the /global/lang directory. Client specific changes are not supported yet. + +/global/lang/ilias_.lang.local +E.g. /global/lang/ilias_en.lang.local + + +3. Skins and Styles + +Skins are applied through changes of HTML template files that are stored in the +/skin directory. Currently they can be defined only globally. + +/global/skin//tpl.xxx.html + +The skin directory must include a template.xml description file, example: + + +