Feature Wiki

Information about planned and released features

Tabs

Introduction of Versioning Service

This feature request is part of the initiative for an [[[Project] Improved test question sharing]]. A first implementation of this service would be Versioning Support in Test Questions.

1 Initial Problem

There is the need for a general concept in ILIAS for versioning resources. We have already versioning in some modules, e.g. the file object counts versions of files - but in a very special way[1]. Versioning is needed also for test questions. Using test item statistics and reviews requires a method to distinct versions of a question. Version numbers would also be highly appreciated when sharing content and trying to identify which version of a resource is used by a third party.

2 Conceptual Summary

A general versioning service should be introduced. This service could be implemented by any module that should support versioning.

  1. Version numbers should be incremented linear without branching and subnumbers, starting with '1'.
  2. The versioning service should provide information for a 'History' screen that could be implemented by each component as a sub-tab. The provided information includes all existing version numbers, their date of creation and the name of the user that created a new version. This information can be extended by each component.

3 User Interface Modifications

3.1 List of Affected Views

{Please list all views (screens) of ILIAS that should be modified, newly introduced or removed.}

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

3.3 New User Interface Concepts

{If the proposal introduces any completely new user interface elements, please provide a link to separate feature wiki entries for each of them according to the kitchen sink template.}

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 Contact

  • Author of the Request: Kunkel, Matthias [mkunkel]
  • 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.}

6 Funding

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

  • ...

7 Discussion

Kunkel, Matthias [mkunkel]&Heyser, Björn [bheyser]&Neumann, Fred [fneumann], April 26, 2017: Today, we discussed this suggestion and we agree with a clear distinction between the service and its implementation in the different components (e.g. test question pool).

  • The service should offer a UI element that can be used by every component to display the current lifecycle status under the item's description (similar to 'Offline' status information in courses).

Workshop at June 23, 2017 with Heyser, Björn [bheyser], Neumann, Fred [fneumann] and Kunkel, Matthias [mkunkel]: In our VC meeting today we discussed the current concept for Introduction of Lifecycle Service and the comments made in and since (see wiki page) the last Jour Fixe. We decided to postpone both requests for general services due to missing time for completing a sound concept and implementation, see comments in Introduction of Lifecycle Service.

8 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}

Approval

Approved at {date} by {user}.


[1] One can choose between uploading a new versions and keep the old one or remove the old one. If the old one is removed, the number is set back to 1.

Last edited: 18. Oct 2024, 15:32, Kunkel, Matthias [mkunkel]