Chemistry essay with rich text (chemistryessayV2)
Allows the learner to submit an essay response to a Question and input text and chemistry formulas, of up to 10,000 words.
The chemistry essay with rich text Question is referenced by its type in the code, which is "chemistryessayV2"
.
- Read the authoring documentation for a description of what this Question does.
Examples
{
"response_id": "60043-a",
"type": "chemistryessayV2",
"stimulus": "Write the formula for water and explain its structure.",
"max_length": 400
}
Attributes
-
type string
Defines the Question type to be rendered.
Must be set to
"chemistryessayV2"
in this case. -
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.
-
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. -
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.min_height stringUnits
The minimum height of the text entry area. Input as units. Example: "100px"
-
ui_style.max_height stringUnits
The max height of the text input including units. Example: "100px"
-
validation object
In this section, configure the correct answer(s) for the question.
-
validation.max_score number
The highest score a marker can award to this question response.
-
validation.min_score_if_attempted number
Positive value indicating the minimum score if a student attempted the question.
Default: 0
-
validation.unscored boolean
When enabled, this option will remove all scoring from the question. This is useful for creating practice questions.
Default: false
-
description string
Deprecated See stimulus_review.
Description of the question and its context to be displayed. It supports HTML entities. -
formatting_options array
An array containing strings of text formatting options to make available. Available options:
bold
italic
underline
unorderedList
orderedList
removeFormat
alignLeft
alignCenter
alignRight
alignJustify
superscript
subscript
indentIncrease
indentDecrease
textDirectionLtr
textDirectionRtl
insertHorizontalRule
table
charactermap
image
formulaEditor
undo
redo
Default: ["bold","italic","underline","|","unorderedList","orderedList"]
-
max_length number
Maximum number of words that can be entered in the field. Maximum: 100,000 chars ~ 10,000 words
Default: 10000
-
character_map array
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.
IMPORTANTThe HTML document will require a charset of utf-8:<meta charset="utf-8">
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: true
-
disable_auto_link boolean
Sets whether urls, entered by the user should automatically become clickable-links.
Default: false
-
submit_over_limit boolean
Determines if the user is able to save/submit when the word limit has been exceeded.
Default: false
-
placeholder string
Placeholder text that can be added into the response entry area, which disappears when user starts typing.
-
show_word_limit string
Determines how the word limit UI will display. Options are the following strings:
"always": Word limit is always shown and updated as the user types
"on-limit": Word limit is only displayed when the word limit is exceeded
"off": No word limit it shown.Default: "always"
-
text_blocks array
List of custom text blocks. Maximum length 9 characters.
Default: []
-
show_word_count boolean
Displays the word count underneath the entry dialog.
Default: true
-
showHints boolean
Disables hints, including keyboard shortcuts and group titles, shown on the keypad's top left corner when hovering over a symbol group key.
Default: true
-
horizontal_layout boolean
Enables a horizontal layout with ten columns and two rows.
Default: false
-
numberPad array[string]
Defines a custom set of symbols for the learner's keypad which allows you to add or remove symbols. We recommend to use Learnosity authoring tools to build your custom keypad.
See Keypad Customization for more information.
Default:
["7", "8", "9", "\u00f7", "4", "5", "6", "multiply", "1", "2", "3", "minus", "0", "decimal", "comma", "plus", "left", "right", "backspace", "="]
Example:
["1", "2", "3", "multiply", "="]
Response format
The data returned in the response format for this Question is the text and chemistry formula(s) that the learner entered.
Response format examples
{
"value": "<p>The formula for water is:</p><p>\\(H_2O\\)<br></p>",
"wordCount": 6,
"type": "string",
"apiVersion": "v2.221.0",
"revision": 1
}
Response attributes
-
value string
The text and chemistry formula(s) that the learner entered. The formula(s) are stored and then rendered with LaTeX markup.
-
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.