Skip to content

Commit

Permalink
Improved documentation for Quiz filters
Browse files Browse the repository at this point in the history
  • Loading branch information
moodler committed Jan 7, 2004
1 parent e77c81e commit 1cfed10
Show file tree
Hide file tree
Showing 4 changed files with 170 additions and 0 deletions.
24 changes: 24 additions & 0 deletions lang/en/help/quiz/formataiken.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<p align=center><b>Importing "Aiken" format files</b></p>

<p>The Aiken format is a very simple way of creating multiple choice questions using a clear human-readable format. Here is an example of the format:</p>
<pre>
What is the correct answer to this question?
A. Is it this one?
B. Maybe this answer?
C. Possibly this one?
D. Must be this one!
ANSWER: D

Which LMS has the most quiz import formats?
A) Moodle
B) ATutor
C) Claroline
D) Blackboard
E) WebCT
F) Ilias
ANSWER: A
</pre>

<p>The question must be all on one line.</p>
<p>Each answer must start with a single-letter character, followed by a period '.' or a bracket ')', then a space.</p>
<p>The answer line must immediately follow, starting with "ANSWER:" and then giving the appropriate letter.</p>
105 changes: 105 additions & 0 deletions lang/en/help/quiz/formatgift.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<p align=center><b>Importing "GIFT" format files</b></p>


<p>GIFT is the most comprehensive import format available for importing
Moodle quiz questions from a text file. It supports Multiple-Choice,
True-False, Short Answer and Numerical questions, as well as insertion
of a _____ for the Missing word format. 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>

<h3>QUESTION TYPES</h3>

<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>
<pre> Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}</pre>
<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>
<pre> Grant is {~buried =entombed ~living} in Grant's tomb.</pre>
<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>
<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 /> 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>
<pre> Who's buried in Grant's tomb?{=no one =nobody}

Two plus two equals {=four =4}.</pre>
<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.
<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><u>Numerical:</u><br>
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>
<pre> When was Ulysses S. Grant born? {#1922}

What is the value of pi (to 3 decimal places)? {#3.1415:0.0005}.</pre>
<p>Optionally, numerical answers can be written as a span in the following format {#<i>MinimumValue</i>..<i>MaximumValue</i>}.</p>
<pre> What is the value of pi (to 3 decimal places)? {#3.141..3.142}.</pre>
<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>
<pre> When was Ulysses S. Grant born? {#
=1922:0
=%50%1922:2}</pre>
<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>
<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 answer with a number sign (# also known as a hash mark) and the feedback.</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/format.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 missingword format, which included code from Martin Dougiamas, 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>
<p><small>GIFT documentation, version 1.2. Paul Tsuchido Shew, 6 Jan 2004.</small></p>

39 changes: 39 additions & 0 deletions lang/en/help/quiz/import.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,45 @@

<P>A number of file formats are supported:

<P><B>GIFT format</B></P>
<ul>
<p>GIFT is the most comprehensive import format available for importing
Moodle quiz questions from a text file. It supports Multiple-Choice,
True-False, Short Answer and Numerical questions, as well as insertion
of a _____ for the Missing word format. Various question-types can be
mixed in a single text file, and the format also supports question names,
feedback comments and percentage-weight grades. Below are some examples:</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}

When was Ulysses S. Grant born?{#1922:1}
</pre>

<p align=right><a href="help.php?file=formatgift.html&module=quiz">More info about the "GIFT" format</a></p>
</ul>

<P><B>Aiken format</B></P>
<ul>
<p>The Aiken format is a very simple way of creating multiple choice questions using a very clear human-readable format. Here is an example of the format:</p>
<pre>
What is the purpose of first aid?
A. To save life, prevent further injury, preserve good health
B. To provide medical treatment to any injured or wounded person
C. To prevent further injury
D. To aid victims who may be seeking help
ANSWER: A
</pre>

<p align=right><a href="help.php?file=formataiken.html&module=quiz">More info about the "Aiken" format</a></p>
</ul>


<P><B>Missing Word</B></P>
<UL>
<P>This format only supports multiple choice questions.
Expand Down
2 changes: 2 additions & 0 deletions lang/en/help/quiz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@
<li><a href="help.php?module=quiz&file=multianswer.html">Embedded Answers (Cloze)</a>
<li><a href="help.php?module=quiz&file=grademethod.html">Grading method</a>
<li><a href="help.php?module=quiz&file=import.html">Importing questions</a>
<li><a href="help.php?module=quiz&file=formataiken.html">Importing Aiken format files</a>
<li><a href="help.php?module=quiz&file=formatblackboard.html">Importing Blackboard quiz files</a>
<li><a href="help.php?module=quiz&file=formatcustom.html">Importing custom quiz files</a>
<li><a href="help.php?module=quiz&file=formatgift.html">Importing GIFT format files</a>
<li><a href="help.php?module=quiz&file=formatmissingword.html">Importing "Missing Word" files</a>
<li><a href="help.php?module=quiz&file=match.html">Matching questions</a>
<li><a href="help.php?module=quiz&file=maxgrade.html">Maximum grade</a>
Expand Down

0 comments on commit 1cfed10

Please sign in to comment.