adaptlearning / adapt_framework

A toolkit for creating responsive, accessible, multilanguage HTML5 e-learning courses.
https://www.adaptlearning.org/
GNU General Public License v3.0
569 stars 242 forks source link

States and indicators outline #3557

Open oliverfoster opened 1 month ago

oliverfoster commented 1 month ago

Priority

'Priority' is a proposed name for the concept of 'optional vs required'. Priority applies to menus, pages, articles, blocks and components.

Name Description
Optional Content does not need to be completed to mark the parent or tracking criteria complete.
Required Content needs to be completed to mark the parent or tracking criteria complete.

Existing priority indicators:

Works

Locked

Items which should not yet be accessed or which have criteria to unlock them can be considered 'locked'.

Name Description
Locked The criteria have not been met to view this content.
Unlocked Pseudo status with no existing meaning.

We use a locked icon and/or a disabled state to signify that something is locked.

Works

Visited

'Visited' is typically used to show that a some of page's children have been interacted with or that a component item had been selected.

Page visited has two potential modes:

  1. The page was opened in this session
  2. The page was restored and some of its descendants were completed or visited

Indicators for visited include:

Works

Selection

'Selection' tends to signify that a user has chosen a subset of options from a visible list. it is the common term for the _isActive status of the ComponentItemModel and ItemModel code.

Name Description
Selected The user has chosen this item
Not Selected The user has not chosen this item

The indicators for selection include:

Completion is subject to the 'priority' of its children (blocks to articles, items to components, etc) and the rules governing their completion, such as inview states, item visited states, _requireCompletionOf, correctness criteria, branching ends etc.

Completion can also refer to the fulfillment of the course tracking criteria, a course is said to be complete at its conclusion.

Completion applies to menus, pages, articles, blocks and components.

Completion is usually called _isVisited for presentation component items.

Name Description
Complete Content does not need to be completed to mark the parent or tracking criteria complete.
Incomplete Content needs to be completed to mark the parent or tracking criteria complete.

Current completion indicators include:

Correctness

'Correctness' is a sub state of the 'complete', such that something generally can't be wholly marked for correctness whilst being incomplete.

Correctness tends to apply to question components, question component items and assessments.

Name Current indicator
Correct Tick and/or feedback
Partly correct Cross and/or feedback
Incorrect Cross and/or feedback

Current correctness indicators include:

Assessment correctness tends to have more complex criteria than item and question correctness, such as score or the number of items correct thresholds.

Name Description
Pass The specified criteria have been met.
Fail The specified criteria have not been met.

Correctness feedback includes:

Todo