| |
B.1.1. | Do I need a <meta> element in every message? |
Yes, unless you are logging directly to an OLI log database using the OLI logging service—in this case, you never need to supply a meta element. The DataShop uses the context_message_id, the user_id, and the session_id to group the tool-tutor message pairs together with their context message. | |
B.1.2. | If an element is required, can I just include it but leave it empty? |
No, required elements should not be left blank/empty. They are required for a reason. | |
B.1.3. | How should I represent an untutored action? |
An untutored action can be represented by a single tool message with no tutor message following it. | |
B.1.4. | In this document, you say that the <interpretation> element should not be used, but there is no guidance as to what to replace it with. |
There is no replacement for the interpretation element. For Andes data, the DataShop team can run a program over the logs which will convert the multiple steps in the interpretation elements into multiple transactions. | |
B.1.5. | I want to record HTML in the <tutor_advice> element. How can I format the content so that it is valid XML? |
An easy way to avoid having to escape all special characters in XML (which includes "<", ">", and "&") is to use a CDATA section. A CDATA section is a section of element content that is marked for the parser to interpret as only character data, not markup. It starts with the following sequence: <![CDATA[ and ends with the first occurrence of the sequence: ]]> For example: <tutor_advice><![CDATA[We can define a body for the swimmer.; Click on a <a href="#"
onClick="andes.help.link('Manual','body-tool');andes.principles.review('manual.html',
'Manual','body-tool');">Body Tool</a> (<img src="../review/ui-images/ellipse-tool.png"
class="button" alt="ellipse tool"> or <img src="../review/ui-images/rectangle-tool.png"
class="button" alt="rectangle-tool">), drag out a shape, and enter <span
class="text-box">swimmer</span>.]]></tutor_advice> | |