Test: Revise Hints and their visibility in manual scoring

1 Initial Problem

Hints are planned to be abandoned (https://docu.ilias.de/go/wiki/wpage_8398_1357) although there are some installations that have a lot of hints on their installations. The problem is that there are "UI elements and conceptual elements missing".

This article tries to provide a detailed instruction on how to save the hints for future ILIAS versions if funding for keeping it is available.

2 Conceptual Summary

Hints are used in the following list of screens:

• Creating a hint
• Working through a test
• Admin view
  • Results->Actions->Testresults
  • Statistics
  • Dropdown: show marked pass overview
• Manual Correction

3 Status Quo in ILIAS 9

• Hints can be either created via TinyMCE or via the ILIAS Page Editor (IPE)
  • While the TinyMCE is pretty slim the IPE requires a lot of clicks in order to create hints and is more complicated
• Hints within the test require an awful lot of clicks, especially when showing IPE hints
• The amount of hints shown is not visible in a lot of result screens

4 New ideas for ILIAS 11

Move hints to Markdown editor

• The TinyMCE is supposed to be abandoned and the IPE is pretty complicated for showing the hints. We would like to do a migration from TinyMCE and IPE elements into the Markdown Editor. We are aware that this is probably not gonna be fully downwards compatible but in our experience hints usually do not need all the features of the IPE
• #todo: It is not clear yet, though, how the migration of old data would work. Essential is probably the table "qpl_hints" which (probably) contains all the hint data. This problem, however, needs to be solved when abandoning tinyMCE. It might be possible to gain knowledge from this work in progress

Move hints from subscreens into the slate

• By making the hints less complicated through the use of the Markdown editor they could be shown in the slate instead of in different subscreens. (see Slide 11/12)

Check where hint statistics are shown and need to be shown

• The amount of hints needs to be shown in the following screens (e.g. m/n hints in every occasion)
  • Results->Actions->Testresults (Columns "Angeforderte Lösungshinweise")
  • Results->Actions->Testresults->Detailed results (m/n hints)
  • Statistics (m/n hints)
  • Statistics->Detailed Statistics (m/n hints)
  • Dropdown: show marked pass overview (m/n hints)
  • Manual scoring by question (new column "Angeforderte Lösungshinweise"), m/n hints
  • Manual scoring by participant (new row "Angeforderte Lösungshinweise"), m/n hints

5 User Interface Modifications

5.1 List of Affected Views

move hints to markdown editor

Status Quo ILIAS 9 of Tiny

Proposal for ILIAS 11 in Markdown

move hints from subscreens into slate

Moving the hints to the slate might look like this

The "*" might for example be used to open the slate which then shows the button "Lösungshinweis anfordern"

check where hint statistics are shown and need to be shown

• The amount of hints needs to be shown in the following screens (e.g. m/n hints in every occasion)
  • Results->Actions->Testresults (Columns "Angeforderte Lösungshinweise")
  • Results->Actions->Testresults->Detailed results (m/n hints)
  • Statistics (m/n hints)
  • Statistics->Detailed Statistics (m/n hints)
  • Dropdown: show marked pass overview (m/n hints)
  • Manual scoring by question (new column "Angeforderte Lösungshinweise"), m/n hints
  • Manual scoring by participant (new row "Angeforderte Lösungshinweise"), m/n hints

The screenshot are in the order of this list. All blue marked rectangles propose the addition of showing the amount of hints that the question offers.

5.2 User Interface Details

{ For each of these views please list all user interface elements that should be modified, added or removed. Please provide the textual appearance of the UI elements and their interactive behaviour. }

5.3 New User Interface Concepts

{ If the proposal introduces any completely new user interface elements, you might consult UI Kitchen Sink in order to find the necessary information to propose new UI-Concepts. Note that any maintainer might gladly assist you with this. }

5.4 Accessibility Implications

{ If the proposal contains potential accessibility issues that are neither covered by existing UI components nor clarified by guidelines, please list them here. For every potential issue please either propose a solution or write down a short risk assessment about potential fallout if there would be no solution for the issue. }

6 Technical Information

{ The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues. }

7 Privacy

{ Please list all personal data that will need to be stored or processed to implement this feature. For each date give a short explanation why it is necessary to use that date. }

8 Security

{ Does the feature include any special security relevant changes, e.g. the introducion of new endpoints or other new possible attack vectors. If yes, please explain these implications and include a commitment to deliver a written security concept as part of the feature development. This concept will need an additional approvement by the JourFixe. }

9 Contact

• Author of the Request: Falkenstein, Rob [rob]
• Maintainer: {Please add your name before applying for an initial workshop or a Jour Fixe meeting.}
• Implementation of the feature is done by: {The maintainer must add the name of the implementing developer.}

10 Funding

If you are interest in funding this feature, please add your name and institution to this list.

• …

11 Discussion

12 Implementation

{ The maintainer has to give a description of the final implementation and add screenshots if possible. }

Test Cases

Test cases completed at {date} by {user}

• {Test case number linked to Testrail} : {test case title}

Privacy

Information in privacy.md of component: updated on {date} by {user} | no change required

Approval

Approved at {date} by {user}.