matching wiki

❗ Do not edit this page. Edit the wiki in the repo. ❗

#adapt-contrib-matching

Matching is a question component bundled with the Adapt framework.

Matching presents the learner with a question stem followed one or more statements, each accompanied by a drop down. The dropdown contains a list of options for the learner to select. Once the learner selects all their answers, the question may be submitted.

Upon submission, feedback is provided via the tutor extension, if installed. Feedback can be provided for correct, incorrect and partially correct answers.

If all answers are correct, no further learner interaction is available.

If one or more answers are incorrect, the user may reset their submission, and try again. The number of times they can do this is determined by the Attempts setting. Subsequent submissions are treated as before, until the maximum number of attempts is reached. At this point, the user is presented with the opportunity to view the model answer, and compare this with their own submission. Further submission is not allowed.

Back to Top

Visit the page dedicated to Usage and Tips.

##Installation

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

• If Matching 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-matching

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

Back to Top

##Settings

The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Matching source code. Finally, an explanation is provided to help the course author better utilize the property.

The relationship between Matching's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.

Title (title): A reference title for the component. Title is distinct from the Display Title which, if present, appears above the component. If Display Title is rather long, Title provides the opportunity to use a shortened form in tighter spaces, such as in a menu or in the drawer.

Display Title (displayTitle): Optional text that will display as a title above the component. It can be used as a headline. In the authoring tool, Title and Display Title may be linked for easy input. Click the chain icon to toggle linking.

Body (body): Optional text that appears above the component. It can be used in a variety of ways, including as an introduction to the content in the component. HTML is permitted.

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

Classes (_classes): Custom classes predefined in the theme's Less files may be applied to this component. To do this, enter the name of the CSS class. If using more than one class, separate each with a space.

Layout (_layout): This defines the horizontal position of the component in the block that contains it. This property is set when the component is being added to the block. When Add to left or Add to right is selected, another component can occupy the space next to it. If Add is selected, the component spans the width of the containing block.

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

Display Attempts (_shouldDisplayAttempts): 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.

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

Question Weight (_questionWeight): A number which reflects the significance of the question in relation to the other questions in the course. This number is used in calculations of the final score reported to the LMS.

Placeholder (placeholder): This text is displayed as input before a learner interacts with the element.

Matching Items (_items): Multiple items may be created. Each item represents one question and its possible answers. It contains values for text and multiple _options.

Text (text): Text that functions as the question.

Matching Options (_options): Multiple options may be created. Each option functions as a possible answer to the question text. It contains values for text and isCorrect.

Option Text (text): This is the value of the dropdown. It is the text of a possible answer.

Is correct option (_isCorrect): This value determines whether the dropdown must be selected for a correct answer. Set to true if this option is a correct answer. The default is false.

Feedback (_feedback): 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 Partly Correct.

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

Incorrect Feedback (_incorrect): Texts that will be displayed when the submitted answer is incorrect. It contains values that are displayed under differing conditions: Incorrect Final and Incorrect Not Final.

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

Incorrect Not Final (notFinal): Text that will be displayed when the submitted answer is incorrect while more attempts are permitted.

Partly Correct Feedback (_partlyCorrect): Texts that will be displayed when the submitted answer is partially correct. It contains values that are displayed under differing conditions: Partly Correct Final and Partly Correct Not Final.

Partly Correct Final (final): Text that will be displayed when the submitted answer is partly correct and no more attempts are permitted.

Partly Correct Not Final (notFinal): Text that will be displayed when the submitted answer is partly correct while more attempts are permitted.

Back to Top

##Limitations

No known limitations.