Feature Wiki

Information about planned and released features

Tabs

ListGUI Guideline

Page Overview

1 Guideline
2 Status
3 Components that are not compliant with the Guideline
4 Discussion

1 Guideline

Based on Mantis report 12578 "Reduce clutter in description texts of ListGUI" I suggest to

Abstain from showing key-value pairs in the description of objects and use only the value with a good and self-explaining text. Key-value pairs should only be used if really necessary.

The aim of this guideline is to reduce visual clutter and to show just the information that is needed

The following table shows existing types of description texts and how they should change:

Kind of information	Examples of current presentation	Suggested presentation
Object description	Plain text	- no change required -
Offline status	"Status: Offline" (in red)	"Offline" (in red)
Changed inside	"Changed inside"	- no change requirede -
Registration Period	"Registration Period: No Registration Possible"	"No Registration Possible"
Availability	"Availability: 22. Oct 2012, 12:27 - 12. Dec 2014, 00:00"	"Available from {start date} until {end date}"
Learning Progress	"Learning Progress: {Pöppel}"	{Pöppel}
Preconditions	"Preconditions that need to be fulfilled to access this object: » Show"	"Show preconditions" (when opened: "You have to fulfill n of the following preconditions to access this object:")
Tags	"Tags: 4.5 course hundekuchen leifos release"	"4.5 course hundekuchen leifos release" and give tags a style to make them easily identify as tags (e.g.: background colour and slightly rounded corners)

2 Status

Effective from release: Release 5.0
Approved by Jour Fixe at: JourFixe-2014-11-24
Implementation status: needs implementation
Funding for streamlining existing features: { name of organisation }
Implementation of guideline: all developers

3 Components that are not compliant with the Guideline

4 Discussion

JF 24 Nov 2014: We support the idea to hide "keys" in key/value pairs if possible. Keys should only be used, if the meaning of the values alone is unclear. This should become a guideline in the DEV guide.

We worked through Matthias list and agreed to most of the points except:

We keep "Availability" as it is.
For the tags we would need a mockup and an implemented style, before we can remove the key.

Please continue to work through the list of properties as collected by Jörg on the Improving ListGUI page.

Matthias Kunkel, 03 Dec 2014: Please have a look at the following screenshot. I have modified the presentation of tags for category "Dateien" as follows:

font-size:90%;background-color:#7BB4E2;color:#FFFFFF;margin-right:2px;padding:1px 2px;border-radius:3px;

Of course, we can discuss about the background-color. But I didn't found a suitable one in our colour scheme.

JF 8 Dec 2014: Alex will introduce a style class for this purpose. We will try out some alternatives.

Improved presentation of tags in ListGUI

Last edited: 13. Jan 2015, 12:35, Kunkel, Matthias [mkunkel]