Instruction Error is an extension which can be installed in the Adapt framework. It provides core question components with the ability to display an error reiterating the question instructions on an invalid submission. The error is configured globally but may take values from the question component.
Instruction Error can be installed using the Adapt CLI, run the following from the command line:
adapt install adapt-contrib-instructionError
This extension can also be installed by adding the following line of code to the adapt.json file:
"adapt-contrib-instructionError": "*"
Then running the command:
adapt install
(This second method will reinstall all plug-ins listed in adapt.json.)
If Instruction Error needs to be installed in the Adapt authoring tool, it may be installed by uploading the zip.
The following attributes, set within course.json, configure the defaults for Instruction Error.
_instructionError (object): The Instruction Error attributes group contains values for _isEnabled, _showAsPopup, title and body.
_isEnabled (boolean): Turns on and off the Instruction Error extension.
_showAsPopup (boolean): When set to
true, the Instruction Error will display the error in a notify popup. The default isfalse.title (boolean): When using the
_showAsPopupoption, this is the notify title for the instruction error. Otherwise, this is not used.body (boolean): When using the
_showAsPopupoption, this is the notify body for the instruction error. Otherwise, this replaces the existing.component__instructiontext. Defaults to the question instruction text. If instruction text is not set, a generic message is used.
No known limitations.
Author / maintainer: Adapt Core Team with contributors
Accessibility support: WAI AA
RTL support: Yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, Safari for macOS/iOS/iPadOS, Opera