Token highlight (tokenhighlight)
The token highlight Question is referenced by its Question type in the code, which is tokenhighlight
. This Question allows students to highlight certain words, sentences, or paragraphs in a text passage by clicking on the text.
- Read the authoring documentation for a description of what this Question does.
- Read the developer reference documentation to see configuration options for this Question type.
Examples
{
"response_id": "60026",
"stimulus": "<strong>Which sentence or sentences imply that the cheetahs run fast?</strong>",
"template": "<p>Most cheetahs live in the wilds of Africa. There are also some in Iran and northwestern Afghanistan. The cheetah's head is smaller than the leopard's, and its body is longer. This cat is built for speed. Its legs are much longer than the leopard', allowing it to run at speeds of up to 70 miles per hour! This incredible ability helps the cheetahs catch their dinner, which is usually an unfortunate antelope. A cheetahs spots are simply black spots, not rosettes or circles.</p>",
"tokenization": "sentence",
"type": "tokenhighlight",
"validation": {
"scoring_type": "partialMatch",
"valid_response": {
"value": [3, 4]
}
},
"instant_feedback": true
}
Attributes
-
is_math boolean
Set to true to have LaTeX or MathML contents to be rendered with mathjax.
Default: false
-
metadata object
Object containing additional information about the question.
-
metadata.distractor_rationale string
Used to display individual response feedback/rationale to the student.
-
metadata.rubric_reference string
A unique identifier for the rubric to be used with the question - defaults to course rubric if assigned in activity
-
metadata.sample_answer string
A sample answer to be displayed on the Learnosity Reports API. HTML is supported.
-
metadata.acknowledgements string
References for any text passages, documents, images etc. used in the question.
-
metadata.distractor_rationale_response_level array
Used for storing the distractor rationales that map to responses in the same order for use/rendering by the host environment.
-
stimulus string
The question stimulus. This can include text, tables, images, resources and LaTeX entered via the Math Editor.
-
stimulus_review string
HTML/Text content displayed only in review state rendered above the response area. Supports embedded Feature <span> tags. Will override stimulus in review state.
-
instructor_stimulus string
HTML/Text content displayed when
showInstructorStimulus
is set totrue
on the activity. Supports embedded Feature <span> tags. -
type string
Type of question being asked, e.g. 'association'
Default: "tokenhighlight"
-
ui_style object
Object used to control different aspects of the UI
-
ui_style.fontsize string
Controls the size of base font for this question. Options are among 'small', 'normal', 'large', 'xlarge' and 'xxlarge'.
Default: "normal"
-
feedback_attempts number
If instant_feedback is true, this field determines how many times the user can click on the 'Check Answer' button. 0 means unlimited.
Default: 0
-
instant_feedback boolean
Flag to determine whether to display a 'Check Answer' button to provide instant feedback to the user.
Default: false
-
validation object
In this section, configure the correct answer(s) for the question.
-
validation.allow_negative_scores boolean
Negative scores will be normalised to zero by default. Allowing negative scores, on the other hand, means that the score can drop below zero when penalties are applied.
Default: false
-
validation.penalty number
Value indicating the marks deducted for an incorrect response.
Default: 0
-
validation.min_score_if_attempted number
Positive value indicating the minimum score if a student attempted the question.
Default: 0
-
validation.scoring_type string
Defines the scoring approach used. Possible options:
'exactMatch': Exact Match - Entire response must match exactly
'partialMatchV2': Partial Match - A relative part of the score will be given for each correct response area
'partialMatch': Partial Match Per Response - Cumulative Score value will be given for each correct response areaDefault: "exactMatch"
-
validation.unscored boolean
When enabled, this option will remove all scoring from the question. This is useful for creating practice questions.
Default: false
-
validation.valid_response object
An object containing the valid response score and value.
-
validation.valid_response.score number
Score awarded for the correct response(s).
Default: 1
-
validation.valid_response.value array
An array contains the index of valid token
-
validation.automarkable boolean
Defines whether the question will be marked automatically, or must be marked manually.
Default: true
-
validation.alt_responses array
Add an alternate response if there is more than one correct overall solution to a question.
-
validation.alt_responses[ ].score number
Score if the alternative response is correct.
Default: 1
-
validation.alt_responses[ ].value array
An array contains the index of valid token
-
validation.alt_responses[ ][ ].score number
Score if the alternative response is correct.
Default: 1
-
validation.alt_responses[ ][ ].value array
An array contains the index of valid token
-
template string
A string contains the mark up. Wrap words/phrases with <span class="lrn_token"> tag to create clickable token
-
max_selection number
How many elements can user select
-
tokenization string
Type of tokenizaton. "sentence", "word", "paragraph" or "custom". Default is "custom".
Default: "custom"
Response format
The data returned in the response format for this Question is the words, sentences, or paragraphs in a text passage, that the student highlighted.
Response format examples
{
"value": [
3
],
"type": "array",
"apiVersion": "v2.173.0",
"revision": 1,
"feedbackAttemptsCount": 1
}
Response attributes
-
value array
The words, sentences, or paragraphs in the text passage, that the student highlighted.
-
type string
Informs the scoring engine about what kind of data to expect in the values entered by the student. For this Question type, you must always supply a string for this attribute with the value
"array"
. -
apiVersion string
The version of the Questions API that returned this response.
-
revision numeric
Keeps track of the number of Question attempt submissions, i.e. how many times the student answered the Question and submitted it.
-
feedbackAttemptsCount numeric
Keeps track of the number of feedback attempts.