Skip to content

Latest commit

 

History

History
124 lines (71 loc) · 11.2 KB

README.md

File metadata and controls

124 lines (71 loc) · 11.2 KB
Raw

adapt-contrib-mcq

multiple choice question in action Multiple Choice Question (MCQ) is a question component bundled with the Adapt framework.

Possible answers are presented to the learner accompanied by a radio button or checkbox, depending on whether a single answer or multiple answers are required. Upon submission, feedback is provided via the Tutor extension, if installed. Feedback can be provided for correct, incorrect and partially correct answers. The number of attempts allowed may be configured. GMCQ is a variation that includes a graphic.

Visit the MCQ wiki for more information about its functionality and for explanations of key properties.

Installation

As one of Adapt's core components, MCQ is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

  • If MCQ has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line: adapt install adapt-contrib-mcq

    Alternatively, this component can also be installed by adding the following line of code to the adapt.json file: "adapt-contrib-mcq": "*" Then running the command: adapt install (This second method will reinstall all plug-ins listed in adapt.json.)

  • If MCQ has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

Settings Overview

The attributes listed below are used in components.json to configure MCQ, and are properly formatted as JSON in example.json. Visit the MCQ wiki for more information about how they appear in the authoring tool.

Attributes

In addition to the attributes specifically listed below, question components can implement the following sets of attributes:

  • core model attributes: These are inherited by every Adapt component. They have no default values. Like the attributes below, their values are assigned in components.json.
  • core buttons: Default values are found in course.json, but may be overridden by MCQ's model in components.json.

_component (string): This value must be: mcq.

_classes (string): CSS class name to be applied to MCQ’s containing div. The class must be predefined in one of the Less files. Separate multiple classes with a space.

_layout (string): This defines the horizontal position of the component in the block. Acceptable values are full, left or right.

instruction (string): This optional text appears above the component. It is frequently used to guide the learner’s interaction with the component.

ariaQuestion (string): This will be read out by screen readers instead of reading the title, body & instruction fields when focusing on the group or radiogroup.

_attempts (integer): This specifies the number of times a learner is allowed to submit an answer. The default is 1.

_shouldDisplayAttempts (boolean): Determines whether or not the text set in remainingAttemptText and remainingAttemptsText will be displayed. These two attributes are part of the core buttons attribute group. The default is false.

_isRandom (boolean): Setting this value to true will cause the _items to appear in a random order each time the component is loaded. The default is false.

_hasItemScoring (boolean): When false, this question scores 0 for incorrect and _questionWeight for correct. When true, this question scores by summing the _score of the selected items.

_questionWeight (number): When _hasItemScoring is false, this is the question score for a correct response. This number is used in calculations of the final score reported to the LMS.

_selectable (integer): Defines the number of _items, or answers, that can be selected. If the value of _selectable is 1, _items will be presented with HTML radio buttons. If the value is greater than 1, they will be presented with HTML checkboxes. This number can be smaller, match or exceed the number of _items whose _shouldBeSelected is set to true. The default is 1.

_canShowModelAnswer (boolean): Setting this to false prevents the _showCorrectAnswer button from being displayed. The default is true.

_canShowCorrectness (boolean): Setting this to true replaces the associated _canShowModelAnswer toggle button and displays correctness directly on the component items. The default is false.

_canShowFeedback (boolean): Setting this to false disables feedback, so it is not shown to the user. The default is true.

_canShowMarking (boolean): Setting this to false prevents ticks and crosses being displayed on question completion. The default is true.

_recordInteraction (boolean) Determines whether or not the learner's answers will be recorded to the LMS via cmi.interactions. Default is true. For further information, see the entry for _shouldRecordInteractions in the README for adapt-contrib-spoor.

_items (array): Each item represents one choice for the multiple choice question and contains values for text, _shouldBeSelected, and feedback.

text (string): Text that comprises the multiple choice option.

altText (string): This will be read out by screen readers instead of reading text. Optional for providing alternative text, for example, to specify how a word should be pronounced.

_shouldBeSelected (boolean): Determines whether the item must be selected for the answer to be correct. Value can be true or false. The value of _selectable can be smaller, match or exceed the total number of _items where _shouldBeSelected is set to true.

_isPartlyCorrect (boolean): Determines whether the item when selected marks the question as partly correct. Value can be true or false. Default is false.

feedback (string): This attribute is used only when the value for _selectable is set to 1 (i.e., radio button style questions). This text will be shown if the learner selects this item, and it is an incorrect answer.

_score (number): If _hasItemScoring is true, when selected, item scores are summed to give the question score.

_feedback (object): If the Tutor extension is enabled, these various texts will be displayed depending on the submitted answer. _feedback contains values for three types of answers: correct, _incorrect, and _partlyCorrect. Some attributes are optional. If they are not supplied, the default that is noted below will be used.

title (string): Title text for the feedback that will be displayed when the question is submitted.

altTitle (string): This will be read out by screen readers as an alternative title if no visual title is included.

correct (string): Text that will be displayed when the submitted answer is correct.

_incorrect (object): Texts that will be displayed when the submitted answer is incorrect. It contains values that are displayed under differing conditions: final and notFinal.

final (string): Text that will be displayed when the submitted answer is incorrect and no more attempts are permitted.

notFinal (string): Text that will be displayed when the submitted answer is incorrect while more attempts are permitted. This is optional—if you do not supply it, the _incorrect.final feedback will be shown instead.

_partlyCorrect (object): Texts that will be displayed when the submitted answer is partially correct. It contains values that are displayed under differing conditions: final and notFinal.

final (string): Text that will be displayed when the submitted answer is partly correct and no more attempts are permitted. This is optional—if you do not supply it, the _incorrect.final feedback will be shown instead.

notFinal (string): Text that will be displayed when the submitted answer is partly correct while more attempts are permitted. This is optional—if you do not supply it, the _incorrect.notFinal feedback will be shown instead.

Accessibility

Multiple Choice Question has been assigned a descriptive label using the aria-label attribute: ariaRegion.

When Multiple Choice Question is used with Adapt Framework v5.12.0 (or better), it supports announcing the correct/learner answer to screen readers (via an an ARIA Live Region) when the Correct Answer button is toggled by the learner. The following attributes are used to provide this functionality: ariaCorrectAnswer, ariaCorrectAnswers, ariaUserAnswer, ariaUserAnswers.

These ARIA labels are not visible elements; they are used by assistive technology (such as screen readers). Should any of these labels need to be customised or translated, they can be found within the _globals._components._mcq object in course.json (or Project settings > Globals in the Adapt Authoring Tool).

Limitations

No known limitations.

adapt learning logo 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, IE11, Safari 14 for macOS/iOS/iPadOS, Opera