GIFT Import Filter Documentation

From 24c70149add504a5b552ebc8c67791e9b811af07 Mon Sep 17 00:00:00 2001 From: thetrinity Date: Tue, 6 Jan 2004 02:19:11 +0000 Subject: [PATCH] Changed to UNIX file type and removed tabs for documentation. o U --- mod/quiz/format/gift/docs.html | 101 +++++++++++++++++---------------- 1 file changed, 51 insertions(+), 50 deletions(-) diff --git a/mod/quiz/format/gift/docs.html b/mod/quiz/format/gift/docs.html index 861fb14cc6..634a71d90f 100755 --- a/mod/quiz/format/gift/docs.html +++ b/mod/quiz/format/gift/docs.html @@ -1,13 +1,13 @@ - - - GIFT Import Filter Documentation - + + + GIFT Import Filter Documentation + - -

DESCRIPTION

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.

+ +

DESCRIPTION

     Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}
      
      Grant is {~buried =entombed ~living} in Grant's tomb.
@@ -17,23 +17,24 @@
      Who's buried in Grant's tomb?{=no one =nobody}
 
      When was Ulysses S. Grant born?{#1922:1}

Various question-types can be mixed in a sigle text file, and the format also supports question names, feedback comments and percentage-weight grades.

DOCUMENTATION

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.

QUESTION TYPES

Various question-types can be mixed in a sigle text file, and the format also supports question names, feedback comments and percentage-weight grades.

DOCUMENTATION

QUESTION TYPES

Multiple Choice:
For multiple choice questions, wrong answers are prefixed with a tilde (~) and the correct answer is prefixed with an equal sign (=).

     Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}

The Missing Word 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.

     Grant is {~buried =entombed ~living} in Grant's tomb.

If the answers come before the closing punctuation mark, a fill-in-the-blank line will be inserted for the "missing word" format. All question types can be written in the Missing Word format.

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:

Multiple Choice:
+ For multiple choice questions, wrong answers are prefixed with a tilde (~) and the correct answer is prefixed with an equal sign (=).

     Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}

     Grant is {~buried =entombed ~living} in Grant's tomb.

If the answers come before the closing punctuation mark, a fill-in-the-blank line will be inserted for the "missing word" format. All question types can be written in the Missing Word format.

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:

     The American holiday of Thanksgiving is celebrated on the {
          ~second
          ~third
@@ -46,38 +47,38 @@
          ~Korea
          ~Egypt}

Short Answer:
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.

     Who's buried in Grant's tomb?{=no one =nobody}
+        Short Answer:
 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.
+             Who's buried in Grant's tomb?{=no one =nobody}
 
      Two plus two equals {=four =4}.
-		If there is only one correct Short Answer, it may be written without the equal sign prefix, as long as it cannot be confused as True-False.
-		
True-False:

-			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}.
-		     Grant is buried in Grant's tomb.{F}
+        If there is only one correct Short Answer, it may be written without the equal sign prefix, as long as it cannot be confused as True-False.
+        
True-False:

+            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}.
+             Grant is buried in Grant's tomb.{F}
 
      The sun rises in the east.{T}
 
-		Numerical:

-			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 {#2:0.5}. 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.
-		     When was Ulysses S. Grant born? {#1922}
+        Numerical:

+            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 {#2:0.5}. 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.
+             When was Ulysses S. Grant born? {#1922}
 
      What is the value of pi (to 3 decimal places)? {#3.1415:0.0005}.
-     	Optionally, numerical answers can be written as a span in the following format {MinimumValue..MaximumValue}.
-		     What is the value of pi (to 3 decimal places)? {#3.141..3.142}.
-		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.
-		     When was Ulysses S. Grant born? {#
+         Optionally, numerical answers can be written as a span in the following format {#MinimumValue..MaximumValue}.
+             What is the value of pi (to 3 decimal places)? {#3.141..3.142}.
+        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.
+             When was Ulysses S. Grant born? {#
          =1922:0
          =%50%1922:2}
-		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).
-		OPTIONS
-		In addition to these basic question types, this filter offers the following options: question name, feedback and percentage answer weight.
-		Question Name:
 A question name can be specified by placing it first and enclosing it within double colons.
+        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).
+        OPTIONS
+        In addition to these basic question types, this filter offers the following options: question name, feedback and percentage answer weight.
+        Question Name:
 A question name can be specified by placing it first and enclosing it within double colons.
      ::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.
-		If no question name is specified, the entire question will be used as the name by default.
+        If no question name is specified, the entire question will be used as the name by default.
 Feedback Comments:
 Feedback can be included for each answer by following the answer with a number sign (# also known as a hash mark) and the feedback.
      What's the answer to this multiple-choice question?{
      ~wrong answer#comment on the wrong answer
@@ -110,15 +111,15 @@ within percent signs (e.g., %50%). This option can be combined with feedback com
 Note that the last two examples are essentially the same question, first as multiple choice and then as short answer.
 
 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.
-		Other Options:

-		Other options are avalable through editing the import filter gift/format.php. 
-		Short Answer questions can be made case sensitive by changing "0" to "1" in the following line:

-			 $question->usecase = 0;  // Ignore case
-		It is also possible to enable multiple answers, by uncommenting the appropriate code. Search for "enable multiple answers" to find the lines.
-		 
-		CREDITS
-		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  "General Import Format Technology" or something like that, but it's too long for a simple filter like this, so it just GIFT.
-		GIFT documentation, version 1.2. Paul Tsuchido Shew, 6 Jan 2004.
+        Other Options:

+        Other options are avalable through editing the import filter gift/format.php. 
+        Short Answer questions can be made case sensitive by changing "0" to "1" in the following line:

+             $question->usecase = 0;  // Ignore case
+        It is also possible to enable multiple answers, by uncommenting the appropriate code. Search for "enable multiple answers" to find the lines.
+         
+        CREDITS
+        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  "General Import Format Technology" or something like that, but it's too long for a simple filter like this, so it just GIFT.
+        GIFT documentation, version 1.2. Paul Tsuchido Shew, 6 Jan 2004.
 
 
 
\ No newline at end of file
-- 
2.39.5