GIFT guessit format
For general info about GIFT see the documentation at GIFT format. For information about the Guess It question type see the documentation at Guess It question type.
The specific GIFT guessit format plugin allows you to use a text editor to write Guess It questions in a simple format that can be imported into your Moodle question bank. It can only be used if the Guess It question type is already installed on your Moodle site, of course.
If both qtype_guessit and qformat_gift_guessit plugins have been installed on your Moodle site, when going to the Question Bank and selecting Import you should be able to select the GIFT to guessit format option as shown above.
Question format examples
Here is an example of a demonstration text file containing most of the accepted questions GIFT formatting.
// Q0 This gift_guessit file contains various possible cases of formattings with no errors and a category. $CATEGORY: All guessit and wordle cases
// Q1 guessit full params with 8 tries before help etc.
::English Proverb 01::In Egypt they say "Two captains on the ship will sink it."{Too many cooks spoil the broth.[8]####When there are too many people trying to lead and give their opinions, it's confusing and leads to bad results. Jobs and projects should have one or two strong leaders.}
// Q2 wordle minimal will detect single word (which must be capitalised)
{WHISKY}
// Q3 wordle with no question name but with instructions (definition)
A group of manuscript pages stitched together on one side to form a book; as opposed to pages sewn together on both sides to form a continuous scroll that had to be rolled up for storage and unrolled to be read.{CODEX}
// Q4 wordle with 8 maxtries and URL link in the feedback
::name pizza::Guess an Italian dish that’s cooked in a very hot oven{PIZZA[8]####Click to read more about <a href="https://nomadparadise.com/italian-pizza/">Italian pizzas</a>.}
// Q5 wordle no question name with 14 maxtries
Guess an Italian type of dish{PASTA[14]####More than 600 different types of pasta exist from all regions of Italy.}
// Q6 guessit minimal
{A rolling stone gathers no moss.}
// Q7 guessit no question name and uses default params
Eating an apple a day will keep you healthy.{An apple a day keeps the doctor away.}
Q0 is not a real question but a category name. See explanations in the GIFT format doc here: Specifying Categories
Q1 is an example of a Guessit question where all the parameters are specified, as follows:
- // Comment (will not be imported to the questions bank)
- ::English Proverb 01:: Question title (optional)
- Question text (optional; becomes title if no title specified) . Actually, in the Guessit question type, the Question text field is used as a Description or Instructions field.
- { ... Start answer. In the default Guess It option, the "answer" consists of a short sentence which the student will have to guess; in the Wordle option, the answer consists of a single word, which must be in CAPITAL LETTERS and no diacritics. The qformat_gift_guessit will automatically detect the number of words in the {answer} and decide on which option will be used (Guess It default or Wordle option).
- [8] This (optional) parameter between square brackets contains either the Number of tries before getting help (for the Guess It option) or the Maximum number of tries before the solution is given (for the Wordle option). If this parameter is not provided, the default value [10] will be used.
- Feedback text (optional) if preceded by 4 # characters.
- ... } End answer.
Q2 is an example of a question with the Wordle option as answer. No parameters are provided, no feedback, default Maximum number of tries [10] will be used. Because no Question text or Question title are provided, the Wordle answer {WHISKY} will be used for the question title.
From the other examples provided above it is clear that you can easily create text files with minimal parameters if needed.
Import error messages
Like all GIFT import files, respecting the format syntax is essential for correct import process. The qformat_gift_guessit plugin provides a number of ad hoc error messages to help the end-user detect syntax errors.
For demonstration purposes a text file has been created with lots of syntax errors and imported into the question bank using qformat_gift_guessit.
// No brackets: no word(s) to be guessed: no guessit gaps Too many cooks
// Brackets do not match
{My tailor is rich.
// Brackets do not match My tailor is rich}.
// Question name not correctly enclosed :...::
:Question 02::Find this cook{Too many cooks spoil the broth.}
// Question name not correctly enclosed in ::...:
::Question 03:The description{My tailor is rich.}
// Question name not correctly enclosed in :...:
:Question 05:{My brother is not a girl.}
// Question name not correctly enclosed in ::...
::Question 06{My mum likes me.}
// guessit square brackets do not match
::Proverb::Description{My sister is not a boy.[6}
// guessit nbtries error
{My tailor is very rich.[9]}
// guessit minimal params (correct)
{A rolling stone gathers no moss.}
// guessit full params (correct) At least one correct question is needed for behat test to work.
::English Proverb 01::When there are too many people...{Too many cooks spoil the broth.}
The error messages are self-explanatory and are followed by the full text of the Guess It question to be imported (highlighted in yellow on this screenshot).
