Perl-Compatible Regular Expression

Question types ::: qtype_preg
Maintained by Oleg Sychev
A question that could check student's response against several regular expressions and could give next character and next word hints. If you do not know what regular expression is, it could also work like Moodle Shortanswer question with hints, just choose "Moodle shortanswer" as notation and you could enter answers just like in shortanswer question type.

Perl-Compatible Regular Expression Preg 3.2

Moodle 3.2, 3.3, 3.4, 3.5
Released: Saturday, May 2, 2020, 12:06 AM
Perl-compatible regular expression question
-------------------------------------------

The major new feature of this release is the support for detecting typos in students' responses.

Authors:
1. Idea, design, question type and behaviours code, hinting, error reporting, regular expression testing (authoring tool) - Oleg Sychev.
2. Regex parsing, FA regex matching engine, matchers testing, backup&restore, unicode support, selection in regex text (in authoring tools) - Valeriy Streltsov.
3. Explaining graph (authoring tool) - Vladimir Ivanov.
4. Syntax tree (authoring tool) - Grigory Terekhov.
5. Regex description (authoring tool) - Dmitriy Pahomov.
6. Assertion support - Elena Lepilkina.
7. Typo detection support - Prokudin Artem

Thanks going to:
* Joseph Rezeau - for been devoted tester of preg question type in several releases;
* Tim Hunt - for his polite and useful answers and commentaries that helped writing this question;
* Bondarenko Vitaly - for conversion of a vast set of regular expression matching tests from PCRE library.

==============
1. Description
==============
The question was primarily intended to allow the usage of php perl-compatible regular expressions in short answer
questions. It supports full regular expression syntax and can be used with expressions of any complexity
that php preg extension can handle. Regular expressions can be used to specify wide array of patterns for student
answer to match. You can find some links to the descriptions of regular expression syntax in the question docs.

Preg question is also able to hint next character or lexem for a specified penalty in adaptive and interactive
behaviours if the student is stuck, which can be useful in training quizzes.

To use hinting you don't need to know anything about regular expressions. Choosing Moodle Shortanswer notation allows
you to just copy answers from shortanswer question and have hinting capabilities. '*' wildcard is supported.
FA engine is preferable for such questions for now.

===============
2. Installation
===============
To work with hinting, Preg question type needs 2 behaviours: adaptivehints and adaptivehintsnopenalties.
They all need to be installed in order for question to work. You can download the question type and behaviours
in one archive (from GoogleCode or GitHub) or separately.

If you downloaded one archive, unpacking it you should found "question" and "blocks" folders. Copy them in the main
directory of Moodle installation (the one containing config.php) - it will install everything in the correct places.

If you downloaded all parts separately (for example because Moodle plugins Directory don't allow them to be downloaded together),
you should get 5 archives. Place "preg" and "poasquestion" folders in the question/type folder of Moodle installation.
"adaptivehints", "interactivehints" and "adaptivehintsnopenalties" should be placed in question/behaviour folder.
"formal_langs" should be placed in the blocks folder.

After having files in place login as administrator and go to the notifications page.

Pay heed to the default matching engine setting. Most of your teachers would use it, though you can choose engine in every question.
See the "Matching engines" section for more information.

In order to get Authoring tools to work, you should also install Graphviz package and make it accessible from Moodle, using the admin setting
"Path to Dot" at Administration > Server > System Paths. It is necessary for drawing Syntax Tree and Explaining Graph for regular expression.
Graphviz is a well-known and respected open source package for drawing graphs and should not cause any trouble to you server.
Be sure to use Graphviz 2.36 or newer (earlier versions had a bug in svg output which led to incorrect pictures).

==========
3. Hinting
==========
FA matching engine support hinting for partial matching. If there is no full match in the response,
question chooses the partial match that has less characters to complete matching. It could also show
a next character (or lexem) that leads to the shortest path to complete matching as a hint (with adding hint penalty)
when using adaptive behaviour. Only answers with grade greater or equal hint grade border are used in hinting.

===================
4. Matching engines
===================
There is no 'best' matching enginge, so you could choose best fit for every question. Start by analyzing you needs and
choosing default engine, that could be set on the question type settings page.

If you primary need is to use very complex regular expressions, than "PHP preg extension" is you most likely choice.
By "very complex" we understand regular expression using complex assertions etc.

If you regular expressions are not that hardcore, but you want to make heavy use of hinting facility, choose FA engine instead.

Then just experiment. If some engine don't allow you to do something you need (you get messages that something is unsupported, or
regular expression is too complex or hinting is inactive etc) or just have bug in you particular regular expression - try another one.

==================
5. Regex constructor
==================
Regex constructor help you with regular expression development. There are several tools in it. For now they are concentrated on the
describing you regular expression in different ways.

Syntax tree shows you the internal structure of expression - what is inside what. If you understand regular expressions throught operators
and operands, it can be of a great help to you. If not, it can help you determine if repeating or alternative applied to the correct parts
of the expression, do you need to use parentheses and where they should be placed.

Explaining graph shows you graphically how expression works: its nodes are characters or character sequences; concatenation, alternation and
simple assertions are shown by edges, while rectangles show you repetition and subpattern capturing.

Description is a natural language sentence, generated from regular expression, which explains you how your expression will work.

Testing tool allows you to see how you regexes match different strings. It expected to be much more convenient than question previewing.
Entered test strings will be saved in database with the question for future use.

For better understanding of how regex parts affect the entire picture, you can select a regex part to be highlighted in the syntax tree,
explaining graph and description tools. Testing tool will show you parts of strings, matched with given selection.

====================================
6. Bugs, suggestions and giving back
====================================
Please report bugs at GoogleCode tracker (set Component-Preg label) - this is the preferable way - or at Moodle Tracker.
Google Code tracker can be found there: http://code.google.com/p/oasychev-moodle-plugins/issues/list
You may also post suggestions of how to develop question type in the future, but please accompany them with information of
who are you, how you are using question type and how you intend to use enchancements you suggest pedagogically.

If you like the project, please consider helping it too. That doesn't necessary mean money or tough programming.

You could publish a paper or thesis about using this question type and send me a reference I could quote to
improve rating of this project. If you could publish a scientific paper on this question and its usage with
me as co-author this would help much more, please inform me immediately if you choose to do so.

You could also help by testing - either manual or unit-testing. Unit-testing of regular expressions
is not that hard - look for cross-test files in "tests" subfolder of "preg" folder for examples and feel free to ask me questions
about them. You need not be much of a programmer to write them at all - you only need to know regular expressions.

Version information

Version build number
2020020701
Version release name
Preg 3.2
Maturity
Stable version
MD5 Sum
a949b801ecf9e11ca8d55704114a28c2
Supported software
Moodle 3.2, Moodle 3.3, Moodle 3.4, Moodle 3.5
  • Latest release for Moodle 3.2
  • Latest release for Moodle 3.3
  • Latest release for Moodle 3.4
  • Latest release for Moodle 3.5

Version control information

Version control system (VCS)
GIT
VCS repository URL

Default installation instructions for plugins of the type Question types

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder (eg "myquestiontype") in the "question/type" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation