Documentation

Text Identification

Description

This addon allows users to add multiple selections activity with HTML content to a presentation. Each element works as a single selection option.

Properties

Property name Description
Text This property serves for inserting HTML content to be displayed in the module
Selection is correct This property indicates whether a selected element is correct.
On selected Event to be executed when the module is selected.
On deselected Event to be executed when the module is deselected.
Block wrong answers With this option checked, wrong answers are removed and the "on wrong" event is sent.
Send event on select/deselect With this option is checked and the command select/deselect is run on the addon the event is sent..
Speech texts List of speech texts: selected, deselected, correct, incorrect.
This texts will be read by Text to Speech addon after a user performs an action.
Lang attribute This property allows to define the language for this addon (different than the language of the lesson).

Supported commands

Command name Params Description
select --- Select the element if not selected (not available in error checking mode).
deselect --- Deselect the element if selected (not available in error checking mode).
isSelected --- Returns true if the addon is selected, otherwise false.
markAsCorrect --- Marks the addon as correct.
markAsWrong --- Marks the addon as wrong.
markAsEmpty --- Marks the addon as empty.
isAllOK --- Returns true if the element is selected correctly, otherwise false.
show --- Shows the module.
hide --- Hides the module.
disable --- Disables module activities.
enable --- Enables module activities.

Show Answers

This module is fully compatible with Show Answers module and displays correct answers when a relevant event is sent.

CSS classes

Class name Description
text-identification-element The element base class when it has no other state.
text-identification-element-selected Class for a selected element while not in the error checking mode.
text-identification-element-correct Class for an element (un)selected correctly while in the error checking mode.
text-identification-element-incorrect Class for an element (un)selected incorrectly while in the error checking mode.
text-identification-element-mouse-hover Class for an element if it is deselected & when it is on mouse hover.
text-identification-element-mouse-hover-selected Class for an element if it is selected & when it is on mouse hover.
text-identification-container Class for a container.
text-identification-element-show-answers Class for an element if Show Answers is active.
text-identification-element-empty Class for an empty element.

Events

Text Identification Addon sends events to Event Bus when user selects it.

Field name Description
Item It's always '1'
Value 1 for selection, 0 for deselection
Score 1 for correct answer, 0 for wrong

When a user selects element properly, the addon sends the 'ALL OK' event. This event is different from a normal event so its structure is shown below.

Field name Description
Item all
Value N/A
Score N/A

Keyboard navigation

  • Enter – select a current element

Demo presentation

Demo presentation contains examples of how the Text Identification addon can be used.