Extend System Styles

This Feature is an extension of the existing KS: Integration in Layout and Styles feature, which has been implemented for 5.3.

1 Initial Problem

The Integration of the KS into Layout and Styles offers the possible to create and change system styles in the ILIAS front end and offers a ways to visualize items of the KS directly in ILIAS.

Several potential very useful features are yet missing, especially to make the KS more accessible to less involved people:

• Delos Skin needs read only mode. If you do not have any custom skins created, you have no chance to see the available less variables, icons and KS documentation. You also will not be aware, that such options even exist. That needs to be changed.
• Read Access: Read access is currentyl incomplete. One with read access sees only the table listing system styles, but not their less-variables and icons as well as the documentation. 
• Perma Links: Currently it is not possible to directly link to some specific KS article by using a perma link.

2 Conceptual Summary

• All KS-Entries in all Styles get a Perma-Link at the bottom of the page. Those entries will be accessible with this perma link. 
• Those KS-Entries will be accessible for Users with only the "Read" Permission for the Administration and the "System Styles".
• There will be a read only mode showing only the documentation for System Styles.

3 User Interface Modifications

New Action "Open Documentation" for all styles (including delos):

Read only mode of the documentation:

Note the absence of tabs and the breadcrumb in this mode (set if user those not have the permission to actually edit system styles settings, only read them). Also note the permalink at the bottom of the screen (also visible in the regular mode).

3.1 List of Affected Views

The following views will be affected:

• Administration -> System Style -> Overview
• Administration -> System Style -> Open Documentation

3.2 User Interface Details

3.3 New User Interface Concepts

None. 

4 Technical Information

There are two major points to be noted:

• goto.php will get a new case to handle the system styles goto-logic. Note System Styles are part of the administration and so far no administration items offer a goto link. 

1
2
3
4

case 'stys':
		require_once('./Services/Style/System/classes/class.ilSystemStyleMainGUI.php');
		ilSystemStyleMainGUI::_goto($target_id,$additional);
		break;

• The ilAdministrationGUI should allow the access for users with only read access (not visible) to open those links. Currently it does not allow this by checking for visible rights in the execute command.

1
2
3
4
5
6

Change:
-		if(!ilMainMenuGUI::_checkAdministrationPermission())
To:
+		if(!$rbacsystem->checkAccess("read", SYSTEM_FOLDER_ID))
 
In execute command of ilAdministrationGUI

5 Contact

• Author of the Request: Amstutz, Timon [amstutz]
• Maintainer: Amstutz, Timon [amstutz]
• 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.

• University of Bern

7 Discussion

JourFixe, ILIAS [jourfixe], August 28, 2017: We highly appreciate the suggestion to have an easy access to the Kitchen Sink documentation. We schedule this feature for 5.3. We only raise an error in the executeCommand function if neither visible nor read permission is given.

8 Implementation

The Feature was implemented as shown in the section: "User Interface Modifications".

Test Cases

Test cases completed at 28.08.2017 by Amstutz, Timon [amstutz]

• 18793 : Permalink anzeigen 
• 18795 : Permalink aufrufen
• 18797 : Dokumentation für "Delos" öffnen

Approval

Approved at 28.8.2017 by Amstutz, Timon [amstutz].