-
Notifications
You must be signed in to change notification settings - Fork 28
/
properties.schema
497 lines (497 loc) · 20.4 KB
/
properties.schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://jsonschema.net",
"$ref": "http://localhost/plugins/content/component/model.schema",
"globals": {
"ariaRegion": {
"type": "string",
"required": true,
"default": "Matching. Select from lists and then submit.",
"inputType": "Text",
"validators": [],
"translatable": true
},
"ariaCorrectAnswer": {
"type": "string",
"required": true,
"default": "The correct answer for {{{itemText}}} is {{{correctAnswer}}}",
"inputType": "Text",
"validators": [],
"help": "Text that will be announced by the screen reader when the learner selects the 'correct answer' button",
"translatable": true
},
"ariaUserAnswer": {
"type": "string",
"required": true,
"default": "The answer you chose for {{{itemText}}} was {{{userAnswer}}}",
"inputType": "Text",
"validators": [],
"help": "Text that will be announced by the screen reader when the learner selects the 'hide correct answer' button",
"translatable": true
},
"correctAnswerPrefix": {
"type": "string",
"required": false,
"default": "The correct answer is",
"inputType": "Text",
"validators": [],
"help": "If _canShowCorrectness is enabled, this text provides a prefix for the correct option displayed below the submitted question item",
"translatable": true
},
"correctAnswersPrefix": {
"type": "string",
"required": false,
"default": "The correct answers are",
"inputType": "Text",
"validators": [],
"help": "If _canShowCorrectness is enabled, this text provides a prefix for the comma separated list of correct options displayed below the submitted question item",
"translatable": true
}
},
"properties": {
"_supportedLayout": {
"type": "string",
"required": true,
"enum": ["full-width", "half-width", "both"],
"default": "half-width",
"editorOnly": true
},
"instruction": {
"type": "string",
"required": false,
"default": "Choose an option from each dropdown list and select Submit.",
"inputType": "Text",
"validators": [],
"help": "This is the instruction text",
"translatable": true
},
"ariaQuestion": {
"type": "string",
"required": false,
"default": "",
"inputType": "Text",
"validators": [],
"help": "This will be read out by screen readers instead of reading the 'Display title', 'Body' & 'Instruction' fields when focusing on the options. To be clear and concise, ensure the text encompasses only the question associated.",
"translatable": true
},
"_attempts": {
"type": "number",
"required": true,
"default": 1,
"title": "Attempts",
"inputType": "Number",
"validators": ["required", "number"],
"help": "How many attempts the learner is allowed"
},
"_canShowModelAnswer": {
"type": "boolean",
"required": true,
"default": true,
"title": "Display Model Answer",
"inputType": "Checkbox",
"validators": [],
"help": "Allow the user to view the 'model answer' if they answer the question incorrectly?"
},
"_canShowCorrectness": {
"type": "boolean",
"required": false,
"default": false,
"title": "Display correct answers after submit",
"inputType": "Checkbox",
"validators": [],
"help": "If enabled, this replaces the associated 'model answer' toggle button and a comma separated list of correct options is displayed below the submitted question item."
},
"_canShowFeedback": {
"type": "boolean",
"required": true,
"default": true,
"title": "Display Feedback",
"inputType": "Checkbox",
"validators": []
},
"_canShowMarking": {
"type": "boolean",
"default": true,
"title": "Display Marking",
"inputType": "Checkbox",
"validators": []
},
"_shouldResetAllAnswers": {
"type": "boolean",
"required": false,
"default": true,
"title": "Reset all answers?",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether all - or just incorrect - answers should be reset when the question is reset."
},
"_shouldDisplayAttempts": {
"type": "boolean",
"required": false,
"default": false,
"title": "Display Attempts",
"inputType": "Checkbox",
"validators": [],
"help": "Display the number of attempts remaining?"
},
"_isRandom": {
"type": "boolean",
"required": false,
"default": false,
"title": "Randomise answers",
"inputType": "Checkbox",
"validators": []
},
"_isRandomQuestionOrder": {
"type": "boolean",
"required": false,
"default": false,
"title": "Randomise questions",
"inputType": "Checkbox",
"validators": []
},
"_questionWeight": {
"type": "number",
"required": false,
"default": 1,
"title": "Question Weight",
"inputType": "Number",
"validators": ["number"],
"help": "How much this question is worth"
},
"_recordInteraction": {
"type": "boolean",
"required": false,
"default": true,
"title": "Record interaction",
"inputType": "Checkbox",
"validators": [],
"help": "If disabled, recording the user's answer(s) to this question to cmi.interactions on the LMS will be disabled for this component only. Defaults to true."
},
"_hasItemScoring": {
"type": "boolean",
"required": false,
"default": false,
"title": "Enable item scoring",
"inputType": "Checkbox",
"validators": [],
"help": "When disabled, this question scores 0 for incorrect and 'Question Weight' for correct. When enabled, this question scores by summing the scores of the selected options. Defaults to false."
},
"_allowOnlyUniqueAnswers": {
"type": "boolean",
"required": false,
"default": false,
"title": "Unique answers only",
"inputType": "Checkbox",
"validators": [],
"help": "When disabled, multiple items can be selected with the same option text. Defaults to false."
},
"placeholder": {
"type": "string",
"required": true,
"default": "Please select an option",
"title": "",
"inputType": "Text",
"validators": ["required"],
"help": "Text that will be displayed at the top of each list of options.",
"translatable": true
},
"_items": {
"type": "array",
"required": true,
"title": "Matching Items",
"items": {
"type": "object",
"required": true,
"properties": {
"text": {
"type": "string",
"required": true,
"default": "",
"inputType": "Text",
"validators": ["required"],
"help": "Title text displayed above the matching option",
"translatable": true
},
"_options": {
"type": "array",
"required": true,
"title": "Matching Options",
"items": {
"type": "object",
"required": true,
"properties": {
"text": {
"type": "string",
"required": true,
"default": "",
"title": "Option Text",
"inputType": "Text",
"validators": ["required"],
"help": "Option text",
"translatable": true
},
"_isCorrect": {
"type": "boolean",
"required": true,
"default": false,
"title": "Is correct option?",
"inputType": "Checkbox",
"validators": [],
"help": "Defines whether this option is correct or not"
},
"_score": {
"type": "number",
"required": false,
"default": 0,
"title": "Score",
"inputType": "Number",
"validators": ["required", "number"],
"help": "If item scoring is enabled, selected item scores are summed to give the question score."
}
}
}
}
}
}
},
"_feedback": {
"type": "object",
"required": false,
"title": "Feedback",
"properties": {
"title": {
"type": "string",
"required": false,
"default": "",
"title": "Feedback Title",
"inputType": "Text",
"validators": [],
"help": "Leave blank to have the component's title shown instead.",
"translatable": true
},
"correct": {
"type": "string",
"required": false,
"default": "",
"title": "Correct",
"inputType": "TextArea",
"validators": [],
"help": "Correct answer feedback for this question",
"translatable": true
},
"_incorrect": {
"type": "object",
"required": false,
"title": "Incorrect Feedback",
"properties": {
"final": {
"type": "string",
"required": false,
"default": "",
"title": "Incorrect Final",
"inputType": "TextArea",
"validators": [],
"help": "Incorrect answer feedback for the final attempt",
"translatable": true
},
"notFinal": {
"type": "string",
"required": false,
"default": "",
"title": "Incorrect Not Final",
"inputType": "TextArea",
"validators": [],
"help": "Incorrect answer feedback for any attempt apart from the last attempt. If you leave this blank, the 'Incorrect Final' feedback will be used instead.",
"translatable": true
}
}
},
"_partlyCorrect": {
"type": "object",
"required": false,
"properties": {
"final": {
"type": "string",
"required": false,
"default": "",
"title": "Partly Correct Final",
"inputType": "TextArea",
"validators": [],
"help": "Partly correct answer feedback for the final attempt. If you leave this blank, the 'Incorrect Final' feedback will be used instead.",
"translatable": true
},
"notFinal": {
"type": "string",
"required": false,
"default": "",
"title": "Partly Correct Not Final",
"inputType": "TextArea",
"validators": [],
"help": "Partly correct answer feedback for any attempt apart from the last attempt. If you leave this blank, the 'Partly Correct Final' feedback will be used instead.",
"translatable": true
}
}
}
}
},
"_buttons": {
"type": "object",
"title": "Buttons",
"required": false,
"properties": {
"_submit": {
"type": "object",
"title": "Submit",
"properties": {
"buttonText": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Button label text for the submit button",
"translatable": true
},
"ariaLabel": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Aria label for the submit button",
"translatable": true
}
}
},
"_reset": {
"type": "object",
"title": "Reset",
"properties": {
"buttonText": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Button label text for the reset button",
"translatable": true
},
"ariaLabel": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Aria label for the reset button",
"translatable": true
}
}
},
"_showCorrectAnswer": {
"type": "object",
"title": "Show Correct Answer",
"properties": {
"buttonText": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Button label text to show the model answer",
"translatable": true
},
"ariaLabel": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Aria label for the show model answer button",
"translatable": true
}
}
},
"_hideCorrectAnswer": {
"type": "object",
"title": "Hide Correct Answer",
"properties": {
"buttonText": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Button label text to hide the model answer",
"translatable": true
},
"ariaLabel": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Aria label for the hide model answer button",
"translatable": true
}
}
},
"_showFeedback": {
"type": "object",
"title": "Show Feedback",
"properties": {
"buttonText": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Button label text to show feedback",
"translatable": true
},
"ariaLabel": {
"type": "string",
"required": false,
"default": "",
"title": "",
"inputType": "QuestionButton",
"validators": [],
"help": "Aria label for the show feedback button",
"translatable": true
}
}
},
"remainingAttemptsText": {
"type": "string",
"required": false,
"default": "",
"title": "Attempts Remaining Text",
"inputType": "QuestionButton",
"validators": [],
"help": "Shown when there are multiple attempts left",
"translatable": true
},
"remainingAttemptText": {
"type": "string",
"required": false,
"default": "",
"title": "Final Attempt Text",
"inputType": "QuestionButton",
"validators": [],
"help": "Shown when there is one attempt left",
"translatable": true
}
}
}
}
}