From 2d8bfda03f5823979e66a5e8e4fc8bd9396a360a Mon Sep 17 00:00:00 2001 From: tjhunt Date: Wed, 26 Sep 2007 20:13:47 +0000 Subject: [PATCH] MDL-5086 - Improve the formatting of the question import and export help so that the code samples fit. Merged from MOODLE_18_STABLE. --- lang/en_utf8/help/quiz/export.html | 15 +- lang/en_utf8/help/quiz/formatgift.html | 226 +++++++++++++++---------- lang/en_utf8/help/quiz/formatxml.html | 1 + lang/en_utf8/help/quiz/import.html | 44 +++-- 4 files changed, 163 insertions(+), 123 deletions(-) diff --git a/lang/en_utf8/help/quiz/export.html b/lang/en_utf8/help/quiz/export.html index 145bd5e242..cb5c4296af 100644 --- a/lang/en_utf8/help/quiz/export.html +++ b/lang/en_utf8/help/quiz/export.html @@ -14,7 +14,7 @@

The format(s) currently supported are:

GIFT format

-
+

GIFT is the most comprehensive import/export format available for exporting Moodle quiz questions to a text file. It was designed to be an easy method for teachers writing questions as a text file. It supports Multiple-Choice, @@ -36,31 +36,30 @@ When was Ulysses S. Grant born?{#1822}

More info about the "GIFT" format

-

Moodle XML format

-
+

This Moodle specific format exports quiz questions in a simple XML format. They can then be imported into another quiz category or used in some other process such as an XSLT transformation. The XML format will export images attached to questions (encoded base64).

-
+

IMS QTI 2.0

-
+

Exports in the standard IMS QTI (version 2.0) format. Note that this generates a group of files within a single 'zip' file.

More information on the IMS QTI site (external site in new window)

-
+

XHTML

-
+

Exports the category as a single page of 'strict' XHTML. Each question is clearly placed in its own <div> tag. If you want to use this page as-is, you will need to at least edit the <form> tag at the start of the <body> section to provide a suitable action (eg, a 'mailto').

-
+

Import and Export formats are a pluggable resource. Other optional formats may be available in the Modules and Plugins database.

diff --git a/lang/en_utf8/help/quiz/formatgift.html b/lang/en_utf8/help/quiz/formatgift.html index 574550070a..75ad58a018 100644 --- a/lang/en_utf8/help/quiz/formatgift.html +++ b/lang/en_utf8/help/quiz/formatgift.html @@ -21,56 +21,69 @@

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}
+
+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 Missing Word format, place the answers where you want the line to appear in the sentence.

- 
     Grant is {~buried =entombed ~living} in Grant's tomb.
+
+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) separating questions. For clarity, the answers can be written on separate lines and even indented. For example:

- 
     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}
+
+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
+}
+

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}
+
+Who's buried in Grant's tomb?{=no one =nobody}
 
-     Two plus two equals {=four =4}.

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

+The sun rises in the east.{T}
+

Matching:
Matching pairs begin with an equal sign (=) and are separated by this symbol "->". There must be at least three matching pairs.

- 
     Matching Question. {
-         =subquestion1 -> subanswer1
-         =subquestion2 -> subanswer2
-         =subquestion3 -> subanswer3
-         }
-     
-     Match the following countries with their corresponding capitals. {
-         =Canada -> Ottawa
-         =Italy  -> Rome
-         =Japan  -> Tokyo
-         =India  -> New Delhi
-         }
+
+Matching Question. {
+    =subquestion1 -> subanswer1
+    =subquestion2 -> subanswer2
+    =subquestion3 -> subanswer3
+}
+
+Match the following countries with their corresponding capitals. {
+    =Canada -> Ottawa
+    =Italy  -> Rome
+    =Japan  -> Tokyo
+    =India  -> New Delhi
+}
+

Matching questions do not support feedback or percentage answer weights.

Numerical:
@@ -79,17 +92,24 @@ 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? {#1822}
+
+When was Ulysses S. Grant born? {#1822}
 
-     What is the value of pi (to 3 decimal places)? {#3.1415:0.0005}.

+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}.
+
+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 separated by an equal sign, like short answer questions.

- 
     When was Ulysses S. Grant born? {#
-         =1822:0
-         =%50%1822:2}
+
+When was Ulysses S. Grant born? {#
+    =1822:0
+    =%50%1822: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 @@ -98,11 +118,15 @@

Essay:
An essay question is simply a question with an empty answer field. Nothing is permitted between the curly braces at all.

- 
    Write a short biography of Ulysses S. Grant {}
+
+Write a short biography of Ulysses S. Grant {}
+

Description:
A description "question" has no answer part at all

- 
    The next set of questions will concern arithmatic
+
+The next set of questions will concern arithmatic
+

OPTIONS

@@ -113,28 +137,35 @@ Comments that will not be imported into Moodle can be included in the text file. This can be used to provide headers or more information about questions. All lines that start with a double backslash (not counting tabs or spaces) will be ignored by the filter.

- 
     // Subheading: Numerical questions below
-     What's 2 plus 2? {#4}
+
+// Subheading: Numerical questions below
+What's 2 plus 2? {#4}
+

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}
+
+::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.

+::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.

Feedback:
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#feedback comment on the wrong answer
-     ~another wrong answer#feedback comment on this wrong answer
-     =right answer#Very good!}
+
+What's the answer to this multiple-choice question? {
+    ~wrong answer#feedback comment on the wrong answer
+    ~another wrong answer#feedback comment on this wrong answer
+    =right answer#Very good!
+}
      
-     Who's buried in Grant's tomb?{
-     =no one#excellent answer!
-     =nobody#excellent answer!}
+Who's buried in Grant's tomb? {
+    =no one#excellent answer!
+    =nobody#excellent answer!
+}
      
      Grant is buried in Grant's tomb.{FALSE#Wrong, No one is buried in Grant's tomb.#Right, well done.}

     
For Multiple Choice questions, feedback is displayed only for the answer the student selected. 
@@ -147,18 +178,21 @@
     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.

-    
     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!}.
+
+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.}

+::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.
+}

     
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 
@@ -172,31 +206,39 @@
     markdown (Markdown format). The format is specified in square brackets immediately before the 
     question text. More information on text formats in Moodle.

 
- 
[markdown]The *American holiday of Thanksgiving* is celebrated on the {
-         ~second
-         ~third
-         =fourth
-     } Thursday of November.    

+
+[markdown]The *American holiday of Thanksgiving* is celebrated on the {
+    ~second
+    ~third
+    =fourth
+} Thursday of November.
+

 
 
 
Multiple Answers:

     The Multiple Answers option is used for multiple choice questions when two or more answers must 
     be selected in order to obtain full credit. The multiple answers option is enabled by assigning 
     partial answer weight to multiple answers, while allowing no single answer to receive full credit.

-    
     What two people are entombed in Grant's tomb? {
-          ~No one
-          ~%50%Grant
-          ~%50%Grant's wife
-          ~Grant's father }

+
+What two people are entombed in Grant's tomb? {
+    ~No one
+    ~%50%Grant
+    ~%50%Grant's wife
+    ~Grant's father
+}
+

     
Note that there is no equal sign (=) in any answer and the answers should total no more than 100%, 
     otherwise Moodle will return an error. 
     To avoid the problem of students automatically getting 100% by simply checking all of the answers, 
     it is best to include negative answer weights for wrong answers.

-    
     What two people are entombed in Grant's tomb? {
-          ~%-50%No one
-          ~%50%Grant
-          ~%50%Grant's wife
-          ~%-50%Grant's father }

+
+What two people are entombed in Grant's tomb? {
+    ~%-50%No one
+    ~%50%Grant
+    ~%50%Grant's wife
+    ~%-50%Grant's father
+}
+

 
 
Special Characters ~ = # { } :

     These symbols  ~ = # { } :  control the operation of this filter and cannot be used as normal text within questions.
@@ -206,21 +248,23 @@
     This means simply putting a backslash (\) before a control character so the filter will know that you want to use
     it as a literal character instead of as a control character.
     For example:

-    
     Which answer equals 5? {
-          ~ \= 2 + 2
-          = \= 2 + 3
-          ~ \= 2 + 4  }
-
-     ::GIFT Control Characters::
-     Which of the following is NOT a control character for the GIFT import format? {
-        ~ \~     # \~ is a control character.
-        ~ \=     # \= is a control character.
-        ~ \#     # \# is a control character.
-        ~ \{     # \{ is a control character.
-        ~ \}     # \} is a control character.
-        = \     # Correct! \ (backslash) is not a control character. BUT,
-                   it is used to escape the control characters.
-     }

+
+Which answer equals 5? {
+    ~ \= 2 + 2
+    = \= 2 + 3
+    ~ \= 2 + 4
+}
+
+::GIFT Control Characters::
+Which of the following is NOT a control character for the GIFT import format? {
+   ~ \~     # \~ is a control character.
+   ~ \=     # \= is a control character.
+   ~ \#     # \# is a control character.
+   ~ \{     # \{ is a control character.
+   ~ \}     # \} is a control character.
+   = \      # Correct! \ (backslash) is not a control character. BUT,
+              it is used to escape the control characters.
+}

     
When the question is processed, the backslash is removed and is not saved in Moodle.

 
 
Specifying Categories

diff --git a/lang/en_utf8/help/quiz/formatxml.html b/lang/en_utf8/help/quiz/formatxml.html
index 3168ca3e5e..f72619de49 100644
--- a/lang/en_utf8/help/quiz/formatxml.html
+++ b/lang/en_utf8/help/quiz/formatxml.html
@@ -1,6 +1,7 @@
 
Importing "Moodle XML" format files

 
 
Category Switching

+
 
You can insert a special dummy question into the XML file to specify
 the category path into which the following questions will be inserted.
 If the category or categories do not exist they will be created. Note that
diff --git a/lang/en_utf8/help/quiz/import.html b/lang/en_utf8/help/quiz/import.html
index b8c091b455..83b5dc0c87 100644
--- a/lang/en_utf8/help/quiz/import.html
+++ b/lang/en_utf8/help/quiz/import.html
@@ -17,8 +17,9 @@
 
 
A number of file formats are supported:

 
+
 
GIFT format

-

+
 
GIFT is the most comprehensive import format available for importing 
    Moodle quiz questions from a text file.  It was designed to be an easy 
    method for teachers writing questions as a text file. It supports Multiple-Choice, 
@@ -39,26 +40,26 @@ When was Ulysses S. Grant born?{#1822}

More info about the "GIFT" format

- +

Aiken Format

-
+

This is a simple format for importing multiple choice questions from a text file.

More info about the "Aiken" format

-
+

Moodle XML format

-
+

This Moodle specific format imports quiz questions that have previously been exported in the same format. The format is straightforward and is best demonstrated by exporting a category in the Moodle XML format. The XML format is capabable of importing image files.

More info about the "Moodle XML" format

-
+

Missing Word

-
+

This format only supports multiple choice questions and short answer question, depending on the number of answers. One answer generates a short answer question, two or more answers @@ -80,37 +81,35 @@ we become students of {=anatomy and physiology ~reflexology

More info about the "Missing Word" format

-
+

Blackboard

-
+

This module can import questions saved in Blackboard's "POOL" type export format. It relies on XML functions being compiled into your PHP. Note that you must first unpack the exported zip file and provide Moodle with the appropriate .dat file. Note that this version does not work with Blackboard Version 6 and newer.

-
+

Blackboard V6+

-
+

This module can import questions saved in Blackboard's export format. It provides limited support for Blackboard Version 6 and 7. It relies on XML functions being compiled into your PHP. You must upload the zip file exported from Blackboard.

-

WebCT

-
+

This module can import questions saved in WebCT's text-based format.

More info about the "WebCT" format

-

Course Test Manager

-
+

This module can import questions saved in a Course Test Manager test bank. It relies on different ways of accessing the test bank, which is in a Microsoft Access database, depending on whether Moodle is running on a Windows or Linux web server.

@@ -121,32 +120,29 @@ to transfer data to moodle on the Linux server.

Please read the full help file below before using this import class.

-

More info about the "CTM" format

-
-

Embedded answers (Cloze)

-
+

This special purpose format imports just one type of question, the Embedded Answers (also known as Cloze) format.

More info about the "Cloze" format

-
+

Learnwise format

-
+

This format can import multiple choice questions saved in Learnwise's XML format.

-
+

Examview format

-
+

This format can import from Examview 4 XML files. Note that the older versions of Examview are not supported.

-
+

Import and Export formats are a pluggable resource. Other optional formats may be available in the Modules and Plugins database.

-- 2.39.5