Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

States and indicators outline #3557

Open
oliverfoster opened this issue May 13, 2024 · 0 comments
Open

States and indicators outline #3557

oliverfoster opened this issue May 13, 2024 · 0 comments
Assignees

Comments

@oliverfoster
Copy link
Member

oliverfoster commented May 13, 2024

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:

  • PageLevelProgress "Optional Content" text

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.

  • Trickle buttons
  • PageLevelProgress items
  • Menu items

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:

  • Menu progress bars showing more than the minimum notch
  • Component items showing highlighted and/ticked where supported

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:

  • MCQ radio and checkboxes, either unfilled or filled
  • GMCQ highlighting
  • Hotgraphic pagination
  • Accordion highlighting / expansion
  • Narrative indicator highlighting
  • Matching highlighting / dropdown
  • Slider handle
  • Text input cursor

Completion

'Completion' usually denotes that a component, item or page has been interacted with in totality.

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:

  • PageLevelProgress bars are either unfilled, partly filled or filled on menu items, the navigation bar, drawer items and title asides where utilised
  • Question buttons marking central icon with a tick or crosses
  • Question buttons button disablement
  • Question interface disablement
  • Menu ticks
  • Item visited ticks in Hotgraphic, Accordion, Media and Narrative
  • Item visited highlighting in Accordion, Narrative

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:

  • Tutor for notify or inline feedback
  • Question buttons ticks and crosses
  • MCQ, GMCQ, Matching item ticks and crosses

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:

  • Assessment results
  • LMS completion/pass/fail status

Todo

  • Please add examples and references accordingly
  • If you need to critique or require changes, please open a new issue and reference this one
  • Add links to existing works
  • Add standard accessibility practises for conveying these statuses to users
@oliverfoster oliverfoster self-assigned this May 13, 2024
@oliverfoster oliverfoster moved this from New to Awaiting Response in adapt_framework: The TODO Board May 13, 2024
@oliverfoster oliverfoster moved this from Awaiting Response to New in adapt_framework: The TODO Board May 13, 2024
@joe-allen-89 joe-allen-89 moved this from New to Assigned in adapt_framework: The TODO Board May 23, 2024
@oliverfoster oliverfoster changed the title Completion, correctness, priority, selection and locked outline States and indicators outline May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant