MoodleDocs - User contributions [en]

Editing Questionnaire questions

2020-05-14T08:04:32Z

Rezeau: /* Possible answers */

{{Questionnaire}}

==Editing questions==
* On the Questionnaire '''Editing Questions''' page is displayed a drop-down list of the question types available and a list of the questions already created for the current questionnaire instance (if any).
* Using the standard Moodle icons you can change the order of the questions in the questionnaire, edit or delete questions.

==Common options==
===Question Name===

====Questionnaires '''not''' using the Conditional Branching or the Personality Test features====

You can ''optionally'' enter a '''Question Name''' for each question.

If your questionnaire does not use the "Conditional Branching" or the "Personality Test" feature, the '''Question Name''' is only used when you export responses to CSV/Excel format. If you never export to CSV, then you needn't worry about Question names. If you plan to regularly export your questionnaire data to CSV, then you have a choice of two options for question naming.

=====Option 1: significant names=====

In the '''Question Name ''' box, enter ''meaningful'', ''short'' and '''''different''''' question names for all of the questions within one questionnaire. In the CSV export file, all those question names will be prefixed with the question's actual number (= position) in the quiz. Examples:

{| border="1"
! scope="col" | question number (position) in the questionnaire
! scope="col" | question name entered by teacher
! scope="col" | field header in csv export
|-
|
<div style="text-align: center">5</div>
| favorite colors
| Q05_favorite colors
|-
|
<div style="text-align: center">6</div>
| why_use_Moodle
| Q06_why_use_moodle
|-
|
<div style="text-align: center">7</div>
|
user-friendliness

'' (rate question with 3 possible answers: Moodle, WebCT and Blackboard) ''
|
Q07_user-friendliness->Moodle Q07_user-friendliness->WebCT Q07_user-friendliness->Blackboard
|}

=====Option 2: leave the Question Name boxes blank=====

For each un-named question, CSV export will automatically generate a question name. This is required for table header fields in the CSV and subsequent Excel tables or any statistics package you might be using. The question name generated will be based on the question number in the actual Quiz (excluding ''Section Text'' pseudo-questions, of course) e.g. Q01, Q02, ... Q99. For questions with multiple answers, such as rate-type or Likert type questions, a sub-question number will be generated (Q02_1, Q02_2, Q02_3, etc.). This type of "short-name" naming scheme is advisable for exporting your data to a statistics software. Of course, it's up to you to have your own system for remembering which abbreviated question name corresponds to which question in your questionnaire!

{| width="100%" border="1"
! style="width: 33%" scope="col" | question number (position) in the questionnaire
! style="width: 33%" scope="col" | question name entered by teacher
! style="width: 33%" scope="col" | field header in csv export
|-
|
<div style="text-align: center">5</div>
| style="background-color: #CCCCCC" |
| Q05
|-
|
<div style="text-align: center">6</div>
| style="background-color: #CCCCCC" |
| Q06
|-
|
<div style="text-align: center">7</div>
| style="background-color: #CCCCCC" |
|
Q07_1 Q07_2 Q07_3
|}

It is quite possible (but maybe not advisable) to mix the two systems, and have within one questionnaire both named and un-named questions.

====Questionnaires using the Conditional Branching feature====

If you need a question to be used as the "parent" of one or more subsequent questions in your questionnaire, then you '''must''' name that "parent question". Only those (radio buttons, dropdown list or yes/no) questions with a ''name'' will appear in the Parent question dropdown list when adding a new question, as shown on the following screenshots.

[[Image:05-08-2013 15-26-11.jpg]]

[[Image:05-08-2013 15-34-55.jpg]]

For more information, see [[Questionnaire_Conditional_branching|Conditional branching]].

===Response Required===
If you select '''''Yes''''', response to this question will be required, i.e. the respondent will not be able to submit the questionnaire until this question has been answered. If the respondent tries to submit a questionnaire with unanswered required questions (or, in the case of a questionnaire with more than one section, to go to the next page), a warning message will be displayed with a list of all the missing ''required ''questions in the questionnaire (or on the actual page).

Default.- '''''No'''''.

'''Note'''.- When you create new questions in sequence (one after the other), this parameter is carried over to subsequent questions. E.g. if you create question #1 with '''Response Required''' = '''''Yes''''', then the '''Response Required''' parameter will be pre-set to '''''Yes''''' for question #2, etc. You can of course change this parameter at any time.

In the ''Manage Questions'' section of the Questions editing page, once a question has been created, you can use the green and red dots to switch its Required state, as a shortcut alternative of editing the question.

[[Image:05-08-2013 15-49-48.jpg|300px]]

===Parent Question===

See [[Questionnaire_Conditional_branching|Conditional branching]]

===Question Text===
Enter your question text in this box. The HTML editor is available, which means that you can display not only formatted text but also images or other media in a questionnaire's questions text.

==Question Types==

Select the type of question from the drop-down list and click on the '''Add selected question type''' button.

===---Page Break---===

Use this to insert page breaks in longish questionnaires. Note that if a page contains questions with required response the respondent will not be allowed to navigate to the next page unless those required responses have been given.

If your questionnaire uses the Conditional branching feature, then page breaks will be ''automatically'' inserted when you add "parent" or "child" questions. Page breaks which are needed to ensure a correct "Conditional branching" flow cannot be moved or deleted. Their Move and Delete icons are disabled.

[[Image:05-08-2013 15-58-09.jpg|300px]]

===Check Boxes===
Check boxes allow the user to select multiple answers from a list of options.

==== Question editing interface ====

[[Image:05-08-2013 14-58-42.jpg|400px]]

==== Options ====

{| style="width: 100%" border="1" cellpadding="5"
! style="width: 50%" scope="col" | Editing Mode
! style="width: 50%" scope="col" | Questionnaire View
|-
|
{| style="width: 300"
| colspan="2" valign="top" | Question text: What are your favorite hobbies?

Possible answers:
|-
| style="border: #666666 thin solid" |
Watching TV Dancing Computing !other=Another hobby:
|}
|
[[Image:05-08-2013 13-29-49.jpg]]
|}

You may enter <tt>“!other”</tt> on a line to create an '''''optional''''' ''fill in the blank'' option. An<tt><nowiki>!other</nowiki></tt> box defaults to using the prompt ''Other: '', (or the equivalent translation for ''Other'' in the current language being used). You may change this default prompt by using the format: <tt>“!other=''prompt text”''</tt> as shown in the example above.

'''Notes.-'''

# At the moment the length of the ''fill in the blank'' input text box is set to 25 characters and is not customizable through the online interface.
# You may provide more than one <tt><nowiki>!other</nowiki></tt> ''fill in the blank'' option for a Check Boxes question, but this might cause problems so it is ''not recommended''.
# When a respondent answers a''' Check Boxes''' question which has been created as '''Required''', and the '''Min. forced responses '''and''' Max. forced responses''' parameters have been used, then a warning message will be displayed if respondent does not check the required number of boxes.
# Note that, if the <tt><nowiki>!other</nowiki></tt> ''fill in the blank'' option has been created, then if it is checked by the respondent, it will count in the total of minimum/maximum required check boxes.
# If a respondent checks a ''fill in the blank'' option '''check box''' and leaves the text field empty, ''that box will be unchecked'' (upon navigating to the next page or upon submitting the questionnaire).
# If a respondent has cheked ''a fill in the blank'' option '''check box''' and has filled in the text field, and later on changes his mind and unckecks that box, the ''fill in the blank'' text field will be automatically emptied (cool, ain't it?).

===Date===

''Use the day/month/year format, e.g. for March 14th, 1945: '''14/3/1945'''''

Use this question type if you expect the response to be a correctly formatted date. The format will depend upon the language currently being used by the questionnaire respondent. For example 4/21/2007 (US); 21/4/2007 (UK); 21-4-2007 (France); etc. An example will be displayed in the questionnaire. If an "impossible" or wrongly formatted date is entered, it will either be re-written or reformatted correctly (if possible) or an error message will be displayed to the respondent. In order for dates to be correctly exported to spreadsheets such as Excel, respondent must enter ''a date in the 1902 to 2037 range''. If a date outside this range is expected from respondents, then use the '''Text Box''' question type instead. The date question type will accept dates consisting only of a month plus a year (e.g. 12/2008 for december 2008) or only a year (e.g. 2008). However, for spreadsheet processing compatibility, such incomplete dates will be automatically transformed to complete dd/mm/yy dates, e.g. 12/2008 -> '''01/'''12/2008 and 2008 -> '''01/01/'''2008. You may have to explain this pecularity to your questionnaire users beforehand.

===Dropdown Box===

There is no real advantage to using the '''Dropdown Box''' over using the '''Radio Buttons''' except perhaps for longish lists of options, to save screen space.

===Essay Box===
====Question editing interface====
[[Image:2014-01-24_15-37-29.jpg|400px]]

====Settings====
This question will display a plain text box with '''x''' ''Textarea columns'' (or area ''width'') and '''y''' ''Textarea rows'' (number of text ''lines'').

If you leave both x and y to their default '''0''' value (or if you set it to '''0'''), then moodle's '''HTML editor''' will be displayed with standard height and width (if available in the course/user context & user profile).

===Label===

This is not a question but a (short) text which will be displayed to introduce a series of questions.

===Numeric===

Use this question type if you expect the response to be a correctly formatted number. By using the '''Max. digits allowed '''and '''Nb of decimal digits '''parameters you can specify the length and number of decimal places required. Use '''Max. digits allowed''' to set a limit to the number of characters entered for a Numeric question. Note that the decimal point also counts as one character! Use '''Nb of decimal digits''' to specify the format of the Average value counted and displayed at the Questionnaire Report page.

Examples:

{| class="nicetable"
|-
!
! Max. digits allowed
! Nb of decimal digits
! Response entered
! Average displayed
|-
| Example 1
| 6
| 2
| 12
| 12.00
|-
| Example 2
| 6
| 2
| 12.569
| 12.57
|-
| Example 3
| 8
| 1
| 12.57898
| 12.6
|}

=== Radio Buttons ===
====Question editing interface====
[[Image:05-08-2013 15-03-17.jpg|400px]]

====Radio buttons Alignment====
[[Image:05-08-2013 13-35-04.jpg]]

====Possible answers====
You must fill in one answer per line in the '''Possible answers''' box.

Examples:

{| border="1" cellpadding="5"
! style="width: 250" scope="col" valign="top" | Editing Mode
! style="width: 243" scope="col" valign="top" | Questionnaire View
! style="width: 434" scope="col" valign="top" | (optional horizontal display)
|-
| valign="top" |
'' 1.Possible answers''<nowiki>: </nowiki>

Red Blue Black
| valign="top" |
''' What is your favorite color? ''' Red Blue Black
| valign="top" |
''' What is your favorite color? ''' Red Blue Black
|-
| valign="top" |
'' 2.Possible answers''<nowiki>: </nowiki>

Red Blue Black !other
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Other:
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Other:
|-
| valign="top" |
'' 3.Possible answers:''

Red Blue Black !other=Another color:
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Another color:
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Another color:
|-
| valign="top" |
| valign="top" | Questionnaire View
| valign="top" | ''''' Text data export '''''
|-
| valign="top" |
'' 4.Possible answers: ''

red::the color of blood blue::the color of the sky black::opposite of white
| valign="top" |
''' What is your favorite color? ''' the color of blood the color of the sky opposite of white
| valign="top" |
'' The "values" red, blue and black will be exported to the columns instead of standard 1, 2 and 3 numbers. See [[Viewing_Questionnaire_responses#Download_in_text_format|Download in text format]]. ''
|-
| valign="top" |
'' 5.Possible answers:''

0=Never 1=Once a year 3=Once a month 5=Once a week 7=Once a day
| valign="top" |
''' How often do you practise a sport? '''Never Once a year Once a month Once a week Once a day
| valign="top" |

|}

You may enter <tt>“!other”</tt> on a line to create an '''''optional''''' ''fill in the blank'' option. An <tt><nowiki>!other</nowiki></tt> box defaults to using the prompt ''Other:'', (or the equivalent translation for ''Other'' in the current language being used). You may change this default prompt by using the format: <tt>“!other=''prompt text”''</tt> as shown in Example #3 above.

'''Notes'''

# At the moment the length of the ''fill in the blank'' input text box is set to 25 characters and is not customizable through the online interface.
# It does not make sense to provide more than one <tt><nowiki>!other</nowiki></tt> ''fill in the blank'' option for a Radio Buttons question.
# If a respondent checks a ''fill in the blank'' option '''radio button''' and leaves the text field empty, ''a warning message will be displayed'' (upon navigating to the next page or upon submitting the questionnaire).
# If a respondent has checked a ''fill in the blank'' option '''radio button''' and has filled in the text field, and later on changes his mind and clicks a different radio button in the same question, the ''fill in the blank'' text field previously entered will be automatically emptied.
# Example #4 shows a possible "hidden" option, for exporting - in responses - named values as data instead of standard numbers. If you never export your data for studying it in stats packages you won't need this option.
# If you plan to use the ''''"Personality Test"'''' feature in your questionnaire, the number preceding each choice will be used to calculate the "score" of the section that includes this question. See https://docs.moodle.org/38/en/mod/questionnaire/personality_test#Questions

=== Rate (scale 1..5) ===
==== Example: ====
The Rate question now features extra "not yet answered" radio buttons. This is especially useful in Rate questions with a long list of choices.
[[File:03-12-2013 15-23-57.jpg]]

In case the respondent forgets to check some radio buttons, upon moving to next page or submitting, the error message will be completed with highlighting of the "not yet answered" radio buttons.

[[File:03-12-2013 15-26-58.jpg]]

==== Question editing interface: ====

[[Image:05-08-2013 14-26-37.jpg|400px]]

==== Number of scale items ====
''' Nb of scale items '''is the ''number of items'' to be used in your rate scale. You would normally use a value of 3 to 5. Default value: '''5'''.

==== Type of rate scale ====
* ''' Normal ''' (default value)
* ''' N/A columns ''' : Choose this if you want an '''N/A''' column to be added to the right of your Rate scale items columns.
* ''' No duplicate choices'''<nowiki>: Choose this if you want </nowiki>''to prevent duplicate choices in each degree '''column'''''.
** This is useful if you want the respondent to rank a number of items on a 1 to n scale and to force each rank to be unique. Example: order items A, B and C in order of preference will accept: ''A1, B3 and C2'' or ''A3, B2 and C1'', but ''it will not be possible'' for the respondent to enter: ''A1, B1, C2'' or ''A1, B2, C2,'' etc.
** Used in conjunction with [[#anchor_one|named degrees]], this '''No duplicate choices''' option can also be useful if you want the respondent to match items with named degrees, e.g. the colors ''red, blue, yellow'' with a set of physiological responses: ''excitement, tranquillity, concentration'' where '''one''' color can only match '''one''' physiological response.
* '''Osgood'''<nowiki>: Choose this to create a question of the </nowiki>[http://en.wikipedia.org/wiki/Semantic_differential Osgood's semantic differential] type. This parameter must be used in conjunction with [[#anchor_one|named degrees]].

====Possible answers====
Examples.

{| style="width: 100%" border="1" cellpadding="5"
! style="width: 50%" scope="col" valign="top" | Editing Mode
! style="width: 50%" scope="col" valign="top" | Questionnaire View
|-
| valign="top" |
''' Ex. 1 Rate''' (single line) ''Possible answers'' -> '''Enter a blank space or a short "label".'''

'''Settings: ''' ''' Nb of scale items ''' = 5 (5 columns numbered 1...5);

'''''Type of rate scale''''' = ''Normal'' (N/A column not needed here). 
| valign="top" |
[[Image:05-08-2013_13-53-43.jpg|400px]]
|-
| valign="top" |
''' Ex. 2 Rate ''' (several lines) ''Possible answers''.

Blackboard Desire2Learn Moodle Sakai WebCT

''' Settings: '' Nb of scale items ''''' = 4 (4 columns numbered 1...4)

'''''Type of rate scale''''' = '' N/A column ''
| valign="top" |
[[Image:05-08-2013 13-50-05.jpg]]
|-
| valign="top" |
''' Ex. 2a Rate ("ordering") '''

This option makes it impossible to click more than one radio button per column; it is thus equivalent to an "ordering" question type.

''' Settings: ''' ''''' Nb of scale items ''''' = 3 (3 columns numbered 1...3) ''''' Type of rate scale''''' = ''No duplicate choices''
| valign="top" |
[[Image:05-08-2013 13-59-31.jpg|400px]]
|-
| valign="top" |
''' Ex. 3 Rate ''with named degrees '' ''' 
''Question text'' : How would you rate the ease of use for each of the following items based on your experience with Moodle? 
''Possible answers'': 
Formatting Your Course 
Laying out Your Course 
Number of Clicks to Access Needed Content 
Adding Content 
Ability to Add/Change Themes/Appearance 
Overall Navigation of Moodle 

''Named degrees'' 
4=Very easy to use 
3=Easy to use 
2=Somewhat difficult to use 
1=Difficult to use 

''' Settings: ''' ''''' Nb of scale items ''''' = 4 (4 named columns) ''''' Type of rate scale ''''' = '' Normal '' (N/A column not needed here)
| valign="top" |
[[Image:05-08-2013 14-04-00.jpg|600px]]
|-
| valign="top" |
''' Ex. 3b Rate ''with named degrees '' ''' ''Possible answers'': 
formatting::Formatting Your Course 
layout::Laying out Your Course 
clicks::Number of Clicks to Access Needed Content 
addcontent::Adding Content 
appearance::Ability to Add/Change Themes/Appearance 
navigation::Overall Navigation of Moodle 

''Named degrees'' 
4=Very easy to use 
3=Easy to use 
2=Somewhat difficult to use 
1=Difficult to use 

| valign="top" |
If the choice options text is fairly long, you may use shorter "labels" immediately followed by two colons (::).
The labels "formatting", "layout", "clicks" etc. will be saved to the columns headings in the Download as text format operation, instead of the longer labels which will be displayed to the questionnaire respondent.

'''Please note''' that in former versions of Questionnaire the separator between "short label" and "options text" used to be the equal sign (=). In Questionnaire 2.5 and later, please use two colons (::) as a separator.
|-
| valign="top" |
''' Ex. 4 [http://en.wikipedia.org/wiki/Semantic_differential Osgood's Semantic differential] '''' ''' Possible answers.

1=-- 2=- 3=± 4=+ 5=++ weak|strong cold|warm cowardly|brave

''' Settings: ''' ''''' Nb of scale items ''''' = 5 (5 named columns) ''''' Type of rate scale ''''' = ''Osgood''

''' Note.- ''' To separate the pairs of words you must use a pipe character '''<nowiki>|</nowiki>'''
| valign="top" |
[[Image:05-08-2013 14-06-54.jpg]]
|}

'''Notes.-''' '''named degrees'''

For this question type you have two display options. The default option displays the [http://en.wikipedia.org/wiki/Likert_scale Likert] scale degrees as numbers (1...5). If you prefer to have named degrees instead of numbers, you'll have to enter those names in the '''''Named degrees''''' list (see '''''Example 3 ''''' above). On each line of "Named degrees" enter the degree number, ''immediately followed'' by the equal sign '''<nowiki>=</nowiki>''' ''immediately followed'' by the name you want to give to that degree.

If you plan to use the "Personality Test" feature in your questionnaire, the number preceding each named degree will be used to calculate the "score" of the section that includes this question. See https://docs.moodle.org/38/en/mod/questionnaire/personality_test#Questions_2.

If ''the number of named degrees'' in the possible answers list ''is different from the number determined by the value you entered'' in the '''Nb of scale items''' field, this will be automatically adjusted when you save the question.

Example #3b shows a possible "hidden" option, for exporting - in responses - shorter label instead of the longer text values. If you never export your data for studying it in stats packages you won't need this option. Please note that the example is provided here for the '''Rate ''with named degrees''''' question sub-type but it works for all Rate question sub-types except Osgood which requires short left and right options anyway.

===Text Box===

For the Text Box question type, enter the Input Box length and the Maximum text length of text to be entered by respondent.

Default values are 20 characters for the Input Box width and 25 characters for the maximum length of text entered.

===Yes/No===

==Manage questions==

In the '''Manage questions''' section of the Edit Questions page, you can conduct a number of operations on a Questionnaire's questions. Normally you should never add questions or delete questions in a questionnaire that is live in a moodle course, and which some students may have already responded to.

You can Move a question to a different position in the Questionnaire. If your questionnaire contains some "conditional branching" questions, you may not be able to move some of the parent or child questions to some positions which would ruin the branching.

You can Edit a question, but again, be extra careful when editing questions once students have started to complete a questionnaire.

If you try to Delete a child or parent question (in a Conditional branching questionnaire), you will be warned of the possible consequences of those deletions.

By clicking on the Green or Red dots, you can switch the "Response required" status of questions.

Please note that the numbers in front of each question in this interface are ''not'' the question numbers that will be displayed when answering the questionnaire. Here, these numbers indicate the question's position, and even non-real questions such as Labels and Page Breaks have a position number.

----
[[Category:Teacher]]

[[es:Editando preguntas de un cuestionario]]
[[fr:Ajouter_des_questions]]

Editing Questionnaire questions

2020-05-13T21:26:09Z

Rezeau: /* Possible answers */ Updated the documentation with the new Named degrees field for Rate question type

{{Questionnaire}}

==Editing questions==
* On the Questionnaire '''Editing Questions''' page is displayed a drop-down list of the question types available and a list of the questions already created for the current questionnaire instance (if any).
* Using the standard Moodle icons you can change the order of the questions in the questionnaire, edit or delete questions.

==Common options==
===Question Name===

====Questionnaires '''not''' using the Conditional Branching or the Personality Test features====

You can ''optionally'' enter a '''Question Name''' for each question.

If your questionnaire does not use the "Conditional Branching" or the "Personality Test" feature, the '''Question Name''' is only used when you export responses to CSV/Excel format. If you never export to CSV, then you needn't worry about Question names. If you plan to regularly export your questionnaire data to CSV, then you have a choice of two options for question naming.

=====Option 1: significant names=====

In the '''Question Name ''' box, enter ''meaningful'', ''short'' and '''''different''''' question names for all of the questions within one questionnaire. In the CSV export file, all those question names will be prefixed with the question's actual number (= position) in the quiz. Examples:

{| border="1"
! scope="col" | question number (position) in the questionnaire
! scope="col" | question name entered by teacher
! scope="col" | field header in csv export
|-
|
<div style="text-align: center">5</div>
| favorite colors
| Q05_favorite colors
|-
|
<div style="text-align: center">6</div>
| why_use_Moodle
| Q06_why_use_moodle
|-
|
<div style="text-align: center">7</div>
|
user-friendliness

'' (rate question with 3 possible answers: Moodle, WebCT and Blackboard) ''
|
Q07_user-friendliness->Moodle Q07_user-friendliness->WebCT Q07_user-friendliness->Blackboard
|}

=====Option 2: leave the Question Name boxes blank=====

For each un-named question, CSV export will automatically generate a question name. This is required for table header fields in the CSV and subsequent Excel tables or any statistics package you might be using. The question name generated will be based on the question number in the actual Quiz (excluding ''Section Text'' pseudo-questions, of course) e.g. Q01, Q02, ... Q99. For questions with multiple answers, such as rate-type or Likert type questions, a sub-question number will be generated (Q02_1, Q02_2, Q02_3, etc.). This type of "short-name" naming scheme is advisable for exporting your data to a statistics software. Of course, it's up to you to have your own system for remembering which abbreviated question name corresponds to which question in your questionnaire!

{| width="100%" border="1"
! style="width: 33%" scope="col" | question number (position) in the questionnaire
! style="width: 33%" scope="col" | question name entered by teacher
! style="width: 33%" scope="col" | field header in csv export
|-
|
<div style="text-align: center">5</div>
| style="background-color: #CCCCCC" |
| Q05
|-
|
<div style="text-align: center">6</div>
| style="background-color: #CCCCCC" |
| Q06
|-
|
<div style="text-align: center">7</div>
| style="background-color: #CCCCCC" |
|
Q07_1 Q07_2 Q07_3
|}

It is quite possible (but maybe not advisable) to mix the two systems, and have within one questionnaire both named and un-named questions.

====Questionnaires using the Conditional Branching feature====

If you need a question to be used as the "parent" of one or more subsequent questions in your questionnaire, then you '''must''' name that "parent question". Only those (radio buttons, dropdown list or yes/no) questions with a ''name'' will appear in the Parent question dropdown list when adding a new question, as shown on the following screenshots.

[[Image:05-08-2013 15-26-11.jpg]]

[[Image:05-08-2013 15-34-55.jpg]]

For more information, see [[Questionnaire_Conditional_branching|Conditional branching]].

===Response Required===
If you select '''''Yes''''', response to this question will be required, i.e. the respondent will not be able to submit the questionnaire until this question has been answered. If the respondent tries to submit a questionnaire with unanswered required questions (or, in the case of a questionnaire with more than one section, to go to the next page), a warning message will be displayed with a list of all the missing ''required ''questions in the questionnaire (or on the actual page).

Default.- '''''No'''''.

'''Note'''.- When you create new questions in sequence (one after the other), this parameter is carried over to subsequent questions. E.g. if you create question #1 with '''Response Required''' = '''''Yes''''', then the '''Response Required''' parameter will be pre-set to '''''Yes''''' for question #2, etc. You can of course change this parameter at any time.

In the ''Manage Questions'' section of the Questions editing page, once a question has been created, you can use the green and red dots to switch its Required state, as a shortcut alternative of editing the question.

[[Image:05-08-2013 15-49-48.jpg|300px]]

===Parent Question===

See [[Questionnaire_Conditional_branching|Conditional branching]]

===Question Text===
Enter your question text in this box. The HTML editor is available, which means that you can display not only formatted text but also images or other media in a questionnaire's questions text.

==Question Types==

Select the type of question from the drop-down list and click on the '''Add selected question type''' button.

===---Page Break---===

Use this to insert page breaks in longish questionnaires. Note that if a page contains questions with required response the respondent will not be allowed to navigate to the next page unless those required responses have been given.

If your questionnaire uses the Conditional branching feature, then page breaks will be ''automatically'' inserted when you add "parent" or "child" questions. Page breaks which are needed to ensure a correct "Conditional branching" flow cannot be moved or deleted. Their Move and Delete icons are disabled.

[[Image:05-08-2013 15-58-09.jpg|300px]]

===Check Boxes===
Check boxes allow the user to select multiple answers from a list of options.

==== Question editing interface ====

[[Image:05-08-2013 14-58-42.jpg|400px]]

==== Options ====

{| style="width: 100%" border="1" cellpadding="5"
! style="width: 50%" scope="col" | Editing Mode
! style="width: 50%" scope="col" | Questionnaire View
|-
|
{| style="width: 300"
| colspan="2" valign="top" | Question text: What are your favorite hobbies?

Possible answers:
|-
| style="border: #666666 thin solid" |
Watching TV Dancing Computing !other=Another hobby:
|}
|
[[Image:05-08-2013 13-29-49.jpg]]
|}

You may enter <tt>“!other”</tt> on a line to create an '''''optional''''' ''fill in the blank'' option. An<tt><nowiki>!other</nowiki></tt> box defaults to using the prompt ''Other: '', (or the equivalent translation for ''Other'' in the current language being used). You may change this default prompt by using the format: <tt>“!other=''prompt text”''</tt> as shown in the example above.

'''Notes.-'''

# At the moment the length of the ''fill in the blank'' input text box is set to 25 characters and is not customizable through the online interface.
# You may provide more than one <tt><nowiki>!other</nowiki></tt> ''fill in the blank'' option for a Check Boxes question, but this might cause problems so it is ''not recommended''.
# When a respondent answers a''' Check Boxes''' question which has been created as '''Required''', and the '''Min. forced responses '''and''' Max. forced responses''' parameters have been used, then a warning message will be displayed if respondent does not check the required number of boxes.
# Note that, if the <tt><nowiki>!other</nowiki></tt> ''fill in the blank'' option has been created, then if it is checked by the respondent, it will count in the total of minimum/maximum required check boxes.
# If a respondent checks a ''fill in the blank'' option '''check box''' and leaves the text field empty, ''that box will be unchecked'' (upon navigating to the next page or upon submitting the questionnaire).
# If a respondent has cheked ''a fill in the blank'' option '''check box''' and has filled in the text field, and later on changes his mind and unckecks that box, the ''fill in the blank'' text field will be automatically emptied (cool, ain't it?).

===Date===

''Use the day/month/year format, e.g. for March 14th, 1945: '''14/3/1945'''''

Use this question type if you expect the response to be a correctly formatted date. The format will depend upon the language currently being used by the questionnaire respondent. For example 4/21/2007 (US); 21/4/2007 (UK); 21-4-2007 (France); etc. An example will be displayed in the questionnaire. If an "impossible" or wrongly formatted date is entered, it will either be re-written or reformatted correctly (if possible) or an error message will be displayed to the respondent. In order for dates to be correctly exported to spreadsheets such as Excel, respondent must enter ''a date in the 1902 to 2037 range''. If a date outside this range is expected from respondents, then use the '''Text Box''' question type instead. The date question type will accept dates consisting only of a month plus a year (e.g. 12/2008 for december 2008) or only a year (e.g. 2008). However, for spreadsheet processing compatibility, such incomplete dates will be automatically transformed to complete dd/mm/yy dates, e.g. 12/2008 -> '''01/'''12/2008 and 2008 -> '''01/01/'''2008. You may have to explain this pecularity to your questionnaire users beforehand.

===Dropdown Box===

There is no real advantage to using the '''Dropdown Box''' over using the '''Radio Buttons''' except perhaps for longish lists of options, to save screen space.

===Essay Box===
====Question editing interface====
[[Image:2014-01-24_15-37-29.jpg|400px]]

====Settings====
This question will display a plain text box with '''x''' ''Textarea columns'' (or area ''width'') and '''y''' ''Textarea rows'' (number of text ''lines'').

If you leave both x and y to their default '''0''' value (or if you set it to '''0'''), then moodle's '''HTML editor''' will be displayed with standard height and width (if available in the course/user context & user profile).

===Label===

This is not a question but a (short) text which will be displayed to introduce a series of questions.

===Numeric===

Use this question type if you expect the response to be a correctly formatted number. By using the '''Max. digits allowed '''and '''Nb of decimal digits '''parameters you can specify the length and number of decimal places required. Use '''Max. digits allowed''' to set a limit to the number of characters entered for a Numeric question. Note that the decimal point also counts as one character! Use '''Nb of decimal digits''' to specify the format of the Average value counted and displayed at the Questionnaire Report page.

Examples:

{| class="nicetable"
|-
!
! Max. digits allowed
! Nb of decimal digits
! Response entered
! Average displayed
|-
| Example 1
| 6
| 2
| 12
| 12.00
|-
| Example 2
| 6
| 2
| 12.569
| 12.57
|-
| Example 3
| 8
| 1
| 12.57898
| 12.6
|}

=== Radio Buttons ===
====Question editing interface====
[[Image:05-08-2013 15-03-17.jpg|400px]]

====Radio buttons Alignment====
[[Image:05-08-2013 13-35-04.jpg]]

====Possible answers====
You must fill in one answer per line in the '''Possible answers''' box.

Examples:

{| border="1" cellpadding="5"
! style="width: 250" scope="col" valign="top" | Editing Mode
! style="width: 243" scope="col" valign="top" | Questionnaire View
! style="width: 434" scope="col" valign="top" | (optional horizontal display)
|-
| valign="top" |
'' 1.Possible answers''<nowiki>: </nowiki>

Red Blue Black
| valign="top" |
''' What is your favorite color? ''' Red Blue Black
| valign="top" |
''' What is your favorite color? ''' Red Blue Black
|-
| valign="top" |
'' 2.Possible answers''<nowiki>: </nowiki>

Red Blue Black !other
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Other:
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Other:
|-
| valign="top" |
'' 3.Possible answers:''

Red Blue Black !other=Another color:
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Another color:
| valign="top" |
''' What is your favorite color? ''' Red Blue Black Another color:
|-
| valign="top" |
| valign="top" | Questionnaire View
| valign="top" | ''''' Text data export '''''
|-
| valign="top" |
'' 4.Possible answers: ''

red::the color of blood blue::the color of the sky black::opposite of white
| valign="top" |
''' What is your favorite color? ''' the color of blood the color of the sky opposite of white
| valign="top" |
'' The "values" red, blue and black will be exported to the columns instead of standard 1, 2 and 3 numbers. See [[Viewing_Questionnaire_responses#Download_in_text_format|Download in text format]]. ''
|-
| valign="top" |
'' 5.Possible answers:''

0=Never 1=Once a year 3=Once a month 5=Once a week 7=Once a day
| valign="top" |
''' How often do you practise a sport? '''Never Once a year Once a month Once a week Once a day
| valign="top" |

|}

You may enter <tt>“!other”</tt> on a line to create an '''''optional''''' ''fill in the blank'' option. An <tt><nowiki>!other</nowiki></tt> box defaults to using the prompt ''Other:'', (or the equivalent translation for ''Other'' in the current language being used). You may change this default prompt by using the format: <tt>“!other=''prompt text”''</tt> as shown in Example #3 above.

'''Notes'''

# At the moment the length of the ''fill in the blank'' input text box is set to 25 characters and is not customizable through the online interface.
# It does not make sense to provide more than one <tt><nowiki>!other</nowiki></tt> ''fill in the blank'' option for a Radio Buttons question.
# If a respondent checks a ''fill in the blank'' option '''radio button''' and leaves the text field empty, ''a warning message will be displayed'' (upon navigating to the next page or upon submitting the questionnaire).
# If a respondent has checked a ''fill in the blank'' option '''radio button''' and has filled in the text field, and later on changes his mind and clicks a different radio button in the same question, the ''fill in the blank'' text field previously entered will be automatically emptied.
# Example #4 shows a possible "hidden" option, for exporting - in responses - named values as data instead of standard numbers. If you never export your data for studying it in stats packages you won't need this option.
# If you plan to use the ''''"Personality Test"'''' feature in your questionnaire, the number preceding each choice will be used to calculate the "score" of the section that includes this question. See https://docs.moodle.org/38/en/mod/questionnaire/personality_test#Questions

=== Rate (scale 1..5) ===
==== Example: ====
The Rate question now features extra "not yet answered" radio buttons. This is especially useful in Rate questions with a long list of choices.
[[File:03-12-2013 15-23-57.jpg]]

In case the respondent forgets to check some radio buttons, upon moving to next page or submitting, the error message will be completed with highlighting of the "not yet answered" radio buttons.

[[File:03-12-2013 15-26-58.jpg]]

==== Question editing interface: ====

[[Image:05-08-2013 14-26-37.jpg|400px]]

==== Number of scale items ====
''' Nb of scale items '''is the ''number of items'' to be used in your rate scale. You would normally use a value of 3 to 5. Default value: '''5'''.

==== Type of rate scale ====
* ''' Normal ''' (default value)
* ''' N/A columns ''' : Choose this if you want an '''N/A''' column to be added to the right of your Rate scale items columns.
* ''' No duplicate choices'''<nowiki>: Choose this if you want </nowiki>''to prevent duplicate choices in each degree '''column'''''.
** This is useful if you want the respondent to rank a number of items on a 1 to n scale and to force each rank to be unique. Example: order items A, B and C in order of preference will accept: ''A1, B3 and C2'' or ''A3, B2 and C1'', but ''it will not be possible'' for the respondent to enter: ''A1, B1, C2'' or ''A1, B2, C2,'' etc.
** Used in conjunction with [[#anchor_one|named degrees]], this '''No duplicate choices''' option can also be useful if you want the respondent to match items with named degrees, e.g. the colors ''red, blue, yellow'' with a set of physiological responses: ''excitement, tranquillity, concentration'' where '''one''' color can only match '''one''' physiological response.
* '''Osgood'''<nowiki>: Choose this to create a question of the </nowiki>[http://en.wikipedia.org/wiki/Semantic_differential Osgood's semantic differential] type. This parameter must be used in conjunction with [[#anchor_one|named degrees]].

====Possible answers====
Examples.

{| style="width: 100%" border="1" cellpadding="5"
! style="width: 50%" scope="col" valign="top" | Editing Mode
! style="width: 50%" scope="col" valign="top" | Questionnaire View
|-
| valign="top" |
''' Ex. 1 Rate''' (single line) Possible answers -> '''Enter a blank space or a short "label".''' '''Settings: ''' ''' Nb of scale items ''' = 5 (5 columns numbered 1...5);'''''Type of rate scale''''' = ''Normal'' (N/A column not needed here). 
| valign="top" |
[[Image:05-08-2013_13-53-43.jpg|400px]]
|-
| valign="top" |
''' Ex. 2 Rate ''' (several lines) Possible answers.

Blackboard Desire2Learn Moodle Sakai WebCT

''' Settings: '' Nb of scale items ''''' = 4 (4 columns numbered 1...4) ''''' Type of rate scale ''''' = '' N/A column ''
| valign="top" |
[[Image:05-08-2013 13-50-05.jpg]]
|-
| valign="top" |
''' Ex. 2a Rate ("ordering") '''

This option makes it impossible to click more than one radio button per column; it is thus equivalent to an "ordering" question type.

''' Settings: ''' ''''' Nb of scale items ''''' = 3 (3 columns numbered 1...3) ''''' Type of rate scale''''' = ''No duplicate choices''
| valign="top" |
[[Image:05-08-2013 13-59-31.jpg|400px]]
|-
| valign="top" |
''' Ex. 3 Rate ''with named degrees '' ''' 
''Question text'' : How would you rate the ease of use for each of the following items based on your experience with Moodle? 
''Possible answers'': 
Formatting Your Course 
Laying out Your Course 
Number of Clicks to Access Needed Content 
Adding Content 
Ability to Add/Change Themes/Appearance 
Overall Navigation of Moodle 

''Named degrees'' 
4=Very easy to use 
3=Easy to use 
2=Somewhat difficult to use 
1=Difficult to use 

''' Settings: ''' ''''' Nb of scale items ''''' = 4 (4 named columns) ''''' Type of rate scale ''''' = '' Normal '' (N/A column not needed here)
| valign="top" |
[[Image:05-08-2013 14-04-00.jpg|600px]]
|-
| valign="top" |
''' Ex. 3b Rate ''with named degrees '' ''' ''Possible answers'': 
formatting::Formatting Your Course 
layout::Laying out Your Course 
clicks::Number of Clicks to Access Needed Content 
addcontent::Adding Content 
appearance::Ability to Add/Change Themes/Appearance 
navigation::Overall Navigation of Moodle 

''Named degrees'' 
4=Very easy to use 
3=Easy to use 
2=Somewhat difficult to use 
1=Difficult to use 

| valign="top" |
If the choice options text is fairly long, you may use shorter "labels" immediately followed by two colons (::).
The labels "formatting", "layout", "clicks" etc. will be saved to the columns headings in the Download as text format operation, instead of the longer labels which will be displayed to the questionnaire respondent.

'''Please note''' that in former versions of Questionnaire the separator between "short label" and "options text" used to be the equal sign (=). In Questionnaire 2.5 and later, please use two colons (::) as a separator.
|-
| valign="top" |
''' Ex. 4 [http://en.wikipedia.org/wiki/Semantic_differential Osgood's Semantic differential] '''' ''' Possible answers.

1=-- 2=- 3=± 4=+ 5=++ weak|strong cold|warm cowardly|brave

''' Settings: ''' ''''' Nb of scale items ''''' = 5 (5 named columns) ''''' Type of rate scale ''''' = ''Osgood''

''' Note.- ''' To separate the pairs of words you must use a pipe character '''<nowiki>|</nowiki>'''
| valign="top" |
[[Image:05-08-2013 14-06-54.jpg]]
|}

'''Notes.-''' '''named degrees'''

For this question type you have two display options. The default option displays the [http://en.wikipedia.org/wiki/Likert_scale Likert] scale degrees as numbers (1...5). If you prefer to have named degrees instead of numbers, you'll have to enter those names in the '''''Possible answers''''' list (see '''''Example 3 ''''' above). On each line of "possible answers" enter the degree number, ''immediately followed'' by the equal sign '''<nowiki>=</nowiki>''' ''immediately followed'' by the name you want to give to that degree.

If you plan to use the "Personality Test" feature in your questionnaire, the number preceding each named degree will be used to calculate the "score" of the section that includes this question. See https://docs.moodle.org/38/en/mod/questionnaire/personality_test#Questions_2.

If ''the number of named degrees'' in the possible answers list ''is different from the number determined by the value you entered'' in the '''Nb of scale items''' field, this will be automatically adjusted when you save the question. If you decide to use named degrees for your Likert scale, it is recommended (but not obligatory) to start your list of possible answers with the named degrees, and then to enter the various ''items'' to be scaled.

Example #3b shows a possible "hidden" option, for exporting - in responses - shorter label instead of the longer text values. If you never export your data for studying it in stats packages you won't need this option. Please note that the example is provided here for the '''Rate ''with named degrees''''' question sub-type but it works for all Rate question sub-types except Osgood which requires short left and right options anyway.

===Text Box===

For the Text Box question type, enter the Input Box length and the Maximum text length of text to be entered by respondent.

Default values are 20 characters for the Input Box width and 25 characters for the maximum length of text entered.

===Yes/No===

==Manage questions==

In the '''Manage questions''' section of the Edit Questions page, you can conduct a number of operations on a Questionnaire's questions. Normally you should never add questions or delete questions in a questionnaire that is live in a moodle course, and which some students may have already responded to.

You can Move a question to a different position in the Questionnaire. If your questionnaire contains some "conditional branching" questions, you may not be able to move some of the parent or child questions to some positions which would ruin the branching.

You can Edit a question, but again, be extra careful when editing questions once students have started to complete a questionnaire.

If you try to Delete a child or parent question (in a Conditional branching questionnaire), you will be warned of the possible consequences of those deletions.

By clicking on the Green or Red dots, you can switch the "Response required" status of questions.

Please note that the numbers in front of each question in this interface are ''not'' the question numbers that will be displayed when answering the questionnaire. Here, these numbers indicate the question's position, and even non-real questions such as Labels and Page Breaks have a position number.

----
[[Category:Teacher]]

[[es:Editando preguntas de un cuestionario]]
[[fr:Ajouter_des_questions]]

Regular Expression Short-Answer question type

2019-11-21T22:04:13Z

Rezeau: /* Inserting RegExp sub-questions in Cloze type questions */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analysing the student's answers'' with the aim of ''providing more relevant immediate feedback''.
The RegExp Short Answer question is meant to be used with questions requiring '''natural language''' answers. This question type is not well-suited to questions requiring mathematical, scientific, programming "languages".

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.5 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

Similar to the ''short answer'' core question type instructions, "Normally the answer box appears below the question text. However, if you include five or more underscores in the text, the input box will be placed there." This inline input feature has recently been made available to the Moodle mobile version for "short answer" questions. It is now available for the "regexp" question type as well.

If you enter this regexp question text: The ____________ sat on the white mat.

This is what it will look like in a moodle mobile quiz:

[[Image:2019-06-04_18-40-30.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/MOODLE_38_STABLE/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/MOODLE_38_STABLE/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Interactive Content - H5P activity

2019-09-07T14:28:31Z

Rezeau: /* Activities available for creation from inside the plugin */

{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_hvp
|tracker = https://github.com/h5p/h5p-moodle-plugin/issues
|discussion = https://h5p.org/forum
|maintainer = [[User:Frode Petterson|Frode Petterson]]
|float = right
}}

==Highlights==
* H5P gives you access to lots of different interactive content types (see [[#Activities_available_for_creation_from_inside_the_plugin| 'Activities available for creation from inside the plugin']] below).
* H5P allows you to easily share and reuse content.
** To reuse content, you just download the H5P you would like to edit and make your changes – e.g. translate to a new language or adjust it to a new situation.

==Overview==

===Supercharge your website with H5P===
* H5P makes it easy to create, share and reuse HTML5 content and applications.
* H5P empowers creatives to create rich and interactive web experiences more efficiently - all you need is a web browser and a web site with an H5P plugin.
{{Note|Moodle itself can embedd [[Media embedding|HTML5 media]].}}

===Mobile friendly content===
* Publish once, view and interact on all screens.
* H5P content is responsive and mobile friendly.
* Users experience the same rich, interactive content on computers, smartphones and tablets alike.

===Share rich content===
* H5P enables existing CMSs and LMSs (such as Moodle) to create richer content.
* With H5P, authors may create and edit interactive videos, presentations, games, advertisements and more.
* Content may be imported and exported.
** All that is needed to view or edit H5P content is a web browser.
* Rich content, applications and content components may be shared on H5P.org.

===Free to use===
* H5P is a completely free and open technology, licensed with the [https://en.wikipedia.org/wiki/MIT_License MIT license].
* Demos/downloads, tutorials and documentation is available for users who want to join the community.

==Links to examples and downloads==
* [https://h5p.org/presentation Course Presentation]
* [https://h5p.org/interactive-video Interactive Video]
* [https://h5p.org/memory-game Memory Game]
* Visit the [https://h5p.org/content-types-and-applications H5P content types and applications] page for more examples and downloads (see the download link inside the red rectangle in the following image).
[[File:H5P download an activity.png|600px]]

==Compatible Moodle versions==
Moodle 2.7 to 3.6

==Potential privacy issues==
The plugin is set up to automatically download content types and provide anonymous usage data which can be disabled through settings.

==Installation==
==== Get the plugin ====
* From the [https://moodle.org/plugins/mod_hvp Moodle plugins database]
==== Install the plugin ====
* Visit http://yoursite.com/admin to finish the installation
==== Moodle Mobile App compatibility ====

H5P contents are compatible with the Mobile App provided these 2 parameters have been set in Admin.
# Site administration > Mobile app > Mobile settings > Enable web services for mobile devices (of course!)
# Site administration > Security > HTTP security > Allow frame embedding
''Note 1.-'' The help text in this 2nd parameter displays a wrong piece of information. It reads "''Please, note also that for the mobile app this setting is ignored and frame embedding is always allowed.''" This is not true for H5P, Frame embedding '''must''' be enabled.

''Note 2.-'' If the admin has forgotten to enable this setting, in the Mobile App 2 different messages will be displayed to the end-user, according to their role (or rather their capacities).
* student role: ''This site is not configured properly for displaying mobile H5P content. Please contact a site administrator.''
* admin role: ''Iframe embedding must be enabled in order to display H5P content in the mobile app. You can enable it by checking Allow frame embedding" in Site Administration / Security / Http Security''

==Usage==
===Display Options===
You can enable/disable:
* Display action bar and frame
* Download button
* Copyright button

=== Uploading or Creating an activity===
[[File:H5P upload an activity.png|400px]]
* If you choose to 'Upload' an activity, you can choose a (.h5p) file or drag and drop one into the designated area.
[[File:H5P upload a previously downloaded h5p activity.png|100px]]

* You can easily create an interactive activity with the built-in editor inside the plugin.

[[File:H5P create an activity.png|400px]]
* If you choose to 'Create' an activity, the Editor drop-down list will let you choose any one of the following:

===Activities available for creation from inside the plugin===

* [https://h5p.org/accordion Accordion] - An accordion content type allowing users to add accessible [https://en.wikipedia.org/wiki/WAI-ARIA WAI - ARIA] enabled accordions. WAI - ARIA is used to increase the accessibility of web pages, in particular, dynamic content and user interface components developed with Ajax, HTML, JavaScript and related technologies.
[[File:H5P example accordion.png|400px]]
{{Note| The images pasted inside the text area will not show up in the final activity, only the text will be shown.}}

* [https://h5p.org/appear.in appear.in] for Chat and Talk - A video conference content type allowing authors to set up conference rooms.
[[File:H5P example appear_in.png|400px]]

* Audio - An easy to use audio player.
[[File:H5P example audio.png|400px]]

* [https://h5p.org/node/6729 Chart] - A chart content type allowing users to create pie charts and bar charts with H5P, to present simple statistical data graphically without creating the artwork manually.
[[File:H5P example chart.png|400px]]

* [https://h5p.org/collage Collage] - A photo collage content type allowing users to set up multiple photos in a custom layout using only a web browser in order to show off their photos in a tasteful way.
[[File:H5P example collage.png|400px]]

* [https://h5p.org/presentation Course presentation] - A presentation content type which allows users to add multiple choice, fill in the blanks, texts and other types of interactions to their presentations using only a web browser in order to make engaging presentations.
[[File:H5P example course presentation.png|400px]]

* [https://h5p.org/dialog-cards Dialog Cards] - A content type allowing authors to create great language learning resources with H5P.
[[File:H5P example dialog cards.png|400px]]

* [https://h5p.org/documentation-tool Documentation Tool] - A content type allowing authors to create guides for structured writing processes with H5P.
[[File:H5P example documentation tool.png|400px]]

* [https://h5p.org/drag-and-drop Drag and Drop] - A drag and drop question type allowing creatives to create many forms of drag and drop using only a web browser in order to make engaging challenges using H5P.
[[File:H5P example drag and drop.png|400px]]

* [https://h5p.org/drag-the-words Drag the Words] - A question type allowing creatives to create text based challenges where users are to drag words into blanks in sentences. Excellent for language training.
[[File:H5P example drag the words.png|400px]]

* [https://h5p.org/fill-in-the-blanks Fill in the Blanks] - A question type allowing creatives to create fill in the blanks, also known as [[Embedded Answers (Cloze) question type|cloze]] tests.
[[File:H5P example fill in the blanks.png|400px]]
{{Note|Moodle has two additional plugins suitable for easily making cloze questions using the Moodle [[Text editor|text editors]]: the [[Cloze editor for TinyMCE]] and the [[Cloze editor for Atto]].}}

* [https://h5p.org/image-hotspot-question Find the Hotspot] - A question type allowing creatives to create an image based test where the learner is to find the correct spot on an image. Use this content type with the H5P plugin to challenge your users.
[[File:H5P example find the hotspot.png|400px]]

* [https://h5p.org/flashcards Flashcards] - A content type allowing creatives to create flashcards. Flashcards are often used in language learning for drilling words and expressions. Flashcards can also be used to present math problems or help learners remember facts such as historical dates, formulas or names.
[[File:H5P example flashcards.png|400px]]

* Greeting Card - To easily create a greeting card.
[[File:H5P example greeting card.png|400px]]

* [https://h5p.org/node/2398 Guess the Answer] - A content type allowing creatives to create challenges where the user is to guess an answer based on a picture.
[[File:H5P example guess the answer.png|400px]]

* [https://h5p.org/iframe-embedder Iframe Embedder] - The Iframe embedder makes it easy to make an H5P of already existing JavaScript applications.
[[File:H5P example iframe embedder.png|400px]]
{{Note|Moodle itself can use [[PhET simulations]]. You can embedd them in a page or inside a question in a quiz.}}

* [https://h5p.org/image-hotspots Image Hotspots] - A content type allowing creatives to add hotspots to images. Hotspots may reveal texts, images and videos when clicked.
[[File:H5P example image hotspots.png|400px]]

* [https://h5p.org/interactive-video Interactive Video] - An interactive video content type allowing users to add multiple choice and fill in the blank questions, pop-up text and other types of interactions to their videos using only a web browser. Make your videos more engaging.
[[File:H5P example interactive video.png|400px]]

[https://h5p.org/sites/default/files/front-page-demo.mp4 Click here to link to an interactive video demo]

* [https://h5p.org/mark-the-words Mark the Words] - A question type allowing creatives to create challenges where the user is to mark specific types of verbs in a text.
[[File:H5P example mark the words.png|400px]]

* [https://h5p.org/memory-game Memory Game] - A memory game content type allowing authors to add their own images (and optional text) to a memory game. To play the game, users search for image pairs, which will display a specified text message once a matching pair has been found.
[[File:H5P memory game 001.png|400px]]

* [https://h5p.org/multichoice Multiple Choice] - A question type allowing creatives to create challenges where the user is to identify one ore more correct choices.
[[File:H5P example multiple choice.png|400px]]

* [https://h5p.org/question-set Question Set] - A content type allowing creatives to create quizzes. Many question types are supported like multiple choice, fill in the blanks, drag the words, mark the words and regular drag and drop.
[[File:H5P example question set..png|400px]]

* [https://h5p.org/single-choice-set Single Choice Set] - A content type allowing creatives to create simple and smoot quizzes consisting of single choice questions.
[[File:H5P example single choice set..png|400px]]

* [https://h5p.org/summary Summary] - A summary builder. This content type allows creatives to create challenges where the user is to choose between statements and build the correct summary.
[[File:H5P example summary..png|400px]]

* [https://h5p.org/timeline Timeline] - A content type allowing creatives to create interactive timelines.
[[File:H5P example timeline..png|400px]]

* [https://h5p.org/twitter-user-feed Twitter User feed] - A Twitter feed.
[[File:H5P example twitter user feed..png|400px]]

== See also==
* [https://h5p.org/ H5P] homepage
* [https://h5p.org/forum forum] for discussing H5P
* [https://github.com/h5p/h5p-moodle-plugin source code] repository

[[Category:Audio]]
[[Category:Video]]
[[Category:Language teaching]]
[[Category:Mathematics]]

[[es:Actividad Contenido Interactivo - H5P]]
[[fr:H5P]]

Interactive Content - H5P activity

2019-07-06T14:25:56Z

Rezeau: /* Installation */

{{Infobox plugin
|type = Activity
|entry = https://moodle.org/plugins/mod_hvp
|tracker = https://github.com/h5p/h5p-moodle-plugin/issues
|discussion = https://h5p.org/forum
|maintainer = [[User:Frode Petterson|Frode Petterson]]
|float = right
}}

==Highlights==
* H5P gives you access to lots of different interactive content types (see [[#Activities_available_for_creation_from_inside_the_plugin| 'Activities available for creation from inside the plugin']] below).
* H5P allows you to easily share and reuse content.
** To reuse content, you just download the H5P you would like to edit and make your changes – e.g. translate to a new language or adjust it to a new situation.

==Overview==

===Supercharge your website with H5P===
* H5P makes it easy to create, share and reuse HTML5 content and applications.
* H5P empowers creatives to create rich and interactive web experiences more efficiently - all you need is a web browser and a web site with an H5P plugin.
{{Note|Moodle itself can embedd [[Media embedding|HTML5 media]].}}

===Mobile friendly content===
* Publish once, view and interact on all screens.
* H5P content is responsive and mobile friendly.
* Users experience the same rich, interactive content on computers, smartphones and tablets alike.

===Share rich content===
* H5P enables existing CMSs and LMSs (such as Moodle) to create richer content.
* With H5P, authors may create and edit interactive videos, presentations, games, advertisements and more.
* Content may be imported and exported.
** All that is needed to view or edit H5P content is a web browser.
* Rich content, applications and content components may be shared on H5P.org.

===Free to use===
* H5P is a completely free and open technology, licensed with the [https://en.wikipedia.org/wiki/MIT_License MIT license].
* Demos/downloads, tutorials and documentation is available for users who want to join the community.

==Links to examples and downloads==
* [https://h5p.org/presentation Course Presentation]
* [https://h5p.org/interactive-video Interactive Video]
* [https://h5p.org/memory-game Memory Game]
* Visit the [https://h5p.org/content-types-and-applications H5P content types and applications] page for more examples and downloads (see the download link inside the red rectangle in the following image).
[[File:H5P download an activity.png|600px]]

==Compatible Moodle versions==
Moodle 2.7 to 3.1

==Potential privacy issues==
The plugin is set up to automatically download content types and provide anonymous usage data which can be disabled through settings.

==Installation==
==== Get the plugin ====
* From the [https://moodle.org/plugins/mod_hvp Moodle plugins database]
==== Install the plugin ====
* Visit http://yoursite.com/admin to finish the installation
==== Moodle Mobile App compatibility ====

H5P contents are compatible with the Mobile App provided these 2 parameters have been set in Admin.
# Site administration > Mobile app > Mobile settings > Enable web services for mobile devices (of course!)
# Site administration > Security > HTTP security > Allow frame embedding
''Note 1.-'' The help text in this 2nd parameter displays a wrong piece of information. It reads "''Please, note also that for the mobile app this setting is ignored and frame embedding is always allowed.''" This is not true for H5P, Frame embedding '''must''' be enabled.

''Note 2.-'' If the admin has forgotten to enable this setting, in the Mobile App 2 different messages will be displayed to the end-user, according to their role (or rather their capacities).
* student role: ''This site is not configured properly for displaying mobile H5P content. Please contact a site administrator.''
* admin role: ''Iframe embedding must be enabled in order to display H5P content in the mobile app. You can enable it by checking Allow frame embedding" in Site Administration / Security / Http Security''

==Usage==
===Display Options===
You can enable/disable:
* Display action bar and frame
* Download button
* Copyright button

=== Uploading or Creating an activity===
[[File:H5P upload an activity.png|400px]]
* If you choose to 'Upload' an activity, you can choose a (.h5p) file or drag and drop one into the designated area.
[[File:H5P upload a previously downloaded h5p activity.png|100px]]

* You can easily create an interactive activity with the built-in editor inside the plugin.

[[File:H5P create an activity.png|400px]]
* If you choose to 'Create' an activity, the Editor drop-down list will let you choose any one of the following:

===Activities available for creation from inside the plugin===

* [https://h5p.org/accordion Accordion] - An accordion content type allowing users to add accessible [https://en.wikipedia.org/wiki/WAI-ARIA WAI - ARIA] enabled accordions. WAI - ARIA is used to increase the accessibility of web pages, in particular, dynamic content and user interface components developed with Ajax, HTML, JavaScript and related technologies.
[[File:H5P example accordion.png|400px]]
{{Note| The images pasted inside the text area will not show up in the final activity, only the text will be show.}}

* [https://h5p.org/appear.in appear.in] for Chat and Talk - A video conference content type allowing authors to set up conference rooms.
[[File:H5P example appear_in.png|400px]]

* Audio - An easy to use audio player.
[[File:H5P example audio.png|400px]]

* [https://h5p.org/node/6729 Chart] - A chart content type allowing users to create pie charts and bar charts with H5P, to present simple statistical data graphically without creating the artwork manually.
[[File:H5P example chart.png|400px]]

* [https://h5p.org/collage Collage] - A photo collage content type allowing users to set up multiple photos in a custom layout using only a web browser in order to show off their photos in a tasteful way.
[[File:H5P example collage.png|400px]]

* [https://h5p.org/presentation Course presentation] - A presentation content type which allows users to add multiple choice, fill in the blanks, texts and other types of interactions to their presentations using only a web browser in order to make engaging presentations.
[[File:H5P example course presentation.png|400px]]

* [https://h5p.org/dialog-cards Dialog Cards] - A content type allowing authors to create great language learning resources with H5P.
[[File:H5P example dialog cards.png|400px]]

* [https://h5p.org/documentation-tool Documentation Tool] - A content type allowing authors to create guides for structured writing processes with H5P.
[[File:H5P example documentation tool.png|400px]]

* [https://h5p.org/drag-and-drop Drag and Drop] - A drag and drop question type allowing creatives to create many forms of drag and drop using only a web browser in order to make engaging challenges using H5P.
[[File:H5P example drag and drop.png|400px]]

* [https://h5p.org/drag-the-words Drag the Words] - A question type allowing creatives to create text based challenges where users are to drag words into blanks in sentences. Excellent for language training.
[[File:H5P example drag the words.png|400px]]

* [https://h5p.org/fill-in-the-blanks Fill in the Blanks] - A question type allowing creatives to create fill in the blanks, also known as [[Embedded Answers (Cloze) question type|cloze]] tests.
[[File:H5P example fill in the blanks.png|400px]]
{{Note|Moodle has two additional plugins suitable for easily making cloze questions using the Moodle [[Text editor|text editors]]: the [[Cloze editor for TinyMCE]] and the [[Cloze editor for Atto]].}}

* [https://h5p.org/image-hotspot-question Find the Hotspot] - A question type allowing creatives to create an image based test where the learner is to find the correct spot on an image. Use this content type with the H5P plugin to challenge your users.
[[File:H5P example find the hotspot.png|400px]]

* [https://h5p.org/flashcards Flashcards] - A content type allowing creatives to create flashcards.
[[File:H5P example flashcards.png|400px]]

* Greeting Card - To easily create a greeting card.
[[File:H5P example greeting card.png|400px]]

* [https://h5p.org/node/2398 Guess the Answer] - A content type allowing creatives to create challenges where the user is to guess an answer based on a picture.
[[File:H5P example guess the answer.png|400px]]

* [https://h5p.org/iframe-embedder Iframe Embedder] - The Iframe embedder makes it easy to make an H5P of already existing JavaScript applications.
[[File:H5P example iframe embedder.png|400px]]
{{Note|Moodle itself can use [[PhET simulations]]. You can embedd them in a page or inside a question in a quiz.}}

* [https://h5p.org/image-hotspots Image Hotspots] - A content type allowing creatives to add hotspots to images. Hotspots may reveal texts, images and videos when clicked.
[[File:H5P example image hotspots.png|400px]]

* [https://h5p.org/interactive-video Interactive Video] - An interactive video content type allowing users to add multiple choice and fill in the blank questions, pop-up text and other types of interactions to their videos using only a web browser. Make your videos more engaging.
[[File:H5P example interactive video.png|400px]]

[https://h5p.org/sites/default/files/front-page-demo.mp4 Click here to link to an interactive video demo]

* [https://h5p.org/mark-the-words Mark the Words] - A question type allowing creatives to create challenges where the user is to mark specific types of verbs in a text.
[[File:H5P example mark the words.png|400px]]

* [https://h5p.org/memory-game Memory Game] - A memory game content type allowing authors to add their own images (and optional text) to a memory game. To play the game, users search for image pairs, which will display a specified text message once a matching pair has been found.
[[File:H5P memory game 001.png|400px]]

* [https://h5p.org/multichoice Multiple Choice] - A question type allowing creatives to create challenges where the user is to identify one ore more correct choices.
[[File:H5P example multiple choice.png|400px]]

* [https://h5p.org/question-set Question Set] - A content type allowing creatives to create quizzes. Many question types are supported like multiple choice, fill in the blanks, drag the words, mark the words and regular drag and drop.
[[File:H5P example question set..png|400px]]

* [https://h5p.org/single-choice-set Single Choice Set] - A content type allowing creatives to create simple and smoot quizzes consisting of single choice questions.
[[File:H5P example single choice set..png|400px]]

* [https://h5p.org/summary Summary] - A summary builder. This content type allows creatives to create challenges where the user is to choose between statements and build the correct summary.
[[File:H5P example summary..png|400px]]

* [https://h5p.org/timeline Timeline] - A content type allowing creatives to create interactive timelines.
[[File:H5P example timeline..png|400px]]

* [https://h5p.org/twitter-user-feed Twitter User feed] - A Twitter feed.
[[File:H5P example twitter user feed..png|400px]]

== See also==
* [https://h5p.org/ H5P] homepage
* [https://h5p.org/forum forum] for discussing H5P
* [https://github.com/h5p/h5p-moodle-plugin source code] repository

[[Category:Audio]]
[[Category:Video]]

[[es:Actividad Contenido Interactivo - H5P]]
[[fr:H5P]]

Regular Expression Short-Answer question type

2019-06-04T16:52:02Z

Rezeau: /* In the Mobile App */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analysing the student's answers'' with the aim of ''providing more relevant immediate feedback''.
The RegExp Short Answer question is meant to be used with questions requiring '''natural language''' answers. This question type is not well-suited to questions requiring mathematical, scientific, programming "languages".

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.5 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

Similar to the ''short answer'' core question type instructions, "Normally the answer box appears below the question text. However, if you include five or more underscores in the text, the input box will be placed there." This inline input feature has recently been made available to the Moodle mobile version for "short answer" questions. It is now available for the "regexp" question type as well.

If you enter this regexp question text: The ____________ sat on the white mat.

This is what it will look like in a moodle mobile quiz:

[[Image:2019-06-04_18-40-30.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-06-04T16:50:58Z

Rezeau: /* In the Mobile App */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analysing the student's answers'' with the aim of ''providing more relevant immediate feedback''.
The RegExp Short Answer question is meant to be used with questions requiring '''natural language''' answers. This question type is not well-suited to questions requiring mathematical, scientific, programming "languages".

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.5 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]
Similar to the ''short answer'' core question type instructions, "Normally the answer box appears below the question text. However, if you include five or more underscores in the text, the input box will be placed there." This inline input feature has recently been made available to the Moodle mobile version for "short answer" questions. It is now available for the "regexp" question type as well.
If you enter this regexp question text: The ____________ sat on the white mat.
This is what it will look like in a moodle mobile quiz:

[[Image:2019-06-04_18-40-30.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

File:2019-06-04 18-40-30.jpg

2019-06-04T16:48:26Z

Rezeau:

Regular Expression Short-Answer question type

2019-02-24T16:26:11Z

Rezeau: /* The RegExp Short Answer Question */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analysing the student's answers'' with the aim of ''providing more relevant immediate feedback''.
The RegExp Short Answer question is meant to be used with questions requiring '''natural language''' answers. This question type is not well-suited to questions requiring mathematical, scientific, programming "languages".

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.5 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-02-02T21:43:47Z

Rezeau: /* In the Mobile App */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.5 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-01-27T15:54:31Z

Rezeau:

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.1 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-01-19T15:55:51Z

Rezeau: /* Detecting missing required words or character strings */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\bblue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.1 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-01-19T15:30:55Z

Rezeau:

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===In the Mobile App===
Starting with the Moodle 3.1 version, RegExp includes code for the Moodle Mobile App. If you access a quiz with the mobile app that contains RegExp questions it will be automatically loaded as a remote add-on.

[[Image:regexp05.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

File:regexp05.jpg

2019-01-19T15:22:14Z

Rezeau:

Regular Expression Short-Answer question type

2019-01-19T11:16:58Z

Rezeau: /* Automatic formatted extra feedback */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted (correct but misplaced words) are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted (Wrong words) are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

''Please note that the colour scheme has been changed starting with the Moodle 3.1 version of RegExp.''

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-01-19T11:14:43Z

Rezeau: /* Feedback given by the Help button */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word/punctuation''' button to buy/get a letter/word/punctuation mark, that letter, word or punctuation mark is added to their response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''Response history'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word/punctuation mark was added.
----
[[Image:regexp03.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-01-19T11:10:42Z

Rezeau: /* Automatic formatted extra feedback */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the colour associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are displayed on a green background;
** any words not present in the potential Alternate Answers following the initial correct part submitted are displayed on a red background.
The meaning of those colours is explained below the feedback with the 2 labels "Wrong words" and "Misplaced words".

[[Image:regexp04.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

File:regexp04.jpg

2019-01-19T11:07:03Z

Rezeau:

File:regexp03.jpg

2019-01-19T11:06:41Z

Rezeau:

File:regexp02.jpg

2019-01-19T11:03:37Z

Rezeau:

Regular Expression Short-Answer question type

2019-01-18T22:38:56Z

Rezeau:

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Regular Expression Short-Answer question type

2019-01-18T18:05:21Z

Rezeau: /* Editing a regular expression question */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:regexp settings 01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word or punctuation mark (including the very first letter or word).

''The "Word or Punctuation" help mode is a new feature starting in Moodle 3.1.
''

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" or "Buy next word or punctuation" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word" or "Get next word or punctuation".

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

File:regexp settings 01.jpg

2019-01-18T17:58:39Z

Rezeau:

Regular Expression Short-Answer question type

2019-01-18T10:18:06Z

Rezeau:

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/rezeau/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Joseph Rézeau]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort vom Typ regulärer Ausdruck]]

Glossary export to quiz

2019-01-10T22:22:05Z

Rezeau: /* Configuring an Export Glossary to Quiz block */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions. Starting with the Moodle 3.6 version, it is also possible to export entries to the '''Gapfill''' contributed question type, if that plugin is installed on your Moodle site, of course.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Drag and drop into text''''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## If the '''''Gapfill''''' question type is installed on your moodle site, it will appear as an option in the -- Select question type -- drop-down list. If you select the Gapfill question type, one more drop-down list will be displayed, where you can choose from the 3 display modes for Gapfill: gapfill, dragdrop or dropdown. If you select the gapfill or the dragdrop modes, you'll have a further option of fixed gap size. See the [[Gapfill_question_type|Gapfill question documentation]] for more info.
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!

== Exporting the selected entries as questions to a moodle Questions XML file ==
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the '''Export n entries and create n questions''' link.
# Now you are on page Your course -> Glossaries -> [glosssary name] -> Glossary -> Export entries to Quiz (XML)
# Click on the Export button.
# At the prompt, save file to your computer. Its named after this pattern: '''[glosssary name] [QUESTIONTYPE (abbreviated)] questions.xml'''.
# Click the Return to course button/link. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# In Administration block, click Questions to go to the Questions bank
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported
# You can now use these questions in a quiz.

[[Category:Block]]
[[Category:Contributed code]]

[[fr:Exporter un glossaire vers un Test]]
[[es:Exportación de glosario a examen]]

Glossary export to quiz

2019-01-10T22:03:18Z

Rezeau: /* Overview */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions. Starting with the Moodle 3.6 version, it is also possible to export entries to the '''Gapfill''' contributed question type, if that plugin is installed on your Moodle site, of course.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## ''''Drag and drop into text'''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!
== Exporting the selected entries as questions to a moodle Questions XML file ==
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the '''Export n entries and create n questions''' link.
# Now you are on page Your course -> Glossaries -> [glosssary name] -> Glossary -> Export entries to Quiz (XML)
# Click on the Export button.
# At the prompt, save file to your computer. Its named after this pattern: '''[glosssary name] [QUESTIONTYPE (abbreviated)] questions.xml'''.
# Click the Return to course button/link. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# In Administration block, click Questions to go to the Questions bank
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported
# You can now use these questions in a quiz.

[[Category:Block]]
[[Category:Contributed code]]

[[fr:Exporter un glossaire vers un Test]]
[[es:Exportación de glosario a examen]]

Embedded Answers (Cloze) question type

2018-12-21T15:04:26Z

Rezeau: /* Detailed syntax explanations */

{{Questions}}
'''Embedded answers (Cloze)''' questions consist of a passage of text (in Moodle format) that has various answers embedded within it, including multiple choice, short answers and numerical answers.

Until mid2013, there was no graphical interface to create these questions within your Moodle site - you needed to specify the question format using the text box or by importing them from external files.

You can link to an external web site that does create these questions from a graphical interface, see the ''[http://projects.ael.uni-tuebingen.de/quiz/htmlarea/index.php Online Cloze Question quiz generator]'' below.

There is an Excel-based [http://hbwubecc.wixsite.com/jordan/tools Cloze and GIFT Generator] that was presented at the 2017 Moodle Moot Japan.

There is a [[Cloze editor for TinyMCE]] that will let you create these questions from a graphical interface within your Moodle site, but it will overwrite your current HTML editor and only works with the [[TinyMCE editor]] but not with [[Atto]]. In 2016 a [[Cloze editor for Atto]] additional plugin was created.

Lots of people suggested that [[Hot Potatoes]] software is the easiest way to create Embedded answer (Cloze) questions. Once you have created your questions on your PC, you can then import them into Moodle's quiz module.

However, the flexibility of the Cloze question type is hard to equal and despite the minor coding that you need to create the questions, it has great worth in the Moodle Quiz.

==Question set-up==

#Select the question category
#Give the question a descriptive name - this allows you to identify it in the question bank.
#Enter the passage of text (in Moodle format - see [[Embedded_Answers_%28Cloze%29_question_type#Format|Format]] below) into the 'question text' field.
#Select an image to display if you want to add a picture to the question. For the student, it appears immediately above the question text.
#Set the 'default question grade' (i.e. the maximum number of marks for this question).
#Set the 'Penalty factor' (see [[Embedded_Answers_%28Cloze%29_question_type#Penalty_factor|Penalty factor]] below).
#If you wish, add general feedback. This is text that appears to the student after he/she has answered the question.
#The editor has been modified and allows you to test if your syntax is good. The different questions elements decoded will be displayed and syntax errors pinpoint. However, it cannot check if the question decoded is two questions in one because of an error syntax.
#Click Save changes to add the question to the category.

=== Penalty factor ===

The 'penalty factor' only applies when the question is used in a quiz using adaptive mode - i.e. where the student is allowed multiple attempts at a question even within the same attempt at the quiz. If the penalty factor is more than 0, then the student will lose that proportion of the '''maximum''' grade upon each successive attempt. For example, if the default question grade is 10, and the penalty factor is 0.2, then each successive attempt after the first one will incur a penalty of 0.2 x 10 = 2 points. The grading for the cloze question applies the penalty to each subpart of the question as a whole. For example, if you have three fill in the blanks each worth 1 point each, then the penalty will only be incurred on the incorrect parts, not the questions as a whole.

==Question rendering==

The question answer entry space or INPUT HTML ELEMENT (for Short Answer and Numerical question types) and the dropdown list or SELECT HTML ELEMENT (for multichoice) are normally displayed in-line with the text.

The size of the entry space or INPUT HTML ELEMENT ( Short and Numerical) will be adjustable to the length of the longest answer (good or bad) + a random number (0 to 15% total length).([[User:Pierre Pichet|Pierre Pichet]] 15:37, 26 January 2008 (CST))

The size will adjust to the length of the student response when displayed in the grading and feedback process.

The size of the dropdown list or SELECT HTML ELEMENT (multichoice) adjusts itself automatically to the longest answer.

==Format==

Questions consist of a passage of text (in Moodle format) that has various sub-questions embedded within it, including

* short answers (SHORTANSWER or SA or MW), case is unimportant,
* short answers (SHORTANSWER_C or SAC or MWC), case must match,
* numerical answers (NUMERICAL or NM),
* multiple choice (MULTICHOICE or MC), represented as a dropdown menu in-line in the text,
* multiple choice (MULTICHOICE_V or MCV), represented as a vertical column of radio buttons, or
* multiple choice (MULTICHOICE_H or MCH), represented as a horizontal row of radio-buttons,
* multiple choice (MULTIRESPONSE or MR), represented as a vertical row of checkboxes
* multiple choice (MULTIRESPONSE_H or MRH), represented as a horizontal row of checkboxes
* when the quiz question behavior shuffle option IS SET YES, the following multiple choice sub-questions elements will be shuffled,
* multiple choice (MULTICHOICE_S or MCS), represented as a dropdown menu in-line in the text,
* multiple choice (MULTICHOICE_VS or MCVS), represented as a vertical column of radio buttons, or
* multiple choice (MULTICHOICE_HS or MCHS), represented as a horizontal row of radio-buttons.
* multiple choice (MULTIRESPONSE_S or MRS), represented as a vertical row of checkboxes
* multiple choice (MULTIRESPONSE_HS or MRHS), represented as a horizontal row of checkboxes

{{Note|MCS, MCVS, MCHS are new (Moodle 3.0) Cloze subquestion types with shuffling of answers. See MDL-38214.}}

The structure of each cloze sub-question is identical:
:'''{''' start the cloze sub-question with a bracket (AltGr+7)
:'''1''' define a grade for each cloze by a number (optional). This used for calculation of question grading.
:''':SHORTANSWER:''' define the type of cloze sub-question. Definition is bounded by ':'.
:'''~''' is a seperator between answer options
:'''=''' marks a correct answer
:'''#''' marks the beginning of an (optional) feedback message
:'''}''' close the cloze sub-question at the end with a bracket (AltGr+0)

Now a very simple example:
<pre>
{1:SHORTANSWER:=Berlin} is the capital of Germany.
</pre>

For full details of the format for embedded-answers questions, see the [[Embedded_Answers_%28Cloze%29_question_type#Detailed_syntax_explanations|detailed syntax explanation]] below.

NB: Be careful when copying a cloze type question into the WYSIWYG HTML editor, as line breaks tend to get added, which destroys the question.

If the correct answer contains } # ~ / " or \ you will have to escape them by putting a \ in front of each such character. But [[https://moodle.org/mod/forum/discuss.php?d=275299 this is tricky]]. The { shouldn't be escaped, this can be vital in getting TeX expressions to work. In the feedback ~ and } must be escaped otherwise it will be interpreted as ''the next answer'' or ''end of the short answer section'' respectively. Quotation signs: " can lead to trouble anyhow in both places. Use the HTML entity: & quot; (without the space between ''&'' and ''quot;''). If you want to have Mathematical symbols there can be problems with the \ used in TeX expressions. One alternative can be to use [[unicode]] characters.

See the notes further down about numerical embedded question!

===Examples===

====Example 1====
The following text creates a simple embedded-answers question:

Match the following cities with the correct state:
* San Francisco: {1:MULTICHOICE:=California#OK~Arizona#Wrong}
* Tucson: {1:MULTICHOICE:California#Wrong~%100%Arizona#OK}
* Los Angeles: {1:MULTICHOICE:=California#OK~Arizona#Wrong}
* Phoenix: {1:MULTICHOICE:%0%California#Wrong~=Arizona#OK}
The capital of France is {1:SHORTANSWER:%100%Paris#Congratulations!
~%50%Marseille#No, that is the second largest city in France (after
Paris).~*#Wrong answer. The capital of France is Paris, of course.}.

And the result will be:

[[Image:Cloze.gif|Cloze question type]]

====Example 2====
<div style="padding: 1em;border: 1px dashed #FFB53A;color: black;background-color: #f9f9f9;font-family: monospace;font-size:1.2em;">
This question consists of some text with an answer embedded right here {1:MULTICHOICE:Wrong answer#Feedback for this wrong answer~Another wrong answer#Feedback for the other wrong answer~=Correct answer#Feedback for correct answer~%50%Answer that gives half the credit#Feedback for half credit answer}

and right after that you will have to deal with this short answer {1:SHORTANSWER:Wrong answer#Feedback for this wrong answer~=Correct answer#Feedback for correct answer~%50%Answer that gives half the credit#Feedback for half credit answer}

and finally we have a floating point number {2:NUMERICAL:=23.8:0.1#Feedback for correct answer 23.8~%50%23.8:2#Feedback for half credit answer in the nearby region of the correct answer}.

The multichoice question can also be shown in the vertical display of the standard moodle multiple choice.
{2:MCV:1. Wrong answer#Feedback for this wrong answer~2. Another wrong answer#Feedback for the other wrong answer~=3. Correct answer#Feedback for correct answer~%50%4. Answer that gives half the credit#Feedback for half credit answer}

Or in an horizontal display that is included here in a table
{2:MCH:a. Wrong answer#Feedback for this wrong answer~b. Another wrong answer#Feedback for the other wrong answer~=c. Correct answer#Feedback for correct answer~%50%d. Answer that gives half the credit#Feedback for half credit answer}

A shortanswer question where case must match. Write moodle in upper case letters {1:SHORTANSWER_C:moodle#Feedback for moodle in lower case ~=MOODLE#Feedback for MOODLE in upper case ~%50%Moodle#Feedback for only first letter in upper case}

Note that addresses like www.moodle.org and smileys :-) all work as normal:

a) How good is this? {:MULTICHOICE:=Yes#Correct~No#We have a different opinion}

b) What grade would you give it? {3:NUMERICAL:=3:2}
</div>
[[Image:Cloze example.png]]

Some things to note:
* The individual embedded answers are represented by the code in braces {}.
* The number at the start is the 'weight', so in this case each answer contributes an equal share of the overall grade.
* The correct option in each case is preceded either by an = sign or by %100%.
* The text appearing after the # that follows each option is the feedback that the student will see if they choose that option.
* If the student enters 'Marseille' in the final example, they score 50% of the total grade.
* The asterisk * preceding the "Wrong answer" feedback in the final example means that the student will see this feedback if they enter anything other than "Paris" or "Marseille".
* For multiple choice vertical or horizontal rendering there is no automatic numbering, though can added at each answer.

==Detailed syntax explanations==
# all question items within a cloze-type question are coded inside curled braces { }
# the number which appears between the opening brace and the colon {1: is the weighting of that item; if it is set at 1 for all the items, it needs not be specified, so you can have {:
# after the colon we have the item question type: MULTICHOICE, SHORTANSWER, NUMERICAL
# '''NOTE'''.- If you have installed the [https://moodle.org/plugins/qtype_regexp REGEXP question type plugin] you can also use the REGEXP question type; see [https://docs.moodle.org/38/en/Regular_Expression_Short-Answer_question_type#Inserting_RegExp_sub-questions_in_Cloze_type_questions instructions here].
# the syntax for MULTICHOICE and SHORTANSWER is the same; the only difference is in the displaying of the item to the student
# the order of the various answers is indifferent (except if you want a catch-all for wrong answers, see #13 below)
# a correct answer is preceded with the equal sign = or a percentage (usually %100%) - '''Note''': [[Talk:Embedded_Answers_(Cloze)_question_type| The equal sign (=) doesn't seem to work with SHORTANSWER.]]
# a wrong answer is preceded with nothing or a percentage (usually %0%)but you can even use negative points by preceding with ~%-25% [not before Moodle 2.0])
# you can allocate some points between 0 and 100 to some answers, if you put the appropriate percentage
# all answers except the first one are separated from one another by the tilde ~ sign
# answers can be followed by an optional feedback message, preceded with the # sign; if there is no feedback message, the # sign can be present or absent, it does not matter
# note that the feedback message and the correct answer are displayed in a small popup window (if and when the correct and or feedback have been declared accessible to the students in the Quiz settings) upon mouse hovering. The popup window has a title "feedback" and you can use HTML tags to format your feedback. In some browsers (For example IE5.5) the form fields can cover part of the feedback windows. It can help to not have the formfields for the answers too close to each other.
# in the SHORTANSWER type you may want to put a catch-all (wrong) answer in order to send a "wrong, try again" feedback; you can do this by inserting an asterisk '''*''' as '''the very last expected answer''' in your formula

==Numerical Cloze questions==

From the student perspective, a numerical Cloze question looks just like a short-answer question or ''fill in the blanks''.

The difference is that numerical answers are allowed to have an accepted error. This allows a continuous range of answers to be set. You can also express your answer in some different numerical formats. 23.4 23,4 (some countries use , as a decimal separator) and 2.34E+1 (meaning 2.34*10^1) would be interpreted as the same.

=== False positives ===

'''Note:''' the following examples of false positives do '''not''' apply to Moodle 1.8+, where you cannot use percentages or fractions as the answers in a numerical Cloze test; Moodle will generate an error if you try to save such a question. However the following may be relevant for earlier versions of Moodle.

More examples:
0.5 accepts .5 0.5 ,5 0,5 0.500 5e-1 5E-1 but not 1/2 50%
50% accepts 50% 50.0% 5E1% 50/100 even '''50/1000 50''' but not 500/1000 0.5
1/2 accepts 1/2 '''1/3 1twenty''' but not 2/4 0.5 0,5 3/6 50% ½
½ accepts ½
HALF doesn't even accept HALF (maybe '''0'''?)

If you want to accept several variants you can have them in the same {} but '''be careful, notice the "false positives" in bold'''!

===Syntax for numerical Cloze questions===

The format of a NUMERICAL Cloze question is similar to that of the other Cloze types and they can be mixed in the same question. As with other Cloze tests, you write your question or incomplete text, and add the Cloze code at the point where the student is supposed to enter their numerical answer.

An example of the syntax used is shown below:

'''Note: ''' It is preferable to write the code in 'source code' mode. The WSIWYG editor can insert linebreaks that make the question not function. The linebreak in the example box below is for readability only! A problem with these questions is the readability of the code! :(

{2:NUMERICAL:=23.8:0.1#Feedback for correct answer 23.8
~%50%23.8:2#Feedback for ½credit near correct answer}.

In this example:
* 2: is the question point weight, which means that this question has twice the weight in the final point(s) for this question as other partial answers with weight 1 (or no declared weight - you can start with {: for the default weight 1) in the same question.
* NUMERICAL: says what kind of question it is. It must be in CAPS.
* =23.8:0.1 = or %100% means correct if the answer is 23.8 with an accepted error of 0.1, then any number between 23.7 and 23.9 will be accepted as correct. (In the GIFT numerical question one can express an interval like this 13..15 or 14:1 but in Cloze only 14:1 works.)
* #Feedback for correct answer 23.8 is preceded by #
* ~%50%23.8:2 ~ is the separator for answer alternatives %50% means this answer would get 50% of the score that the more precise answer had gotten. Because the tolerance here is 2, 21.8 to 25.8 would get this point and feedback.

The feedback (which is seen within a popup window when the user hovers over the answer space) is formattable with HTML tags. For example, if you want an exponent, surround it with superscript tags: . You can even include pictures in the feedback popup, but you must clean out all " characters and save while still in source code mode (not WYSIWYG). So, this works in feedback popup:
#See this picture: <img src=Something.gif />}
but not this:
#See this picture: <img src="Something.gif" />}

(ALGEBRA and TEX filters don't work in the feedback popups, but they can be very useful in the question writing for math/science expressions). But you can use [[Unicode]] characters.

If you want to give feedback for any answer that didn't fit the intervals you already have specified feedback for, add some BIG general intervals, like for positive answers (if they aren't bigger than 20000 you could add:
~%0%10000.0001:10000#Feedback for unspecified not_right answers}
This would give feedback for anything from 0.0001 to 20000.0001 (that hadn't already gotten feedback). I didn't want to include 0 since that special case as well as negative ought to have specific reactions.
~%0%0#Hey! It can't be zero
~%0%-10000.0001:10000#We just want the size here,
so a negative value is not what we want}

Numerical questions could, before version 1.7, also have case-insensitive non-numerical answers. This is useful whenever the answer for a numerical question is something like +inf, -inf, NaN etc.
==Importing CLOZE questions==
If you try importing directly as CLOZE this text:
<pre>
Single line per question! Match the following cities with the correct state:
* San Francisco: {1:MULTICHOICE:=California#OK~Arizona#Wrong}
* Tucson: {1:MULTICHOICE:California#Wrong~%100%Arizona#OK}
* Los Angeles: {1:MULTICHOICE:=California#OK~Arizona#Wrong}
* Phoenix: {1:MULTICHOICE:%0%California#Wrong~=Arizona#OK}

The capital of France is {1:SHORTANSWER:%100%Paris#Congratulations!~%50%Marseille#No, that is the second largest city in France (after Paris).~*#Wrong answer. The capital of France is Paris, of course.}.

23+ 0.8 = {2:NUMERICAL:=23.8:0.1#Feedback for correct answer 23.8 ~%50%23.8:2#Feedback for ½credit near correct answer}. </pre>

You would get all three questions as different parts of '''ONE question'''. (NOTE see that there are no linebreaks between the { } !)

Multiple CLOZE questions can be imported using the XML format:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<quiz>


<question type="cloze">
<name><text>Book Test #1</text>
</name>
<questiontext>
<text><![CDATA[..............]]></text>
</questiontext>
<generalfeedback>
<text></text>
</generalfeedback>
<shuffleanswers>0</shuffleanswers>
</question>


<question type="cloze">
<name><text>Book Test #2</text>
</name>
<questiontext>
<text><![CDATA[............]]></text>
</questiontext>
<generalfeedback>
<text></text>
</generalfeedback>
<shuffleanswers>0</shuffleanswers>
</question>

</quiz>
</pre>
You would put the question text including CLOZE code in the ....... spaces.

==Online Cloze Question generator==
* There is a website to generate CLOZE quizzes for Moodle (1.9 and 2.x and 3.x versions) and/or to try out the CLOZE editor integration for Moodle.
* This editor was built at the Chair of Applied English Linguistics at Universitaet Tuebingen, Germany, by Andreas Glombitza (andiglombitza(at)googlemail.com) and Achim Skuta (achim.skuta(at)googlemail.com).
* The authors are currently maintaining this software and webservice as a private project.

Website: [http://projects.ael.uni-tuebingen.de/quiz/htmlarea/index.php http://projects.ael.uni-tuebingen.de/quiz/htmlarea/index.php]

==Cloze editor plugin for TinyMCE==
* You can download a [https://moodle.org/plugins/view.php?plugin=other_cloze Moodle plugin from the Moodle plugins database] that will let you create these questions from a graphical interface within your Moodle site. There are versions available for Moodle 1.9, 2.x and 3.x.

==Cloze editor plugin for Atto==
This [[Cloze editor for Atto|new plugin for Moodle 3.1+]] was developed by Daniel Thies and is available for download and install from the Moodle plugins database..

==Question with 1 media (e.g. audio) and several subquestions==
As described in [https://moodle.org/mod/forum/discuss.php?d=376874 this forum post], you can easily make a question where the student inspect a media (e.g. an audio file) and then has to answer several small multiple choice questions. The example below is from a Moodle 3.5.2+ site using the new Record audio tool in the Atto editor. The Record video tool will also let you add video as part of the question, if you want to.

[[File:CLOZE question with 1 audio and 3 sub-questions.png|400px]]

== Questions with student notes and feedback for teacher==
You can easily make one/many/all question(s) with an optional field for student notes and/or feedback for the teacher, as requested in [https://moodle.org/mod/forum/discuss.php?d=353587 this forum thread]. Note that only the first MULTICHOICE question is marked, and the two optional fields do not score positive nor negative points:

[[File:CLOZE question with student comment and teacher feedback.png]]

The full question for the above example is:

Which of the following options is the right answer ?
{1:MULTICHOICE_VS:~A wrong answer~Another wrong answer~Yet another wrong answer~%100%This is the only right answer}
Optionally:Write a personal note: {0:SHORTANSWER:~%0%I want to have a longer input box for the note.~%100%*}
Optionally:Send feedback to teacher:{0:SHORTANSWER:~%0%I want to have a longer input box for the feedback.~%100%*}

==See also==
* See the [http://projects.ael.uni-tuebingen.de/quiz/htmlarea/index.php online Cloze question generator].
* Download the newest version of the [[Cloze editor for TinyMCE]] for Moodle 1.9 and for Moodle 2.0 to 3.3 from [https://moodle.org/plugins/view.php?plugin=tinymce_clozeeditor the Moodle plugins database]
* Easily edit embedded answer questions with the additional plugin [[Cloze editor for Atto]] for Moodle 2.7+

This information was drawn from:
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=36521 Is there a guide to using the cloze format?] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=36430&parent=170308 Cloze-type question syntax] forum post

[[Category:Language teaching]]

[[de:Fragetyp Lückentext (Cloze)]]
[[es:Tipo de Pregunta con respuestas incrustadas (Cloze)]]
[[fr:Question Cloze à réponses intégrées]]
[[ja: 穴埋め問題 ( Cloze ) タイプ]]
[[zh:填空題(克漏字)]]

Glossary export to quiz

2018-12-19T15:15:22Z

Rezeau: /* Import to the quiz questions bank */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## ''''Drag and drop into text'''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!
== Exporting the selected entries as questions to a moodle Questions XML file ==
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the '''Export n entries and create n questions''' link.
# Now you are on page Your course -> Glossaries -> [glosssary name] -> Glossary -> Export entries to Quiz (XML)
# Click on the Export button.
# At the prompt, save file to your computer. Its named after this pattern: '''[glosssary name] [QUESTIONTYPE (abbreviated)] questions.xml'''.
# Click the Return to course button/link. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# In Administration block, click Questions to go to the Questions bank
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported
# You can now use these questions in a quiz.

[[Category:Block]]
[[Category:Contributed code]]

[[fr:Exporter un glossaire vers un Test]]
[[es:Exportación de glosario a examen]]

Regular Expression Short-Answer question type

2018-10-31T21:55:53Z

Rezeau: /* Detecting missing required words or character strings */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/ndunand/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Nicolas Dunand]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr].*". '''OR''' * Teacher Answer: "--^(b|c|r).*".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort Regulärer Ausdruck]]

Regular Expression Short-Answer question type

2018-10-29T15:07:29Z

Rezeau: /* In Accepted Answers */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/ndunand/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Nicolas Dunand]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as "Computers are $usually$ (cheaper|less expensive) than cars.".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr]". '''OR''' * Teacher Answer: "--^(b|c|r)".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort Regulärer Ausdruck]]

Regular Expression Short-Answer question type

2018-10-29T15:06:04Z

Rezeau: /* Example 5. */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/ndunand/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Nicolas Dunand]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes a man healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as ""Computers are $usually$ (cheaper|less expensive) than cars."".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr]". '''OR''' * Teacher Answer: "--^(b|c|r)".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort Regulärer Ausdruck]]

Regular Expression Short-Answer question type

2018-10-05T21:42:11Z

Rezeau: /* Inserting RegExp sub-questions in Cloze type questions */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/ndunand/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Nicolas Dunand]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes an ma healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as ""Computers are $usually$ (cheaper|less expensive) than cars."".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr]". '''OR''' * Teacher Answer: "--^(b|c|r)".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!
[[Image:regexp_in_cloze_question.jpg]]

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort Regulärer Ausdruck]]

File:regexp in cloze question.jpg

2018-10-05T21:36:03Z

Rezeau:

Regular Expression Short-Answer question type

2018-10-05T21:27:22Z

Rezeau: Re-introduced links to the 2 hacked files for inserting REGEXP questions in CLOZE questions.

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/ndunand/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Nicolas Dunand]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes an ma healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as ""Computers are $usually$ (cheaper|less expensive) than cars."".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr]". '''OR''' * Teacher Answer: "--^(b|c|r)".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]
===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle '''Cloze''' question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/questiontype.php

https://raw.githubusercontent.com/rezeau/moodle_multianswer_regexp_compatible/master/renderer.php

|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

A more complete example. If you enter the following in the text of a Cloze question:
''The colors of the French flag are {:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}.'' and click the ''Decode and verify the question text'' button, you will see this:

Question {#9} Regular expression short answer
Question definition
{:REGEXP:=blue, white and red#Very correct indeed!~--.*\bblue\b.*#The color of the sky is missing!~--.*(blue|red|white).*#You have not even found one of the colors of the French flag!}
Default mark
1
Answer
blue, white and red
Grade
1
Feedback
Very correct indeed!
Answer
--.*\bblue\b.*
Grade
0
Feedback
The color of the sky is missing!
Answer
--.*(blue|red|white).*
Grade
0
Feedback
You have not even found one of the colors of the French flag!

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort Regulärer Ausdruck]]

Regular Expression Short-Answer question type

2018-10-02T08:27:08Z

Rezeau: /* First correct answer */

{{Infobox plugin
|type = question type
|entry = https://moodle.org/plugins/pluginversions.php?plugin=qtype_regexp
|tracker = https://github.com/ndunand/moodle-qtype_regexp/issues
|discussion = https://moodle.org/plugins/qtype_regexp
|maintainer = [[user:Nicolas Dunand]]
|float = right
}}{{Questions}}
===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes an ma healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as ""Computers are $usually$ (cheaper|less expensive) than cars."".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr]". '''OR''' * Teacher Answer: "--^(b|c|r)".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost (me )?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====See also these other Moodle question types based on regular expressions====
* [[Pattern-match question type]]
* [[Preg question type]]
* [[Essay (auto-grade) question type]] additional plugin (NOT based on regular expressions)

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]
[[de:Fragetyp Kurzantwort Regulärer Ausdruck]]

Question behaviours

2018-10-01T10:04:27Z

Rezeau: Re-named Interactive mode to Interactive with multiple tries

{{Questions}}
==How questions behave==
The following question behaviours are available when [[Quiz settings|creating a quiz]] (also when previewing questions):

;Deferred feedback
:Students must enter an answer to each question and then submit the entire quiz, before anything is graded or they get any feedback.
;Adaptive mode and Adaptive mode (no penalties)
:Allows students to have multiple attempts at the question before moving on to the next question. This behaviour requires that the "Whether correct" box is ticked under "During the attempt" in the "Review options" section, at a minimum.
;Manual grading
:Used for essay questions (irrespective of what the quiz is set to) but you can now choose to have every question in the quiz manually graded, if you wish.
;Interactive with multiple tries
:After submitting one answer, and reading the feedback, the student has to click a 'Try again' button before they can try a new response. They can be given hints to help them. Once the student has got the question right, they can no longer change their response. Once the student has got the question wrong too many times, they are just graded wrong (or partially correct) and get shown the feedback and can no longer change their answer. There can be different feedback after each try the student makes. The number of tries the student gets is the number of hints in the question definition plus one.
;Immediate feedback
:Similar to interactive mode in that the student can submit their response immediately during the quiz attempt, and get it graded. However, they can only submit one response, they cannot change it later.
;Deferred feedback or Immediate feedback with Certainty-based marking (CBM)
:With CBM, the student does not only answer the question, but they also indicate how sure they are they got the question right. The grading is adjusted by the choice of certainty, so that students have to reflect honestly on their own level of knowledge in order to get the best mark.
;Conditional questions
:If using the Interactive with multiple tries or Immediate Feedback behaviour and with the navigation method set to 'Free', it is possible to make the display of a question dependent on a previous question being answered first.
:The question editing page will display padlock icons to the right of each question.

==Certainty-based marking==
When a student answers a question they also have to state how sure they are of the answer: not very (less than 67%); fairly (more than 67%) or very (more than 80%). Their grading is then adjusted according to how certain they are, which means that for example if they answered correctly but were only guessing, their mark is adjusted from 1 to 0.33. If they answered wrongly but were very sure, their mark is adjusted from 0 to -2.

For detailed information on how CBM works and how students can benefit from it, see [[Using certainty-based marking]].
{|
| [[File:cbm03.png|thumb|correct answer; very sure]]
| [[File:cbm05.png|thumb|correct answer; fairly sure]]
| [[File:cmb04.png|thumb|correct answer; not very sure]]
| [[File:cbm01.png|thumb|wrong answer; very sure]]
| [[File:cbm99.png|thumb|wrong answer; not very sure]]
|}

==Managing question behaviours==

An administrator can manage question behaviours available across the site in ''Administration > Site administration > Plugins > Question behaviours > Manage question behaviours''.

==Deferred feedback with explanation==
[https://moodle.org/plugins/view.php?plugin=qbehaviour_deferredfeedbackexplain Deferred feedback with explanation] is an additional question behaviour, available for Moodle 2.6+, that is just like deferred feedback, but with an additional input box where students can give a reason why they gave the answer they did. No attempt is made to automatically grade the explanation, nor is it required.
* It may be used in various ways, for example:
** The teacher may want to manually edit the grades where the student gave a wrong answer, to give partial credit if the student used the right method or approach.
** The student might want to explain their thinking, so that later, when the results and feedback are revealed, they are reminded of what they were thinking at the time, and so can reflect more deeply.
* You can use [[Language customization]] to change the default text string "Explain your reasons" in the file qbehaviour_deferredfeedbackexplain.php to a more specific text such as "Enter justifications below if you want partial credit in numerical problems by showing your steps, ignore otherwise." as described in https://moodle.org/mod/forum/discuss.php?d=275752

==See also==

* [http://www.ucl.ac.uk/lapt/ LAPT: UCL home of Certainty-Based Marking]
* [https://moodle.org/mod/forum/discuss.php?d=225920 CBM too harsh?] forum discussion
* [http://school.demo.moodle.net/mod/quiz/view.php?id=1496 School demo example of a quiz with CBM] Log into with username "parent" and password "moodle"
* [http://helderenwijzer.nl/2011/10/certainty-based-marking-in-moodle/ Certainty Based Marking in Moodle] blog post by Isabelle Langeveld
* [http://www.open.edu/openlearnworks/mod/oucontent/view.php?id=51788&section=6 Styles of interactive computer marked assessments] from the Open University
*[https://moodle.org/mod/forum/discuss.php?d=313947 This forum thread] about adding an 'all or nothing' behaviour for adaptive and deferred feedback for questions in a quiz.

[[Category:Site administration]]

[[de:Frageverhalten]]
[[es:Comportamientos de preguntas]]

Glossary export to quiz

2018-09-25T09:26:25Z

Rezeau:

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## ''''Drag and drop into text'''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!
== Exporting the selected entries as questions to a moodle Questions XML file ==
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the '''Export n entries and create n questions''' link.
# Now you are on page Your course -> Glossaries -> [glosssary name] -> Glossary -> Export entries to Quiz (XML)
# Click on the Export button.
# At the prompt, save file to your computer. Its named after this pattern: '''[glosssary name] [QUESTIONTYPE (abbreviated)] questions.xml'''.
# Click the Return to course button/link. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported
# You can now use these questions in a quiz.

[[Category:Block]]
[[Category:Contributed code]]

[[fr:Exporter un glossaire vers un Test]]
[[es:Exportación de glosario a examen]]

Glossary export to quiz

2018-09-24T21:45:12Z

Rezeau:

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## ''''Drag and drop into text'''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!
== Exporting the selected entries as questions to a moodle Questions XML file ==
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the '''Export n entries and create n questions''' link.
# Now you are on page Your course -> Glossaries -> [glosssary name] -> Glossary -> Export entries to Quiz (XML)
# Click on the Export button.
# At the prompt, save file to your computer. Its named after this pattern: '''[glosssary name] [QUESTIONTYPE (abbreviated)] questions.xml'''.
# Click the Return to course button/link. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported
# You can now use these questions in a quiz.

[[fr:Exporter un glossaire vers un Test]]
[[es:Exportación de glosario a examen]]

Glossary export to quiz

2018-09-21T17:22:18Z

Rezeau:

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## ''''Drag and drop into text'''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!
== Exporting the selected entries as questions to a moodle Questions XML file ==
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the '''Export n entries and create n questions''' link.
# Now you are on page Your course -> Glossaries -> [glosssary name] -> Glossary -> Export entries to Quiz (XML)
# Click on the Export button.
# At the prompt, save file to your computer. Its named after this pattern: '''[glosssary name] [QUESTIONTYPE (abbreviated)] questions.xml'''.
# Click the Return to course button/link. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported
# You can now use these questions in a quiz.

[[es:Exportación de glosario a examen]]

Glossary export to quiz

2018-09-21T17:13:50Z

Rezeau: /* Configuring an Export Glossary to Quiz block */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 2 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of total choices/answers you want to make available to the student (this number includes the correct answer plus the distracters).</li><li>''Number the choices'' Select your preferred numbering style for the choices..</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## '''''Matching''''' questions will consist of a number of concepts and definitions which the student will have to match. A standard text of instructions will be added to the question: 'Match the definitions and the concepts'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of pairs you want to make available for matching.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
## ''''Drag and drop into text'''' questions will consist of a number of definitions which the student will have to complete by dragging & dropping the concepts into blanks. A standard text of instructions will be added to the question: 'Drag each concept label to match its definition'. When you select this type, 2 drop-down lists get displayed. <ul><li> ''Number of choices''. Select the number of articles you want to make available for each question.</li><li>''Shuffle within questions' Select whether the answers will be shuffled.</li></ul>
# '''Save changes''' Upon saving the form validation check may throw out a message warning you that the number of entries or of choices you entered are incorrect. Please amend as needed before re-saving!

# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the [Export n entries] link.
# Now you are on page Your course -> Glossaries -> (e.g.) Demo -> Glossary -> Export entries to Quiz (XML)
# Click on the Export entries to file button.
# At the prompt, save file to your computer. Its name is e.g. Demo_Glossary.xml.
# Go back to the course's homepage. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer in step A 10 (Demo_Glossary.xml. and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported (of the SHORTANSWER type).
# You can use the SHORTANSWER or the MULTICHOICE questions in a quiz.

You can use the SHORTANSWER questions to create one or more Random Short-Answer MATCHING questions.

[[es:Exportación de glosario a examen]]

Glossary export to quiz

2018-09-21T15:03:52Z

Rezeau: Doc for the new version of this block (from Moodle 3.5) ... work in progress

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker = https://github.com/rezeau/moodle-block_glossary_export_to_quiz/issues
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing plugins]].

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to '''Short answer''', '''Multiple choice''', '''Matching''' or '''Drag and drop into text''' questions.

==Export entries from Glossary to moodle quiz XML file==
=== How to access the block's configuration ===
After this block has been installed (by an Admin) on your Moodle site, it should be available to the site's users with a Teacher capability, in their own courses.
# As a teacher, go to your course's front page, Click on the main Actions icon to go into Edit mode and Turn editing on.
# In the side panel, click on Add a block. In the list which appears, click to select the Export Glossary to Quiz block.
# The Export Glossary to Quiz block gets displayed in your course's default block zone (depending on the current theme).
# Click on the block's Action icon to configure the Export Glossary to Quiz block.
=== Configuring an Export Glossary to Quiz block ===
# Use the drop-down list to '''select the glossary''' that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select one category to export its entries. To cancel your choice or to reset the block, simply leave that drop-down list on the Choose... position. Once a glossary has been selected, more options appear...
# '''Sorting Order'''. Use this setting to determine how the exported glossary entries will be ordered when you import them to your questions data bank. This can be used, in combination with the Maximum number of entries, for creating a quiz to test the latest entries to your glossary (especially a fairly large one).
# '''Maximum number of entries to export'''. Leave this field empty (or at its default '''0''' value) to export '''all''' entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# '''Select question type'''
##'''''Short answer''''' When you select this type, a Case sensitivity drop-down list is displayed. <ul><li> ''Case insensitive''. Student responses will be accepted as correct regardless of the original glossary entry concept case (upper-case or lower-case). Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".</li><li>Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used. Example: original entry "Moodle". Accepted correct response: "Moodle".</li></ul>
## '''''Multiple choice''''' questions will consist of the following elements: ''question text'' = glossary entry definition; ''correct answer'' = glossary entry concept; ''distracters'' = 3 (or more) glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected. When you select this type, 3 drop-down lists get displayed. <ul><li> ''Number of choices''. </li><li>Number the choices?</li></ul>
### You have a choice of 4 types of numbering for the exported multiple choice questions:<ul><li> a. b. c. (the default numbering type)</li><li>A. B. C. D.</li><li>1. 2. 3.</li><li>no numbering</li></ul>

# When done, click OK.
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the [Export n entries] link.
# Now you are on page Your course -> Glossaries -> (e.g.) Demo -> Glossary -> Export entries to Quiz (XML)
# Click on the Export entries to file button.
# At the prompt, save file to your computer. Its name is e.g. Demo_Glossary.xml.
# Go back to the course's homepage. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer in step A 10 (Demo_Glossary.xml. and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported (of the SHORTANSWER type).
# You can use the SHORTANSWER or the MULTICHOICE questions in a quiz.

You can use the SHORTANSWER questions to create one or more Random Short-Answer MATCHING questions.

[[es:Exportación de glosario a examen]]

Glossary export to quiz

2018-09-20T21:50:00Z

Rezeau:

URL resource settings

2014-10-13T14:25:03Z

Rezeau: /* Display */

{{URL}}
==Adding a URL resource to your course==

# Turn editing on.
#From the the "Add an activity or resource" link (or, if not present, the "Add a resource" drop down menu),choose URL. All settings may expanded by clicking the "Expand all/Collapse all" link top right.

==General==

[[File:urlgeneral25.png]]

===Name===
Whatever you type here will form the link learners click on to view the URL so it is helpful to give it a name that suggests its purpose.
===Description===
Add a description of your page here. Click "Show editing tools" to display the rich text editor, and drag the bottom right of the text box out to expand it.
===Display description on the course page===
If this box is ticked, the description will appear on the course page just below the name of the URL.

==Content==

[[File:Url.png]]

# Either enter the URL in the external URL field or click the "Choose a link" button to open the file picker and choose a URL YouTube, Picasa etc (depending on which [[Repositories|repositories]] are enabled for the site.

==Appearance==
(These settings are collapsed by default)

[[File:urlappearance.png]]

===Display===

* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
* ''Embed'' - Show the Moodle page with heading, blocks and footer. Show the title/description of the item and display the file directly in the page as well
* ''Open'' - No Moodle heading, blocks, footer or description - just show the file in the web browser (e.g. shows image, PDF, flash animation, taking up the whole browser window)
* ''In pop-up'' - Same as 'Open', but opens a new browser window to show this file (without the Moodle heading, blocks, etc) - this browser window also does not have all the menus in it.

The above options are the default display options. Additional display options (see below) may be enabled by an administrator in ''Site administration > Plugins > Activity modules > URL''.

===Pop-up width/height===
If your URL is to be displayed in a pop-up, specify the width and height here.

===Display URL name/description===
To show the resource name and/or description when clicking to access the URL, simply tick the appropriate checkboxes.

==URL variables==
(These settings are collapsed by default.)

[[File:url.png]]

This section allows you to pass internal information as part of the URL.

This is useful if the URL is actually an interactive web page that takes parameters, and you want to pass something like the name of the current user, for example.

==Common module settings==
See [[Common module settings]]
==Restrict access/Activity completion==
(These settings are collapsed by default)

These settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Drag and Drop a URL==
Alternatively, if an administrator has enabled the experimental feature drag and drop upload of text/links in ''Settings > Site administration > Development > Experimental > [[Experimental settings]]'', a link can be dragged into a section of the course and given a name, as shown in the images below.

{|
| [[File:dragURL.png|thumb|Adding a URL using drag and drop]]
|}

==URL module capabilities==

* [[Capabilities/mod/url:view|View URL resource]]
* [[Capabilities/mod/url:addinstance|Add a new URL resource]]

==Site administration settings==

The URL module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > URL''.

===Frame height===

Here you can specify the height of the top frame (containing the navigation) if you choose the "in frame" display option. Note:If your theme has a large header then the height should be increased to prevent horizontal and vertical scrollbars.

===Require activity description===

This setting allows you to turn off the requirement for users to type something into the description box.

===Password===

Here you can add a password that will connect your users to a secure site. [http://moodle.org/mod/forum/discuss.php?d=189842#p826416 See this forum post] for more details.

===Include role names in parameters===

===Available display options===

This setting allows you to add different ways the resource may be displayed on the course page. There are a number of defaults but you can add or change them here. Other display options are:
* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizeable area below
* ''New window'' - very much like 'in pop-up', but the new window is a full browser window, with menus and address bar, etc.
[[File:Display.gif]]

===Default values for activity settings===

Here you can set the defaults for this resource.

==See Also==
* [http://youtu.be/X32dao-UENQ The Moodle URL Resource] MoodleBites video on YouTube

[[de:Link/URL konfigurieren]]
[[fr:Paramètres de l'URL]]
[[es:Configuraciones del recurso URL]]

Lesson settings

2014-10-08T14:10:20Z

Rezeau: /* Progress bar */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:addlessontitle.png|thumb|274px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
* For lessons containing '''only''' ''Content pages'', once a lesson has been taken to the end, if that same lesson is re-taken, the progress bar will not be "reset", i.e. it will show a 100% progress from page 1!

* For lessons containing ''Question pages'' and set to "Re-take" '''Yes''', the progress bar is always "reset" at 0% upon re-take.

* Note that the Lesson Progress bar only works correctly for lessons with a "straightforward" navigation, such as page 1 -> page 2 -> page n -> end of lesson. It is not guaranteed to work with pages "jumping all over the place".

===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this if you want to show a list of the pages in the Lesson so a student can see what is coming up.
===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===
Please note that slideshow mode currently does not work for Moodle 2. There is a tracker issue and patch here MDL-36673
===Maximum Number of Answers===
Here you can set the default number of answer boxes available when you add your question or content pages. For instance, if you are only going to use True/False, you would only need 2. You can change this at any time so it's not crucial.
===Use default feedback===
Choose this if you want to show a set phrase regardless of their answer. If you have set your own default feedback such as "well done; correct" or "never mind; better luck next time" etc it will appear. If you have not, then Moodle's default feedback will appear.

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessonavailability.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.
===Time limit===
[[Image:Lesson Timer.png|right]]
This allows you to set a time limit on the lesson. Students will see a countdown counter as they work. The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
(These settings are collapsed by default)
{|
|[[File:prereqlesson.png|thumb|460px|Prerequisite lesson settings expanded]]
|}

===Dependent on===
This allows access to the lesson to be dependent on students' performance in another lesson in the same course. ''(Note: this can also be achieved with [[Conditional activities]])''
===Time spent===
Decide here how long you want the student to have spent in the chosen previous lesson
===Completed===
Check this box if you want the student to have completed a previous lesson (according to [[Activity completion]] settings)
===Grade better than===
Enter the grade from the previous lesson which you want the student to have exceeded before they can attempt the current lesson.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongrade.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here.

===Practice lesson===
Use this if you don't need the lesson to be scored/graded but just need students to work through some pages. Set this to Yes to have the same ungraded type Lesson in earlier versions of Moodle.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
(These settings are collapsed by default.)

See [[Common module settings]]
==Restrict access/Activity completion==
(These settings are collapsed by default)

The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

'''NOTE:''' ''The slideshow settings below do not work. See MDL-36673''

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Number of high scores displayed===
Sets the number of high scores to display
*Variable name: lesson_maxhighscores, Default: 10

===Maximum number of answers===
Default maximum number of answers per page for site
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Lesson settings

2014-10-08T13:39:21Z

Rezeau: /* Allow Student Review */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:addlessontitle.png|thumb|274px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this if you want to show a list of the pages in the Lesson so a student can see what is coming up.
===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===
Please note that slideshow mode currently does not work for Moodle 2. There is a tracker issue and patch here MDL-36673
===Maximum Number of Answers===
Here you can set the default number of answer boxes available when you add your question or content pages. For instance, if you are only going to use True/False, you would only need 2. You can change this at any time so it's not crucial.
===Use default feedback===
Choose this if you want to show a set phrase regardless of their answer. If you have set your own default feedback such as "well done; correct" or "never mind; better luck next time" etc it will appear. If you have not, then Moodle's default feedback will appear.

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessonavailability.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.
===Time limit===
[[Image:Lesson Timer.png|right]]
This allows you to set a time limit on the lesson. Students will see a countdown counter as they work. The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
(These settings are collapsed by default)
{|
|[[File:prereqlesson.png|thumb|460px|Prerequisite lesson settings expanded]]
|}

===Dependent on===
This allows access to the lesson to be dependent on students' performance in another lesson in the same course. ''(Note: this can also be achieved with [[Conditional activities]])''
===Time spent===
Decide here how long you want the student to have spent in the chosen previous lesson
===Completed===
Check this box if you want the student to have completed a previous lesson (according to [[Activity completion]] settings)
===Grade better than===
Enter the grade from the previous lesson which you want the student to have exceeded before they can attempt the current lesson.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the students to navigate through the lesson again from the start.
:Note that the students will not be able to ''change'' their answers, only ''view'' them.

===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongrade.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here.

===Practice lesson===
Use this if you don't need the lesson to be scored/graded but just need students to work through some pages. Set this to Yes to have the same ungraded type Lesson in earlier versions of Moodle.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
(These settings are collapsed by default.)

See [[Common module settings]]
==Restrict access/Activity completion==
(These settings are collapsed by default)

The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

'''NOTE:''' ''The slideshow settings below do not work. See MDL-36673''

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Number of high scores displayed===
Sets the number of high scores to display
*Variable name: lesson_maxhighscores, Default: 10

===Maximum number of answers===
Default maximum number of answers per page for site
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Lesson settings

2014-10-08T13:20:41Z

Rezeau: /* Re-takes allowed */

{{Lesson}}
=Lesson administration settings=

This page explains the settings involved when first creating a lesson.
To add a lesson to your Moodle course page:
*With the editing turned on, in the section you wish to add your lesson, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Lesson'' All settings may expanded by clicking the "Expand all" link top right.

==General==
{|
|[[File:addlessontitle.png|thumb|274px|General settings expanded by default]]
|}

===Name===
Whatever you type here will form the link learners click on to view the lesson so it is helpful to give it a name that suggests its purpose.

==Appearance==
(These settings are collapsed by default)
{|
|[[File:lessonappearance.png|thumb|404px|Appearance settings expanded]]
|}
===File pop===
If you want to include a link to a file on the lesson page for students to refer to, upload it here.
===Progress bar===
Choose this to show a bar at the bottom of the page showing how far into the lesson the student has got.
===Display ongoing score===
Choose this to let students see their score as they work through the lesson.
===Display left menu===
Choose this if you want to show a list of the pages in the Lesson so a student can see what is coming up.
===Minimum grade to display menu===
Choose this if you want the student to go through the lesson once and get a grade before they can (on review) see and navigate through all the different pages.
===Slideshow===
Please note that slideshow mode currently does not work for Moodle 2. There is a tracker issue and patch here MDL-36673
===Maximum Number of Answers===
Here you can set the default number of answer boxes available when you add your question or content pages. For instance, if you are only going to use True/False, you would only need 2. You can change this at any time so it's not crucial.
===Use default feedback===
Choose this if you want to show a set phrase regardless of their answer. If you have set your own default feedback such as "well done; correct" or "never mind; better luck next time" etc it will appear. If you have not, then Moodle's default feedback will appear.

===Link to next activity===
Choose this to give students a link to another activity when they reach the end of the lesson. ''(Note: this can also be achieved using [[Conditional activities]])''
==Availability==
(These settings are collapsed by default)
{|
|[[File:lessonavailability.png|thumb|470px|Availability settings expanded]]
|}
===Available from/Deadline===
Here you can set a start and end date and time for your Lesson.
===Time limit===
[[Image:Lesson Timer.png|right]]
This allows you to set a time limit on the lesson. Students will see a countdown counter as they work. The timer does not stop them doing the lesson when the time is up, but correct answers are no longer scored.

===Password protected lesson===
*Change to "Yes" and enter the password if you want students only to access it when they know the password.

==Prerequisite lesson==
(These settings are collapsed by default)
{|
|[[File:prereqlesson.png|thumb|460px|Prerequisite lesson settings expanded]]
|}

===Dependent on===
This allows access to the lesson to be dependent on students' performance in another lesson in the same course. ''(Note: this can also be achieved with [[Conditional activities]])''
===Time spent===
Decide here how long you want the student to have spent in the chosen previous lesson
===Completed===
Check this box if you want the student to have completed a previous lesson (according to [[Activity completion]] settings)
===Grade better than===
Enter the grade from the previous lesson which you want the student to have exceeded before they can attempt the current lesson.

==Flow control==
(These settings are collapsed by default)
{|
|[[File:flowcontrol.png|thumb|450px|Flow control settings expanded]]
|}

===Allow Student Review===
This puts a "Review Lesson" button on the last screen of the lesson to encourage the student to navigate through the lesson again from the start. Be sure to check other settings to allow them to change their answers.
===Provide option to try a question again===
*This displays a button after an incorrectly answered question so that the student can try again (but not get credit for it)
:''TIP:'' Leave this off if you are using essay questions.
===Maximum Number of Attempts===
*Decide here how many times you want students to be able to attempt each question. When they reach the maximum, they will be taken automatically to the next page.
===Action after a Correct Answer===
Choose here where you want a student to be sent to if they get a question right. See [[Using Lesson]] for more details on this setting. The options are:
**the next part of the Lesson (default setting)
**a random, unexpected page
**a random page which they have not yet answered.
===Number of pages to show===
You only need this if you have set "Action after a correct answer" to show an unseen or unanswered page. Otherwise, all pages will be seen

==Grade==
(These settings are collapsed by default.)
{|
|[[File:lessongrade.png|thumb|450px|Grade settings expanded]]
|}

Set a grade and grade category here.

===Practice lesson===
Use this if you don't need the lesson to be scored/graded but just need students to work through some pages. Set this to Yes to have the same ungraded type Lesson in earlier versions of Moodle.

===Custom Scoring===
Use this to give a particular number score (negative or positive) to each answer
===Re-takes allowed===
Choose this if you want your students to be able to do the lesson more than once.
:Note that this setting only applies to lessons containing ''Question pages''. Lessons consisting '''only''' of ''Content pages'' can be re-taken even if 'Re-takes allowed' is set to ''No''.
====Handling of re-take====
If you allow your students to re-take the lesson, then decide here if the grade for all lesson attempts is the mean or the maximum.

:Note that the Question Analysis always uses the answers from the first tries of the lesson. Re-takes by students are ignored.

===Minimum Number of Questions===
Set here the minimum number of questions that will be used to calculate a student's score. Students will be told how many they have answered and how many more they need to answer.
*If you are using Content pages, then set this to 0.
*If you use this setting, then add some explanatory text at the start of the lesson so the student knows how many questions they must answer as a minimum. (They may answer more.

==Common module settings==
(These settings are collapsed by default.)

See [[Common module settings]]
==Restrict access/Activity completion==
(These settings are collapsed by default)

The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Site administration settings==

The lesson module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Lesson''.

'''NOTE:''' ''The slideshow settings below do not work. See MDL-36673''

===Slideshow width===
Sets the width of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowwidth, Default 640.

===Slideshow height===
Sets the height of the slideshow only when this feature is enabled in a Lesson's "Change settings".
*Variable name: lesson_slideshowheight, Default 480.

===Slideshow background colour===
Background colour to for the slideshow if it is enabled.
*Variable name: lesson_slideshowbgcolor, Default #FFFFFF.

===Popup window width===
Sets the width of the popup displayed for a linked media file
*Variable name: lesson_mediawidth, Default 640.

===Popup window height===
Sets the height of the popup displayed for a linked media file
*Variable name: lesson_mediaheight, Default 480.

===Show close button:===
Displays a close button as part of the popup generated for a linked media file
*Variable name: lesson_mediaclose, Default No.

===Number of high scores displayed===
Sets the number of high scores to display
*Variable name: lesson_maxhighscores, Default: 10

===Maximum number of answers===
Default maximum number of answers per page for site
*Variable name: lesson_maxanswers, Default: 4.

===Action after correct answer===
The default action to take after a correct answer
*Variable name: lesson_defaultnextpage, Default: Normal - follow lesson path

==See also==
*[http://youtu.be/cUDV0WE5ZYY Moodle 2.x Lesson (part 1)] MoodleBites video on YouTube
*[http://youtu.be/Mfj-8w-Ze0A Moodle 2.x Lesson (part 2)] MoodleBites video on YouTube
*[http://youtu.be/jXjqHtgC9c0 Moodle 2.x Lesson (part 3)] MoodleBites video on YouTube

[[de:Lektion konfigurieren]]
[[fr:Ajouter/modifier une leçon]]
[[ja:レッスンの設定]]
[[es:Configuraciones de lección]]

Questionnaire module

2014-05-14T21:07:27Z

Rezeau: /* See also */

{{Questionnaire}}

The Moodle '''Questionnaire module''' is a survey-like type of activity. It is a contributed module which can be downloaded from the [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Moodle Plugins Directory]. It allows teachers to create a wide range of questions to get student feedback e.g. on a course or activities. The goals of the Questionnaire module are quite different from those of the Moodle '''Lesson''' or '''Quiz''' modules. With Questionnaire you do not test or assess the student, you ''gather data''.

==Summary of features==
Please look at the [[Adding/editing a questionnaire]] and [[Editing Questionnaire questions|Adding Questions]] pages for more information.

===Types of questions===
*Check Boxes
*Date Box
*Dropdown choices
*Essay box - HTML editor possible, set width and height of box
*Numeric - can set length and number of decimal places
*Radio buttons - have labels you determine for each question
*Scale - can customize in many ways
*Text box
*Yes/no
You can also place:
*Page breaks
*Labels - might be used to give an overview of next set of questions

===Types of reports===
*Responses can be viewed by everyone or select group
*Responses can be exported

==See also==
* The Questionnaire plugin can be downloaded from the [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Moodle Plugins Directory].
*Discussions: please create or find a discussion topic in the [http://moodle.org/mod/forum/view.php?f=469 Questionnaire Forum]
*[http://en.wikipedia.org/wiki/Statistical_survey Statistical_survey] From Wikipedia, the free encyclopedia.

'''Moodle 2.8''' will hopefully have a new module that combines the best of Questionnaire, Feedback and Survey into an upgrade for the Survey module. See [https://docs.moodle.org/en/Development:Survey_2_brainstorm Development: Survey 2 brainstorm]

[[Category:Contributed code]]

[[es:Módulo cuestionario]]
[[fr:Questionnaire]]

Glossary export to quiz

2014-04-23T09:37:23Z

Rezeau: /* Installation */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker =
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

For more information see [[Installing add-ons]]

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to SHORTANSWER or MULTICHOICE questions.

==Export entries from Glossary to moodle quiz XML file==

# Go to your course's front page and go into Edit mode and click on the Configuration icon to configure the Export Glossary to Quiz block.
# Use the dropdown list to select the glossary that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select only one category to export its entries. To cancel your choice or to reset the block, simply leave the dropdown list on the Choose... position.
# Maximum number of entries to export. Leave empty to export all entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# Glossary entries can be exported to the Quiz Questions bank either as multiple choice or short answer questions.
## Multiple choice questions will consist of the following elements:
### question text = glossary entry definition
### correct answer = glossary entry concept
### distracters = 3 glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected.
### You have a choice of 4 types of numbering for the exported multiple choice questions:<ul><li> a. b. c. (the default numbering type)</li><li>A. B. C. D.</li><li>1. 2. 3.</li><li>no numbering</li></ul>
##Short answer questions
### Case insensitive. Student responses will be accepted as correct regardless of the original glossary entry concept case (uppercase or lowercase).Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".
### Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used.Example: original entry "Moodle". Accepted correct response: "Moodle".
# When done, click OK.
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the [Export n entries] link.
# Now you are on page Your course -> Glossaries -> (e.g.) Demo -> Glossary -> Export entries to Quiz (XML)
# Click on the Export entries to file button.
# At the prompt, save file to your computer. Its name is e.g. Demo_Glossary.xml.
# Go back to the course's homepage. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer in step A 10 (Demo_Glossary.xml. and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported (of the SHORTANSWER type).
# You can use the SHORTANSWER or the MULTICHOICE questions in a quiz.
{{New features}}
You can use the SHORTANSWER questions to create one or more Random Short-Answer MATCHING questions.

Glossary export to quiz

2014-04-23T09:27:04Z

Rezeau: /* Import to the quiz questions bank */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_glossary_export_to_quiz
|tracker =
|discussion = https://moodle.org/mod/forum/discuss.php?d=162866
|maintainer = [[User:Joseph Rézeau|Joseph Rézeau]]
|float = right
}}

== Installation ==

# Download the ''Glossary export to quiz'' installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: glossary_export_to_quiz, the full path in your Moodle installation will be blocks/glossary_export_to_quiz
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing plugins]]

== Overview ==
A block to export a Glossary's entries to the Quiz Questions bank. Exports concepts & definitions to SHORTANSWER or MULTICHOICE questions.

==Export entries from Glossary to moodle quiz XML file==

# Go to your course's front page and go into Edit mode and click on the Configuration icon to configure the Export Glossary to Quiz block.
# Use the dropdown list to select the glossary that you want to use to export its entries to the quiz questions bank. If that glossary contains categories, you can select only one category to export its entries. To cancel your choice or to reset the block, simply leave the dropdown list on the Choose... position.
# Maximum number of entries to export. Leave empty to export all entries from selected Glossary or Category. This option can be useful for exporting a limited number of entries from very large glossaries.
# Glossary entries can be exported to the Quiz Questions bank either as multiple choice or short answer questions.
## Multiple choice questions will consist of the following elements:
### question text = glossary entry definition
### correct answer = glossary entry concept
### distracters = 3 glossary entry concepts randomly selected from the glossary (or glossary category) that you have selected.
### You have a choice of 4 types of numbering for the exported multiple choice questions:<ul><li> a. b. c. (the default numbering type)</li><li>A. B. C. D.</li><li>1. 2. 3.</li><li>no numbering</li></ul>
##Short answer questions
### Case insensitive. Student responses will be accepted as correct regardless of the original glossary entry concept case (uppercase or lowercase).Example: original entry "Moodle". Accepted correct responses: "Moodle", "moodle".
### Case sensitive. Student responses will be only be accepted as correct it the case of the original glossary entry concept is used.Example: original entry "Moodle". Accepted correct response: "Moodle".
# When done, click OK.
# You are back in the course homepage, but now the block displays the settings you have selected.
# Click on the [Export n entries] link.
# Now you are on page Your course -> Glossaries -> (e.g.) Demo -> Glossary -> Export entries to Quiz (XML)
# Click on the Export entries to file button.
# At the prompt, save file to your computer. Its name is e.g. Demo_Glossary.xml.
# Go back to the course's homepage. You see that the the Export Glossary to Quiz block has been reset.

==Import to the quiz questions bank==
# Turn editing on
# In Administration block, click Questions
# On the Edit questions page, Click the Import tab
# Set these settings:<ul><li>File format : Moodle XML format</li><li>General</li><li>Category Default</li><li>Get category from file (check it)</li><li>Import from file upload...</li></ul>
# Go to the file you saved to your computer in step A 10 (Demo_Glossary.xml. and click Upload this file button.
# If all goes well, the imported questions should get displayed on the next screen.
# Click Continue.
# On the next page, the Question bank displays the new category name (formed on the name of the exported Glossary, plus the name of its category if you selected one of the glossary's categories) and of course all the questions that were imported (of the SHORTANSWER type).
# You can use the SHORTANSWER or the MULTICHOICE questions in a quiz.
{{New features}}
You can use the SHORTANSWER questions to create one or more Random Short-Answer MATCHING questions.

Regular Expression Short-Answer question type

2014-04-21T12:58:01Z

Rezeau: /* Inserting RegExp sub-questions in Cloze type questions */

===The RegExp Short Answer Question===

* '''IMPORTANT NOTE'''
** The RegExp Short Answer question described in this documentation page is a 3rd-party plugin, which allows you to create questions for the '''''Quiz''''' activity. It is ''different'' from the "Use regular expressions" option in the '''''Lesson''''' module.
** The documentation for the "Use regular expressions" option in the '''''Lesson''''' module is to be found at: [https://docs.moodle.org/en/Short_answer_analysis Short answer analysis].

Like the Short Answer question, the RegExp Short Answer question expects the respondent to answer an "open" question with a word or a short phrase. However, the RegExp system system gives you access to a more powerful system for ''analyzing the student's answers'' with the aim of ''providing more relevant immediate feedback''.

===Correct answer matching a regular expression pattern===

It is not possible to give complete examples of the vast possibilities offered by this system, and the following are just some possibilities.

===='''Example 1.'''====

Suppose your question was "What are the colors of the French flag?". In the Answer 1 box you would type the "best" answer, e.g. "it's blue, white and red". For more details, see [[#firstcorrect|First correct answer]] below.

*In the Answer 2 box you would type this regular expression: "it's blue, white(,| and) red" (quotes should not be typed, of course).
* If [[#casesensivity|Case sensivity]] is set to "No", this will match any of those 4 responses:
it's blue, white, red
it's blue, white and red
It's blue, white, red
It's blue, white and red

===='''Example 2'''.====

Question: "What are blue, red and yellow?".
* Answer 1: "they are colours".
* Answer 2: "(|they('| a)re )colou?rs".
* This will match any of those 6 responses:
colours
colors
they're colours
they're colors
they are colours
they are colors

'''''Note'''''.- The beginning of this regular expression "(|they('| a)re )" will match either nothing or "they're " or "they are ". In "colou?r", the question-mark means: the preceding character (or parenthesized group of characters) zero or one time; it is used here to match British English as well as US spelling.

===='''Example 3.'''====

Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Answer 1: "cat"
* Answer 2: "[bcr]at".
* This will match: bat, cat or rat.

'''''Note'''''.- In Regular Expression syntax, the inclusion of characters between square brackets means than ANY of those characters can be used. So, in the above example, the regular expression "[bcr]at" is the exact equivalent of "(b|c|r)at". Be careful NOT to include the pipe character as separator in your [...] regular expressions. For instance, "[b|c|r]at" will NOT WORK CORRECTLY.

===='''Example 4.'''====

The 'permutation' feature (introduced in regexp version '''2012102900''' for Moodle 2.3+)

Question: "What are the colours of the French flag (in any order)".
* Answer 1: "it's blue, white and red"
* Answer 2: <nowiki>"it's [[_blue_, _white_(,| and) _red_]]".</nowiki>
Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

it's (blue, white(,| and) red|blue, red(,| and) white|white, red(,| and) blue|white, blue(,| and) red|red, blue(,| and) white|red, white(,| and) blue)

and it will match all the following answers:
it's blue, white, red
it's blue, white and red
it's blue, red, white
it's blue, red and white
it's white, red, blue
it's white, red and blue
it's white, blue, red
it's white, blue and red
it's red, blue, white
it's red, blue and white
it's red, white, blue
it's red, white and blue

'''''Note'''''.- This 'permutation feature' has been asked quite a few times by regexp users. It is definitely ''not'' possible to obtain it by using standard Regular Expressions syntax.

It is possible (but tedious) to write a regular expression including all the possible permutations - as in Answer 2b above - but the ''ad hoc'' syntax I am offering makes it easier to write... provided you strictly adhere to that syntax!

Include within double square brackets the part of the Answer which will contain 'permutable' words or phrases. You are actually allowed to have a maximum of 2 such sets of 'permutable' words or phrases. But you cannot embed one set within another!

Then, use pairs of underscores (the _ character) to delimit each 'permutable' word or phrase. You can still use any of the accepted Regular Expressions characters, as explained here, in your Answers which contain one (or two) such sets of 'permutable' words or phrases. If your Answer does not contain an even number of underscores, an Error warning will be displayed upon clicking the Show Alternate Answers button or when trying to Save your question.

===='''Example 5.'''====

Another 'permutation' example

Question: "Quote the English proverb that is an encouragement to hard, diligent work."

* Answer 1: "Early to bed and early to rise makes an ma healthy, wealthy and wise"
* Answer 2: "Early to <nowiki>[[_bed_ and early to _rise_]], makes a man [[_healthy_, _wealthy_ and _wise_]]</nowiki>"

Upon saving the question, Answer 2 will be automatically re-written as Answer 2b:

Early to (bed and early to rise|rise and early to bed) makes a man (healthy, wealthy and wise|healthy, wise and wealthy|wealthy, wise and healthy|wealthy, healthy and wise|wise, healthy and wealthy|wise, wealthy and healthy)

and it will match all the following answers:

Early to bed and early to rise makes a man healthy, wealthy and wise
Early to bed and early to rise makes a man healthy, wise and wealthy
Early to bed and early to rise makes a man wealthy, wise and healthy
Early to bed and early to rise makes a man wealthy, healthy and wise
Early to bed and early to rise makes a man wise, healthy and wealthy
Early to bed and early to rise makes a man wise, wealthy and healthy
Early to rise and early to bed makes a man healthy, wealthy and wise
Early to rise and early to bed makes a man healthy, wise and wealthy
Early to rise and early to bed makes a man wealthy, wise and healthy
Early to rise and early to bed makes a man wealthy, healthy and wise
Early to rise and early to bed makes a man wise, healthy and wealthy
Early to rise and early to bed makes a man wise, wealthy and healthy

===Escaping metacharacters===

====Definition====
In the Regular Expressions syntax, a number of special characters or ''meta characters'' have special functions; but it is possible to force these special characters to be interpreted as normal (or ''literal'') characters by preceding them with a so-called ''escape'' character, the backslash "\".
Below is a (partial) list of those ''meta characters'':

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

====In Accepted Answers====

* '''Accepted Answers''' are Answers which have a grade greater than zero, i.e. are ''totally'' (grade = 100%) or ''partially'' (grade > 0% < 100%) ''correct Answers''.

In those Answers, if you need to use one or more ''meta characters'' for their ''literal'' value, you '''must''' ''escape'' them (i.e. precede them with a backslash).

'''Example 1.-''' If you want to accept the answer "This computer costs 1000$ in the US.", you must write the Answer as "This computer costs 1000\$ in the US\.".

'''Example 2.-''' If you want to accept the answer "Desktop computers are (usually) more powerful than laptops.", you must write the Answer as "Desktop computers are $usually$ more powerful than laptops\.".

* You can mix metacharacters that have a special function with others that have a literal value, within one Answer.
'''Example 3.-''' If you want to accept both answers "Computers are (usually) cheaper than cars." and "Computers are (usually) less expensive than cars.", you must write the Answer as ""Computers are $usually$ (cheaper|less expensive) than cars."".
* In the '''Accepted Answers''' boxes you can only enter regular expressions which can generate a finite number of sentences. That is why you will not be allowed to use some ''meta characters'' which match a potentially infinite number of sentences.
* List of ''meta characters'' which you '''can''' use for their RegExp functions:

'''( ) [ ] ? |'''

* List of ''meta characters'' which you '''cannot''' use for their RegExp functions, and can only be used for their ''literal'' value (and must be ''escaped'').

'''. ^ $ * + { } \ /'''

* The question mark (?) can be used either for its RegExp function OR, if escaped, for its ''literal'' value.

'''Example 4.-''' "Do you like Jack(ie)?\?" will accept both "Do you like Jack?" and "Do you like Jackie?".

====In Incorrect Answers====

* '''Incorrect Answers''' are Answers which have a grade equal to zero (or None).
When you write those Incorrect Answers, you can use the whole range of ''meta characters'' for their special function value:

'''. ^ $ * ( ) [ ] + ? | { } \ /'''

For examples of use, see '''Detecting missing required words or character strings''' below.

====Answers Validation====

When you validate your Question, the question engine checks the validity of your expression, according to the features explained above. If an error is found, an ERROR message is displayed above the erroneous Answer(s) and you cannot save the Question until that error has been corrected.

The validation system also checks that your parentheses and square brackets are correctly balanced.

'''Note.-''' The faulty Answer text is "underlined" with the list of errors, as shown below.

[[Image:Errors_en.jpg]]

===Detecting missing required words or character strings===

This is a powerful feature of the RegExp question type. It will analyse the student's answer for words that are required for the answer to be correct. There are 2 ways to do this.
* Use what is called "negative lookahead assertion" in regular expressions syntax: '''^(?!.*required.*)'''
* or use an ''ad hoc'' pseudo-syntax provided in RegExp (an initial double hyphen): '''--.*required.*'''.
In the examples below, we shall be using the 'ad hoc' RegExp pseudo-syntax, and sometimes give the "negative lookahead assertion" equivalent for anyone interested.

Any Teacher Answer which begins with a double hyphen will analyse the student’s response to find out whether the following string is present or absent. If present, the analysis continues to the next question; if absent, the analysis stops and the relevant feedback message is displayed.

'''Example 4. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*blue.*
* Sample student Response: "it's red and white"
* Feedback 2: The color of the sky is missing!

Here, the . (dot) stands for “any character” and the * (asterisk) means “preceding special character repeated any number of times”. The Teacher Answer 2 regular expression above means: check whether the character string "blue", preceded with anything and followed by anything is absent from the student's answer. Please note that the use of the asterisk is different in Moodle's "normal" Short Answer question type and in the RegExp question type.

Actually, this syntax is not sufficient to track the absence of the word "blue" in a student's answer such as "it's blueish, white and red". To make sure that we want to track the absence of "blue" as a word(and not just as part of a word), we must use the metacharacter \b which is an anchor which matches at a position that is called a "word boundary". Hence the new version of our Example 4:

'''Example 4b. ''' Question "What are the colors of the French flag?".

* Teacher Answer 2: --.*\bblue\b.*
* Sample student Response: "it's blueish, white and red"
* Feedback 2: The color of the sky is missing!

'''Note.-'''
Using the "negative lookahead assertion" syntax mentioned at the beginning of this section, Teacher Answer 2 would look like this:
* Teacher Answer 2: '''^(?!'''.*\blue\b.*''')'''

'''Example 5.''' Question: "Name an animal whose name consists of 3 letters and the middle letter is the vowel ''a''".
* Teacher Answer: "--^[bcr]". '''OR''' * Teacher Answer: "--^(b|c|r)".
* Sample student Response: "dog"
* Feedback: "Your answer should start with one of these letters: b, c or r"

'''Note.-'''
In regular expressions syntax, the caret ^ stands for "beginning of character string to be matched", while the dollar sign $ stands for "end of character string".

'''Example 6.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*(blue|red|white).*"
* Sample student Response #1: "It's black and orange."
* Feedback: "You have not even found one of the colors of the French flag!"
* Sample student Response #2: "It's blue and orange."
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among those listed between brackets and separated by the | sign. As soon as one of those words is found, the "missing condition" is considered false, and the response analysis continues to the next Answer's regular expression.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''^(?!.*(blue|red|white).*)'''

'''Example 7.''' Question "What are the colors of the French flag?".

* Teacher Answer: "--.*('''&&'''blue'''&&'''red'''&&'''white).*"
* Sample student Response #1: "It's blue and orange."
* Feedback: "You have not found all the colors of the French flag".
* Sample student Response #2: "white blue red".
* Feedback: None, the analysis continues to the next Teacher Answer expression.

'''''Explanation'''''.- The regular expression looks for a missing word among all of those listed between brackets and separated by the && double character combination. Only if all of those words are present, will the "missing condition" be considered false, and the response analysis continue to the next Answer's regular expression. Please note that the list of parenthesized words must begin with the && character sequence.

'''Note.-'''
Using the "negative lookahead assertion" syntax, Teacher Answer would look like this: '''(^(?!.*(blue).*)|^(?!.*(white).*)|^(?!.*(red).*))'''

===Editing a regular expression question===

[[Image:settings01.jpg]]

====Help Button Mode====

Selecting a mode other than ''None'' will display a button to enable the student to get the next letter or word (including the very first letter or word).

In ''Adaptive mode'' the button displayed will say "Buy next letter" or "Buy next word" according to the mode selected by the teacher. For setting the "cost" of buying a letter or word, see the ''Penalty for incorrect tries and Buying a letter or word'' settings further down the Edit form.

In ''Adaptive No penalty'' mode the button displayed will say "Get next letter" or "Get next word"

By default the Help button mode value is set at '''None'''. The Help button will only be available to quizzes that have their '''Question behaviour''' mode set to ''Adaptive'' or ''Adaptive (no penalties)'' as it does not make sense to enable the Help button for non-adaptive tests.

====Case sensitivity====

The editing form features a ''Case sensitivity'' setting, which is valid for ''all of the answers'' of the current question. You should not add an '''/i''' parameter at the end of your regular expressions. You may need to edit questions authored in 1.9 when you upgrade to 2.0 and remove any '''/i''' parameters from your regular expressions.

====Show alternate answers to student====
Show all correct alternative answers to student when on review page? If there are a lot of automatically generated correct alternative answers, displaying them all can make the review page quite long. So, you may wish to ''not'' display all those alternative correct answers. The first correct answer will always be displayed, under the label "The best correct answer is:"

====First correct answer====

For Answer 1 you must enter an answer text which a) is the "best" possible answer; b) is '''not''' a regular expression or - more exactly - ''will not be interpreted as a regular expression'' but "as is" and c) has a Grade value of 100%. You will notice that when you create a new RegExp question the Grade value for Answer 1 is already automatically set at 100% and cannot be changed.

Note.- There are two ways to enter an answer containing meta characters, according to whether this is Answer 1 or any of the subsequent Answers. Exemple question: how much did your computer cost?

Answer 1: It cost $1,000.

Answer 2: It cost ( me)?\$1,000\.

In Anwer 1 you just type the expected answer "as is". The text in Answer 2 will be interpreted as a regular expression, and thus you need to escape the two meta characters (the $ sign and the end-of-sentence full stop). Note that here I have added the optional pronoun "me".

====Other answers====

Any answers with a Grade higher than 0% must be entered as valid regular expressions ''which can yield acceptable alternative answers'' (regardless of the Grade being less than 100%).

For example, you cannot enter the following Answer with a grade greater than zero:

.*blue, white(,| and) red.*

The reason is that this expression would accept as correct (with a non-null grade) an infinity of answers, many of which would be incorrect, e.g.: "My hat it blue, white, red and orange", "The French flag is blue, white, red, black and nice" etc.

If you try to do so, validation of your question will fail and an error message will be displayed to tell you where you went wrong.

This means that some regular expressions, which are perfectly valid and would correctly analyse the student's (correct) answer are not recommended. The only case where they would work is a) if your question's '''Display Hint Button''' is set at No and b) your quiz '''Adaptative Mode''' is set at No. This means that you must ''not'' enter as an answer with a grade higher than 0% a regular expression beginning with a double hyphen "--", used for detecting missing character strings.

====Show/Hide alternate answers====

When you are creating (or modifying) a RegExp question, you may want to make sure that all the alternative correct answers that you have created in the Answers fields will work. You can click the '''Show alternate answers''' button to calculate and display all the correct answers in the form you are editing. This may take quite some time on your server, depending on the number and complexity of the regular expressions you have entered in the Answer fields!

On the other hand, it is the recommended way to check that your "correct answers" expressions are correctly written. Here is an example.

Please remember that only Answers regular expressions with a score greater than zero will be used to calculate those alternative answers.

Please note that clicking the '''Show alternate answers''' button will perform an analysis of all the regular expressions you entered in the Answers field. If a syntax error is detected at this stage, the alternative correct answers will ''not'' be displayed, and an ''ad hoc'' error message will displayed above the faulty regular expression.

[[Image:showhidealternateanswers.jpg]]

===Previewing questions in popup window (teacher only)===

When the teacher previews a question in the popup preview question window they can display all of the acceptable alternative answers. Those alternative answers are automatically generated from the regular expressions you have entered when creating the question which carry a grade higher than 0%. The very first acceptable answer is printed as is at the top of the list. This is followed by all the other alternative acceptable answers, consisting of a) the Grade attributed; b) a reminder of the regular expression you entered and c) a list of all alternative answers.

[[Image:alternate_answers.jpg]]

===Automatic formatted extra feedback===
Please note that the RegExp question can be used in any '''Question behaviour''' mode. However, it is advised to create quizzes containing only RegExp questions or containing other types of questions, but ''preferably'' if the quiz's '''''Question behaviour / How questions behave''''' setting is set to ''Adaptive mode'' (with or without penalty).

When a student (or teacher in Preview Question mode) submits a response to a RegExp question, 3 types of feedback messages are displayed (in Adaptive mode).

* (line 3) The standard correct/incorrect Quiz message (plus the color associated with either state).
* (line 2) The Feedback message entered by the question creator for each Teacher Answer.
* (line 1) An extra feedback system is automatically provided, displaying the student's submitted response, with the following format codes:
** the beginning of the student's submitted response which best matches one of the Alternate Answers is displayed in blue;
** any words from the submitted response which are present in the potential Alternate Answers following the initial correct part submitted are colored in red;
** any words not present in the potential Alternate Answers following the initial correct part submitted are colored in red and formatted as strike-through.
The meaning of those colors etc. may need to be explained to the student before they take the quiz, especially the difference between "red" and "red plus strike-through".

[[Image:regexp_colored_feedback_21.jpg]]

===Feedback given by the Help button===

Each time a student clicks the '''Buy/Get next letter/word''' button to buy/get a letter/word, that letter or word is added to his response. The last line of the feedback zone shows the following information: added letter/word; penalty cost (if applicable); total penalties so far (if applicable). Note that if the total of penalties exceeds 1 (i.e. 100%), that total is displayed in red.

When the teacher views the quiz results, on the ''''Review Attempt'''' pages, ''''History of responses'''' section, the response history shows ''Submit (with a request for help)'' with the response states before and after the letter/word was added.

[[Image:21-addedletterhistory.jpg]]

----
[[Image:21-addedwordhistory.jpg]]
----
If the student clicked the '''Buy/Get next word''' button while his current submitted answer contained the beginning of a (correct) word, the full correct word is displayed in the Answer field, and the feedback message says "''Completed'' word" rather than "''Added'' word".

[[Image:21-completedwordhistory.jpg]]

===Display right answers===

If your Quiz settings ''Review options'' are set to display the Right answer (During the attempt or Immediately after the attempt etc.), and your question's ''Show alternate answers to student'' setting is set to '''Yes''', when the student has submitted his attempt, and is reviewing his answers, all of the possible answers will be displayed, as shown in this screenshot. Correct responses with a grade < 100% are also listed, with their grade value.

Please note that the ''teacher'' will always be able to see that "other accepted answers" section when reviewing the Quiz answers.

[[Image:23 correct responses.jpg]]

===Inserting RegExp sub-questions in Cloze type questions===

{| class="nicetable"
|-
!Important notice
|-
|
The RegExp question type is '''''not''''' recognized by the standard Moodle Cloze question type. If you want to use it you'll have to replace 2 files (''renderer.php'' and ''questiontype.php'') on your ''<yourmoodle>/question/type/multianswer'' with the hacked files available from the links below.

https://raw.github.com/rezeau/moodle/multianswer_regexp-26/question/type/multianswer/questiontype.php

https://raw.github.com/rezeau/moodle/multianswer_regexp-26/question/type/multianswer/renderer.php

Note.- If you are interested in comparing the 2 "standard" Moodle 2.6 multianswer files with the "RegExp hacked" files, go to

https://github.com/rezeau/moodle/compare/MOODLE_26_STABLE...multianswer_regexp-26
|}

Syntax for inserting RegExp sub-questions in Cloze type questions.

Use '''REGEXP''' or shorter '''RX''' coding for questions which ignore case

* The colors of the French flag are {:REGEXP:=blue, white and red#Correct!}.
* The colors of the French flag are {:RX:=blue, white and red#Correct!}.

Will accept "blue, white and red" as a correct answer as well as "Blue, White and Red"

use '''REGEXP_C''' or shorter '''RXC''' coding for questions in which case matters
* The colors of the French flag are {:REGEXP_C:=blue, white and red#Correct!}.
* The colors of the French flag are {:RXC:=blue, white and red#Correct!}.

Will not accept "Blue, White and Red" as a correct answer (wrong capital letters).

Please note that, as explained above, the very first answer ''must'' be Graded 100% (in Cloze type question syntax, all correct is either '''=''' or '''100%''') and it must ''not'' be a regular expression.

Please note that the syntax of the sub-questions inside a Cloze-type question must be followed exactly and that you must never ever copy and paste any question text from e.g. a word-processor into the Cloze-type question editing window. Quite often Cloze-type questions yield errors because extraneous blank spaces, new lines, or any odd formatting character has made its way into the question text.

Note that the ''Hint'' button is not available for a RegExp question embedded in a Cloze-type question.

==See also==
====Downloads====
* Download [http://moodle.org/plugins/view.php?plugin=qtype_regexp the Regexp question type] from the Moodle Plugins repository.
* IMPORTANT : Starting with the 2.2 version of REGEXP, if you want the Help feature, you must also download and install the following 2 "question behaviours" from the Moodle Plugins repository: [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelp RegExp Adaptive mode with Help] and [http://moodle.org/plugins/view.php?plugin=qbehaviour_regexpadaptivewithhelpnopenalty RegExp Adaptive mode with Help (no penalties)].

====Installation====
-------------------------------
If you have downloaded the zip archive from the new moodle.org plugins page

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named "regexp".

3.- GO TO STEP 4 below
---

If you have downloaded the zip archive from https://github.com/rezeau/moodle-qtype_regexp ('''for latest developments''')

1.- Unzip the zip archive to your local computer.

2.- This will give you a folder named something like "rezeau-moodle_qtype_regexp-ff8c6a1". The end of the name may vary.

3.- ***Rename*** that folder to "regexp".

---

4.- Upload the regexp folder to <yourmoodle>/question/type/ folder.

5.- Visit your Admin/Notifications page so that the new question type gets installed.

====Learn more about regular expressions====

*[http://www.regular-expressions.info/tutorial.html Regular Expressions Tutorial] A complete introduction to the topic.
*[http://www.regexplanet.com/simple/index.html Regular Expression Test Page] Test your regular expressions on a variety of "answers".

====Other Moodle question types based on regular expressions====
[https://docs.moodle.org/dev/The_OU_PMatch_algorithm The OUP's PMatch]

[https://docs.moodle.org/20/en/Preg_question_type Oleg Sychev's Preg question type]

[[Category:Quiz]]
[[Category:Questions]]
[[Category:Contributed code]]

[[fr:question/type/regexp]]
[[es:Tipo de pregunta respuesta corta de expresión regular]]