Cloze text (clozetext)

The cloze text Question is referenced by its Question type in the code, which is clozetext. This Question allows students to type their responses into empty response boxes that have been inserted by the author into a passage of 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

{
    "case_sensitive": false,
    "instant_feedback": true,
    "max_length": 2,
    "response_id": "60011",
    "stimulus": "fill in the blanks",
    "template": "<table class=\"table table-bordered table-hover\"><thead><tr><th><strong>Multiply</strong></th><th><strong>_ x 1</strong></th><th><strong>_ x 2</strong></th><th><strong>_ x 3</strong></th><th><strong>_ x 4</strong></th><th><strong>_ x 5</strong></th></tr></thead><tbody><tr><td><strong>1 x _</strong></td><td>{{response}}</td><td>2</td><td>3</td><td>4</td><td>5</td></tr><tr><td><strong>2 x _</strong></td><td>2</td><td>{{response}}</td><td>6</td><td>8</td><td>10</td></tr><tr><td><strong>3 x _</strong></td><td>3</td><td>6</td><td>{{response}}</td><td>12</td><td>15</td></tr><tr><td><strong>4 x _</strong></td><td>4</td><td>8</td><td>12</td><td>{{response}}</td><td>20</td></tr><tr><td><strong>5 x _</strong></td><td>5</td><td>10</td><td>15</td><td>20</td><td>{{response}}</td></tr></tbody></table>",
    "type": "clozetext",
    "validation": {
        "scoring_type": "partialMatch",
        "valid_response": {
            "value": ["1", "4", "9", "16", "25"]
        }
    }
}

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
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 to true on the activity. Supports embedded Feature <span> tags.
type string

Type of question being asked, e.g. 'association'

Default: "clozetext"
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"
ui_style.validation_stem_numeration string

Numeration character to be displayed to the left of the validation label.

Default: "number"
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 area

Default: "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 containing the valid responses for each {{response}} in the template in corresponding order.

Default: []
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

Default: []
validation.alt_responses[ ][ ].score number

Score if the alternative response is correct.

Default: 1
validation.alt_responses[ ][ ].value array

Default: []
validation.enable_fullwidth_scoring boolean

For languages such as Japanese, where full-width and half-width characters are used, validate responses with either type of character width. For example, in this question: What do we call '犬' in English? And you have set 'Ｄｏｇ' (full-width) as the correct answer, if the learner enters 'Ｄｏｇ' (full-width) or 'Dog' (half-width) these will both be marked as correct responses when this option is enabled.

Default: false
response_container response container object

Use Response Container (global) to make changes to all response boxes at once.
response_container.height stringUnits
response_container.width stringUnits
response_container.placeholder string

Text to display as a hint to the user of what to enter
response_container.input_type string

Type of input

Default: "text"
response_containers array [response container object]

Array containing objects defining each individual response container style.
response_containers[ ].height stringUnits
response_containers[ ].width stringUnits
response_containers[ ].placeholder string

Placeholder text that can be added into the response entry area, which disappears when user starts typing.
response_containers[ ].input_type string

Type of input

Default: "text"
response_containers[ ].aria_label string

Custom aria label text for the response container.
description string

Deprecated See stimulus_review.
Description of the question and its context to be displayed. It supports HTML entities.
template string

Text, tables, images and response boxes can be added to this area. Click on the Insert Response button in the Rich Text Editor to add a response box, or press the underscore button on your keyboard twice as a shortcut.
character_map boolean / array [characters]

If true, the character map button will display within the short text field. The character map will display the default set of special characters.
If an Array, the character map button will show and display only the array of characters.
IMPORTANT The HTML document will require a charset of utf-8: <meta charset="utf-8">

Default: false
max_length number

Maximum number of characters that can be entered in the field. Maximum value is 250. For longer questions use longtext type.

Default: "15"
multiple_line boolean

If true the response input will be a text area supporting multiple lines of input. If false the response input will be a text input only supporting one line responses.

Default: false
spellcheck boolean

Control the input/textarea attributes spellcheck, autocapitalize, autocomplete and autocorrect. See "Spell check MDN". "Autocapitalize MDN". "Autocomplete MDN" " Autocorrect ". Note these are browser features and may not always be available.

Default: false
case_sensitive boolean

If true, responses will be compared against valid_responses considering the letters' case.

Default: false
ignore_leading_and_trailing_spaces boolean

Determines whether the automatic marking will ignore leading and trailing spaces. E.g. 'a' and ' a ' will be treated as the same.

Default: true

Response format

The data returned in the response format for this Question is an array containing indexes, which are the responses that the student typed into the blank spaces in the passage.

Response format examples

{
    "value": [
        "1",
        "4",
        "9",
        "16",
        "25"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Response attributes

value array

The responses that were typed into the blank spaces in the passage.
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 reponse.
revision numeric

Keeps track of the number of Question attempt submissions, i.e. how many times the student answered the Question and submitted it.