Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Brings documentation up to date with rev.1.2 of gift/format.php

  • Loading branch information...
commit d0f86d165415f87a33f88f120b9385f4cfddf9c4 1 parent 282ecaf
thetrinity authored

Showing 1 changed file with 38 additions and 26 deletions. Show diff stats Hide diff stats

  1. +38 26 mod/quiz/format/gift/docs.html
64 mod/quiz/format/gift/docs.html
@@ -7,56 +7,68 @@
7 7
8 8 <body bgcolor="#ffffff">
9 9 <h2>DESCRIPTION</h2>
10   - <p>GIFT</p>
11   - <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>
  10 + <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 multiple-choice, true-false, short answer and numerical 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, short-answer and numerical.</p>
12 11 <pre> Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}
13 12
14 13 Grant is {~buried =entombed ~living} in Grant's tomb.
15 14
16 15 Grant is buried in Grant's tomb.{FALSE}
17 16
18   - Who's buried in Grant's tomb?{=no one =nobody}</pre>
19   - <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>
  17 + Who's buried in Grant's tomb?{=no one =nobody}
  18 +
  19 + When was Ulysses S. Grant born?{#1922:1}</pre>
  20 + <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.</p>
20 21 <hr>
21 22 <p>
22 23 </p>
23 24 <h2>DOCUMENTATION</h2>
24 25 <p>
25 26 </p>
26   - <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>
  27 + <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 four basic question types recognized by Moodle: Multiple Choice, True-False, Short Answer and Numerical. Various question-types can be mixed in a single text file, and the format also supports question names, feedback comments and percentage-weight grades.</p>
27 28 <p></p>
28 29 <h3>QUESTION TYPES</h3>
29 30
30   - <p><u>Multiple Choice:</u><br />
31   - For multiple choice questions, each answer is separated with a tilde (~), and the correct answer is prefixed with an equal sign (=).</p>
  31 + <p><u>Multiple Choice:</u><br /> For multiple choice questions, wrong answers are prefixed with a tilde (~) and the correct answer is prefixed with an equal sign (=).</p>
32 32 <pre> Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}</pre>
33   - <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>
  33 + <p>The <b>Missing Word</b> format automatically inserts a fill-in-the-blank line (like this _____) in the middle of the sentence. To use the Misssing Word format, place the answers where you want the line to appear in the sentence.</p>
34 34 <pre> Grant is {~buried =entombed ~living} in Grant's tomb.</pre>
  35 + <p>If the answers come before the closing punctuation mark, a fill-in-the-blank line will be inserted for the &quot;missing word&quot; format. All question types can be written in the Missing Word format.</p>
35 36 <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>
36 37 <pre> The American holiday of Thanksgiving is celebrated on the {
37   - ~second
38   - ~third
39   - =fourth
  38 + ~second
  39 + ~third
  40 + =fourth
40 41 } Thursday of November.
41 42
42 43 Japanese characters originally came from what country? {
43   - ~India
44   - =China
45   - ~Korea
46   - ~Egypt}</pre>
47   - <p><u>Short Answer:</u><br />
48   - 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>
  44 + ~India
  45 + =China
  46 + ~Korea
  47 + ~Egypt}</pre>
  48 +
  49 + <p><u>Short Answer:</u><br /> Answers in Short Answer question-type are all prefixed by an equal sign (=), indicating that they are all correct answers .The answers must not contain a tilde.</p>
49 50 <pre> Who's buried in Grant's tomb?{=no one =nobody}
50 51
51 52 Two plus two equals {=four =4}.</pre>
52   - <p>Note that if the answers come before the closing punctuation mark, a fill-in-the-blank line will be inserted.<p>
53   - <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.
  53 + <p>If there is only <u>one</u> correct Short Answer, it may be written without the equal sign prefix, as long as it cannot be confused as True-False.
54 54 <p><u>True-False:</u><br />
55   - 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>
  55 + 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>
56 56 <pre> Grant is buried in Grant's tomb.{F}
57 57
58 58 The sun rises in the east.{T}</pre>
59   - <p> </p>
  59 +
  60 + <p><u>Numerical:</u><br>
  61 + The answer section for Numerical questions must start with a number sign (#). Numerical answers can include an error margin, which is written following the correct answer, seperated by a colon. So for example, if the correct answer is anything between 1.5 and 2.5, then it would be written as follows <u>{#2:0.5}</u>. This indicates that 2 with an error margin of 0.5 is correct (i.e., the span from 1.5 to 2.5). If no error margin is specified, it will be assumed to be zero.</p>
  62 + <pre> When was Ulysses S. Grant born? {#1922}
  63 +
  64 + What is the value of pi (to 3 decimal places)? {#3.1415:0.0005}.</pre>
  65 + <p>Optionally, numerical answers can be written as a span in the following format {<i>MinimumValue</i>..<i>MaximumValue</i>}.</p>
  66 + <pre> What is the value of pi (to 3 decimal places)? {#3.141..3.142}.</pre>
  67 + <p>Moodle's browser interface does not support multiple numerical answers, but Moodle's code can and so does GIFT. This can be used to specify numerical multiple spans, and can be particularly usefully when combined with percentage weight grades. If multiple answers are used, they must be seperated by an equal sign, like short answer questions.</p>
  68 + <pre> When was Ulysses S. Grant born? {#
  69 + =1922:0
  70 + =%50%1922:2}</pre>
  71 + <p>Note that since Moodle's browser GUI doesn't support multiple answers for Numerical questions, there's no way to see them or edit them through Moodle. The only way to change a numerical answer beyond the first, is to delete the question and re-import it (or use something like phpMyAdmin).</p>
60 72 <h3>OPTIONS</h3>
61 73 <p>In addition to these basic question types, this filter offers the following options: question name, feedback and percentage answer weight.</p>
62 74 <p><u>Question Name:</u><br /> A question name can be specified by placing it first and enclosing it within double colons.</p>
@@ -66,7 +78,7 @@
66 78 ::Thanksgiving Date::The American holiday of Thanksgiving is
67 79 celebrated on the {~second ~third =fourth} Thursday of November.</pre>
68 80 <p>If no question name is specified, the entire question will be used as the name by default.</p>
69   -<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>
  81 +<p><u>Feedback Comments:</u><br /> Feedback can be included for each answer by following the answer with a number sign (# also known as a hash mark) and the feedback.</p>
70 82 <pre> What's the answer to this multiple-choice question?{
71 83 ~wrong answer#comment on the wrong answer
72 84 ~another wrong answer#comment on this wrong answer
@@ -99,14 +111,14 @@
99 111
100 112 <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>
101 113 <p><u>Other Options:</u><br />
102   - Other options are avalable through editing the import filter <b>gift.php</b>. </p>
  114 + Other options are avalable through editing the import filter <b>gift/format.php</b>. </p>
103 115 <p>Short Answer questions can be made case sensitive by changing &quot;0&quot; to &quot;1&quot; in the following line:<br />
104 116 <tt>$question-&gt;usecase = 0; // Ignore case</tt></p>
105 117 <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>
106 118 <p> </p>
107 119 <h3>CREDITS</h3>
108   - <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>
109   - <p><small>GIFT documentation, version 1.0. Paul Tsuchido Shew, 12 Dec. 2003.</small></p>
  120 + <p>This filter was written through the collaboration of numerous members of the Moodle community. It was originally based on the missingword format, which included code from Thomas Robb and others. Paul Tsuchido Shew wrote this filter in December 2003 incorporating community suggestions for a more robust question format. The name was conceived as an acronym for &quot;General Import Format Technology&quot; or something like that, but it's too long for a simple filter like this, so it just GIFT.</p>
  121 + <p><small>GIFT documentation, version 1.2. Paul Tsuchido Shew, 6 Jan 2004.</small></p>
110 122 </body>
111 123
112   -</html>
  124 +</html>

0 comments on commit d0f86d1

Please sign in to comment.
Something went wrong with that request. Please try again.