]> git.mjollnir.org Git - moodle.git/commitdiff
Put docs here temporarily until the format settles down
authormoodler <moodler>
Fri, 12 Dec 2003 07:50:11 +0000 (07:50 +0000)
committermoodler <moodler>
Fri, 12 Dec 2003 07:50:11 +0000 (07:50 +0000)
mod/quiz/format/gift/docs.html [new file with mode: 0755]

diff --git a/mod/quiz/format/gift/docs.html b/mod/quiz/format/gift/docs.html
new file mode 100755 (executable)
index 0000000..a76d243
--- /dev/null
@@ -0,0 +1,112 @@
+<html>
+
+       <head>
+               <meta http-equiv="content-type" content="text/html;charset=x-sjis">
+               <title>GIFT Import Filter Documentation</title>
+       </head>
+
+       <body bgcolor="#ffffff">
+               <h2>DESCRIPTION</h2>
+               <p>GIFT</p>
+               <p>GIFT is a versitile import filter that provides a quick and easy method for teachers to write Moodle quiz questions as a text file. It supports true-false, short answer and multiple-choice questions, as well as insertion of a blank line for the missing word format. Below are examples of the following question types: multiple choice, missing word, true-false and short-answer.</p>
+<pre>     Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}
+     
+     Grant is {~buried =entombed ~living} in Grant's tomb.
+     
+     Grant is buried in Grant's tomb.{FALSE}
+     
+     Who's buried in Grant's tomb?{=no one =nobody}</pre>
+               <p>Various question-types can be mixed in a sigle text file, and the format also supports question names, feedback comments and percentage-weight grades. GIFT stands for &quot;General Import Format Template.&quot;</p>
+               <hr>
+               <p>
+               </p>
+               <h2>DOCUMENTATION</h2>
+               <p>
+               </p>
+               <p>GIFT is a versitile import filter that provides a quick and easy method for teachers to write Moodle quiz questions as a text file. GIFT can process three basic question types recognized by Moodle: Multiple Choice, True-False and Short Answer. Various question-types can be mixed in a sigle text file, and the format also supports question names, feedback comments and percentage-weight grades. GIFT stands for &quot;General Import Format Template.&quot; Curly brackets are used to indicate answers in the GIFT format. </p>
+               <p></p>
+               <h3>QUESTION TYPES</h3>
+
+               <p><u>Multiple Choice:</u><br />
+               For multiple choice questions, each answer is separated with a tilde (~), and the correct answer is prefixed with an equal sign (=).</p>
+               <pre>     Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}</pre>
+               <p>Missing Word is a subset of the multiple choice question that automatically inserts a fill-in-the-blank line (like this _____) in the middle of the sentence. To make this kind of question, place the answers where you want the line to appear in the sentence.</p>
+               <pre>     Grant is {~buried =entombed ~living} in Grant's tomb.</pre>
+               <p>There must be a blank line (double carriage return) seperating questions. For clarity, the answers can be written on seperate lines and even indented. For example:</p>
+<pre>     The American holiday of Thanksgiving is celebrated on the {
+     ~second
+     ~third
+     =fourth
+     } Thursday of November.
+     
+     Japanese characters originally came from what country? {
+          ~India
+          =China
+          ~Korea
+          ~Egypt}</pre>
+               <p><u>Short Answer:</u><br />
+               Short answer questions are seperated by an equal sign (=), indicating that they are all correct answers. Short answer questions must not contain a tilde. They can also be written as a missing word statement.</p>
+               <pre>     Who's buried in Grant's tomb?{=no one =nobody}
+
+     Two plus two equals {=four =4}.</pre>
+               <p>Note that if the answers come before the closing punctuation mark, a fill-in-the-blank line will be inserted.<p>
+               <p>If there is only <u>one</u> correct Short Answer, it may be written without the equal sign prefix, providing it cannot be confused as True-False.
+               <p><u>True-False:</u><br />
+                       In this question-type the answer indicates whether the statement is true or false. The answer should be written as {TRUE} or [FALSE}, or abbreviated to {T} or {F}.</p>
+               <pre>     Grant is buried in Grant's tomb.{F}
+
+     The sun rises in the east.{T}</pre>
+               <p> </p>
+               <h3>OPTIONS</h3>
+               <p>In addition to these basic question types, this filter offers the following options: question name, feedback and percentage answer weight.</p>
+               <p><u>Question Name:</u><br /> A question name can be specified by placing it first and enclosing it within double colons.</p>
+<pre>     ::Kanji Origins::Japanese characters originally
+     came from what country? {=China}
+
+     ::Thanksgiving Date::The American holiday of Thanksgiving is 
+     celebrated on the {~second ~third =fourth} Thursday of November.</pre>
+               <p>If no question name is specified, the entire question will be used as the name by default.</p>
+<p><u>Feedback Comments:</u><br /> Feedback can be included for each answer by following the comment with a hash mark(#) and the comment.</p>
+<pre>     What's the answer to this multiple-choice question?{
+     ~wrong answer#comment on the wrong answer
+     ~another wrong answer#comment on this wrong answer
+     =right answer#Very good!}
+     
+     Who's buried in Grant's tomb?{
+     =no one#excellent answer!
+     =nobody#excellent answer!}
+     
+     Grant is buried in Grant's tomb.{FALSE#No one is buried in Grant's tomb.}</pre>
+
+<p>For Multiple Choice questions, feedback is displayed only for the answer the student selected. For short answer, feedback is shown only when students input the corresponding correct answer. For true-false questions, the imported feedback is saved so that it will display if the student marked the question incorrectly. So, in the last example above, the student would see the comment only if they selected TRUE as their answer.</p>
+
+<p><u>Percentage Answer Weights:</u><br />
+Percentage answer weights are available for both Multiple Choice and Short Answer questions. Percentage answer weights can be included by following the tilde (for Multiple Choice) or equal sign (for Short Answer) with the desired percent enclosed 
+within percent signs (e.g., %50%). This option can be combined with feedback comments.</p>
+<pre>     Difficult question.{~wrong answer ~%50%half credit answer =full credit answer}
+          
+     ::Jesus' hometown::Jesus Christ was from {
+     ~Jerusalem#This was an important city, but the wrong answer.
+     ~%25%Bethlehem#He was born here, but not raised here.
+     ~%50%Galilee#You need to be more specific.
+     =Nazareth#Yes! That's right!}.
+     
+     ::Jesus' hometown:: Jesus Christ was from {
+     =Nazareth#Yes! That's right!
+     =%75%Nazereth#Right, but misspelled.
+     =%25%Bethlehem#He was born here, but not raised here.}</pre>
+<p>Note that the last two examples are essentially the same question, first as multiple choice and then as short answer.</p>
+
+<p><small>Note that it is possible to specify percentage answer weights that are NOT available through the browser interface. Such answer-weights will calculate correctly (according to the value assigned when imported), and will appear normal to students taking the test. But such answer-weights will not display correctly to teachers when editing them through Moodle's Edit Question interface. The pull-down menu only allows certain fixed values, and if the answer-weight does not exactly match one of those predetermined values, then it will not display correctly. If you edit such a question through the browser interface, the answer weight will change to that displayed.</small></p>
+               <p><u>Other Options:</u><br />
+               Other options are avalable through editing the import filter <b>gift.php</b>. </p>
+               <p>Short Answer questions can be made case sensitive by changing &quot;0&quot; to &quot;1&quot; in the following line:<br />
+                        <tt>$question-&gt;usecase = 0;  // Ignore case</tt></p>
+               <p>It is also possible to enable multiple answers, by uncommenting the appropriate code. Search for &quot;enable multiple answers&quot; to find the lines.</p>
+               <p> </p>
+               <h3>CREDITS</h3>
+               <p>This filter was written through the collaboration of numerous members of the Moodle community. It was originally based on the simple missingword format. In July 2003, Thomas Robb wrote the original code for the percentage answer weight parser and comment insertion . Paul Tsuchido Shew rewrote the filter in December 2003 incorporating community suggestions for a more robust question format, and adding the question name parser, additional question types and other features.</p>
+               <p><small>GIFT documentation, version 1.0. Paul Tsuchido Shew, 12 Dec. 2003.</small></p>
+</body>
+
+</html>