Feature Wiki

Information about planned and released features

Tabs

Introducing Table of Contents

1 Summary

ILIAS should provide a reusable Table of Contents UI component that presents an automatically generated, collapsible overview of the visible hierarchy in a suitable context. It will be opened in the Slate through a context-specific trigger and allow users to inspect and navigate the available structure without leaving the current context.

2 Problem Statement

ILIAS contexts can contain nested containers, content objects and other entries. Users often cannot see the overall structure of a context without opening several levels, which makes orientation and content discovery unnecessarily difficult.

The current view of a context typically shows only the current level of the repository hierarchy (without any sort of navigational help, except the very technical Tree View). To understand the overall content structure, users must open containers one by one and repeatedly move forward and backward through the hierarchy.

This makes the following tasks unnecessarily difficult:

  • Understanding which content exists inside a context
  • Finding out whether a particular resource, activity or container is available
  • Returning to a previously seen entry
  • Navigating directly to a deeper entry
  • Identifying the relationship between an entry and the section or container in which it is located
  • Gaining an overview after entering an unfamiliar context
  • Accessing content efficiently on smartphones and tablets

A recent large-scale needs assessment identifies navigation and content discovery as major usability issues in ILIAS. Better and more intuitive navigation was the most frequently requested improvement, while respondents additionally reported difficulties finding content, particularly in deeply nested structures. The open-ended feedback confirms a need for clearer overviews and clearer navigation paths. These issues are especially relevant for mobile use, as smartphones and tablets are widely used and navigation is rated less favourably on smartphones.

Existing mechanisms do not sufficiently solve the problem:

Existing mechanism

Limitation

Current content page

Shows only the current repository level, not the wider content structure

Breadcrumbs

Show the path to the current object but do not provide a compact overview of available content

Repository Tree

Can become visually complex, is not clearly understood as a navigation aid and is unsuitable as the primary orientation mechanism

Search

Helps only if users know what to search for; users report that search is not sufficiently reliable or intuitive

Browser navigation

Depends on previous user actions and does not provide a structural overview

A table of contents should therefore provide a compact, context-specific overview of the visible hierarchy inside the current context. It should reduce the amount of exploratory clicking required to understand the available content without replacing search, breadcrumbs, global navigation or existing administration functions.

3 Concept

3.1 Core Idea

ILIAS should provide a reusable Table of Contents UI component. The component presents an automatically generated overview of the structure available in a given context. It reflects the existing hierarchy of that context and enables direct navigation to visible and accessible entries.

The component is not a second, manually maintained navigation structure. It is generated from the actual structure of the respective context and automatically reflects changes made by users with appropriate permissions.

The proposed feature answers a context-specific user question:

What content is available in this context, and where is it located?

This distinguishes it from a global repository navigation, which addresses a different question:

Where am I in the repository, what is above this object, and how can I move through the wider repository structure?

Courses and groups would most definitely benefit most from this component, because they are the places where learning environments most commonly start or take place. They often contain numerous and deeply nested objects, making structural orientation and content discovery particularly important. Therefore, courses and groups could be the first contexts in which the component is applied.

3.2 Entry Point and Placement

The table of contents should be triggered from the context in which it is used. It must therefore not be placed exclusively under a generic “Tools” category in the Main Bar. “Tools” is not a meaningful or expected category for a content overview. Users looking for an overview of the current context are likely to look at the context itself, especially near its title, a sticky (float) button or a dedicated main menu entry, rather than under a global collection of technical functions.

The entry point should use a clear text label, for example:

  • Content Overview
  • Contents
  • Table of contents

The final label should be selected and validated through usability testing and language experts. 

The interaction pattern can be compared to Wikipedia’s table of contents: when the overview is not persistently visible, it remains accessible through a clearly associated control near the page title. The user can expand the overview when orientation is needed and collapse it again by button when the main content area should receive full attention.

Activation Settings

The availability of the table of contents should be configurable. Administrators should be able to activate or deactivate the table of contents for the respective context in its settings. When the table of contents is deactivated, the Contents trigger must not be displayed and the table of contents must not be accessible in the affected context.

The setting should be clearly labelled, for example:

  • Enable table of contents

The default behaviour and the exact scope of the setting - for example, whether it is available per context, per object type or installation-wide—should be defined during concept and implementation.

3.3 Slate-Based Presentation

Activating the table-of-contents trigger opens the Slate containing the structure of the current context.

The Slate is appropriate because it:

  • Keeps the user in the current context
  • Does not require navigation to a separate overview page
  • Allows users to inspect the hierarchy without losing their current entry or scroll position
  • Provides a responsive space for hierarchical information
  • Can adapt to desktop, tablet and smartphone layouts
  • Can be closed quickly after the user has selected a target entry or regained orientation

The component should use progressive disclosure rather than rendering all nested levels at once (if possible or advisable). The initial view should show the top-level entries of the current context. Containers can be expanded to reveal their contents.

This avoids recreating a complete, permanently visible repository tree. The table of contents should support orientation, not overwhelm users with every possible branch of a complex structure.

3.4 Content Structure

The table of contents should reflect the actual, visible hierarchy inside the currently opened context.

It should include all relevant and accessible entries. The exact display treatment for individual entry types may be refined during implementation. The basic principle is that users should receive a coherent overview of the structure, regardless of how the content has been organised.

The table of contents should preserve the established order of the underlying context. It must not introduce a separate or competing sorting logic.

3.4.1 Headings and Object Blocks

The concept should also consider headings as structural elements. Similar to the table of contents in the ILIAS Wiki, headings can group consecutive objects into meaningful sections, such as Course information, Week 1, Learning materials or Assignments.

Where headings are used in a context, the table of contents should display them as distinct structural entries and group the following entries beneath them until the next heading of the same level. This would make flat or only lightly nested structures easier to scan without requiring containers for every thematic block.

Headings and container objects serve different purposes:

Element

Function in the table of contents

Heading

Groups related consecutive objects on the same level

Container objects

Can be opened and may contain child objects

Content object

Opens the respective resource or activity

The feature should work without headings, but should improve the overview where course authors use them. The exact handling of multiple heading levels and object blocks can be refined during concept and UI development.

Contents Mock-Up
Table of Content Mock-up

3.5 Navigation Behaviour

Each entry in the table of contents represents an existing repository object.

For content objects, selecting the entry opens the object directly.

For container objects, users need to be able to distinguish between two actions:

  1. Open the container object itself.
  2. Reveal the objects contained inside the container.

This distinction is important because a container may have its own view while also containing deeper levels of content.

The proposed interaction model is:

Element

Interaction

Result

Object title

Select or activate

Opens the selected object

Separate disclosure control

Select or activate

Expands or collapses the object’s child items within the Slate

Close control

Select or activate

Closes the Slate and returns focus to the trigger

The disclosure control should use an understandable visual indicator, such as a chevron. The title and disclosure control must remain separate interactive targets. Clicking a container title must not unexpectedly expand it when users intended to open the container itself.

3.6 Current Location

When users are currently inside a nested entry belonging to the displayed context, the table of contents should indicate that entry and its path within the current context. For example, when a user is viewing an exercise located in a nested folder, the table of contents should make the relationship visible.

The current entry should be visually distinguishable and programmatically identifiable. Parent entries along the path should be expanded or otherwise clearly represented, so users can understand where the entry is located inside the current context. The component should not use colour as the only indicator of the active entry or active path.

3.7 Permissions

The table of contents must reflect the user’s effective permissions. Users must see only objects they are permitted to access. The table of contents must not disclose object titles, metadata or structural information about inaccessible content.

Where objects are hidden because of permissions, the table of contents should remain structurally understandable for the visible content. It must not create links to inaccessible objects or misleading representations of the available structure.

3.8 Relationship to Existing Functionality

The feature complements existing navigation mechanisms:

Existing functionality

Relationship after implementation

Context content page

Remains the primary view for the respective context; the table of contents adds a structural overview

Breadcrumbs

Remain a compact path-based orientation aid; the table of contents provides an explorable overview within the container

Global repository navigation (see FR)

Remains responsible for repository-wide orientation and movement to parent contexts; the table of contents is limited to the current context

Repository Tree

May remain available for specialised purposes; the table of contents provides a clearer, contextual alternative for members

Search

Remains useful for known items and text-based discovery; the table of contents supports browsing and structural orientation

This Feature Request is especially closely related to, but distinct from, the proposed Feature Request Introducing Global Navigation.

Feature

Main purpose

Scope

Global repository navigation

Orient and move through the repository, including parent levels and cross-container context

Entire accessible repository

Table of Contents component

Show the contents of the current context at a glance

One defined context

The table of contents component answers:

What content exists in this specific context?

The global navigation answers:

Where am I in the repository, how do I move upwards, and what can I explore from here?

Both features should use compatible interaction principles and possibly shared UI components. They should not be merged into one feature because their context, scope and user expectations differ.

Additionally: In parallel, the breadcrumb component should be modernized. Even small CSS adjustments (see discussion) could align its visual representation with current industry standards and best practices, as documented in the analysis.

Edit: This FR has been approved and will be implemented with ILIAS 12.

3.9 Impact on Existing Workflows

The component does not require administrators to create, curate or maintain an additional navigation structure.

Administrators continue to create and order content as they do today. The table of contents updates automatically based on the existing hierarchy and object order. Users gain an additional way to inspect and navigate the current context. Existing entry points, direct links, bookmarks and workflows remain valid.

The component must not alter the underlying repository structure, object permissions, URLs or existing object-specific navigation.

4 User Interface Modifications

4.1 List of Affected Views

View

Breadcrumb / Context

Modification

Object view

Repository › … › Object

Add a context-specific "Contents" trigger near the container title; provide a Slate-based course table of contents

Nested object inside current object

Repository › … › Object › … › Object

Ensure the table of contents can indicate the active object and its path within the Object

Slate: table of contents

Opened from container view

Introduce a Slate view containing a collapsible, hierarchical navigation structure

Object view

Object in narrow viewport

Present the same trigger and Slate content in a responsive mobile layout

4.2 User Interface Details

4.2.1 Object title/content area

A new trigger is added near the title of the context object, in the main menu or as a sticky (float) button.

The trigger is displayed only when the table of contents is activated for the respective context. If the table of contents is deactivated, no Contents trigger is shown.

The trigger should be a text-based button. An icon should be included, but it should not replace the text label. Testing for small screen sizes may be necessary, whether a text-based button is meaningful.

4.2.2 Table-of-contents Slate

UI element

Textual appearance

Behaviour

Slate heading

[Object title]; optionally followed by "Contents"

Identifies the container whose hierarchy is currently displayed

Container entry

Object title

Opens the selected container object

Content entry

Object title

Opens the selected object

Disclosure control

Chevron

Expands or collapses visible child objects

Current-location indicator

Textual and visual indication, e.g. [Current location] where appropriate

Identifies the currently opened object within the table of contents

Close control

Close

Closes the Slate and returns focus to the original Contents trigger

Loading indicator

Loading contents…

Indicates that a hierarchy level is being retrieved

Empty state

No visible contents are available in this course/group.

Communicates that no visible objects exist for the current user

Error state

Contents could not be loaded. Try again.

Provides an understandable error message and retry action

4.2.3 Visual hierarchy

The hierarchy should be represented through a combination of:

  • Indentation
  • Expand/collapse controls
  • Object titles
  • Optional object-type icons
  • State indicators
  • A clearly marked current object

Object-type icons are optional and must be supplementary. The hierarchy and object type must remain understandable through text and semantics.

4.3 New User Interface Concepts

The Feature Request introduces a new, reusable Table of Contents UI component.

The table of contents is opened in a Slate through the Contents trigger in the course or group title area. It uses the Expandable Tree component from the UI Kitchen Sink to display the hierarchy of the current course or group. The Expandable Tree is suitable because it can represent shallow nested structures while allowing users to expand or collapse individual branches. It should display the existing hierarchy of visible course or group content, including headings, object blocks, folders, sessions and other repository objects.

Object titles open the respective object. Separate expand/collapse controls reveal or hide child objects. The current object and its path are marked where applicable.

The component is limited to the current context and does not replace the repository tree.

4.4 Technical Aspects

The table of contents retrieves the visible hierarchy below the current context. It must preserve the existing order, respect permissions and visibility settings, and support nested containers, headings and object blocks. For large structures, child levels may be loaded when a tree branch is expanded. If the current entry is nested, its parent path should be available when opening the table of contents.

The feature is additive: it does not change existing URLs, permissions, structures or ordering, and it requires no content migration or additional maintenance by administrators.

The table of contents must respect the activation setting of the respective context. When it is deactivated, the component, its trigger and any related data retrieval must not be made available in the affected context.

5 Non-Functional Implications

5.1 Security

{ Does the feature include any special security relevant changes, e.g. the introducion of new endpoints or other new possible attack vectors. If yes, please explain these implications and include a commitment to deliver a written security concept as part of the feature development. This concept will need an additional approvement by the JourFixe. }

5.2 Privacy

{ Please list here all personal data that will need to be stored or processed to implement this feature. For each date give a short explanation why it is necessary to use that date. Use the Privacy Guidance for Feature Requests to fill out this section correctly. }

5.3 Accessibility Implications

The feature introduces a new hierarchical navigation component. Its accessibility must therefore be explicitly designed and tested.

Potential issue

Required solution

Users may not understand expandable hierarchy controls

Use clear text labels and accessible names such as Show contents of [title] and Hide contents of [title]

Opening and expanding a container are different actions

Provide separate interactive controls with separate accessible names

Current location may be communicated only visually

Provide programmatic indication of the current object and active path; do not rely on colour alone

Slate interaction may cause focus loss

Move focus predictably into the Slate when opened and return it to the trigger when closed

Deep structures may be difficult for screen-reader users

Communicate level, expanded state and relevant hierarchy context semantically

Small controls may be difficult on touch devices

Ensure sufficiently large target sizes and spacing

Long titles may overflow in narrow viewports

Support text wrapping, truncation with access to full text, and responsive reflow

Lazy loading may be invisible to assistive technology users

Announce loading, completion and error states programmatically

Keyboard users may become trapped in the Slate

Ensure logical tab order, Escape/close behaviour and reliable focus return

The implementation should be tested with:

  • Keyboard-only use
  • Screen readers
  • Browser zoom and text enlargement
  • Responsive reflow
  • Different devices and screen sizes
  • Deeply nested course and group structures

6 Process Information

6.1 Involved Authorities

If this request is related to multiple components, please list both authorities for all related components.

6.2 Contact

Person to be contacted in case of questions about the feature or for funding offers:  Becker, Matthias [matthias.becker]

6.3 Funding

Funding status and funding parties are listed in the block 'Status of Feature' in the right column of this page.

If you are interested to give funding for this feature, please get into contact with the person mentioned above as 'Contact'.

7 Discussion

8 Implementation

Feature has been implemented by {Please add related profile link of this person}

8.1 Description and Screenshots

{ Description of the final implementation and the changed behaviour in the related components. Please add screenshots to visualise the changes if possible. }

8.2 Test Cases

Test cases completed at {date} by {user}

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

8.3 Privacy

Information in privacy.md of component: updated at {date} by {user} | no change required

8.4 Approval

Approved at {date} by {user}.

Last edited: Today, 13:01, Becker, Matthias [matthias.becker]