Skip to content

Commit d72dc69

Browse files
stellaliestellalie
committed
Added more documentation on hotspot
1 parent f65ede1 commit d72dc69

File tree

2 files changed

+203
-1
lines changed

2 files changed

+203
-1
lines changed

‎documentation.html

+171-1
Original file line numberDiff line numberDiff line change
@@ -6462,6 +6462,7 @@ <h4>Supported Question Types</h4>
64626462
<li><a href="#choicematrix">choicematrix</a></li>
64636463
<li><a href="#clozeassociation">clozeassociation</a></li>
64646464
<li><a href="#clozedropdown">clozedropdown</a></li>
6465+
<li><a href="#hotspot">hotspot</a></li>
64656466
<li><a href="#imageclozeassociation">imageclozeassociation</a></li>
64666467
<li><a href="#longtext">longtext</a></li>
64676468
<li><a href="#orderlist">orderlist</a></li>
@@ -6487,7 +6488,6 @@ <h4>Supported Question Types</h4>
64876488
<span class="secondary label">chemistryessay</span>
64886489
<span class="secondary label">graphplotting</span>
64896490
<span class="secondary label">highlight</span>
6490-
<span class="secondary label">hotspot</span>
64916491
<span class="secondary label">imageclozedropdown</span>
64926492
<span class="secondary label">imageclozeformula</span>
64936493
<span class="secondary label">imageclozechemistry</span>
@@ -7235,6 +7235,176 @@ <h4 style="display: inline-block" id="clozedropdown">clozedropdown</h4>
72357235
</tr>
72367236
</table>
72377237

7238+
<hr/>
7239+
<h4 style="display: inline-block" id="hotspot">hotspot</h4>
7240+
<a style="display: inline-block" href="http://docs.learnosity.com/assessment/questions/questiontypes#hotspot" target="_blank">(documentation)</a>
7241+
<a style="display: inline-block; float: right; margin-top: 10px;" href="#mapping-question-types">Back to Top</a>
7242+
7243+
<div class="panel">This question type is mapped to &lt;choiceInteraction&gt; and currently only support `exactMatch` validation. Response processing would by default mapped using `match_correct` template.</div>
7244+
7245+
<table class="doc-table">
7246+
<tr>
7247+
<th></th>
7248+
<th>Support</th>
7249+
<th>Description</th>
7250+
</tr>
7251+
<tr>
7252+
<td class="name">stimulus</td>
7253+
<td class="support-status support-status-yes">YES</td>
7254+
<td class="description">This is mapped to `prompt`</td>
7255+
</tr>
7256+
<tr>
7257+
<td class="name">options</td>
7258+
<td class="support-status support-status-yes">YES</td>
7259+
<td class="description">This is mapped to list of simpleChoice</td>
7260+
</tr>
7261+
<tr>
7262+
<td class="name">image</td>
7263+
<td class="support-status support-status-yes">YES</td>
7264+
<td class="description">This is mapped to the image object width</td>
7265+
</tr>
7266+
<tr>
7267+
<td class="name">image.source</td>
7268+
<td class="support-status support-status-yes">YES</td>
7269+
<td class="description">This is mapped to interaction image object, we will use its extension to map it to its type,ie. `hello.png` would be assumed to have image type of `image/png`</td>
7270+
</tr>
7271+
<tr>
7272+
<td class="name">image.width</td>
7273+
<td class="support-status support-status-yes">YES</td>
7274+
<td class="description">This is mapped to the image object width</td>
7275+
</tr>
7276+
<tr>
7277+
<td class="name">image.height</td>
7278+
<td class="support-status support-status-yes">YES</td>
7279+
<td class="description">This is mapped to the image object height</td>
7280+
</tr>
7281+
<tr>
7282+
<td class="name">areas</td>
7283+
<td class="support-status support-status-yes">YES</td>
7284+
<td class="description">This is mapped to a collection of hotspotChoice. Each hotspotChoice would be of a shape Poly and its percentage-based coordinates would be mapped to QTI fixed-based coordinates</td>
7285+
</tr>
7286+
<tr>
7287+
<td class="name">multiple_responses</td>
7288+
<td class="support-status support-status-yes">YES</td>
7289+
<td class="description">When this option sets to true, then it would map the interaction `maxChoices` attribute with the highest number of choices possible</td>
7290+
</tr>
7291+
<tr>
7292+
<td class="name">is_math</td>
7293+
<td class="support-status support-status-no">NO</td>
7294+
<td class="description"></td>
7295+
</tr>
7296+
<tr>
7297+
<td class="name">metadata</td>
7298+
<td class="support-status support-status-no">NO</td>
7299+
<td class="description"></td>
7300+
</tr>
7301+
<tr>
7302+
<td class="name">metadata.distractor_rationale</td>
7303+
<td class="support-status support-status-no">NO</td>
7304+
<td class="description"></td>
7305+
</tr>
7306+
<tr>
7307+
<td class="name">metadata.rubric_reference</td>
7308+
<td class="support-status support-status-no">NO</td>
7309+
<td class="description"></td>
7310+
</tr>
7311+
<tr>
7312+
<td class="name">metadata.sample_answer</td>
7313+
<td class="support-status support-status-no">NO</td>
7314+
<td class="description"></td>
7315+
</tr>
7316+
<tr>
7317+
<td class="name">metadata.acknowledgements</td>
7318+
<td class="support-status support-status-no">NO</td>
7319+
<td class="description"></td>
7320+
</tr>
7321+
<tr>
7322+
<td class="name">stimulus_review</td>
7323+
<td class="support-status support-status-no">NO</td>
7324+
<td class="description"></td>
7325+
</tr>
7326+
<tr>
7327+
<td class="name">type</td>
7328+
<td class="support-status support-status-no">NO</td>
7329+
<td class="description"></td>
7330+
</tr>
7331+
<tr>
7332+
<td class="name">ui_style</td>
7333+
<td class="support-status support-status-no">NO</td>
7334+
<td class="description"></td>
7335+
</tr>
7336+
<tr>
7337+
<td class="name">ui_style.fontsize</td>
7338+
<td class="support-status support-status-no">NO</td>
7339+
<td class="description"></td>
7340+
</tr>
7341+
<tr>
7342+
<td class="name">ui_style.validation_stem_numeration</td>
7343+
<td class="support-status support-status-no">NO</td>
7344+
<td class="description"></td>
7345+
</tr>
7346+
<tr>
7347+
<td class="name">feedback_attempts</td>
7348+
<td class="support-status support-status-no">NO</td>
7349+
<td class="description"></td>
7350+
</tr>
7351+
<tr>
7352+
<td class="name">instant_feedback</td>
7353+
<td class="support-status support-status-no">NO</td>
7354+
<td class="description"></td>
7355+
</tr>
7356+
<tr>
7357+
<td class="name">area_attributes</td>
7358+
<td class="support-status support-status-no">NO</td>
7359+
<td class="description"></td>
7360+
</tr>
7361+
<tr>
7362+
<td class="name">area_attributes.global</td>
7363+
<td class="support-status support-status-no">NO</td>
7364+
<td class="description"></td>
7365+
</tr>
7366+
<tr>
7367+
<td class="name">area_attributes.global.fill</td>
7368+
<td class="support-status support-status-no">NO</td>
7369+
<td class="description"></td>
7370+
</tr>
7371+
<tr>
7372+
<td class="name">area_attributes.global.stroke</td>
7373+
<td class="support-status support-status-no">NO</td>
7374+
<td class="description"></td>
7375+
</tr>
7376+
<tr>
7377+
<td class="name">area_attributes.individual</td>
7378+
<td class="support-status support-status-no">NO</td>
7379+
<td class="description"></td>
7380+
</tr>
7381+
<tr>
7382+
<td class="name">area_attributes.individual[].area</td>
7383+
<td class="support-status support-status-no">NO</td>
7384+
<td class="description"></td>
7385+
</tr>
7386+
<tr>
7387+
<td class="name">area_attributes.individual[].label</td>
7388+
<td class="support-status support-status-no">NO</td>
7389+
<td class="description"></td>
7390+
</tr>
7391+
<tr>
7392+
<td class="name">area_attributes.individual[].fill</td>
7393+
<td class="support-status support-status-no">NO</td>
7394+
<td class="description"></td>
7395+
</tr>
7396+
<tr>
7397+
<td class="name">area_attributes.individual[].stroke</td>
7398+
<td class="support-status support-status-no">NO</td>
7399+
<td class="description"></td>
7400+
</tr>
7401+
<tr>
7402+
<td class="name">max_width</td>
7403+
<td class="support-status support-status-no">NO</td>
7404+
<td class="description"></td>
7405+
</tr>
7406+
</table>
7407+
72387408
<hr/>
72397409
<h4 style="display: inline-block" id="imageclozeassociation">imageclozeassociation</h4>
72407410
<a style="display: inline-block" href="http://docs.learnosity.com/assessment/questions/questiontypes#imageclozeassociation" target="_blank">(documentation)</a>

‎src/Processors/QtiV2/Out/Documentation/QuestionTypes/HotspotDocumentation.php

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
3+
namespace LearnosityQti\Processors\QtiV2\Out\Documentation\QuestionTypes;
4+
5+
use LearnosityQti\Processors\QtiV2\Out\Documentation\LearnosityDoc;
6+
use LearnosityQti\Processors\QtiV2\Out\Documentation\QuestionTypeDocumentationInterface;
7+
8+
class HotspotDocumentation implements QuestionTypeDocumentationInterface
9+
{
10+
public static function getDocumentation()
11+
{
12+
return [
13+
'stimulus' => LearnosityDoc::support('This is mapped to `prompt`'),
14+
'options' => LearnosityDoc::support('This is mapped to list of simpleChoice'),
15+
'image' => LearnosityDoc::support('This is mapped to the image object width'),
16+
'image.source' => LearnosityDoc::support('This is mapped to interaction image object, we will use its extension to map it to its type,'
17+
. 'ie. `hello.png` would be assumed to have image type of `image/png`'),
18+
'image.width' => LearnosityDoc::support('This is mapped to the image object width'),
19+
'image.height' => LearnosityDoc::support('This is mapped to the image object height'),
20+
'areas' => LearnosityDoc::support('This is mapped to a collection of hotspotChoice. Each hotspotChoice would be of a shape Poly and '
21+
. 'its percentage-based coordinates would be mapped to QTI fixed-based coordinates'),
22+
'multiple_responses' => LearnosityDoc::support('When this option sets to true, then it would map the interaction ' .
23+
'`maxChoices` attribute with the highest number of choices possible')
24+
];
25+
}
26+
27+
public static function getIntroductionNotes()
28+
{
29+
return
30+
"This question type is mapped to <choiceInteraction> and currently only support `exactMatch` validation. Response processing would by default mapped using `match_correct` template.";
31+
}
32+
}

0 commit comments

Comments
 (0)