Feature Wiki

Information about planned and released features

Tabs

Include Media Files in Test Archive

Page Overview

[Hide]

1 Initial Problem

Media files (images, videos) included in test questions are only added to the PDF exports of test runs created with the TestArchiveCreator plugin. This makes the PDF generation for test archives mandatory when it comes to exams.

2 Conceptual Summary

2.1 RFC 2119

In order to provide a clear understanding of the importance/relevance of a requirement we use the following keywords as described in RFC 2119:

  • MUST, MUST NOT
  • REQUIRED
  • SHALL, SHALL NOT
  • SHOULD, SHOULD NOT
  • RECOMMENDED
  • MAY
  • OPTIONAL

  • Media files from ILIAS must be added to the ZIP archive created by the plugin
  • Media files from ILIAS are saved to a subfolder "assets" with a unique ID, i.e. ./assets/UID_of_myimage.png
  • Links to media files/images saved in ILIAS in HTML export files reference the local assets path, i.e. "<img src="assets/uid.png" alt="My Image" title="My Image">"
  • Media files from external sources (i.e. YouTube Videos) should not be included and not saved under "/assets"
  • Media files from external sources should be referenced in the HTML files, ie. "<img src="https://www.youtube.com/watch?v=aqz-KE-bpKQ" alt="Big Buck Bunny YT Video" title="Big Buck Bunny YT Video">"

On external media / files:
It stands to reason that external media files should not (must not?) be used in e-exams, because we are not responsible for external content and have no way of making sure the content will be available during the exam unless we host it ourselves.

3 User Interface Modifications

3.1 List of Affected Views

None.

3.2 User Interface Details

None. Images/media files must be exported always, so there is no need to change configuration masks/views with the plugin.

3.3 New User Interface Concepts

None.

3.4 Accessibility Implications

None.

4 Technical Information

This feature should be combined with a refactoring/migration to the new IRSS.

Currently the plugin calls the question GUI and generates the HTML files. The base tag for files/media files links the files on the server and transfers that information to phantomjs for PDF generation. The PDF generation then gets the files from the server. We'd need to either:

  • check how the question GUI adds images to HTML and build on that,
  • parse the HTML and locally save the images.

Problem: How do we handle external (not saved in ILIAS) files/media, i.e. YouTube videos?

5 Privacy

No personal data is processed in the context of this feature.

6 Security

No security implications.

7 Contact

  • Author of the Request: Sesterhenn, Fabian [sesterhenn]
  • 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.}

8 Funding

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

9 Discussion

Sesterhenn, Fabian [sesterhenn] 26. April 2023: The coordination group for the TestArchiveCreator plugin discussed this feature tody. The maintainer will provide a rough quote on how much effort / time this feature will take until end of May. Before implementing this feature we would like to gather feedback from the members of the SIG EA. Implementation could start in 2024 (for ILIAS 9) depending on funding. TH Köln is still interested in funding this feature.

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

Last edited: 3. May 2023, 15:03, Rabah, Rachid [rabah]