Important Information for File Object

1 Initial Problem

No work instruction can be added to a file. This would currently have to be stored outside the file object in ILIAS or - if the file type allows it - inside the file to be downloaded. In some cases, however, it may be useful if users can see the work instruction (or other important information) and download the file directly on the same page (Info Page).

2 Conceptual Summary

• There is a new field “Important information” in the settings tab of a file
• The field uses the new Markdown Input to format the text
• The work instructions will be displayed on top of the info screen (and in the kiosk mode of LSOs)
• If the field is not filled, no important information will appear on the info page
• the download-button will be replaced by the new Launcher - this will take place BELOW the inportant information (or on top, if this field is not used)

3 User Interface Modifications

3.1 List of Affected Views

• file » settings
• file » info page

3.2 User Interface Details

3.3 New User Interface Concepts

Markdown Input is to be used: https://github.com/ILIAS-eLearning/ILIAS/pull/5152

3.4 Accessibility Implications

In this feature, only existing UI components are used, and the accessibility is derived from them. 

4 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. }

5 Privacy

This feature does not collect, store or process any new user-related data. It still applies: PRIVACY.md  

6 Security

The implementation of this feature does not create any new attack vectors. 

7 Contact

• Author of the Request: Seibt, Alina [alina.seibt], Hochschule Bielefeld
• Maintainer: Schmid, Fabian [fschmid]
• Implementation of the feature is done by: Zehnder, Lukas [lzehnder]

8 Funding

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

• Hochschule Bielefeld

9 Discussion

Kunkel, Matthias [mkunkel], 06 JUN 2023: I am not very happy with the label 'Work Instructions'. It reduces the use of this field of information on a very specific purpose. Why not using a more general label (that is also known from course and group): 'Important Information'.

An alternative solution would be to offer an additional text input for the label. This would satisfy all needs.

And a final recommendation: when implementing this feature, please already consider that an additional feature request to make this text multilingual will come sooner or later. 

JourFixe, ILIAS [jourfixe], 26 JUN 2023 : We highly appreciate this suggestion and schedule the feature for ILIAS 9. We consider the use of the launcher on the Info screen as a special case (compared to its use in T&A or other components in the future. Unlike these other components, the File object does not have a 'Content' tab (at least at the moment - as there are plans to add one later to allow straight editing of files within ILIAS). And please use a distinct lang var for 'Important Information'. This would allow admins to change the label according to their needs on their proper system.

10 Implementation

The feature has been implemented as described.

Test Cases

Test cases completed at 05/09/2023 by Schmid, Fabian [fschmid]

• C63458: Wichtige Informationen hinzufügen 
• C63459: Wichtige Informationen entfernen

Privacy

Information in privacy.md of component: no change required

Approval

Approved at 02 OCT 2023 by Kunkel, Matthias [mkunkel].