Skip to content

Commit

Permalink
Added more documentation on hotspot
Browse files Browse the repository at this point in the history
  • Loading branch information
@stellalie
stellalie committed May 16, 2016
1 parent f65ede1 commit d72dc69
Show file tree
Hide file tree
Showing 2 changed files with 203 additions and 1 deletion.
172 changes: 171 additions & 1 deletion documentation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6462,6 +6462,7 @@ <h4>Supported Question Types</h4>
<li><a href="#choicematrix">choicematrix</a></li>
<li><a href="#clozeassociation">clozeassociation</a></li>
<li><a href="#clozedropdown">clozedropdown</a></li>
<li><a href="#hotspot">hotspot</a></li>
<li><a href="#imageclozeassociation">imageclozeassociation</a></li>
<li><a href="#longtext">longtext</a></li>
<li><a href="#orderlist">orderlist</a></li>
Expand All @@ -6487,7 +6488,6 @@ <h4>Supported Question Types</h4>
<span class="secondary label">chemistryessay</span>
<span class="secondary label">graphplotting</span>
<span class="secondary label">highlight</span>
<span class="secondary label">hotspot</span>
<span class="secondary label">imageclozedropdown</span>
<span class="secondary label">imageclozeformula</span>
<span class="secondary label">imageclozechemistry</span>
Expand Down Expand Up @@ -7235,6 +7235,176 @@ <h4 style="display: inline-block" id="clozedropdown">clozedropdown</h4>
</tr>
</table>

<hr/>
<h4 style="display: inline-block" id="hotspot">hotspot</h4>
<a style="display: inline-block" href="http://docs.learnosity.com/assessment/questions/questiontypes#hotspot" target="_blank">(documentation)</a>
<a style="display: inline-block; float: right; margin-top: 10px;" href="#mapping-question-types">Back to Top</a>

<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>

<table class="doc-table">
<tr>
<th></th>
<th>Support</th>
<th>Description</th>
</tr>
<tr>
<td class="name">stimulus</td>
<td class="support-status support-status-yes">YES</td>
<td class="description">This is mapped to `prompt`</td>
</tr>
<tr>
<td class="name">options</td>
<td class="support-status support-status-yes">YES</td>
<td class="description">This is mapped to list of simpleChoice</td>
</tr>
<tr>
<td class="name">image</td>
<td class="support-status support-status-yes">YES</td>
<td class="description">This is mapped to the image object width</td>
</tr>
<tr>
<td class="name">image.source</td>
<td class="support-status support-status-yes">YES</td>
<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>
</tr>
<tr>
<td class="name">image.width</td>
<td class="support-status support-status-yes">YES</td>
<td class="description">This is mapped to the image object width</td>
</tr>
<tr>
<td class="name">image.height</td>
<td class="support-status support-status-yes">YES</td>
<td class="description">This is mapped to the image object height</td>
</tr>
<tr>
<td class="name">areas</td>
<td class="support-status support-status-yes">YES</td>
<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>
</tr>
<tr>
<td class="name">multiple_responses</td>
<td class="support-status support-status-yes">YES</td>
<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>
</tr>
<tr>
<td class="name">is_math</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">metadata</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">metadata.distractor_rationale</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">metadata.rubric_reference</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">metadata.sample_answer</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">metadata.acknowledgements</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">stimulus_review</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">type</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">ui_style</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">ui_style.fontsize</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">ui_style.validation_stem_numeration</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">feedback_attempts</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">instant_feedback</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.global</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.global.fill</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.global.stroke</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.individual</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.individual[].area</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.individual[].label</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.individual[].fill</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">area_attributes.individual[].stroke</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
<tr>
<td class="name">max_width</td>
<td class="support-status support-status-no">NO</td>
<td class="description"></td>
</tr>
</table>

<hr/>
<h4 style="display: inline-block" id="imageclozeassociation">imageclozeassociation</h4>
<a style="display: inline-block" href="http://docs.learnosity.com/assessment/questions/questiontypes#imageclozeassociation" target="_blank">(documentation)</a>
Expand Down
32 changes: 32 additions & 0 deletions src/Processors/QtiV2/Out/Documentation/QuestionTypes/HotspotDocumentation.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace LearnosityQti\Processors\QtiV2\Out\Documentation\QuestionTypes;

use LearnosityQti\Processors\QtiV2\Out\Documentation\LearnosityDoc;
use LearnosityQti\Processors\QtiV2\Out\Documentation\QuestionTypeDocumentationInterface;

class HotspotDocumentation implements QuestionTypeDocumentationInterface
{
public static function getDocumentation()
{
return [
'stimulus' => LearnosityDoc::support('This is mapped to `prompt`'),
'options' => LearnosityDoc::support('This is mapped to list of simpleChoice'),
'image' => LearnosityDoc::support('This is mapped to the image object width'),
'image.source' => LearnosityDoc::support('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`'),
'image.width' => LearnosityDoc::support('This is mapped to the image object width'),
'image.height' => LearnosityDoc::support('This is mapped to the image object height'),
'areas' => LearnosityDoc::support('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'),
'multiple_responses' => LearnosityDoc::support('When this option sets to true, then it would map the interaction ' .
'`maxChoices` attribute with the highest number of choices possible')
];
}

public static function getIntroductionNotes()
{
return
"This question type is mapped to <choiceInteraction> and currently only support `exactMatch` validation. Response processing would by default mapped using `match_correct` template.";
}
}

0 comments on commit d72dc69

Please sign in to comment.