Show Advanced KnowledgeHide Advanced Knowledge

Schema for Headlines

1 Initial Problem

The current schema for Headlines in ILIAS is skewed:

• It has holes because it lacks h2. The hierarchy is bogus. 
• The headlines' presentation do not convey their respective importance visually. 
• There are too many headlines. 

H1

• Title of Container, if inside the object
• Title of object if inside the object
• Title of Page of Learning Module if inside the Learning Module

H2 

• Breadcrumb
• Tab
• Sub-tab

H3 

• Item Group in the List GUI 
• Little entries in all-caps on Info-tab and in Forms
• Headlines of Side Panels

H4

• Entries in List GUI 

H5 

• Entries in Tiles

H6 

• Only used in Calendar

Questions / Issues 

• What is now H2 is actual navigation, this should get appropriate aria landmark roles and no longer be a headline. 
• Why are accordions not H3?
• List Gui and Tile GUI should be treated the very same.

 
Nicely documented and systematic headine schemes and / or typography concepts are for example: 
Firefox Typography ist schön systematisch hergeleitet

• Firefox Typography
• Atlassian Typography
• Atlassian Grid

2 Conceptual Summary

Rules

We need to get an accessible headline schema. 

• The headings should allow for overview and not create noise. 
• If it is a visually-whole section is not a control then it MUST have a heading to act as a label. 
• This requirement was heavily disputed:
  • There MUST be exactly one single h1 level per page. This is not neccessarily the first element. 
  • There can be more than one H1 level per page. 
• Nesting MUST not have holes in it like h3 following h1 or h5 following h3 . 
• The Breadcrumb does no longer bearing a h2 and thus h2 is freed up for use. 
• Same UI-Elements MUST have the same headline level throughout ILIAS.

Headlines for specific UI-Elements

H1

• Title of Container, if inside the object
• Title of object if inside the object

H2 

• Standard Panels
• Item Group in the List GUI 
• Headlines Info-tab and in Forms
• Question title in Test 
• Glossary Terms
• Year Titles in Blogs
• Headlines in Forms

H3 

• Primary Sub-Panels
• Accordeon titles 

H4 or ARIA Role Complementary 

• Headlines of Side Panels 
• Question List in Test 

H5 and H6

• no longer needed

No longer headlines / Not headlines

• Entries in List GI and Tile Lists are no longer headlines
• Comments are no longer headlines
• Metabar and Mainbar are not headlines

Open Issues

There are some amphibiums like "content elements in slates", these are in a way navigational and in an other way content. 
For these specific elements we think slate content should be allowed to bear headlines. 

3 User Interface Modifications

3.1 List of Affected Views

All

3.2 User Interface Details

Headlines

3.3 New User Interface Concepts

Headline 1 - 5 

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: Tödt, Alexandra [atoedt]
• 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

Schmidt-Sielex, Wolfgang [WSS] 2023-07-20: Feature has been discussed by a sub-group of SIG accessibility and set to 'outdated'. A solution has already been implemented while solving Mantis bugs. Minor issues regarding the headings might still show up from time to time but are reported in Mantis and handled there.

8 Implementation

The improvements for the headline schema are provided by the following pull requests:
Was dealt with in Bug 27327

Test Cases

Test cases completed at {date} by {user}

• {Test case number linked to Testrail} : {test case title}

Approval

Approved at {date} by {user}.

---