https://docs.moodle.org/dev/api.php?action=feedcontributions&feedformat=atom&user=FinnsMoodleDocs - User contributions [en]2026-07-30T18:56:12ZUser contributionsMediaWiki 1.43.5https://docs.moodle.org/dev/index.php?title=MoodleNet&diff=64084MoodleNet2024-03-05T12:55:09Z<p>Finns: /* Migrate from V2 */</p>
<hr />
<div>[[File:Moodlenet-logo.png|400px]]<br />
== What is MoodleNet? ==<br />
[https://moodle.net/ MoodleNet] is a flexible Open Education Technology platform for curating collections of the best known Open Educational (and other) Resources. You'll find more general information in the [https://docs.moodle.org/moodlenet/Main_Page MoodleNet user documentation].<br />
<br />
If you are looking to get started as a MoodleNet developer, we have some courses on Moodle Academy. Both are a bit old but will be updated soon.<br />
* [https://moodle.academy/course/view.php?id=13# Introduction to MoodleNet] <br />
* [https://moodle.academy/course/view.php?id=74 MoodleNet for Developers course with Moodle Academy] <br />
Checkout issues and releases on https://github.com/moodle/moodlenet<br />
<br />
== Current status ==<br />
We have just released MoodleNet 4.0.0. You can follow the releases on Moodle's Jira tracker at [https://tracker.moodle.org/projects/MDLNET?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased MDLNET]. <br />
== Roadmap ==<br />
See [https://tracker.moodle.org/secure/RapidBoard.jspa?rapidView=120&projectKey=MDLNET&view=detail our work on new features in the tracker].<br />
== Quick start guide ==<br />
====System Requirements====<br />
To install MoodleNet, we recommend using the following on your system:<br />
*[https://nodejs.org NodeJS] 16 <br />
*[https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/ npm] 8<br />
*[https://www.arangodb.com/ ArangoDB] 3.10<br />
<br />
<br />
Later versions should probably work but have not been tested yet.<br />
====Deploy an ArangoDB instance====<br />
MoodleNet uses [https://www.arangodb.com/ ArangoDB] as main database<br />
<br />
You can choose how and where to deploy your ArangoDB, as long as it can be reached by MoodleNet process<br />
<br />
An easy way to install run ArangDB locally as a service is by using Docker[https://hub.docker.com/_/arangodb] e.g. :<br />
docker run -d --restart unless-stopped -e ARANGO_NO_AUTH=1 -p 8529:8529 --name=mn-3-db arangodb:3.10<br />
Possibly tweaking some options as you like, e.g. mounting a volume|directory for data or setting a password<br />
====Install MoodleNet ====<br />
Install Moodlenet by simply issuing the following npm command<br />
npm create @moodlenet@latest path/to/installation/folder<br />
That will install all MoodleNet core packages in the chosen folder<br />
<br />
it will also create a default configuration file ('''default.config.json''') and a default cryptographic key-pair for the system ('''default.crypto.privateKey , default.crypto.publicKey''')<br />
====Start MoodleNet process ====<br />
To start MoodleNet issue the following command from within the installation directory<br />
npm start<br />
open your browser on http://localhost:8080<br />
<br />
'''Notice:''' on the first run the system will have to compile the webapp, so you'll get a 404 until ready. It should take a few minutes.<br />
====MoodleNet configuration file====<br />
MoodleNet configuration file ('''default.config.json''') holds all static system configs.<br />
<br />
Here's how the default config looks like after install:<br />
{<br />
"pkgs": {<br />
"@moodlenet/core": {<br />
"baseFsFolder": "/path/to/installation/dir/fs",<br />
"instanceDomain": "<nowiki>http://localhost:8080</nowiki>",<br />
"npmRegistry": "<nowiki>https://registry.npmjs.org</nowiki>",<br />
"mainLogger": {<br />
"consoleLevel": "info",<br />
"file": {<br />
"path": "./log/moodlenet.%DATE%.log",<br />
"level": "info"<br />
}<br />
}<br />
},<br />
"@moodlenet/crypto": {<br />
"keys": {<br />
"alg": "RS256",<br />
"type": "PKCS8",<br />
"private": "/path/to/installation/dir/default.crypto.privateKey",<br />
"public": "/path/to/installation/dir/default.crypto.publicKey"<br />
}<br />
},<br />
"@moodlenet/arangodb": {<br />
"connectionCfg": {<br />
"url": "<nowiki>http://localhost:8529</nowiki>"<br />
}<br />
},<br />
"@moodlenet/http-server": {<br />
"port": 8080,<br />
"defaultRpcUploadMaxSize": "5MB"<br />
},<br />
"@moodlenet/ed-resource": {<br />
"resourceUploadMaxSize": "1.2GB"<br />
},<br />
"@moodlenet/simple-email-auth": {<br />
"newUserNotPublisher": false<br />
},<br />
"@moodlenet/email-service": {<br />
"nodemailerTransport": {<br />
"jsonTransport": true<br />
}<br />
},<br />
"@moodlenet/system-entities": {<br />
"rootPassword": "eqhb30x9iq5"<br />
},<br />
"@moodlenet/react-app": {<br />
"defaultImageUploadMaxSize": "1MB"<br />
}<br />
}<br />
Here are some relevant configs you may want to check and tweak:<br />
*'''@moodlenet/arangodb.connectionCfg.url''' : the default config assumes you installed ArangoDB without password with standard port on the same host<br />
*'''@moodlenet/core.baseFsFolder''' : path (better absolute path instead of relative to MoodleNet process cwd) to the system root folder for system filesystem persistency, if you want to change the system-filesystem-root after the system already run, move or clone the existing folder somewhere else and set this config properly to point to the new path<br />
*'''@moodlenet/core.instanceDomain''' : the public domain of your moodlenet instance (e.g. <nowiki>https://moodlenet.example.com</nowiki>) - the default one (<nowiki>http://localhost:8080</nowiki>) is ok for testing and dev<br />
*'''@moodlenet/email-service.nodemailerTransport''' : the [https://nodemailer.com/ nodemailer] [https://nodemailer.com/smtp/ transport configuration] for the system email service. It can be a simple smtp url string, or a [https://nodemailer.com/smtp/ nodemailer standard config object]. '''Notice''': with the default configuration '''{ "jsonTransport": true }''' the system won't send any email, it will simply log them)<br />
*'''@moodlenet/system-entities.rootPassword''' : a static root password for edge cases - you'll use it to give the first admin permission to a user (see below) - this property is optional, if not set the root user is disabled<br />
*'''@moodlenet/http-server.port''' : the HTTP server port to listen<br />
Moodlenet's HTTP service doesn't support HTTPS. <br />
<br />
It's always a good practice to back Moodlenet with a HTTP reverse proxy (e.g. nginx, Apache) and it is a must if you want to publish over HTTPS, configuring TLS on it.<br />
====Default authentication system====<br />
Moodlenet comes with a simple email+password authentication system (pkg @moodlenet/simple-email-auth) that lets users signup and login with a verified email<br />
<br />
Users can sign up with their email, receive in their inbox a confirmation link to click and create their user-account<br />
====Assign admin privileges to your user====<br />
As you deploy a new instance, no user is present in the system. <br />
<br />
Signup with your email and create your user.<br />
<br />
Test login, then logout and browse to the hidden page '''<nowiki>http://localhost:8080/login/root</nowiki>''', here you can type in the '''rootPassword''' (specified in config file) to login as root.<br />
<br />
Open the avatar menu on top right header, and click '''admin''' link<br />
<br />
Click on '''Users''' section on the left, and see your user listed there. Activate the '''admin''' icon to give yourself admin privileges<br />
<br />
Now you can log out and login back with your email, see you gained the '''admin''' link in your avatar menu<br />
<br />
Admins can directly use that admin page feature anytime to assign and remove admin privileges to other users<br />
== Update the system==<br />
You can easily upgrade MoodleNet keeping system packages always up-to-date with the minor and patch releases by issuing the command<br />
npm update<br />
from within the installation directory, the same where you start the system<br />
<br />
Since MoodleNet is npm-package based, it leverages all npm features for upgrades and new packages installation<br />
<br />
'''Note:'''<br />
<br />
'''npm update''' does not upgrade packages for breaking-change versions (major versions, or minor versions for '''0.x.y''' versions, as from [https://github.com/npm/node-semver#caret-ranges-123-025-004 node-semver specs])<br />
<br />
In case you need to upgrade MoodleNet system packages to newer major versions you may want to either edit manually the main '''package.json'''<br />
<br />
Or, better, use the utility [https://www.npmjs.com/package/npm-check-updates npm-check-updates]:<br />
# for a dry run:<br />
npx npm-check-updates<br />
<br />
# to update all packages writing newest version refs in package.json:<br />
npx npm-check-updates -u<br />
npm update<br />
== Migrate from V2==<br />
If you have a v2 running and want to migrate it to v3 , you can use the [https://www.npmjs.com/package/@moodlenet/v2-migrate-v3 @moodlenet/v2-migrate-v3]<br />
<br />
The v3 system must have access to Moodlenet-V2 persistencies: <br />
<br />
* the running arangoDB instance <br />
* MN2 filesystem folder as configured in [https://gitlab.com/moodlenet/moodlenet/-/tree/1c8c7eb9b9aa2a3ee912871c670480b3e5fa0f70/packages/ce-platform#set-environment-variables V2 env variable '''STATICASSETS_FS_ROOT_FOLDER''']<br />
<br />
V2 persistencies will be used in read-only<br />
<br />
Edit the '''default.config.json''' adding a '''@moodlenet/v2-migrate-v3''' section beside the others, it should look like that<br />
"@moodlenet/v2-migrate-v3": {<br />
"v2DbConnectionCfg": {<br />
"url": "<nowiki>http://your-mn-v2-arangodb-host:8529</nowiki>"<br />
},<br />
"v2AssetFolder": "/path/to/v2/asset/folder"<br />
}<br />
After Moodlenet v3 is installed (as above but choosing the early 3.0 version '''npm create @moodlenet@3.0''' – caution: @3.0.0 wouldn't work!), issue the following command from the installation folder<br />
npm install @moodlenet/v2-migrate-v3@0.5.1<br />
Then just restart the system, the migration will be done, services will be restarted and you can log in.<br />
<br />
After migration completed this package can be safely uninstalled.<br />
<br />
==MoodleNet architecture==<br />
MoodleNet is a full stack TypeScript/JavaScript system using:<br />
*NodeJs<br />
**NPM Packages [https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/]<br />
**ESM Modules [https://nodejs.org/api/esm.html#introduction]<br />
*Browsers<br />
**ReactJs 18 [https://reactjs.org/]<br />
**HTML5 [https://html.spec.whatwg.org/multipage/]<br />
**CSS3 [https://www.w3.org/Style/CSS/]<br />
==MoodleNet development environment ==<br />
*NodeJs ^16 https://nodejs.org/<br />
*ArangoDB ^3 (we suggest using [https://www.docker.com/ Docker])<br />
* We recommend the open source IDE Visual Studio Code https://code.visualstudio.com/<br />
===Setup development environment ===<br />
'''From the command line interface (CLI):'''<br />
<br />
Ensure ArangoDB is running on localhost. You may run it in a Docker container issuing a command as below:<br />
docker run -e ARANGO_NO_AUTH=1 -p 8529:8529 --name=mn3-dev arangodb:3.10<br />
Clone the repository, you may wish to fork it, but that's not required:<br />
git clone <nowiki>https://gitlab.com/moodlenet/moodlenet.git</nowiki><br />
Change to the project's folder:<br />
cd moodlenet<br />
Install and initialise the project:<br />
npm install<br />
Install a development server:<br />
npm run dev-install-backend my-dev # <- my-dev: an arbitrary dev-installation name<br />
In the example we chose '''my-dev''' as installation name, the tool will then setup a dev installation in '''./.dev-machines/my-dev'''<br />
<br />
You can create as many dev installations as you wish.<br />
<br />
Run development backend:<br />
npm run dev-start-backend my-dev # <- my-dev : the name you chose when installed<br />
The first run of the system may take some time to install.<br />
<br />
The default configuration for dev includes the config '''@moodlenet/react-app.noWebappServer: true''' that prevents the server to expensively build and serve the webapp,<br />
<br />
so you'll get all backend services served on http://localhost:8080, except for the webapp.<br />
<br />
Instead, you'll want to run a webpack+HMR serving the webapp issuing<br />
npm run dev-start-webapp my-dev # <- my-dev: the installation server to point to<br />
Once all started, browse http://localhost:3000, any edits to webapp related code will be Hot-Module-Replaced<br />
=== Mono-Repository management with Lerna.js===<br />
MoodleNet project takes leverages [https://lerna.js.org/ lerna.js] to manage multi-package mono-repository .<br />
<br />
Please refer to [https://lerna.js.org/ Lerna documentation] to understand how it manages mono-repo and project-packages dependency linking in the development environment.<br />
<br />
Questions? Please take a look in the [https://moodle.org/mod/forum/view.php?id=8726 MoodleNet Community] and [https://tracker.moodle.org/projects/MDLNET/summary Tracker] for answers or to ask for help.<br />
*[https://moodledev.io/general/development/tracker Using Tracker]<br />
*[https://www.npmjs.com/package/@moodlenet/ce-platform Code repository]<br />
*[https://docs.moodle.org/moodlenet/Main_Page MoodleNet user documentation]<br />
*[https://moodle.org/mod/forum/view.php?id=8726 MoodleNet news and discussion]<br />
*[https://tracker.moodle.org/secure/RapidBoard.jspa?rapidView=167&view=detail MoodleNet Issue Tracker]<br />
*[https://gitlab.com/moodlenet/moodlenet/-/issues MoodleNet Gitlab Issues]<br />
[[es:MoodleNet]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Overview_of_the_Moodle_question_engine&diff=64038Overview of the Moodle question engine2023-11-22T07:37:54Z<p>Finns: /* Database tables */</p>
<hr />
<div>{{Template:Question_engine_2}}<br />
This page summarises how the new question engine works.<br />
<br />
Previous section: [[Question Engine 2:Overview|Design]]<br />
<br />
{{Work in progress}}<br />
<br />
==What does a question engine have to do?==<br />
<br />
We are in a question engine for online assessment. Clearly, we have questions, but we don't need to worry about them much here, they come from the question bank. We can take them as given.<br />
<br />
We are really interested in what happens when a student attempts some questions (for example, when they attempt a quiz). We can handle this by thinking about the student's attempt at each question separately, and then aggregate those separate question attempts into the set of those that comprise the student's attempt at a particular activity.<br />
<br />
For each question attempt, we need some notion of what state it is currently in (in-progress, completed correctly, ...) whether it has been graded, and if so, what mark was awarded. Also, there may be some state private to the question when it is started. For example the calculated question assigns random values to each variable when the question is attempted, and the choices for a multiple choice question may be shuffled.<br />
<br />
Given the current state of a question, we need to be able to display it in HTML. The question may need to be displayed in various ways. For example, perhaps students are not allowed to see the information about the grades awarded yet, but if a teacher reviews it they should see the grades. Teachers may also need to see other bits of interface, like edit links. There may be one or more questions displayed embedded in a particular HTML page, for example a page of a quiz attempt.<br />
<br />
Finally, the question needs to move from one state to another. There two sorts of way that can happen. First, the student may have interacted with some questions that have been displayed as part of a HTML page, and then submitted that page. That is, the question engine needs to directly process data submitted as part of a HTTP POST request. Second, the student may have performed some other action (for example clicked the Start attempt or Submit all and finish buttons in the quiz), and as a result, some other part of the Moodle code may wish to cause some questions to change state.<br />
<br />
Not only to we need to consider the current state of each question. We also need a record of the whole history of what happened. For example a teacher may wish to review everything the student did. Or, when we regrade an interactive question, we need to play back the entire sequence of what the student did.<br />
<br />
To be flexible, the question engine needs to cope with any question-type plug-in. It also needs to be flexible in the ways questions behave. For example some questions can only be graded manually by a teacher. Automatically graded questions can be configured to behave in different ways, for example in interactively with immediate feedback and multiple tries during a single question attempt, or with deferred feedback, where the questions are only graded when the student does submit all and finish.<br />
<br />
==The state of a question==<br />
<br />
<div class="sideblock right" style="width: 18em;"><div class="content">''Show me your flowcharts and conceal your tables, and I shall continue to be mystified. Show me your tables, and I won't usually need your flowcharts; they'll be obvious.'''' -- Fred Brooks, [http://en.wikipedia.org/wiki/The_Mythical_Man-Month The Mythical Man Month]</div></div><br />
<br />
As noted above, a key issues is representing the state of a question that is being attempted, and, indeed, the complete history of the states it has passed through. This is the responsibility of the '''question_attempt''' class. As we have noted, we are not just interested in the current state of the question, but the complete history of states a question has been through. Therefore, a question_attempt, largely consists of a list of '''question_attempt_step'''s. <br />
<br />
===Attempt steps===<br />
<br />
A '''question_attempt_step''' has the following fields:<br />
; state : The state the question is at this step. This will be a '''question_state''' like question_state::$correct.<br />
; fraction : The score the student got for this question so far. This will start off null, and later change. See the note about scores below.<br />
; timecreated : The timestamp of when the action that created this state happened.<br />
; userid : The user whose action created this state. During the attempt, this will be the id of the user who attempted the question, but suppose a teacher manually grades the finished question later, then it will be the id of the teacher.<br />
<br />
In addition to these fields, each step has an associative array (that is, name => value pairs) of extra data. We noted above that the most common cause of a question moving from one state to another was as the result of a HTTP POST request. Well, a POST request basically comprises a set of name => value pairs. For a typical step, the data array will hold those parts of the post data that belong to this question.<br />
<br />
Not all state changes are caused by a POST request. Some are caused by API calls like $quba->finish_question(...). Internally, all these API calls are handled by converting them to special sets of name => value pairs. This means that every action is represented in the same way, which makes it much easier to implement processing like re-grading. Internally, every change of action is caused by a call to the $questionattempt->process_action($dataarray, ...) method. As an example, $quba->finish_question(...) gets handled by calling $questionattempt->process_action(array('!finish' => 1)).<br />
<br />
===A note about scores===<br />
<br />
The question engine stores scores in two different ways.<br />
<br />
Normally, each question in a, say, quiz attempt, will be worth a certain number of marks. For example, question 1 may be worth 5 marks, question 2 worth 3 marks, and so on.<br />
<br />
However, sometimes these marks have to change. For example, perhaps question 2 is now thought to be unsound, and so we want to change the scoring of the quiz so that it now is worth zero marks. But then later we may re-consider, and want to set it back to being worth 3 marks again.<br />
<br />
In order to make it easy to handle this sort of change, almost all scores are internally stored on a scale of 0 to 1. Then there is a field $questionattempt->maxmark. To get the actual mark for a question you need to compute $fraction * $questionattempt->maxmark.<br />
<br />
In the code, things called '''fraction''' are always on the 0 to 1 scale; things called '''mark''' are always on the scale of fraction * maxmark. Marks are what is displayed to users in the UI.<br />
<br />
===More about question attempts===<br />
<br />
As mentioned before, a '''question_attempt''' is mainly a list of question_attempt_steps. However, it also stores some other important information.<br />
<br />
First, we need to know what this attempt is, so there are some links to other objects. There is a link to the '''question_definition''' of the question being attempted. There is a link to the '''question_behaviour''' that controls how the question behaves. Also, the question_attempt will be part of some student's work for some activity. For example, it may be part of a quiz attempt. The collection of all question_attempts that make up that quiz attempt (or whatever) is represented by a class called '''question_usage_by_activity''', of which more in a moment. We store the id of this $quba, and the index number of this question within the usage.<br />
<br />
Second, there is some metadata, stored in the following fields:<br />
; maxmark : How many marks this question is worth. All scores that are stored as fractions need to be multiplied by this before being displayed.<br />
; minfraction : I said above that fraction scores were stored on a scale of 0 to 1. That was a lie. Some questions can return negative marks. For example, a multiple choice question with 5 choices may return +1 for right, and -0.25 for wrong, so that the average score for guessing is 0. Or, if certainty based marking is used, and the student is confident but wrong, they may be awarded a negative mark. The correct statement is that fraction scores are on a scale of minfraction to 1.<br />
; flagged : Questions can be flagged. This is an on/off boolean that can be toggled by the student. Think of this as a simple form of bookmarking. That is stored here. (The history of changes to the flagged state are not considered important. That is why toggling the flag does not create a new step.)<br />
<br />
Thirdly, and finally, some information is recorded to make it easier to run reports efficiently.<br />
; questionsummary : This is a plain-text summary of the question the student was asked. (This makes most sense if you think of a question with randomisation like calculated questions. This field sumarieses the specific question the student was asked.)<br />
; responsesummary : This is a plain-text summary of the response the student gave.<br />
; rightanswer : This is a plain-text summary of what the right answer is.<br />
<br />
===Question usages===<br />
<br />
The '''question_usage_by_activity''' class, in terms of data storage, is really little more than a list of question attempts.<br />
<br />
The little extra comprises:<br />
; owningplugin : the part of Moodle that this usage belongs to. For example 'mod_quiz' or 'core_question_preview'.<br />
; context : the context that the usage belongs to. For a quiz attempt, this will be the quiz context.<br />
; preferredbehaviour : The behaviour that should be used, where possible, when a question is added to this usage.<br />
<br />
===Question behaviours===<br />
<br />
TODO<br />
<br />
===More on question states===<br />
<br />
[[Image:Question_state_diagram.png|right|400px]]<br />
As above, question_attempt_steps::state field is one of the question_state constants. There are quite a lot of these states (about 16) and the state diagram here may help to understand them.<br />
<br />
However, please be aware that although this diagram only shows particular state transitions, it is really up to the behaviour to decide how the question attempt moves from one state to another. Anything is possible, at least in theory. The diagram tried to show what might be sensible.<br />
<br style="clear:both" /><br />
<br />
Summary of the properties of the various states:<br />
{| class="wikitable"<br />
! State !! is_active !! is_finished !! is_graded !! is_correct !! is_partially_correct !! is_incorrect !! is_gave_up !! is_commented<br />
|-<br />
| notstarted || || || || || || || || <br />
|-<br />
| unprocessed || || || || || || || || <br />
|-<br />
| todo || Y || || || || || || || <br />
|-<br />
| invalid || Y || || || || || || || <br />
|-<br />
| complete || Y || || || || || || || <br />
|-<br />
| needsgrading || || Y || || || || || || <br />
|-<br />
| finished || || Y || || || || || || <br />
|-<br />
| gaveup || || Y || || || || || Y || <br />
|-<br />
| gradedwrong || || Y || Y || || || Y || || <br />
|-<br />
| gradedpartial || || Y || Y || || Y || || || <br />
|-<br />
| gradedright || || Y || Y || Y || || || || <br />
|-<br />
| manfinished || || Y || || || || || || Y <br />
|-<br />
| mangaveup || || Y || || || || || Y || Y <br />
|-<br />
| mangrwrong || || Y || Y || || || Y || || Y <br />
|-<br />
| mangrpartial || || Y || Y || || Y || || || Y <br />
|-<br />
| mangrright || || Y || Y || Y || || || || Y <br />
|}<br />
<br />
==Database tables==<br />
<br />
[[Image:Question engine 2 database.png|right|400px]]<br />
<br />
As explained above, all the state is represented by the classes question_usage_by_activity, which is a list of question_attempts, each of which is a list of question_attempt_steps. This is naturally stored in three linked database tables, except that because each step can contain an arbitrary list of name => value pairs, we get a fourth question_attempt_step_data table. This is shown in the diagram.<br />
<br style="clear:both" /><br />
<br />
===Detailed data about an attempt===<br />
<br />
<syntaxhighlight lang="sql"><br />
SELECT<br />
quiza.userid,<br />
quiza.quiz,<br />
quiza.id AS quizattemptid,<br />
quiza.attempt,<br />
quiza.sumgrades,<br />
qu.preferredbehaviour,<br />
qa.slot,<br />
qa.behaviour,<br />
qa.questionid,<br />
qa.variant,<br />
qa.maxmark,<br />
qa.minfraction,<br />
qa.flagged,<br />
qas.sequencenumber,<br />
qas.state,<br />
qas.fraction,<br />
timestamptz 'epoch' + qas.timecreated * interval '1 second', -- or FROM_UNIXTIME(qas.timecreated) if you are on MySQL.<br />
qas.userid,<br />
qasd.name,<br />
qasd.value,<br />
qa.questionsummary,<br />
qa.rightanswer,<br />
qa.responsesummary<br />
<br />
FROM mdl_quiz_attempts quiza<br />
JOIN mdl_question_usages qu ON qu.id = quiza.uniqueid<br />
JOIN mdl_question_attempts qa ON qa.questionusageid = qu.id<br />
JOIN mdl_question_attempt_steps qas ON qas.questionattemptid = qa.id<br />
LEFT JOIN mdl_question_attempt_step_data qasd ON qasd.attemptstepid = qas.id<br />
<br />
WHERE quiza.id = 675767<br />
<br />
ORDER BY quiza.userid, quiza.attempt, qa.slot, qas.sequencenumber, qasd.name<br />
</syntaxhighlight><br />
<br />
==Key processes==<br />
<br />
These two sequence diagrams summarise what happens during the two key operations, displaying a page of the quiz, and processing the student's responses.<br />
<br />
[[Image:Question_processing.png|800px]]<br />
<br />
==See also==<br />
<br />
In the next section, [[Developing a Question Behaviour|Developing a Question Behaviour]] I describe what a developer will need to do to create a Question behaviour plugin for the new system.<br />
<br />
* Back to [[Question_Engine_2|Question Engine 2]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_engine&diff=63886Question engine2023-05-21T16:19:52Z<p>Finns: /* Question types */</p>
<hr />
<div>{{Template:Question development}}<br />
<br />
Moodle has a powerful question engine with a modular structure to allow question type plug-ins. The question engine is responsible for rendering the questions and for processing student responses. It is used by the [[Quiz developer docs|quiz module]] and it is planned that in future it will be used by the Lesson and other modules.<br />
<br />
Historically the question engine started as a part of the quiz module. Only since Moodle 1.6 is it a separate core component of Moodle that can be used by any other Moodle component or module. During this restructuring the code was moved from mod/quiz/ to question/ and the tables and functions were renamed. Wherever the old table or function name contained 'quiz_' the new one will contain 'question_'<br />
<br />
==Terminology==<br />
<br />
When talking about the question engine there are certain terms that can cause confusion because they can be used with different meanings. In Moodle we have adopted a certain terminology that will be explained below.<br />
<br />
===Questions===<br />
<br />
A '''question''' is the set of definitions (question name, question text, possible answers, grading rules, feedback, etc.) that constitute a reusable assessment item. So it includes much more than what one would in everyday language call a question.<br />
In the terminology of the [http://en.wikipedia.org/wiki/QTI QTI] specification a 'question' is more appropriately called an '''assessment item''' or just 'item' for short. <br />
<br />
There are different types of questions, like for example multiple-choice questions or numerical questions. These are referred to as '''[[Question engine#Question types|question types]]''' in Moodle.<br />
<br />
Since version 1.5 Moodle is able to handle so-called '''[[Adaptive questions]]''', also known as 'adaptive items' in QTI speak. These are questions that interact with the student by going through several states depending on the student responses. For example a complicated mathematical question that is answered incorrectly, but is likely to be incorrect because of a common mistake, could provide the user with a hint towards this mistake, apply a penalty and allow a second attempt at this question. Quizzes can be run in 'adaptive mode', in which case Moodle provides buttons to mark each question individually.<br />
<br />
===Answers===<br />
<br />
In Moodle the term ''''answer'''' is used exclusively for the '''teacher-defined answers''' of a question. It is easy to get confused between these teacher-defined answers and the answers that the students actually give. We have therefore adopted the convention to refer to the student-supplied answers as 'responses' and to reserve the term 'answers' to apply to teacher-defined answers. In question types that rely on teacher-supplied answers these are used in the grading process by comparing them with the student responses. Of course not all question types use teacher-defined answers but use some more intelligent way to process the student responses. <br />
<br />
Perhaps one should also stress that 'answer' is not always used in the sense of 'correct answer'. For example every choice in a multiple-choice question is referred to as an answer. Other systems use the term 'distractor' for wrong answers. <br />
<br />
In Moodle we always use the term ''''responses'''' to refer to the students' responses to a question. This term is always used in plural, although for some questiontypes there is only one possible response.<br />
<br />
There is unfortunately, for historical reasons, one exception to the above rule: The question_states table has a field 'answer' whose purpose it actually is to hold the student's responses.<br />
<br />
===Attempts===<br />
<br />
In Moodle the term ''''attempt'''' is used in the sense of "Attempt at a quiz" (or another activity involving questions). Depending on the quiz settings, a student may be allowed several attempts at a quiz. An attempt is finished when the student clicks on the corresponding button on the attempt page. Students do not have to complete an attempt in one visit. They can navigate away from the quiz page and return later to continue the same attempt.<br />
<br />
Each module that uses the question engine should hold its own data for the attempts in its own tables. When the module calls the question engine functions it is often expected to pass an attempt object.<br />
<br />
Within one and the same quiz attempt a student may make several attempts at answering a particular question, at least if the questiontype allows it and the quiz is set up in adaptive mode. These will always be referred to as ''''question sessions'''' or sometimes 'attempts at a question, never just as 'attempts'.<br />
<br />
===Sessions, States, Events===<br />
<br />
When a new attempt is started, a new '''session''' is started for each question. So in a sense a session is for a question what an attempt is for a whole quiz. A question session lasts no longer than an attempt and for each question there can only by one session within one attempt.<br />
<br />
Moodle allows the student to interact with a question repeatedly within one session and each such interaction leads to a new '''state'''. The first state is created when the session is created. A new state is then created when a student saves, validates or submits an answer or .... The student's responses and, if appropriate, the results of response processing (grading) are stored in the new state that gets created.<br />
<br />
The type of '''event''' that led to the creation of a particular state is saved along with the state. The types of events currently used are:<br />
;open :A new session has just been created and this is the opening state. Usually it doesn't hold student responses yet (except where a quiz attempt is based on a previous attempt because the 'attemptonlast' option is set).<br />
;save:The student has clicked the save button.<br />
;validate:The student has asked for his responses to be validated. This means it is checked that they are valid responses. In the case of mathematical questions which requires the input of a mathematical expression in some linear format the question type may want to display the validated result back to the student in typeset form. Similar things may apply to other subject-specific question types. If a student response is found to be invalid the student is told so but no penalty is applied. The invalid response is stored with the state.<br />
;grade:The student has pressed the submit button. The grade is calculated and stored with the attempt.<br />
;duplicategrade:The student has pressed the submit button but the response to this question has not actually changed. This happens a lot in quizzes with several questions on one page where the student may have changed the responses for one question only. I believe that states created by this type of event are not stored in the database.<br />
;close:The last state in a session which is now closed. Currently a session closes only when the attempt closes, either because the student requests it or because the timelimit elapses.<br />
<br />
There are now plans to introduce another event type<br />
;submit:The student has submitted his responses for grading but grading has not yet taken place. This will be used by teacher-marked question types like the essay questions for example.<br />
<br />
==Code documentation==<br />
<br />
The code is documented according to [http://www.phpdoc.org/ PHPdocumentor] conventions. The explanations here in the wiki are meant to complement this.<br />
<br />
Inline comments should be used liberally in the code. The following conventions make it easier to search for comments with special meaning:<br />
* use TODO in comments about things that need to be done<br />
* use ??? in comments that are questions about the code<br />
<br />
Code is organised into packages<br />
* Package questionbank - code that relates to the questionbank system<br />
** Subpackage questiontypes - code that relates to the question types, including the question type base class.<br />
** Subpackage importexport - code that relates to importing and exporting questions.<br />
<br />
Generally, the base classes default_questiontype and qformat_default should contain most of the documentation, since all question types should follow the same interface. There is no value in repeating the same information on all the various subclasses. The subclasses should concentrate on describing any new methods they have that do not come from the base class.<br />
<br />
See the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html#coding.phpcomments PHPdocumentor manual] for more advice on writing good comments.<br />
<br />
Moodle PHPdocs can be seen here: http://phpdocs.moodle.org/.<br />
<br />
==API==<br />
<br />
The library lib/questionlib.php contains all functions that need to be available to any module wanting to use questions (this is new in Moodle 1.6, in Moodle 1.5 this was part of mod/quiz/locallib.php). Loading this library instantiates all questiontype classes by loading the questiontype.php files<br />
<br />
A description of the API still needs to be written. Also lib/questionlib.php should be cleaned up a bit to distinguish between the API functions and the helper functions.<br />
<br />
==Organisation==<br />
The default questiontype class is defined in '''question/type/questiontype.php''' (in Moodle 1.5 this was still in mod/quiz/locallib.php). The individual questiontypes extend this class in their own questiontype.php file. For documentation of the questiontype classes one should often look at the documentation of the default question type because much of the documentation that is in the default class is not repeated in the other questiontype classes.<br />
<br />
While questiontypes are realized as classes, the question engine is not written in a truly object-oriented way. Instead it follows the Moodle model of using objects mostly only as alternatives to arrays to hold database records. So none of the question, attempt, and state objects that play a central role in the module have any methods. Only the questiontype objects have methods. Strangely enough the quiz module instantiates one object of each questiontype class at the start and then reuses their methods for the different questions. If one is used to the Moodle way of programming then this is easy enough to handle.<br />
<br />
==Objects and data structures==<br />
<br />
Key to understanding how the question engine works is to understand how the different kinds of object work together. The most important ones are:<br />
<br />
*Questions<br />
*Attempts<br />
*States<br />
<br />
Questions are data created by the teacher. Attempts and States are data created by the student when interacting with a quiz. <br />
<br />
The Moodle quiz module allows students to make several attempts at a quiz. Data about such an '''attempt''' is stored in an attempt object. The Moodle question engine was optimized to deal with such attempts and therefore every module wanting to use the question engine also has to implement the attempt object and pass it to many of the question engine functions. The attempt object holds for example information about how the quiz was randomized for this attempt and the ordering of the questions and answers.<br />
<br />
Moodle allows students to interact repeatedly with a single question. So for example the student might initially just save an answer, later mark it, then correct it if it was marked incorrect. When the student first views a question within a particular attempt a '''question session''' and the first question state is created. Each time the student interacts with the question a new '''question state''' is created. So states are indexed by user id, attempt id and question id.<br />
<br />
===Database structure===<br />
All this data needs to be kept in Moodle's database. How this is achieved is explained on a separate page about the '''[[Quiz database structure]]''', which also contains a useful diagram.<br />
<br />
As is customary in Moodle, most runtime objects simply represent the data from a particular database record. So for example a $quiz object has fields corresponding to all the fields in the [[Quiz database structure#quiz|quiz table]]. In some cases the objects have some additional fields that are added at runtime. This is particularly the case for $question and $state objects. These additional fields are also described on the page about the '''[[Quiz database structure]]'''. Many functions that are used to process these objects make use of the additional fields and it is therefore necessary to use the correct functions for creating these objects.<br />
<br />
===Runtime objects===<br />
Some objects used by the quiz module are purely runtime object and do not correspond to a database table. The structure of these objects is explained in detail on a separate page about the '''[[Quiz runtime objects]]'''.<br />
<br />
The main script of the quiz module is attempt.php which will have to deal with all these objects. Studying the '''[[Quiz attempt|explanation of attempt.php]]''' is therefore a good way to start to study the quiz module code.<br />
<br />
==Response storage==<br />
<br />
The student's responses to a question are stored in <syntaxhighlight lang="php">$state->responses</syntaxhighlight>. Questiontypes are completely free to implement the storage mechanism of their responses (and other state information) the way they want. Still, the standard questiontypes all follow a similar model. The default storage model and the questiontype specific variations are explained below.<br />
<br />
The flexibility for the questiontypes to choose their response storage mechanism freely and to convert from the storage model to the runtime model is provided by a set of three functions, which allow to initialise the runtime <syntaxhighlight lang="php">$state->responses</syntaxhighlight> field, to convert from the runtime to the storage model and vice versa:<br />
<br />
;<syntaxhighlight lang="php">create_session_and_responses()</syntaxhighlight><br />
:Initializes the $state object, in particular the <syntaxhighlight lang="php">$state->responses</syntaxhighlight> field<br />
<br />
;<syntaxhighlight lang="php">restore_session_and_responses()</syntaxhighlight><br />
:Loads the question type specific session data from the database into the <syntaxhighlight lang="php">$state</syntaxhighlight> object, in particular it loads the responses that have been saved for the given <syntaxhighlight lang="php">$state</syntaxhighlight> into the <syntaxhighlight lang="php">$state->responses</syntaxhighlight> field.<br />
<br />
;<syntaxhighlight lang="php">save_session_and_responses()</syntaxhighlight><br />
:Saves the question type specific session data from the $state object to the database. In particular, for most questiontypes, it saves the responses from the <syntaxhighlight lang="php">$state->responses</syntaxhighlight> to the database.<br />
<br />
The generic quiz module code saves the contents form the <syntaxhighlight lang="php"><nowiki>$state->responses['']</nowiki></syntaxhighlight> field to the answer field in the [[Quiz database structure#quiz_states|quiz_states table]] and also automatically restores the contents of this field to <syntaxhighlight lang="php"><nowiki>$state->responses['']</nowiki></syntaxhighlight>. This means that any questiontype, which only expects a single value as its response can skip the implementation of the three methods described above. All questiontypes that have multiple value responses need to implement these methods. <br />
<br />
The default questiontypes handle this problem by serializing/de-serializing the responses to/from the answer field in the quiz_states table. However, it is also possible (and may be better practice) to extend the quiz_states table with a questiontype specific table, i.e. take the id of the quiz_states record as a foreign key in the questiontype specific table. Because the value of <syntaxhighlight lang="php"><nowiki>$state->responses['']</nowiki></syntaxhighlight> is set to the value of the answer field, questiontypes that serialize their response need to overwrite (in <syntaxhighlight lang="php">save_session_and_responses()</syntaxhighlight>) whatever value the generic code set this field to with their serialized value (usually achieved with a simple set_field). <br />
<br />
In the method <syntaxhighlight lang="php">restore_session_and_responses()</syntaxhighlight> the serialized value can be read from <syntaxhighlight lang="php"><nowiki>$state->responses['']</nowiki></syntaxhighlight> because this is where the value from answer field of the quiz_states table has been moved. Care needs to be taken that this array value is then unset or the whole array overwritten, so that the array does not accidentally contain a value with the empty string index.<br />
<br />
==Response processing==<br />
<br />
The runtime model for responses dictates the structure of the $state->responses array. Starting with the names of the form elements this section goes through the relevant processing steps and thus attempts to clarify why the keys of the $state->responses array can differ for different questiontypes; even more, it explains how the array keys are chosen and set.<br />
<br />
Although it may initially seem strange to start with the naming convention of the form fields, the reason for this will become clear later on. The controls (i.e. the form fields) of a question get printed by the method <syntaxhighlight lang="php">print_question_formulation_and_controls()</syntaxhighlight>. The convention only dictates that the name of the control element(s) must begin with the value of <syntaxhighlight lang="php">$question->name_prefix</syntaxhighlight>. The <syntaxhighlight lang="php">$question->name_prefix</syntaxhighlight> is a string starting with "resp" followed by the question id and an underscore, e.g. <syntaxhighlight lang="php">resp56_</syntaxhighlight>. In the default case, when there is only a single control element (this includes the case of a list of equally named radio buttons), no postfix is appended to the name prefix. For questiontypes that allow or require multiple form elements, an arbitrary string can be appended to the name prefix to form the name of these form elements. The postfix must not include any relational data (i.e. ids of records in the quiz_answers table), because this can lead to problems with regrading of versioned questions.<br />
<br />
After the printing of the question the server only sees it again when it is submitted. So the submitted data will contain several values indexed by strings starting with <syntaxhighlight lang="php">respXX_</syntaxhighlight>. Upon submission, the function <syntaxhighlight lang="php">quiz_process_responses()</syntaxhighlight> is called, which assigns the submitted responses to the state of the question with id XX, using the postfix (i.e. everything after the underscore) as array keys. In the default case with only one control element the name only consists of the name prefix. This explains why the default index of the <syntaxhighlight lang="php">$state->responses</syntaxhighlight> array is the empty string. The value of each array element is obviously the value that was submitted by the form, basically a raw response.<br />
<br />
The function <syntaxhighlight lang="php">quiz_process_responses()</syntaxhighlight> in turn calls the questiontype specific method <syntaxhighlight lang="php">grade_responses()</syntaxhighlight> to assign a grade to the submitted responses and <syntaxhighlight lang="php">compare_responses()</syntaxhighlight> to determine whether the response was identical to the previous submission and to avoid regrading the same responses repeatedly. These questiontype specific functions need to be aware of the expected keys of the <syntaxhighlight lang="php">$state->responses</syntaxhighlight> array.<br />
<br />
Finally, the methods <syntaxhighlight lang="php">restore_session_and_responses()</syntaxhighlight> and <syntaxhighlight lang="php">save_session_and_responses()</syntaxhighlight> also need to know the questiontype specific layout of the <syntaxhighlight lang="php">$state->responses array</syntaxhighlight> and restore or save the information, e.g. by converting from or to the data representation.<br />
<br />
==Question types==<br />
{{Questiontype developer docs}}<br />
The quiz module is itself modular and allows question type plug-ins. For each question type there should be a page, accessible via the menu at the right, which provides at least the details about<br />
*Database tables<br />
*Response storage<br />
*Question options object<br />
*State options object<br />
[[Question type code flow]]<br />
<br />
It is hoped that Moodlers will contribute a lot of non-core question types in the future. For this, see [https://docs.moodle.org/en/How_to_write_a_question_type_plugin Question type plugin how to].<br />
<br />
==Grades==<br />
<br />
The handling of grades is a bit complicated because there are so many different grades around that get rescaled and combined in various ways. This section should summarize how this is done and why.<br />
<br />
The following grade fields are being used:<br />
*$question->defaultgrade<br />
::This is the default value for the maximum grade for this question. This is set up when the teacher creates the question and it is stored in an int(10) field in the [[Quiz database structure#quiz_questions|quiz_questions]] table. However when the question is actually used in a particular quiz the teacher can overrule this default and this is stored in:<br />
*$question->maxgrade<br />
::This is the maximum grade that the teacher has assigned to this question in the context of the current quiz. This is by default equal to $questions->defaultgrade but the teacher can change this when editing the quiz. In the database it is stored in an int(10) field in the [[Quiz database structure#quiz_question_instances|quiz_question_instances table]].<br />
*$question->penalty<br />
<br />
*$state->raw_grade<br />
*$state->grade<br />
*$state->penalty<br />
*$state->sumpenalty<br />
<br />
*$attempt->sumgrades<br />
<br />
The maximum grades set by the teacher, $question->defaultgrade and $question->maxgrade, are integers. All student-obtained grades are in principle floating point numbers. For historical reasons they are stored in the database as varchar(10) fields. Care has to be taken when writing to the database to make sure all grades are correctly rounded and squeezed into a string of no more than 10 characters, otherwise the writing to database will fail, see bug 4220.<br />
<br />
The final outcome of the calculation of the grade for a user at a particular quiz is stored in the 'grade' field of the [[Quiz database structure#quiz_grades|quiz_grades table]]. This field has type double.<br />
<br />
==Penalty mechanism==<br />
<br />
===What it is for===<br />
<br />
When the quiz is run in adaptive mode the student can interact with a question repeatedly. So in particular the student can try again when he gets a wrong answer. Clearly the final mark for the question must reflect the fact that the student did not get it right originally. Therefore a penalty is subtracted from the final mark.<br />
<br />
===How the penalty is determined===<br />
<br />
First of all penalties are relevant only if a quiz is run in adaptive mode. Only in this case can a student have a second attempt and therefore only in this mode can there be any occasion to subtract a penalty.<br />
<br />
Even in adaptive mode the penalty mechanism is only used when it is selected in the quiz options. If "Apply penalties" is set to "No" then the final mark for the question is the mark for the last graded response.<br />
<br />
Each question has a 'penalty' field (which should really be called 'penaltyfactor') which is a number between 0 and 1. The penalty for a wrong response is calculated as the product ($quiz->penalty * $quiz->grade), i.e., as the product of the penaltyfactor with the maximum achievable grade for the question. This product is stored in $state->penalty. So $quiz->penalty is the fraction of the maximum grade that is subtracted as a penalty for each wrong response.<br />
<br />
The $quiz->penalty field has a default value of 0.1, both in the database and in mod/quiz/defaults.php. This default can of course be overwritten by the admin on the quiz configuration page. This admin-selected default is (as usual for admin defaults) stored in $CFG->quiz_penalty. The teacher can choose a different penalty factor for each individual question when adding or editing a question. (In Moodle 1.8 the default value of 0.1 is actually hardcoded at line 87 of moodle/question/type/edit_question_form.php)<br />
<br />
Now if a student makes repeated wrong attempts (or partially correct attempts) the penalties for all these attempts are added up in $state->sumpenalties. The mark for the question is then calculated as the mark for the last graded response minus the sum of the penalties.<br />
<br />
One curious fact about $state->sumpenalties is that, for efficiency reasons, it is not stored in the quiz_states table but instead in the 'sumpenalty' field of the quiz_newest_states table. That way it only has to be stored once per attempt rather than once per response.<br />
<br />
===Where it is done in the code===<br />
<br />
The function quiz_apply_penalty_and_timelimit() subtracts the penalty in $state->sumpenalty from the raw grade in $state->raw_grade to obtain $state->grade for the response. However it is ensured that the grade of a new attempt at the question never falls below the previously achieved grade. This function also increases $state->sumpenalty by the amount in $state->penalty. The assumption is that $state->penalty has just been set appropriately by the code calling this function, e.g., quiz_process_responses.<br />
<br />
==Files belonging to questions==<br />
<br />
This talks about the situation in relation to the Moodle 2.0 file API.<br />
<br />
===File areas===<br />
<br />
There are various file areas associated with each question.<br />
<br />
For example there is a file are 'questiontext', belonging to the 'question' core component, which stores any images or other embedded files used by the question text. There are also 'generalfeedback' and 'question_answer' file areas.<br />
<br />
There may also be some file areas specific to each question type. For example the 'qtype_multichoice' component has a 'correctfeedback' file area (among others).<br />
<br />
All these file areas belong to the context that is the context of $question->category.<br />
<br />
===Serving files and access checks===<br />
<br />
This is a bit complicated because, although the files belong to the question system or a particular question type, then whether the user should be able to see a particular file (for example an image in the general feedback) is influenced by whichever part of Moodle is using the question (for example the quiz module or question preview).<br />
<br />
The easiest way to explain is probably to show the call-stack for determining whether a particular image is displayed, then you can go and read the code.<br />
<br />
For the request .../pluginfile.php/123/question/questiontext/234/345/image.png for an impage in the questiontext of a question in a quiz attempt.<br />
<br />
(here, 123 is the contextid, 234 if the attemptid (corresponding to question_attempts.id) and 345 is the questionid.)<br />
<br />
# pluginfile.php<br />
# question_pluginfile() ''in lib/questionlib.php''<br />
# quiz_question_pluginfile() ''in mod/quiz/lib.php''<br />
# quiz_attempt->check_file_access() ''in mod/quiz/attemptlib.php''<br />
# question->check_file_access() ''in lib/questionlib.php''<br />
# qtype_''whatever''->check_file_access() ''in question/type/whatever/quetsiontype.php''<br />
<br />
If, instead, the question was appearing in the question preview pop-up window, the call stack would be<br />
<br />
# pluginfile.php<br />
# question_pluginfile() ''in lib/questionlib.php''<br />
# '''question_preview_question_pluginfile()''' ''in question/previewlib.php''<br />
# question->check_file_access() ''in lib/questionlib.php''<br />
# qtype_''whatever''->check_file_access() ''in question/type/whatever/quetsiontype.php''<br />
<br />
(the different bit is highlighted in bold).<br />
<br />
If, instead, the image url was .../pluginfile.php/123/qtype_multichoice/correctfeedback/234/345/image.png, the call stack would be<br />
<br />
# pluginfile.php<br />
# '''qtype_multichoice_pluginfile()''' ''in question/type/multichoice/lib.php''<br />
# question_pluginfile() ''in lib/questionlib.php''<br />
# quiz_question_pluginfile() ''in mod/quiz/lib.php''<br />
# quiz_attempt->check_file_access() ''in mod/quiz/attemptlib.php''<br />
# question->check_file_access() ''in lib/questionlib.php''<br />
# qtype_multichoice->check_file_access() ''in question/type/multichoice/quetsiontype.php''<br />
<br />
Roughly speaking, qtype_whatever->check_file_access() takes the same $question, $state and $options objects as print_question_formulation_and_controls, so, for example, you can do the same permissions check when trying to access a file in the feedback as was done when deciding whether to display the feedback.<br />
<br />
The quiz_question_pluginfile or question_preview_question_pluginfile functions are responsible for getting the right $question, $state, $options based on the $attemptid and $questionid in the URL. They also do some basic access checks.<br />
<br />
All the other functions are really just about dispatching the request to the right place to be handled.<br />
<br />
==Question engine upgrade helper 2.1 ==<br />
<br />
''Site administration > Question engine upgrade helper'' has a menu to assist quiz conversion. It contains links for:<br />
*List quizzes still to upgrade<br />
*List already upgrade quizzes than can be reset<br />
*Extract test case<br />
*Config cron<br />
<br />
<br />
<br />
<br />
[[Category:Question engine]]<br />
[[Category:Quiz]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Quiz&diff=63883Quiz2023-05-18T13:59:11Z<p>Finns: </p>
<hr />
<div>{{Quiz developer docs}}<br />
<br />
The quiz is a complex module, although attempts have been made to re-organise the code to keep things managable.<br />
<br />
This page is only intended to give a high level overview. To really understand the quiz, you will have to look at the code, much of which should be clear and well commented.<br />
<br />
<br />
==What the quiz does and does not do==<br />
<br />
The quiz module uses the [[Question bank]] to manage the questions that teachers create, and the [[Question engine]] to display and process questions when students attempt them. You are particularly advised to read [[Using the question engine from module]].<br />
<br />
The quiz module itself is only responsible for<br />
# letting teachers assemble questions into quizzes.<br />
# controlling which students can attempt the quiz when.<br />
# providing access so that students can review their past attempts and the feedback (if the teacher permits it).<br />
# providing reports on the outcomes for teachers.<br />
<br />
Displaying the results is delegated to [[Quiz reports|quiz report]] sub-plugins. Note that some fairly core functionality is implemented in the reports. For example deleting and regrading attempts is handled by <tt>quiz_overview</tt> report, and bulk manual grading is handled by <tt>quiz_grading</tt>.<br />
<br />
A lot of the details of when and if students can access the quiz are handled by [[Quiz access rules|quiz access rule]] sub-plugins.<br />
<br />
<br />
==Code overview==<br />
<br />
All the code has PHPdoc comments which provides a lot of detailed explanation. That is not repeated here.<br />
<br />
This is a [[Modules|standard Moodle activity module]], so inside <tt>mod/quiz</tt> there are all the things you would expect to see like <tt>db/</tt>, <tt>lib.php</tt>, <tt>locallib.php</tt>, <tt>view.php</tt>, <tt>version.php</tt> and so on.<br />
<br />
The scripts that are directly accessed by the user are listed on [[Quiz user interface overview]], and I will not list them again here. It would probably also help to look at the [[Quiz database structure]] before trying to understand the back-end code.<br />
<br />
The back-end code is organised thus:<br />
; lib.php<br />
: All the functions that are called by the Moodle core. For performance reasons it is important that this does not include any other files.<br />
; locallib.php<br />
: This contains all the other quiz library functions that do not have a more specific home. Including this file also includes all the other quiz libraries that you might need.<br />
; mod_form.php<br />
: The module settings form, as you would expect for any Moodle activity module.<br />
; editlib.php<br />
: This defines the functions that are used when at teacher edits the quiz. Thus, they are mostly called from <tt>edit.php</tt>.<br />
; attemptlib.php<br />
: This defines the <tt>quiz</tt> and <tt>quiz_attempt</tt> classes. These are all about what happens when a student (or other user) is looking at the quiz, so they provide a personalised view of the quiz data from the point of view of that user. Thus these classes are mainly used by the <tt>view.php</tt>, <tt>startattempt.php</tt>, <tt>attempt.php</tt>, <tt>processattempt.php</tt>, <tt>summary.php</tt> and <tt>review.php</tt> scripts.<br />
; accessmanager.php<br />
: This provides the interface point that the rest of the quiz code uses to access the [[Quiz access rules|quiz access rule]] sub-plugins.<br />
; renderer.php<br />
: the quiz uses the [[Themes 2.0 overriding a renderer|Moodle 2.x renderer system]] to generate the HTML for all the student-visible parts of the UI. This means that theme designer have a lot of freedom as to how the quiz is displayed to students. Perhaps one day the editing UI will also be re-factored. As is standard for a Moodle plug-in, this file defines the renderer class.<br />
; settings.php & settingslib.php<br />
: define the admin settings for the quiz.<br />
; accessmanager_form.php, addrandomform.php & override_form.php<br />
: Used by <tt>accessmanager.php</tt>, <tt>addrandom.php</tt> and <tt>overridedit.php</tt> respectively.<br />
; module.js<br />
: JavaScript used by <tt>attempt.php</tt> and to a lesser extent <tt>view.php</tt>, <tt>summary.php</tt> and <tt>review.php</tt>.<br />
; edit.js<br />
:JavaScript used by <tt>edit.php</tt>.<br />
<br />
<br />
==Quiz navigation fake block==<br />
<br />
During the quiz attempt (so, on <tt>attempt.php</tt>, <tt>summary,php</tt> (from Moodle 2.2 onwards) and <tt>review.php</tt>) we display a navigation UI that looks like a block. This uses the <tt>block_manager::add_fake_block</tt> feature.<br />
<br />
The block contents is produce by classes in <tt>attemptlib.php</tt> working with methods in the renderer. The navigation relies on some JavaScript in <tt>module.js</tt> because it is vitally important that every time the user moves from one page of the quiz attempt to another, we save their answers. The javascript turns click on the navigation links into form submissions.<br />
<br />
<br />
==Quiz layout==<br />
<br />
Information about the structure of a quiz is stored in the <tt>quiz.qestions</tt> column and the <tt>quiz_question_instances</tt> table. The layout is a comma-separated list of question ids, with 0s to represent page-breaks.<br />
<br />
There are methods in <tt>locallib.php</tt> and <tt>editlib.php</tt> to manipulate this structure.<br />
<br />
When a quiz attempt is stared, the questions are added to a <tt>question_usage_by_activity</tt> object ($quba) that is managed by the question bank. The $quba indexes things by 'slot' rather than question.id, so the quiz layout gets rewritten and stored in <tt>quiz_attempts.layout</tt>. This is done in <tt>startattempt.php</tt>.<br />
<br />
One of the options is to randomise the order of the question in the quiz. This is done by shuffling <tt>quiz_attempts.layout</tt>.<br />
<br />
<tt>startattempt.php</tt> also handles selecting a real question to go in each place where the teacher has added a 'Random question from category X' to the quiz. <br />
<br />
<br />
==See also==<br />
<br />
* [[Goals of an online assessment system]] - a summary of what the quiz is trying to achieve, and the developments that might be done in the future.<br />
* [[Question bank]]<br />
* [[Question engine]] - also [[Question_Engine_2]], which needs to be merged into it. In particular, see [[Using the question engine from module]].<br />
* [[Quiz Usability portal]] - docs from the project to re-design the editing interface in Moodle 2.1.<br />
* [[Quiz support in the Mobile app]] - Quiz support in the Mobile app is one of the most requested features by users<br />
<br />
[[Category:Quiz]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Web_services:Files&diff=63862Web services:Files2023-04-11T19:14:47Z<p>Finns: </p>
<hr />
<div>These APIs will be used to browse Moodle files by Moodle Web Services.<br />
<br />
===class moodle_file_external()===<br />
<br />
This class implements the interface to moodle files, for browsing, downloading and uploading files. It is defined in files/externals.php.<br />
<br />
We cannot return the whole files tree by web service API, because to make sure the web services is working in every language and platform, we need to define a fixed data structure of return value, but the files tree can change all the time. See more information about web services at: [[External_services_description]].<br />
<br />
The class contains following methods:<br />
<br />
====get_files====<br />
This function is used to browse files.<br />
<br />
It takes 5 parameters, all of them are optional, if you provide no parameters, it will return the top level content of moodle repository.<br />
<br />
* contextid<br />
* component<br />
* filearea<br />
* itemid<br />
* filename<br />
* filepath<br />
<br />
It will return an array, can be described as PHP array:<br />
<pre><br />
$files = array(<br />
'path' => array(array('name'=>'root', 'path=>'/'), array('name'=>'subdir', 'path=>'/sub/')),<br />
'files' => array(<br />
array('filename'=>'readme', 'filepath'=>'/', 'filearea'=>'forum', 'itemid'=>110, 'contextid'=>1, 'isdir'=>true),<br />
array('filename'=>'changes', 'filepath'=>'/', 'filearea'=>'forum', 'itemid'=>112, 'contextid'=>1, 'isdir'=>false),<br />
)<br />
);<br />
</pre><br />
<br />
The service name is "moodle_file_get_files", defined in lib/db/services.php.<br />
<br />
<br />
====upload====<br />
This function is used to upload a file to user private area.<br />
<br />
It takes 7 parameters, all of them are mandatory:<br />
<br />
* contextid<br />
* component<br />
* filearea<br />
* itemid<br />
* filepath<br />
* filename<br />
* filecontent<br />
<br />
It will return a boolean value, true/false.<br />
<br />
The service name is "moodle_file_upload", defined in lib/db/services.php<br />
<br />
Sample code (using Zend Framework):<br />
<syntaxhighlight lang="php"><br />
$url = MOODLE_WSROOT. '?wstoken=xxxxxxxxxxxxxxxxxxxxxx';<br />
$zend = new Zend_XmlRpc_Client($url);<br />
$srv = $zend->getProxy();<br />
$files = $srv->moodle_file_get_files($contextid, $component, $filearea, $itemid, $filepath, $filename);<br />
$file = $srv->moodle_file_upload($contextid, 'user', 'private', 0, '/', 'info.txt', base64_encode('this is file content'));<br />
</syntaxhighlight></div>Finnshttps://docs.moodle.org/dev/index.php?title=Using_the_question_engine_from_module&diff=63839Using the question engine from module2023-03-19T10:14:36Z<p>Finns: /* Outputting the questions */</p>
<hr />
<div>{{Template:Question_engine_2}}<br />
This page explains how to use the new Moodle [[Question Engine 2|question engine]] in an activity module you are developing.<br />
<br />
Previous section: [[Developing_a_Question_Type|Developing a Question Type]]<br />
<br />
The first example of a module that uses the question engine is the quiz module. Looking at how the quiz code works will let you see a real working example of what is explained on this page. Another, much simpler example to look at is <tt>question/preview.php</tt>, and https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is simpler still.<br />
<br />
Note that all the question engine code has extensive PHP documentor comments that should explain the purpose of every class and method. This document is supposed to provide an overview of the key points to get you started. It does not attempt to duplicate all the details in the PHPdocs.<br />
<br />
<br />
==Overview==<br />
<br />
The key class you will be working with is <tt>question_usage_by_activity</tt>. This tracks an attempt at some questions, for example a quiz attempt. The usage should provide all the interface methods you need to do things with the question engine. You should rarely need to dive deeper into the inner workings of the question engine than this.<br />
<br />
A usage is a collection of <tt>question_attempt</tt> objects. A question attempt represents the state of the user's attempt at one question within the usage. When you add a question to the usage, you get back a '''slot''' number. This serves to index that question within the attempt. Using slot numbers like this means that the same question can be added more than once to the same usage. A lot of the usage API calls take this slot number to indicate which question attempt to operate on. Other API methods let you perform batch actions on all the question attempts within the usage.<br />
<br />
==Starting an attempt at some questions==<br />
<br />
The example code in this section all came from <tt>mod/quiz/startattempt.php</tt>.<br />
<br />
===Creating the usage===<br />
<br />
To create a new usage, ask the question engine:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());<br />
$quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);<br />
</syntaxhighlight><br />
<br />
You will see that the constructor takes the plugin name (using the Moodle 2.0 'frankenstyle' naming convention) and the context that owns the usage. Usages should be cleaned up automatically when a context is deleted or a plugin un-installed. You also have to tell the usage which behaviour should be used when creating the attempt at each question.<br />
<br />
===Adding questions===<br />
<br />
Having got a usage, you will probably then want to add some questions to it. The question data you loaded from the database (probably using the <tt>get_question_options</tt> function) come in a form suitable for data handling like import/export, backup/restore, and so on. We need to convert that to an <tt>question_definition</tt> object. That can be done using the <tt>question_bank::make_question</tt> method. Alternatively, you could just use the <tt>question_bank::load_question</tt> method, but that can only load one question at a time.<br />
<br />
Once you have a <tt>question_definition</tt> object, you add it to the usage by calling the <tt>add_question</tt> method passing the question definition, and also the score you want this question marked out of. You get back the slot number that has been assigned to this question. The slot numbers are allocated in order, starting from 1. You can rely on that numbering convention. For example, the quiz module uses the slot numbers to make sure the grade for each question lines up properly in the reports.<br />
<br />
Here is the applicable code from the quiz module (some code to handle random questions and question shuffling omitted)<br />
<syntaxhighlight lang="php"><br />
$slot = 0;<br />
$questions = [];<br />
$maxmark = [];<br />
$page = [];<br />
foreach ($quizobj->get_questions() as $questiondata) {<br />
$slot += 1;<br />
$maxmark[$slot] = $questiondata->maxmark;<br />
$page[$slot] = $questiondata->page;<br />
$questions[$slot] = question_bank::make_question($questiondata);<br />
}<br />
</syntaxhighlight><br />
<br />
===Starting the question attempts===<br />
<br />
The usage does not do much when the question is added. Before the user can start interacting with the question, you have to start it. You can either do that in bulk:<br />
<syntaxhighlight lang="php"><br />
$quba->start_all_questions();<br />
</syntaxhighlight><br />
or you can start just one particular question using the <tt>start_question($slot)</tt> method.<br />
<br />
===Saving the usage===<br />
<br />
So far, all these method calls have just built up a data structure in memory. If you want to keep it, you have to save it in the database. Fortunately, that is easy:<br />
<syntaxhighlight lang="php"><br />
question_engine::save_questions_usage_by_activity($quba);<br />
</syntaxhighlight><br />
<br />
The usage is stored as a row in the <tt>question_usages</tt> table (plus rows in other tables). To get the id of the usage, call <tt>$quba->get_id()</tt> after you have saved it.<br />
<br />
<br />
==Displaying questions==<br />
<br />
Suppose that you wish to display a page that contains several questions from the usage. The questions to display will be the ones whose slot numbers are in an array called <tt>$slotsonpage</tt>.<br />
<br />
The example code in this section is derived from code used by <tt>mod/quiz/attempt.php</tt>. However, the quiz code is split between <tt>mod/quiz/attempt.php</tt> and the <tt>quiz_attempt</tt> class in <tt>mod/quiz/attemptlib.php</tt>. That separation means that if I used the real quiz code in this tutorial, it would be unnecessarily hard to understand. Instead, I have simplified the examples below. If you are interested, you should be able to match up what you see below with the real quiz code.<br />
<br />
===Loading the usage===<br />
<br />
At the end of the last section, you had just saved the usage to the database. To display the questions as part of a different script, they must be loaded from the database again. Once again you ask the question engine to do this:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
</syntaxhighlight><br />
<br />
The id that you pass to this method is the id you got from <tt>$quba->get_id()</tt> after saving the usage.<br />
<br />
===The question form===<br />
<br />
Within the page, all the questions have to be wrapped in a HTML <tt><nowiki><form></nowiki></tt> tag. This form needs to POST to a scripts that processes the submitted data ([[#Processing_responses|see below]]).<br />
<syntaxhighlight lang="php"><br />
echo '<form id="responseform" method="post" action="' . $processurl .<br />
'" enctype="multipart/form-data" accept-charset="utf-8">', "\n<div>\n";<br />
<br />
$PAGE->requires->js_init_call('M.core_question_engine.init_form',<br />
array('#responseform'), false, 'core_question_engine');<br />
<br />
echo '<input type="hidden" name="slots" value="' . implode(',', $slotsonpage) . "\" />\n";<br />
echo '<input type="hidden" name="scrollpos" value="" />';<br />
</syntaxhighlight><br />
<br />
The <tt>enctype</tt> and <tt>accept-charset</tt> parameters are important. Please copy them. The form must have an id, and you must then write some JavaScript that passes that id to to the <tt>question_init_form</tt> function. That function is defined in <tt>question/qengine.js</tt> if you want to find out what it does and why it is important.<br />
<br />
You should output a hidden form field <tt>slots</tt> that contains a comma-separated list of the slot numbers that appear on this page. That is not absolutely necessary, but it will make processing the form submission much more efficient.<br />
<br />
Another nicety is the <tt>scrollpos</tt> hidden field. Some question behaviours, for example the interactive behaviour, have submit buttons that do something to the question. When the user clicks this button, it is nice if when the page re-displays, it is scrolled to exactly the same place where it was. The question engine has JavaScript which, if it finds a <tt>scrollpos</tt> hidden field, will automatically save the scroll position to it when a button is clicked, and cause the page to scroll to that position when it reloads.<br />
<br />
<br />
===Outputting the questions===<br />
<br />
Finally, you can actually print the questions. Well, there is one more thing to take care of first. To control how the question appears, you must prepare a <tt>question_display_options</tt> object that describes what should be visible. For example:<br />
<syntaxhighlight lang="php"><br />
$options = new question_display_options();<br />
$options->marks = question_display_options::MAX_ONLY;<br />
$options->markdp = 2; // Display marks to 2 decimal places.<br />
$options->feedback = question_display_options::VISIBLE;<br />
$options->generalfeedback = question_display_options::HIDDEN;<br />
// etc.<br />
</syntaxhighlight><br />
<br />
(In the quiz code, the display options actually come from the quiz settings.) Then you really are ready to output the questions<br />
<syntaxhighlight lang="php"><br />
foreach ($slotsonpage as $displaynumber => $slot) {<br />
echo $quba->render_question($slot, $options, $displaynumber);<br />
}<br />
</syntaxhighlight><br />
<br />
Here <tt>$displaynumber</tt> is the 'question number' you want printed next to each question. This is not necessarily the same as the slot number. For example, in the quiz, Description 'questions' are not numbered, although they take up a slot. It does not have to be a single integer and can also be combined with alphabetic glyphs if you have some other scheme for identifying questions in your activity. For example you could pass '4.3.1', '2a)' '2b)', or '7 of 10' if that is what your activity needs. If you don't pass in a number to display, that is, if you pass null, then the question is printed without a Question X heading.<br />
<br />
==Processing responses==<br />
<br />
Once again, the example here are inspired by real code from the quiz module, in this case <tt>mod/quiz/processattempt.php</tt>, but simplified to remove mention of the <tt>quiz_attempt</tt> class.<br />
<br />
<br />
===The simple case===<br />
<br />
Normally, you just need to do something like:<br />
<syntaxhighlight lang="php"><br />
$timenow = time();<br />
$transaction = $DB->start_delegated_transaction();<br />
<br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
$quba->process_all_actions($timenow);<br />
question_engine::save_questions_usage_by_activity($quba);<br />
<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
Behind the scenes there is, of course, a lot going on, including the use of the <tt>slots</tt> parameter to control which questions are processed.<br />
<br />
There may also be additional work you need to do. For example, in the quiz (before the <tt>commit_sql()</tt> line) there is:<br />
<br />
<syntaxhighlight lang="php"><br />
if ($attempt->timefinish) {<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
}<br />
$attempt->timemodified = $timenow;<br />
$DB->update_record('quiz_attempts', $attempt);<br />
</syntaxhighlight><br />
<br />
===More selective processing===<br />
<br />
If you want something other than the default processing, you can use code like <tt>$submitteddata = $quba->extract_responses($slot); $quba->process_action($slot, $submitteddata);</tt> or something similar.<br />
<br />
===Handling scrollpos===<br />
<br />
You will remember that when we printed the questions, we created a <tt>scrollpos</tt> hidden field. Presumably, after you have processed the submission, you will redirect the user back to a page to display the questions again. In that case, you need to get the <tt>scrollpos</tt> parameter, and add it on to the URL you redirect to:<br />
<br />
<syntaxhighlight lang="php"><br />
// With the other required/optional_param calls at the start of processattempt.php.<br />
$scrollpos = optional_param('scrollpos', '', PARAM_RAW);<br />
<br />
// ... a bit later in the file<br />
$nexturl = new moodle_url(/* something */);<br />
if ($scrollpos !== '') {<br />
$nexturl->param('scrollpos', (int) $scrollpos);<br />
}<br />
<br />
// ... after all the processing is done.<br />
redirect($nexturl);<br />
</syntaxhighlight><br />
<br />
==Reports==<br />
<br />
Places like the quiz reports, we need to get data about a lot of usages at the same time. There are methods on the <tt>question_engine_data_mapper</tt> to do this. You should never access the data in the question engine tables directly.<br />
<br />
For example from the quiz grades report. (Again the example code has been simplified.)<br />
<syntaxhighlight lang="php"><br />
// $qubaids is an array of integer ids.<br />
$qubaidscondition = new qubaid_list($qubaids);<br />
<br />
$dm = new question_engine_data_mapper();<br />
$latesstepdata = $dm->load_questions_usages_latest_steps(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
<tt>qubaid_list</tt> is a subclass of the <tt>qubaid_condition</tt> class. This is an efficient way to represent a set of usage ids in a way that can be used in database queries. The other main subclass is <tt>qubaid_join</tt>. That could be used like this:<br />
<syntaxhighlight lang="php"><br />
$qubaidscondition = new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid))<br />
</syntaxhighlight><br />
<br />
Another example, from the quiz manual grading report is<br />
<syntaxhighlight lang="php"><br />
$dm = new question_engine_data_mapper();<br />
$statesummary = $dm->load_questions_usages_question_state_summary(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
(Perhaps the use of the class <tt>question_engine_data_mapper</tt> should be hidden inside a helper class <tt>question_engine_reporter</tt>?)<br />
<br />
<br />
==Other methods==<br />
<br />
===Methods to help with settings UI===<br />
<br />
When you want to present users with a choice of question behaviour (for example, the quiz How questions behave option) use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_behaviour_options();<br />
</syntaxhighlight><br />
<br />
Question marks are stored in the database to a fixed number of decimal places. To get a list of possible decimal place display options, use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_dp_options();<br />
</syntaxhighlight><br />
<br />
===Clean-up methods===<br />
<br />
To delete usages you no longer need:<br />
<syntaxhighlight lang="php"><br />
// A single usage ...<br />
question_engine::delete_questions_usage_by_activity($qubaid);<br />
<br />
// ... or many.<br />
question_engine::delete_questions_usage_by_activities(<br />
new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid)));<br />
</syntaxhighlight><br />
<br />
===Changing the score of a question in all attempts===<br />
<br />
Suppose you change the number of marks awarded to question 2 in the quiz, you need to change that information in every attempt at that quiz, you can do that with a call like<br />
<syntaxhighlight lang="php"><br />
question_engine::set_max_mark_in_attempts($qubaids, $slot, $newmaxmark);<br />
</syntaxhighlight><br />
<br />
===Re-grading a question===<br />
<br />
You only need to re-grade a question when the question definition is edited, for example to change the scoring rules. If you are just changing the maximum possible score for a question, see the previous sub-section.<br />
<br />
This code example is adapted from <tt>mod/quiz/report/overview/report.php</tt>. It re-grades selected slots within a quiz attempt.<br />
<syntaxhighlight lang="php"><br />
$transaction = $DB->start_delegated_transaction();<br />
$quba = question_engine::load_questions_usage_by_activity($attempt->uniqueid);<br />
<br />
foreach ($slots as $slot) {<br />
$oldfraction[$slot] = $quba->get_question_fraction($slot);<br />
$quba->regrade_question($slot);<br />
$newfraction[$slot] = $quba->get_question_fraction($slot);<br />
}<br />
<br />
question_engine::save_questions_usage_by_activity($quba);<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
update_record('quiz_attempts', $attempt);<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
==See also==<br />
<br />
In the next section, [[Question Engine 2:Implementation plan|Implementation plan]] outlines how I will implement this proposal.<br />
<br />
* https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is probably the simplest example code that displays a question and lets a user interact with it.<br />
<br />
* The PHP documenter comments that explain the purposes of every method in the question engine code.<br />
* Back to [[Question_Engine_2|Question Engine 2]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Using_the_question_engine_from_module&diff=63838Using the question engine from module2023-03-19T09:53:53Z<p>Finns: /* Adding questions */</p>
<hr />
<div>{{Template:Question_engine_2}}<br />
This page explains how to use the new Moodle [[Question Engine 2|question engine]] in an activity module you are developing.<br />
<br />
Previous section: [[Developing_a_Question_Type|Developing a Question Type]]<br />
<br />
The first example of a module that uses the question engine is the quiz module. Looking at how the quiz code works will let you see a real working example of what is explained on this page. Another, much simpler example to look at is <tt>question/preview.php</tt>, and https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is simpler still.<br />
<br />
Note that all the question engine code has extensive PHP documentor comments that should explain the purpose of every class and method. This document is supposed to provide an overview of the key points to get you started. It does not attempt to duplicate all the details in the PHPdocs.<br />
<br />
<br />
==Overview==<br />
<br />
The key class you will be working with is <tt>question_usage_by_activity</tt>. This tracks an attempt at some questions, for example a quiz attempt. The usage should provide all the interface methods you need to do things with the question engine. You should rarely need to dive deeper into the inner workings of the question engine than this.<br />
<br />
A usage is a collection of <tt>question_attempt</tt> objects. A question attempt represents the state of the user's attempt at one question within the usage. When you add a question to the usage, you get back a '''slot''' number. This serves to index that question within the attempt. Using slot numbers like this means that the same question can be added more than once to the same usage. A lot of the usage API calls take this slot number to indicate which question attempt to operate on. Other API methods let you perform batch actions on all the question attempts within the usage.<br />
<br />
==Starting an attempt at some questions==<br />
<br />
The example code in this section all came from <tt>mod/quiz/startattempt.php</tt>.<br />
<br />
===Creating the usage===<br />
<br />
To create a new usage, ask the question engine:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());<br />
$quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);<br />
</syntaxhighlight><br />
<br />
You will see that the constructor takes the plugin name (using the Moodle 2.0 'frankenstyle' naming convention) and the context that owns the usage. Usages should be cleaned up automatically when a context is deleted or a plugin un-installed. You also have to tell the usage which behaviour should be used when creating the attempt at each question.<br />
<br />
===Adding questions===<br />
<br />
Having got a usage, you will probably then want to add some questions to it. The question data you loaded from the database (probably using the <tt>get_question_options</tt> function) come in a form suitable for data handling like import/export, backup/restore, and so on. We need to convert that to an <tt>question_definition</tt> object. That can be done using the <tt>question_bank::make_question</tt> method. Alternatively, you could just use the <tt>question_bank::load_question</tt> method, but that can only load one question at a time.<br />
<br />
Once you have a <tt>question_definition</tt> object, you add it to the usage by calling the <tt>add_question</tt> method passing the question definition, and also the score you want this question marked out of. You get back the slot number that has been assigned to this question. The slot numbers are allocated in order, starting from 1. You can rely on that numbering convention. For example, the quiz module uses the slot numbers to make sure the grade for each question lines up properly in the reports.<br />
<br />
Here is the applicable code from the quiz module (some code to handle random questions and question shuffling omitted)<br />
<syntaxhighlight lang="php"><br />
$slot = 0;<br />
$questions = [];<br />
$maxmark = [];<br />
$page = [];<br />
foreach ($quizobj->get_questions() as $questiondata) {<br />
$slot += 1;<br />
$maxmark[$slot] = $questiondata->maxmark;<br />
$page[$slot] = $questiondata->page;<br />
$questions[$slot] = question_bank::make_question($questiondata);<br />
}<br />
</syntaxhighlight><br />
<br />
===Starting the question attempts===<br />
<br />
The usage does not do much when the question is added. Before the user can start interacting with the question, you have to start it. You can either do that in bulk:<br />
<syntaxhighlight lang="php"><br />
$quba->start_all_questions();<br />
</syntaxhighlight><br />
or you can start just one particular question using the <tt>start_question($slot)</tt> method.<br />
<br />
===Saving the usage===<br />
<br />
So far, all these method calls have just built up a data structure in memory. If you want to keep it, you have to save it in the database. Fortunately, that is easy:<br />
<syntaxhighlight lang="php"><br />
question_engine::save_questions_usage_by_activity($quba);<br />
</syntaxhighlight><br />
<br />
The usage is stored as a row in the <tt>question_usages</tt> table (plus rows in other tables). To get the id of the usage, call <tt>$quba->get_id()</tt> after you have saved it.<br />
<br />
<br />
==Displaying questions==<br />
<br />
Suppose that you wish to display a page that contains several questions from the usage. The questions to display will be the ones whose slot numbers are in an array called <tt>$slotsonpage</tt>.<br />
<br />
The example code in this section is derived from code used by <tt>mod/quiz/attempt.php</tt>. However, the quiz code is split between <tt>mod/quiz/attempt.php</tt> and the <tt>quiz_attempt</tt> class in <tt>mod/quiz/attemptlib.php</tt>. That separation means that if I used the real quiz code in this tutorial, it would be unnecessarily hard to understand. Instead, I have simplified the examples below. If you are interested, you should be able to match up what you see below with the real quiz code.<br />
<br />
===Loading the usage===<br />
<br />
At the end of the last section, you had just saved the usage to the database. To display the questions as part of a different script, they must be loaded from the database again. Once again you ask the question engine to do this:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
</syntaxhighlight><br />
<br />
The id that you pass to this method is the id you got from <tt>$quba->get_id()</tt> after saving the usage.<br />
<br />
===The question form===<br />
<br />
Within the page, all the questions have to be wrapped in a HTML <tt><nowiki><form></nowiki></tt> tag. This form needs to POST to a scripts that processes the submitted data ([[#Processing_responses|see below]]).<br />
<syntaxhighlight lang="php"><br />
echo '<form id="responseform" method="post" action="' . $processurl .<br />
'" enctype="multipart/form-data" accept-charset="utf-8">', "\n<div>\n";<br />
<br />
$PAGE->requires->js_init_call('M.core_question_engine.init_form',<br />
array('#responseform'), false, 'core_question_engine');<br />
<br />
echo '<input type="hidden" name="slots" value="' . implode(',', $slotsonpage) . "\" />\n";<br />
echo '<input type="hidden" name="scrollpos" value="" />';<br />
</syntaxhighlight><br />
<br />
The <tt>enctype</tt> and <tt>accept-charset</tt> parameters are important. Please copy them. The form must have an id, and you must then write some JavaScript that passes that id to to the <tt>question_init_form</tt> function. That function is defined in <tt>question/qengine.js</tt> if you want to find out what it does and why it is important.<br />
<br />
You should output a hidden form field <tt>slots</tt> that contains a comma-separated list of the slot numbers that appear on this page. That is not absolutely necessary, but it will make processing the form submission much more efficient.<br />
<br />
Another nicety is the <tt>scrollpos</tt> hidden field. Some question behaviours, for example the interactive behaviour, have submit buttons that do something to the question. When the user clicks this button, it is nice if when the page re-displays, it is scrolled to exactly the same place where it was. The question engine has JavaScript which, if it finds a <tt>scrollpos</tt> hidden field, will automatically save the scroll position to it when a button is clicked, and cause the page to scroll to that position when it reloads.<br />
<br />
<br />
===Outputting the questions===<br />
<br />
Finally, you can actually print the questions. Well, there is one more thing to take care of first. To control how the question appears, you must prepare a <tt>question_display_options</tt> object that describes what should be visible. For example:<br />
<syntaxhighlight lang="php"><br />
$options = new question_display_options();<br />
$options->marks = question_display_options::MAX_ONLY;<br />
$options->markdp = 2; // Display marks to 2 decimal places.<br />
$options->feedback = question_display_options::VISIBLE;<br />
$options->generalfeedback = question_display_options::HIDDEN;<br />
// etc.<br />
</syntaxhighlight><br />
<br />
(In the quiz code, the display options actually come from the quiz settings.) Then you really are ready to output the questions<br />
<syntaxhighlight lang="php"><br />
foreach ($slotsonpage as $displaynumber => $slot) {<br />
echo $quba->render_question($slot, $options, $displaynumber);<br />
}<br />
</syntaxhighlight><br />
<br />
Here <tt>$displaynumber</tt> is the 'question number' you want printed next to each question. This is not necessarily the same as the slot number. For example, in the quiz, Description 'questions' are not numbered, although they take up a slot. It does not have to be a single integer (once MDL-62358 is fixed) if you have some other scheme for identifiying quesitions in your activity. For example you could pass '4.3.1' or '7 of 10' if that is what your activity needs. If you don't pass in a number to display, that is, if you pass null, then the question is printed without a Question X heading.<br />
<br />
==Processing responses==<br />
<br />
Once again, the example here are inspired by real code from the quiz module, in this case <tt>mod/quiz/processattempt.php</tt>, but simplified to remove mention of the <tt>quiz_attempt</tt> class.<br />
<br />
<br />
===The simple case===<br />
<br />
Normally, you just need to do something like:<br />
<syntaxhighlight lang="php"><br />
$timenow = time();<br />
$transaction = $DB->start_delegated_transaction();<br />
<br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
$quba->process_all_actions($timenow);<br />
question_engine::save_questions_usage_by_activity($quba);<br />
<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
Behind the scenes there is, of course, a lot going on, including the use of the <tt>slots</tt> parameter to control which questions are processed.<br />
<br />
There may also be additional work you need to do. For example, in the quiz (before the <tt>commit_sql()</tt> line) there is:<br />
<br />
<syntaxhighlight lang="php"><br />
if ($attempt->timefinish) {<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
}<br />
$attempt->timemodified = $timenow;<br />
$DB->update_record('quiz_attempts', $attempt);<br />
</syntaxhighlight><br />
<br />
===More selective processing===<br />
<br />
If you want something other than the default processing, you can use code like <tt>$submitteddata = $quba->extract_responses($slot); $quba->process_action($slot, $submitteddata);</tt> or something similar.<br />
<br />
===Handling scrollpos===<br />
<br />
You will remember that when we printed the questions, we created a <tt>scrollpos</tt> hidden field. Presumably, after you have processed the submission, you will redirect the user back to a page to display the questions again. In that case, you need to get the <tt>scrollpos</tt> parameter, and add it on to the URL you redirect to:<br />
<br />
<syntaxhighlight lang="php"><br />
// With the other required/optional_param calls at the start of processattempt.php.<br />
$scrollpos = optional_param('scrollpos', '', PARAM_RAW);<br />
<br />
// ... a bit later in the file<br />
$nexturl = new moodle_url(/* something */);<br />
if ($scrollpos !== '') {<br />
$nexturl->param('scrollpos', (int) $scrollpos);<br />
}<br />
<br />
// ... after all the processing is done.<br />
redirect($nexturl);<br />
</syntaxhighlight><br />
<br />
==Reports==<br />
<br />
Places like the quiz reports, we need to get data about a lot of usages at the same time. There are methods on the <tt>question_engine_data_mapper</tt> to do this. You should never access the data in the question engine tables directly.<br />
<br />
For example from the quiz grades report. (Again the example code has been simplified.)<br />
<syntaxhighlight lang="php"><br />
// $qubaids is an array of integer ids.<br />
$qubaidscondition = new qubaid_list($qubaids);<br />
<br />
$dm = new question_engine_data_mapper();<br />
$latesstepdata = $dm->load_questions_usages_latest_steps(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
<tt>qubaid_list</tt> is a subclass of the <tt>qubaid_condition</tt> class. This is an efficient way to represent a set of usage ids in a way that can be used in database queries. The other main subclass is <tt>qubaid_join</tt>. That could be used like this:<br />
<syntaxhighlight lang="php"><br />
$qubaidscondition = new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid))<br />
</syntaxhighlight><br />
<br />
Another example, from the quiz manual grading report is<br />
<syntaxhighlight lang="php"><br />
$dm = new question_engine_data_mapper();<br />
$statesummary = $dm->load_questions_usages_question_state_summary(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
(Perhaps the use of the class <tt>question_engine_data_mapper</tt> should be hidden inside a helper class <tt>question_engine_reporter</tt>?)<br />
<br />
<br />
==Other methods==<br />
<br />
===Methods to help with settings UI===<br />
<br />
When you want to present users with a choice of question behaviour (for example, the quiz How questions behave option) use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_behaviour_options();<br />
</syntaxhighlight><br />
<br />
Question marks are stored in the database to a fixed number of decimal places. To get a list of possible decimal place display options, use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_dp_options();<br />
</syntaxhighlight><br />
<br />
===Clean-up methods===<br />
<br />
To delete usages you no longer need:<br />
<syntaxhighlight lang="php"><br />
// A single usage ...<br />
question_engine::delete_questions_usage_by_activity($qubaid);<br />
<br />
// ... or many.<br />
question_engine::delete_questions_usage_by_activities(<br />
new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid)));<br />
</syntaxhighlight><br />
<br />
===Changing the score of a question in all attempts===<br />
<br />
Suppose you change the number of marks awarded to question 2 in the quiz, you need to change that information in every attempt at that quiz, you can do that with a call like<br />
<syntaxhighlight lang="php"><br />
question_engine::set_max_mark_in_attempts($qubaids, $slot, $newmaxmark);<br />
</syntaxhighlight><br />
<br />
===Re-grading a question===<br />
<br />
You only need to re-grade a question when the question definition is edited, for example to change the scoring rules. If you are just changing the maximum possible score for a question, see the previous sub-section.<br />
<br />
This code example is adapted from <tt>mod/quiz/report/overview/report.php</tt>. It re-grades selected slots within a quiz attempt.<br />
<syntaxhighlight lang="php"><br />
$transaction = $DB->start_delegated_transaction();<br />
$quba = question_engine::load_questions_usage_by_activity($attempt->uniqueid);<br />
<br />
foreach ($slots as $slot) {<br />
$oldfraction[$slot] = $quba->get_question_fraction($slot);<br />
$quba->regrade_question($slot);<br />
$newfraction[$slot] = $quba->get_question_fraction($slot);<br />
}<br />
<br />
question_engine::save_questions_usage_by_activity($quba);<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
update_record('quiz_attempts', $attempt);<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
==See also==<br />
<br />
In the next section, [[Question Engine 2:Implementation plan|Implementation plan]] outlines how I will implement this proposal.<br />
<br />
* https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is probably the simplest example code that displays a question and lets a user interact with it.<br />
<br />
* The PHP documenter comments that explain the purposes of every method in the question engine code.<br />
* Back to [[Question_Engine_2|Question Engine 2]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Using_the_question_engine_from_module&diff=63837Using the question engine from module2023-03-19T09:51:37Z<p>Finns: /* Adding questions */</p>
<hr />
<div>{{Template:Question_engine_2}}<br />
This page explains how to use the new Moodle [[Question Engine 2|question engine]] in an activity module you are developing.<br />
<br />
Previous section: [[Developing_a_Question_Type|Developing a Question Type]]<br />
<br />
The first example of a module that uses the question engine is the quiz module. Looking at how the quiz code works will let you see a real working example of what is explained on this page. Another, much simpler example to look at is <tt>question/preview.php</tt>, and https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is simpler still.<br />
<br />
Note that all the question engine code has extensive PHP documentor comments that should explain the purpose of every class and method. This document is supposed to provide an overview of the key points to get you started. It does not attempt to duplicate all the details in the PHPdocs.<br />
<br />
<br />
==Overview==<br />
<br />
The key class you will be working with is <tt>question_usage_by_activity</tt>. This tracks an attempt at some questions, for example a quiz attempt. The usage should provide all the interface methods you need to do things with the question engine. You should rarely need to dive deeper into the inner workings of the question engine than this.<br />
<br />
A usage is a collection of <tt>question_attempt</tt> objects. A question attempt represents the state of the user's attempt at one question within the usage. When you add a question to the usage, you get back a '''slot''' number. This serves to index that question within the attempt. Using slot numbers like this means that the same question can be added more than once to the same usage. A lot of the usage API calls take this slot number to indicate which question attempt to operate on. Other API methods let you perform batch actions on all the question attempts within the usage.<br />
<br />
==Starting an attempt at some questions==<br />
<br />
The example code in this section all came from <tt>mod/quiz/startattempt.php</tt>.<br />
<br />
===Creating the usage===<br />
<br />
To create a new usage, ask the question engine:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());<br />
$quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);<br />
</syntaxhighlight><br />
<br />
You will see that the constructor takes the plugin name (using the Moodle 2.0 'frankenstyle' naming convention) and the context that owns the usage. Usages should be cleaned up automatically when a context is deleted or a plugin un-installed. You also have to tell the usage which behaviour should be used when creating the attempt at each question.<br />
<br />
===Adding questions===<br />
<br />
Having got a usage, you will probably then want to add some questions to it. The question data you loaded from the database (probably using the <tt>get_question_options</tt> function) come in a form suitable for data handling like import/export, backup/restore, and so on. We need to convert that to an <tt>question_definition</tt> object. That can be done using the <tt>question_bank::make_question</tt> method. Alternatively, you could just use the <tt>question_bank::load_question</tt> method, but that can only load one question at a time.<br />
<br />
Once you have a <tt>question_definition</tt> object, you add it to the usage by calling the <tt>add_question</tt> method passing the question definition, and also the score you want this question marked out of. You get back the slot number that has been assigned to this question. The slot numbers are allocated in order, starting from 1. You can rely on that numbering convention. For example, the quiz module uses the slot numbers to make sure the grade for each question lines up properly in the reports.<br />
<br />
Here is the applicable code from the quiz module (some code to handle random questions and answer shuffling omitted)<br />
<syntaxhighlight lang="php"><br />
$slot = 0;<br />
$questions = [];<br />
$maxmark = [];<br />
$page = [];<br />
foreach ($quizobj->get_questions() as $questiondata) {<br />
$slot += 1;<br />
$maxmark[$slot] = $questiondata->maxmark;<br />
$page[$slot] = $questiondata->page;<br />
$questions[$slot] = question_bank::make_question($questiondata);<br />
}<br />
</syntaxhighlight><br />
<br />
===Starting the question attempts===<br />
<br />
The usage does not do much when the question is added. Before the user can start interacting with the question, you have to start it. You can either do that in bulk:<br />
<syntaxhighlight lang="php"><br />
$quba->start_all_questions();<br />
</syntaxhighlight><br />
or you can start just one particular question using the <tt>start_question($slot)</tt> method.<br />
<br />
===Saving the usage===<br />
<br />
So far, all these method calls have just built up a data structure in memory. If you want to keep it, you have to save it in the database. Fortunately, that is easy:<br />
<syntaxhighlight lang="php"><br />
question_engine::save_questions_usage_by_activity($quba);<br />
</syntaxhighlight><br />
<br />
The usage is stored as a row in the <tt>question_usages</tt> table (plus rows in other tables). To get the id of the usage, call <tt>$quba->get_id()</tt> after you have saved it.<br />
<br />
<br />
==Displaying questions==<br />
<br />
Suppose that you wish to display a page that contains several questions from the usage. The questions to display will be the ones whose slot numbers are in an array called <tt>$slotsonpage</tt>.<br />
<br />
The example code in this section is derived from code used by <tt>mod/quiz/attempt.php</tt>. However, the quiz code is split between <tt>mod/quiz/attempt.php</tt> and the <tt>quiz_attempt</tt> class in <tt>mod/quiz/attemptlib.php</tt>. That separation means that if I used the real quiz code in this tutorial, it would be unnecessarily hard to understand. Instead, I have simplified the examples below. If you are interested, you should be able to match up what you see below with the real quiz code.<br />
<br />
===Loading the usage===<br />
<br />
At the end of the last section, you had just saved the usage to the database. To display the questions as part of a different script, they must be loaded from the database again. Once again you ask the question engine to do this:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
</syntaxhighlight><br />
<br />
The id that you pass to this method is the id you got from <tt>$quba->get_id()</tt> after saving the usage.<br />
<br />
===The question form===<br />
<br />
Within the page, all the questions have to be wrapped in a HTML <tt><nowiki><form></nowiki></tt> tag. This form needs to POST to a scripts that processes the submitted data ([[#Processing_responses|see below]]).<br />
<syntaxhighlight lang="php"><br />
echo '<form id="responseform" method="post" action="' . $processurl .<br />
'" enctype="multipart/form-data" accept-charset="utf-8">', "\n<div>\n";<br />
<br />
$PAGE->requires->js_init_call('M.core_question_engine.init_form',<br />
array('#responseform'), false, 'core_question_engine');<br />
<br />
echo '<input type="hidden" name="slots" value="' . implode(',', $slotsonpage) . "\" />\n";<br />
echo '<input type="hidden" name="scrollpos" value="" />';<br />
</syntaxhighlight><br />
<br />
The <tt>enctype</tt> and <tt>accept-charset</tt> parameters are important. Please copy them. The form must have an id, and you must then write some JavaScript that passes that id to to the <tt>question_init_form</tt> function. That function is defined in <tt>question/qengine.js</tt> if you want to find out what it does and why it is important.<br />
<br />
You should output a hidden form field <tt>slots</tt> that contains a comma-separated list of the slot numbers that appear on this page. That is not absolutely necessary, but it will make processing the form submission much more efficient.<br />
<br />
Another nicety is the <tt>scrollpos</tt> hidden field. Some question behaviours, for example the interactive behaviour, have submit buttons that do something to the question. When the user clicks this button, it is nice if when the page re-displays, it is scrolled to exactly the same place where it was. The question engine has JavaScript which, if it finds a <tt>scrollpos</tt> hidden field, will automatically save the scroll position to it when a button is clicked, and cause the page to scroll to that position when it reloads.<br />
<br />
<br />
===Outputting the questions===<br />
<br />
Finally, you can actually print the questions. Well, there is one more thing to take care of first. To control how the question appears, you must prepare a <tt>question_display_options</tt> object that describes what should be visible. For example:<br />
<syntaxhighlight lang="php"><br />
$options = new question_display_options();<br />
$options->marks = question_display_options::MAX_ONLY;<br />
$options->markdp = 2; // Display marks to 2 decimal places.<br />
$options->feedback = question_display_options::VISIBLE;<br />
$options->generalfeedback = question_display_options::HIDDEN;<br />
// etc.<br />
</syntaxhighlight><br />
<br />
(In the quiz code, the display options actually come from the quiz settings.) Then you really are ready to output the questions<br />
<syntaxhighlight lang="php"><br />
foreach ($slotsonpage as $displaynumber => $slot) {<br />
echo $quba->render_question($slot, $options, $displaynumber);<br />
}<br />
</syntaxhighlight><br />
<br />
Here <tt>$displaynumber</tt> is the 'question number' you want printed next to each question. This is not necessarily the same as the slot number. For example, in the quiz, Description 'questions' are not numbered, although they take up a slot. It does not have to be a single integer (once MDL-62358 is fixed) if you have some other scheme for identifiying quesitions in your activity. For example you could pass '4.3.1' or '7 of 10' if that is what your activity needs. If you don't pass in a number to display, that is, if you pass null, then the question is printed without a Question X heading.<br />
<br />
==Processing responses==<br />
<br />
Once again, the example here are inspired by real code from the quiz module, in this case <tt>mod/quiz/processattempt.php</tt>, but simplified to remove mention of the <tt>quiz_attempt</tt> class.<br />
<br />
<br />
===The simple case===<br />
<br />
Normally, you just need to do something like:<br />
<syntaxhighlight lang="php"><br />
$timenow = time();<br />
$transaction = $DB->start_delegated_transaction();<br />
<br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
$quba->process_all_actions($timenow);<br />
question_engine::save_questions_usage_by_activity($quba);<br />
<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
Behind the scenes there is, of course, a lot going on, including the use of the <tt>slots</tt> parameter to control which questions are processed.<br />
<br />
There may also be additional work you need to do. For example, in the quiz (before the <tt>commit_sql()</tt> line) there is:<br />
<br />
<syntaxhighlight lang="php"><br />
if ($attempt->timefinish) {<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
}<br />
$attempt->timemodified = $timenow;<br />
$DB->update_record('quiz_attempts', $attempt);<br />
</syntaxhighlight><br />
<br />
===More selective processing===<br />
<br />
If you want something other than the default processing, you can use code like <tt>$submitteddata = $quba->extract_responses($slot); $quba->process_action($slot, $submitteddata);</tt> or something similar.<br />
<br />
===Handling scrollpos===<br />
<br />
You will remember that when we printed the questions, we created a <tt>scrollpos</tt> hidden field. Presumably, after you have processed the submission, you will redirect the user back to a page to display the questions again. In that case, you need to get the <tt>scrollpos</tt> parameter, and add it on to the URL you redirect to:<br />
<br />
<syntaxhighlight lang="php"><br />
// With the other required/optional_param calls at the start of processattempt.php.<br />
$scrollpos = optional_param('scrollpos', '', PARAM_RAW);<br />
<br />
// ... a bit later in the file<br />
$nexturl = new moodle_url(/* something */);<br />
if ($scrollpos !== '') {<br />
$nexturl->param('scrollpos', (int) $scrollpos);<br />
}<br />
<br />
// ... after all the processing is done.<br />
redirect($nexturl);<br />
</syntaxhighlight><br />
<br />
==Reports==<br />
<br />
Places like the quiz reports, we need to get data about a lot of usages at the same time. There are methods on the <tt>question_engine_data_mapper</tt> to do this. You should never access the data in the question engine tables directly.<br />
<br />
For example from the quiz grades report. (Again the example code has been simplified.)<br />
<syntaxhighlight lang="php"><br />
// $qubaids is an array of integer ids.<br />
$qubaidscondition = new qubaid_list($qubaids);<br />
<br />
$dm = new question_engine_data_mapper();<br />
$latesstepdata = $dm->load_questions_usages_latest_steps(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
<tt>qubaid_list</tt> is a subclass of the <tt>qubaid_condition</tt> class. This is an efficient way to represent a set of usage ids in a way that can be used in database queries. The other main subclass is <tt>qubaid_join</tt>. That could be used like this:<br />
<syntaxhighlight lang="php"><br />
$qubaidscondition = new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid))<br />
</syntaxhighlight><br />
<br />
Another example, from the quiz manual grading report is<br />
<syntaxhighlight lang="php"><br />
$dm = new question_engine_data_mapper();<br />
$statesummary = $dm->load_questions_usages_question_state_summary(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
(Perhaps the use of the class <tt>question_engine_data_mapper</tt> should be hidden inside a helper class <tt>question_engine_reporter</tt>?)<br />
<br />
<br />
==Other methods==<br />
<br />
===Methods to help with settings UI===<br />
<br />
When you want to present users with a choice of question behaviour (for example, the quiz How questions behave option) use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_behaviour_options();<br />
</syntaxhighlight><br />
<br />
Question marks are stored in the database to a fixed number of decimal places. To get a list of possible decimal place display options, use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_dp_options();<br />
</syntaxhighlight><br />
<br />
===Clean-up methods===<br />
<br />
To delete usages you no longer need:<br />
<syntaxhighlight lang="php"><br />
// A single usage ...<br />
question_engine::delete_questions_usage_by_activity($qubaid);<br />
<br />
// ... or many.<br />
question_engine::delete_questions_usage_by_activities(<br />
new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid)));<br />
</syntaxhighlight><br />
<br />
===Changing the score of a question in all attempts===<br />
<br />
Suppose you change the number of marks awarded to question 2 in the quiz, you need to change that information in every attempt at that quiz, you can do that with a call like<br />
<syntaxhighlight lang="php"><br />
question_engine::set_max_mark_in_attempts($qubaids, $slot, $newmaxmark);<br />
</syntaxhighlight><br />
<br />
===Re-grading a question===<br />
<br />
You only need to re-grade a question when the question definition is edited, for example to change the scoring rules. If you are just changing the maximum possible score for a question, see the previous sub-section.<br />
<br />
This code example is adapted from <tt>mod/quiz/report/overview/report.php</tt>. It re-grades selected slots within a quiz attempt.<br />
<syntaxhighlight lang="php"><br />
$transaction = $DB->start_delegated_transaction();<br />
$quba = question_engine::load_questions_usage_by_activity($attempt->uniqueid);<br />
<br />
foreach ($slots as $slot) {<br />
$oldfraction[$slot] = $quba->get_question_fraction($slot);<br />
$quba->regrade_question($slot);<br />
$newfraction[$slot] = $quba->get_question_fraction($slot);<br />
}<br />
<br />
question_engine::save_questions_usage_by_activity($quba);<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
update_record('quiz_attempts', $attempt);<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
==See also==<br />
<br />
In the next section, [[Question Engine 2:Implementation plan|Implementation plan]] outlines how I will implement this proposal.<br />
<br />
* https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is probably the simplest example code that displays a question and lets a user interact with it.<br />
<br />
* The PHP documenter comments that explain the purposes of every method in the question engine code.<br />
* Back to [[Question_Engine_2|Question Engine 2]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Using_the_question_engine_from_module&diff=63836Using the question engine from module2023-03-19T09:44:25Z<p>Finns: /* Creating the usage */</p>
<hr />
<div>{{Template:Question_engine_2}}<br />
This page explains how to use the new Moodle [[Question Engine 2|question engine]] in an activity module you are developing.<br />
<br />
Previous section: [[Developing_a_Question_Type|Developing a Question Type]]<br />
<br />
The first example of a module that uses the question engine is the quiz module. Looking at how the quiz code works will let you see a real working example of what is explained on this page. Another, much simpler example to look at is <tt>question/preview.php</tt>, and https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is simpler still.<br />
<br />
Note that all the question engine code has extensive PHP documentor comments that should explain the purpose of every class and method. This document is supposed to provide an overview of the key points to get you started. It does not attempt to duplicate all the details in the PHPdocs.<br />
<br />
<br />
==Overview==<br />
<br />
The key class you will be working with is <tt>question_usage_by_activity</tt>. This tracks an attempt at some questions, for example a quiz attempt. The usage should provide all the interface methods you need to do things with the question engine. You should rarely need to dive deeper into the inner workings of the question engine than this.<br />
<br />
A usage is a collection of <tt>question_attempt</tt> objects. A question attempt represents the state of the user's attempt at one question within the usage. When you add a question to the usage, you get back a '''slot''' number. This serves to index that question within the attempt. Using slot numbers like this means that the same question can be added more than once to the same usage. A lot of the usage API calls take this slot number to indicate which question attempt to operate on. Other API methods let you perform batch actions on all the question attempts within the usage.<br />
<br />
==Starting an attempt at some questions==<br />
<br />
The example code in this section all came from <tt>mod/quiz/startattempt.php</tt>.<br />
<br />
===Creating the usage===<br />
<br />
To create a new usage, ask the question engine:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());<br />
$quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);<br />
</syntaxhighlight><br />
<br />
You will see that the constructor takes the plugin name (using the Moodle 2.0 'frankenstyle' naming convention) and the context that owns the usage. Usages should be cleaned up automatically when a context is deleted or a plugin un-installed. You also have to tell the usage which behaviour should be used when creating the attempt at each question.<br />
<br />
===Adding questions===<br />
<br />
Having got a usage, you will probably then want to add some questions to it. The question data you loaded from the database (probably using the <tt>get_question_options</tt> function) come in a form suitable for data handling like import/export, backup/restore, and so on. We need to convert that to an <tt>question_definition</tt> object. That can be done using the <tt>question_bank::make_question</tt> method. Alternatively, you could just use the <tt>question_bank::load_question</tt> method, but that can only load one question at a time.<br />
<br />
Once you have a <tt>question_definition</tt> object, you add it to the usage by calling the <tt>add_question</tt> method passing the question definition, and also the score you want this question marked out of. You get back the slot number that has been assigned to this question. The slot numbers are allocated in order, starting from 1. You can rely on that numbering convention. For example, the quiz module uses the slot numbers to make sure the grade for each question lines up properly in the reports.<br />
<br />
Here is the applicable code from the quiz module<br />
<syntaxhighlight lang="php"><br />
foreach ($quizobj->get_questions() as $i => $questiondata) {<br />
$question = question_bank::make_question($questiondata);<br />
$idstoslots[$i] = $quba->add_question($question, $questiondata->maxmark);<br />
}<br />
</syntaxhighlight><br />
<br />
===Starting the question attempts===<br />
<br />
The usage does not do much when the question is added. Before the user can start interacting with the question, you have to start it. You can either do that in bulk:<br />
<syntaxhighlight lang="php"><br />
$quba->start_all_questions();<br />
</syntaxhighlight><br />
or you can start just one particular question using the <tt>start_question($slot)</tt> method.<br />
<br />
===Saving the usage===<br />
<br />
So far, all these method calls have just built up a data structure in memory. If you want to keep it, you have to save it in the database. Fortunately, that is easy:<br />
<syntaxhighlight lang="php"><br />
question_engine::save_questions_usage_by_activity($quba);<br />
</syntaxhighlight><br />
<br />
The usage is stored as a row in the <tt>question_usages</tt> table (plus rows in other tables). To get the id of the usage, call <tt>$quba->get_id()</tt> after you have saved it.<br />
<br />
<br />
==Displaying questions==<br />
<br />
Suppose that you wish to display a page that contains several questions from the usage. The questions to display will be the ones whose slot numbers are in an array called <tt>$slotsonpage</tt>.<br />
<br />
The example code in this section is derived from code used by <tt>mod/quiz/attempt.php</tt>. However, the quiz code is split between <tt>mod/quiz/attempt.php</tt> and the <tt>quiz_attempt</tt> class in <tt>mod/quiz/attemptlib.php</tt>. That separation means that if I used the real quiz code in this tutorial, it would be unnecessarily hard to understand. Instead, I have simplified the examples below. If you are interested, you should be able to match up what you see below with the real quiz code.<br />
<br />
===Loading the usage===<br />
<br />
At the end of the last section, you had just saved the usage to the database. To display the questions as part of a different script, they must be loaded from the database again. Once again you ask the question engine to do this:<br />
<syntaxhighlight lang="php"><br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
</syntaxhighlight><br />
<br />
The id that you pass to this method is the id you got from <tt>$quba->get_id()</tt> after saving the usage.<br />
<br />
===The question form===<br />
<br />
Within the page, all the questions have to be wrapped in a HTML <tt><nowiki><form></nowiki></tt> tag. This form needs to POST to a scripts that processes the submitted data ([[#Processing_responses|see below]]).<br />
<syntaxhighlight lang="php"><br />
echo '<form id="responseform" method="post" action="' . $processurl .<br />
'" enctype="multipart/form-data" accept-charset="utf-8">', "\n<div>\n";<br />
<br />
$PAGE->requires->js_init_call('M.core_question_engine.init_form',<br />
array('#responseform'), false, 'core_question_engine');<br />
<br />
echo '<input type="hidden" name="slots" value="' . implode(',', $slotsonpage) . "\" />\n";<br />
echo '<input type="hidden" name="scrollpos" value="" />';<br />
</syntaxhighlight><br />
<br />
The <tt>enctype</tt> and <tt>accept-charset</tt> parameters are important. Please copy them. The form must have an id, and you must then write some JavaScript that passes that id to to the <tt>question_init_form</tt> function. That function is defined in <tt>question/qengine.js</tt> if you want to find out what it does and why it is important.<br />
<br />
You should output a hidden form field <tt>slots</tt> that contains a comma-separated list of the slot numbers that appear on this page. That is not absolutely necessary, but it will make processing the form submission much more efficient.<br />
<br />
Another nicety is the <tt>scrollpos</tt> hidden field. Some question behaviours, for example the interactive behaviour, have submit buttons that do something to the question. When the user clicks this button, it is nice if when the page re-displays, it is scrolled to exactly the same place where it was. The question engine has JavaScript which, if it finds a <tt>scrollpos</tt> hidden field, will automatically save the scroll position to it when a button is clicked, and cause the page to scroll to that position when it reloads.<br />
<br />
<br />
===Outputting the questions===<br />
<br />
Finally, you can actually print the questions. Well, there is one more thing to take care of first. To control how the question appears, you must prepare a <tt>question_display_options</tt> object that describes what should be visible. For example:<br />
<syntaxhighlight lang="php"><br />
$options = new question_display_options();<br />
$options->marks = question_display_options::MAX_ONLY;<br />
$options->markdp = 2; // Display marks to 2 decimal places.<br />
$options->feedback = question_display_options::VISIBLE;<br />
$options->generalfeedback = question_display_options::HIDDEN;<br />
// etc.<br />
</syntaxhighlight><br />
<br />
(In the quiz code, the display options actually come from the quiz settings.) Then you really are ready to output the questions<br />
<syntaxhighlight lang="php"><br />
foreach ($slotsonpage as $displaynumber => $slot) {<br />
echo $quba->render_question($slot, $options, $displaynumber);<br />
}<br />
</syntaxhighlight><br />
<br />
Here <tt>$displaynumber</tt> is the 'question number' you want printed next to each question. This is not necessarily the same as the slot number. For example, in the quiz, Description 'questions' are not numbered, although they take up a slot. It does not have to be a single integer (once MDL-62358 is fixed) if you have some other scheme for identifiying quesitions in your activity. For example you could pass '4.3.1' or '7 of 10' if that is what your activity needs. If you don't pass in a number to display, that is, if you pass null, then the question is printed without a Question X heading.<br />
<br />
==Processing responses==<br />
<br />
Once again, the example here are inspired by real code from the quiz module, in this case <tt>mod/quiz/processattempt.php</tt>, but simplified to remove mention of the <tt>quiz_attempt</tt> class.<br />
<br />
<br />
===The simple case===<br />
<br />
Normally, you just need to do something like:<br />
<syntaxhighlight lang="php"><br />
$timenow = time();<br />
$transaction = $DB->start_delegated_transaction();<br />
<br />
$quba = question_engine::load_questions_usage_by_activity($usageid);<br />
$quba->process_all_actions($timenow);<br />
question_engine::save_questions_usage_by_activity($quba);<br />
<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
Behind the scenes there is, of course, a lot going on, including the use of the <tt>slots</tt> parameter to control which questions are processed.<br />
<br />
There may also be additional work you need to do. For example, in the quiz (before the <tt>commit_sql()</tt> line) there is:<br />
<br />
<syntaxhighlight lang="php"><br />
if ($attempt->timefinish) {<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
}<br />
$attempt->timemodified = $timenow;<br />
$DB->update_record('quiz_attempts', $attempt);<br />
</syntaxhighlight><br />
<br />
===More selective processing===<br />
<br />
If you want something other than the default processing, you can use code like <tt>$submitteddata = $quba->extract_responses($slot); $quba->process_action($slot, $submitteddata);</tt> or something similar.<br />
<br />
===Handling scrollpos===<br />
<br />
You will remember that when we printed the questions, we created a <tt>scrollpos</tt> hidden field. Presumably, after you have processed the submission, you will redirect the user back to a page to display the questions again. In that case, you need to get the <tt>scrollpos</tt> parameter, and add it on to the URL you redirect to:<br />
<br />
<syntaxhighlight lang="php"><br />
// With the other required/optional_param calls at the start of processattempt.php.<br />
$scrollpos = optional_param('scrollpos', '', PARAM_RAW);<br />
<br />
// ... a bit later in the file<br />
$nexturl = new moodle_url(/* something */);<br />
if ($scrollpos !== '') {<br />
$nexturl->param('scrollpos', (int) $scrollpos);<br />
}<br />
<br />
// ... after all the processing is done.<br />
redirect($nexturl);<br />
</syntaxhighlight><br />
<br />
==Reports==<br />
<br />
Places like the quiz reports, we need to get data about a lot of usages at the same time. There are methods on the <tt>question_engine_data_mapper</tt> to do this. You should never access the data in the question engine tables directly.<br />
<br />
For example from the quiz grades report. (Again the example code has been simplified.)<br />
<syntaxhighlight lang="php"><br />
// $qubaids is an array of integer ids.<br />
$qubaidscondition = new qubaid_list($qubaids);<br />
<br />
$dm = new question_engine_data_mapper();<br />
$latesstepdata = $dm->load_questions_usages_latest_steps(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
<tt>qubaid_list</tt> is a subclass of the <tt>qubaid_condition</tt> class. This is an efficient way to represent a set of usage ids in a way that can be used in database queries. The other main subclass is <tt>qubaid_join</tt>. That could be used like this:<br />
<syntaxhighlight lang="php"><br />
$qubaidscondition = new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid))<br />
</syntaxhighlight><br />
<br />
Another example, from the quiz manual grading report is<br />
<syntaxhighlight lang="php"><br />
$dm = new question_engine_data_mapper();<br />
$statesummary = $dm->load_questions_usages_question_state_summary(<br />
$qubaidscondition, $slots);<br />
</syntaxhighlight><br />
<br />
(Perhaps the use of the class <tt>question_engine_data_mapper</tt> should be hidden inside a helper class <tt>question_engine_reporter</tt>?)<br />
<br />
<br />
==Other methods==<br />
<br />
===Methods to help with settings UI===<br />
<br />
When you want to present users with a choice of question behaviour (for example, the quiz How questions behave option) use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_behaviour_options();<br />
</syntaxhighlight><br />
<br />
Question marks are stored in the database to a fixed number of decimal places. To get a list of possible decimal place display options, use<br />
<syntaxhighlight lang="php"><br />
$options = question_engine::get_dp_options();<br />
</syntaxhighlight><br />
<br />
===Clean-up methods===<br />
<br />
To delete usages you no longer need:<br />
<syntaxhighlight lang="php"><br />
// A single usage ...<br />
question_engine::delete_questions_usage_by_activity($qubaid);<br />
<br />
// ... or many.<br />
question_engine::delete_questions_usage_by_activities(<br />
new qubaid_join('{quiz_attempts} quiza', 'quiza.uniqueid',<br />
'quiza.quiz = :quizaquiz', array('quizaquiz' => $quizid)));<br />
</syntaxhighlight><br />
<br />
===Changing the score of a question in all attempts===<br />
<br />
Suppose you change the number of marks awarded to question 2 in the quiz, you need to change that information in every attempt at that quiz, you can do that with a call like<br />
<syntaxhighlight lang="php"><br />
question_engine::set_max_mark_in_attempts($qubaids, $slot, $newmaxmark);<br />
</syntaxhighlight><br />
<br />
===Re-grading a question===<br />
<br />
You only need to re-grade a question when the question definition is edited, for example to change the scoring rules. If you are just changing the maximum possible score for a question, see the previous sub-section.<br />
<br />
This code example is adapted from <tt>mod/quiz/report/overview/report.php</tt>. It re-grades selected slots within a quiz attempt.<br />
<syntaxhighlight lang="php"><br />
$transaction = $DB->start_delegated_transaction();<br />
$quba = question_engine::load_questions_usage_by_activity($attempt->uniqueid);<br />
<br />
foreach ($slots as $slot) {<br />
$oldfraction[$slot] = $quba->get_question_fraction($slot);<br />
$quba->regrade_question($slot);<br />
$newfraction[$slot] = $quba->get_question_fraction($slot);<br />
}<br />
<br />
question_engine::save_questions_usage_by_activity($quba);<br />
$attempt->sumgrades = $quba->get_total_mark();<br />
update_record('quiz_attempts', $attempt);<br />
$transaction->allow_commit();<br />
</syntaxhighlight><br />
<br />
==See also==<br />
<br />
In the next section, [[Question Engine 2:Implementation plan|Implementation plan]] outlines how I will implement this proposal.<br />
<br />
* https://github.com/moodleou/moodle-filter_embedquestion/blob/master/showquestion.php is probably the simplest example code that displays a question and lets a user interact with it.<br />
<br />
* The PHP documenter comments that explain the purposes of every method in the question engine code.<br />
* Back to [[Question_Engine_2|Question Engine 2]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=MoodleNet&diff=63682MoodleNet2022-11-14T05:37:41Z<p>Finns: </p>
<hr />
<div>[[File:Moodlenet-logo.png|400px]]<br />
== What is MoodleNet? ==<br />
[https://moodle.net/ MoodleNet] is a federated and flexible Open Education Technology platform for curating collections of the best known Open Educational (and other) Resources. You'll find more general information in the [https://docs.moodle.org/moodlenet/Main_Page MoodleNet user documentation].<br />
== Current status ==<br />
Take a look at MoodleNet [https://tracker.moodle.org/projects/MDLNET?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased releases in our Tracker] and get involved by creating issues or reporting bugs, discussing and voting for features and connect with the MoodleNet team directly. <br />
== Roadmap ==<br />
* The MoodleNet release is available on the [https://tracker.moodle.org/projects/MDLNET?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased MoodleNet Roadmap].<br />
== Important links ==<br />
* [https://www.npmjs.com/package/@moodlenet/ce-platform Code repository]<br />
* [https://docs.moodle.org/moodlenet/Main_Page MoodleNet user documentation]<br />
* [https://moodle.org/mod/forum/view.php?id=8726 MoodleNet news and discussion]<br />
* [https://tracker.moodle.org/secure/RapidBoard.jspa?rapidView=167&view=detail MoodleNet Issue Tracker]<br />
[[es:MoodleNet]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Quiz_report_statistics&diff=63680Quiz report statistics2022-11-06T23:12:44Z<p>Finns: </p>
<hr />
<div>'''These [http://www.education.com/reference/article/item-analysis/ statistics] are designed for use with [https://en.wikipedia.org/wiki/Summative_assessment summative tests] where students have just one attempt and complete that attempt.'''<br />
== Test statistics ==<br />
''Average grade'': For discriminating, deferred feedback, tests aim for between 50% and 75%. Values outside these limits need thinking about. Interactive tests with multiple tries invariably lead to higher averages.<br />
<br />
''Median grade'': Half the students score less than this figure.<br />
<br />
''Standard deviation'': A measure of the spread of scores about the mean. Aim for values between 12% and 18%. A smaller value suggests that scores are too bunched up.<br />
<br />
''Skewness'': A measure of the asymmetry of the distribution of scores. Zero implies a perfectly symmetrical distribution, positive values a ‘tail’ to the right and negative values a ‘tail’ to the left.<br />
<br />
[[Image:Skewness.jpg]]<br />
<br />
Aim for a value of -1.0. If it is too negative, it may indicate lack of discrimination between students who do better than average. Similarly, a large positive value (greater than 1.0) may indicate a lack of discrimination near the pass fail border.<br />
<br />
''Kurtosis'': Kurtosis is a measure of the flatness of the distribution.<br />
<br />
A normal, bell shaped, distribution has a kurtosis of zero. The greater the kurtosis, the more peaked is the distribution, without much of a tail on either side.<br />
<br />
Aim for a value in the range 0-1. A value greater than 1 may indicate that the test is not discriminating very well between very good or very bad students and those who are average.<br />
<br />
''Coefficient of internal consistency (CIC)'': It is impossible to get internal consistency much above 90%. Anything above 75% is satisfactory. If the value is below 64%, the test as a whole is unsatisfactory and remedial measures should be considered.<br />
<br />
A low value indicates either that some of the questions are not very good at discriminating between students of different ability and hence that the differences between total scores owe a good deal to chance or that some of the questions are testing a different quality from the rest and that these two qualities do not correlate well – i.e. the test as a whole is inhomogeneous.<br />
<br />
''Error ratio (ER)'': This is related to CIC according to the following table: it estimates the percentage of the standard deviation which is due to chance effects rather than to genuine differences of ability between students. Values of ER in excess of 50% cannot be regarded as satisfactory: they imply that less than half the standard deviation is due to differences in ability and the rest to chance effects.<br />
{| class="wikitable"<br />
|-<br />
! CIC<br />
! ER<br />
|-<br />
| 100<br />
| 0<br />
|-<br />
| 99<br />
| 10<br />
|-<br />
| 96<br />
| 20<br />
|-<br />
| 91<br />
| 30<br />
|-<br />
| 84<br />
| 40<br />
|-<br />
| 75<br />
| 50<br />
|-<br />
| 64<br />
| 60<br />
|-<br />
| 51<br />
| 70<br />
|}<br />
''Standard error (SE)'': This is SD x ER/100. It estimates how much of the SD is due to chance effects and is a measure of the uncertainty in any given student’s score. If the same student took an equivalent test, his or her score could be expected to lie within ±SE of the previous score. The smaller the value of SE the better the test, but it is difficult to get it below 5% or 6%. A value of 8% corresponds to half a grade difference on a typical scale – if the SE exceeds this, it is likely that a substantial proportion of the students will be wrongly graded in the sense that the grades awarded do not accurately indicate their true abilities.<br />
== Question statistics ==<br />
''Facility index (F)'': The mean score of students on the item.<br />
{| class="wikitable"<br />
|-<br />
! F<br />
! Interpretation<br />
|-<br />
| 5 or less<br />
| Extremely difficult or something wrong with the question.<br />
|-<br />
| 6-10<br />
| Very difficult.<br />
|-<br />
| 11-20<br />
| Difficult.<br />
|-<br />
| 21-34<br />
| Moderately difficult.<br />
|-<br />
| 35-65<br />
| About right for the average student.<br />
|-<br />
| 66-80<br />
| Fairly easy.<br />
|-<br />
| 81-89<br />
| Easy.<br />
|-<br />
| 90-94<br />
| Very easy.<br />
|-<br />
| 95-100<br />
| Extremely easy.<br />
|}<br />
''Standard deviation (SD)'': A measure of the spread of scores about the mean and hence the extent to which the question might discriminate. If F is very high or very low it is impossible for the spread to be large. Note however that a good SD does not automatically ensure good discrimination. A value of SD less than about a third of the question maximum (i.e. 33%) in the table is not generally satisfactory.<br />
<br />
''Random guess score (RGS)'': This is the mean score students would be expected to get for a random guess at the question. Random guess scores are only available for questions that use some form of multiple choice. All random guess scores are for deferred feedback only and assume the simplest situation e.g. for multiple response questions students will be told how many answers are correct.<br />
<br />
Values above 40% are unsatisfactory – and show that True/False questions must be used sparsely in summative tests.<br />
<br />
''Intended weight'': The question weight expressed as a percentage of the overall test score.<br />
<br />
''Effective weight'': An estimate of the weight the question actually has in contributing to the overall spread of scores. The effective weights should add to 100% - but read on.<br />
<br />
The intended weight and effective weight are intended to be compared. If the effective weight is greater than the intended weight it shows the question has a greater share in the spread of scores than may have been intended. If it is less than the intended weight it shows that it is not having as much effect in spreading out the scores as was intended.<br />
<br />
The calculation of the effective weight relies on taking the square root of the covariance of the question scores with overall performance. If a question’s scores vary in the opposite way to the overall score, this would indicate that this is a very odd question which is testing something different from the rest. And the computer cannot calculate the effective weights of such questions resulting in warning message boxes being displayed.<br />
<br />
''Discrimination index'': This is the correlation between the weighted scores on the question and those on the rest of the test. It indicates how effective the question is at sorting out able students from those who are less able. The results should be interpreted as follows<br />
{| class="wikitable"<br />
|-<br />
! Index<br />
! Interpretation<br />
|-<br />
| 50 and above<br />
| Very good discrimination<br />
|-<br />
| 30 – 50<br />
| Adequate discrimination<br />
|-<br />
| 20 - 29<br />
| Weak discrimination<br />
|-<br />
| 0 - 19<br />
| Very weak discrimination<br />
|-<br />
| -ve<br />
| Question probably invalid<br />
|}<br />
''Discrimination efficiency'': This statistic attempts to estimate how good the discrimination index is relative to the difficulty of the question.<br />
<br />
An item which is very easy or very difficult cannot discriminate between students of different ability, because most of them get the same score on that question. Maximum discrimination requires a facility index in the range 30% - 70% (although such a value is no guarantee of a high discrimination index).<br />
<br />
The discrimination efficiency will very rarely approach 100%, but values in excess of 50% should be achievable. Lower values indicate that the question is not nearly as effective at discriminating between students of different ability as it might be and therefore is not a particularly good question.<br />
<br />
Note: The discrimation index is used in Moodle ≥ 4.0 to make a column 'Need for revision' for questions in the question bank. Questions will probably need revision if the Discrimination index is on average very low.<br />
<br />
[[es:Estadísticas del reporte del examen]]<br />
[[de:Test-Statistik]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63602Question bank improvements for Moodle 4.12022-09-02T05:06:36Z<p>Finns: /* Contributors (financially) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community, Switzerland<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* University of Applied Sciences and Arts Western Switzerland, Switzerland<br />
* University College London, United Kingdom<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63601Question bank improvements for Moodle 4.12022-09-02T05:05:47Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community, Switzerland<br />
* University of Applied Sciences and Arts Northwestern Switzerland<br />
* University of Applied Sciences and Arts Western Switzerland, Switzerland<br />
* University College London, United Kingdom<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63592Question bank improvements for Moodle 4.12022-08-16T08:47:25Z<p>Finns: /* Contributors (financially) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community, Switzerland<br />
* University of Applied Sciences and Arts Western Switzerland, Switzerland<br />
* University College London, United Kingdom<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63591Question bank improvements for Moodle 4.12022-08-16T08:45:59Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community, Switzerland<br />
* University College London, United Kingdom<br />
* University of Applied Sciences and Arts Western Switzerland, Switzerland<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63500Question bank improvements for Moodle 4.12022-06-29T09:47:48Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community, Switzerland<br />
* University of Applied Sciences and Arts Western Switzerland, Switzerland<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63333Question bank improvements for Moodle 4.12022-06-16T18:10:23Z<p>Finns: /* Contributors (financially) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community, Switzerland<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=63332Question bank improvements for Moodle 4.12022-06-16T18:09:58Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* RWTH Aachen University, Germany<br />
* SWITCH eduhub Community<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62131Question bank improvements for Moodle 4.12022-04-28T14:56:27Z<p>Finns: /* Technical overview of the plans */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=434031 this forum thread].<br />
<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=62089Question bank improvements for Moodle 4.02022-04-27T10:22:47Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Done<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
This project has a follow-up project [[Question_bank_improvements_for_Moodle_4.1|Question bank improvements for Moodle 4.1]] which continues with the issues not making it into Moodle 4.0, and new additional requirements.<br />
<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread]. That thread is quite long, with discussion of the plan, but the key posts which describe the plan are:<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1682674 Setting the scope]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683127 Question bank will be made up of plugins]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1687624 List of the plugins that will be created initially]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683186 Question bank will store the version history of each question]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1688163 How the question bank will track the places (quizzes) where questions are used]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1685143 Some initial UI wireframes]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1705076 Question (and following discussion) about how complicated the filtering/searching system needs to be at first]<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=62088Question bank improvements for Moodle 4.02022-04-27T10:20:22Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Done<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread]. That thread is quite long, with discussion of the plan, but the key posts which describe the plan are:<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1682674 Setting the scope]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683127 Question bank will be made up of plugins]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1687624 List of the plugins that will be created initially]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683186 Question bank will store the version history of each question]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1688163 How the question bank will track the places (quizzes) where questions are used]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1685143 Some initial UI wireframes]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1705076 Question (and following discussion) about how complicated the filtering/searching system needs to be at first]<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62077Question bank improvements for Moodle 4.12022-04-26T08:38:43Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the Question bank improvements for Moodle 4.0 project ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 project. The remaining funds were allowed to be used in this project here.<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany<br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62076Question bank improvements for Moodle 4.12022-04-26T07:52:02Z<p>Finns: /* Work-in-progress */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will add more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 and/or the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62075Question bank improvements for Moodle 4.12022-04-26T07:51:34Z<p>Finns: /* Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.0 and/or the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62074Question bank improvements for Moodle 4.12022-04-26T07:50:32Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Question bank improvements for Moodle 4.1 and/or the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62070Question bank improvements for Moodle 4.12022-04-25T13:15:21Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.1#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62069Question bank improvements for Moodle 4.12022-04-25T13:11:59Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0|Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62068Question bank improvements for Moodle 4.12022-04-25T13:11:18Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0#Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* replace the question bank with a mod_qbank activity.<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is not yet outlined in a forum thread.<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62067Question bank improvements for Moodle 4.12022-04-25T12:25:59Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0#Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread]. That thread is quite long, with discussion of the plan, but the key posts which describe the plan are:<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1682674 Setting the scope]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683127 Question bank will be made up of plugins]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1687624 List of the plugins that will be created initially]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683186 Question bank will store the version history of each question]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1688163 How the question bank will track the places (quizzes) where questions are used]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1685143 Some initial UI wireframes]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1705076 Question (and following discussion) about how complicated the filtering/searching system needs to be at first]<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project and Question bank improvements for Moodle 4.0 ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62066Question bank improvements for Moodle 4.12022-04-25T12:15:48Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
<br />
This is a project to continue the issues initially planned with the [[Question_bank_improvements_for_Moodle_4.0#Question bank improvements for Moodle 4.0]] project, and new additional requirements.<br />
The aim is to<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread]. That thread is quite long, with discussion of the plan, but the key posts which describe the plan are:<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1682674 Setting the scope]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683127 Question bank will be made up of plugins]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1687624 List of the plugins that will be created initially]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683186 Question bank will store the version history of each question]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1688163 How the question bank will track the places (quizzes) where questions are used]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1685143 Some initial UI wireframes]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1705076 Question (and following discussion) about how complicated the filtering/searching system needs to be at first]<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.1&diff=62065Question bank improvements for Moodle 4.12022-04-25T12:14:12Z<p>Finns: Created page with "{{Infobox Project |name = Question bank improvements for Moodle 4.1 |state = Development in progress |tracker = MDL-72752 |discussion = |assignee = Project instigated by Us..."</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.1<br />
|state = Development in progress<br />
|tracker = MDL-72752<br />
|discussion = <br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]]. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.1}}<br />
<br />
This is a project to continue the issues initially planned with the [Question bank improvements for Moodle 4.0] project, and new additional requirements.<br />
The aim is to<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
== Technical overview of the plans ==<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread]. That thread is quite long, with discussion of the plan, but the key posts which describe the plan are:<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1682674 Setting the scope]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683127 Question bank will be made up of plugins]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1687624 List of the plugins that will be created initially]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683186 Question bank will store the version history of each question]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1688163 How the question bank will track the places (quizzes) where questions are used]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1685143 Some initial UI wireframes]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1705076 Question (and following discussion) about how complicated the filtering/searching system needs to be at first]<br />
== Project support ==<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
== Work-in-progress ==<br />
In time, we will and more information here, for example links to a prototype site.<br />
== Contributors ==<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Catalyst Australia<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Moodle_4.0_developer_update&diff=61801Moodle 4.0 developer update2022-03-13T22:07:03Z<p>Finns: </p>
<hr />
<div>{{Moodle 4.0}}This page highlights the important changes that are coming in Moodle 4.0 for developers. Including how the UX improvements impact custom themes, relevant API changes, and what you can do as developer to prepare for the 4.0 release.<br />
== Navigation changes ==<br />
The core Navigation API has been left mostly untouched. The callbacks to all navigation callbacks remains unchanged and will be called as part of the regular 'navigation' and 'settingsnav' initialisation. Some new core classes have been created and exist within a new namespace 'core/navigation' and serves as conduit to rearrange, cherry-pick existing navigation nodes from the navigation/settingsnav trees and display within the respective navigation type. As such, it is highly recommended to provide unique keys for custom navigation nodes as this helps in the cherry-picking / rearranging process within the new classes.<br />
=== Primary navigation ===<br />
The primary navigation(the navbar) apart from the existing content will now display links to the Dashboard, My Courses, Site Admin and Course search, by default. You can still add items to the navbar via the 'custom menu' option. This will be displayed within the 'More' menu. We have transitioned the menus to be rendered via templates - refer user_menu.mustache. The lang menu has been moved to reside within the user menu.<br />
==== Customising the primary navigation ====<br />
Not yet implemented but we are looking at allowing the full addition and removal of any of the primary navigation tabs in the boost theme config file.<br />
=== Secondary navigation ===<br />
The main content area shows tabs for secondary navigation with a maximum of 5 items being rendered in this ‘more’ menu. A new UI component has been created to render menus like this. Files:<br />
/lib/templates/moremenu.mustache<br />
==== Changing the order of tabs ====<br />
Apart from the previously mentioned functions, you can also create a custom secondary class as mentioned earlier. This will automatically be picked by getter and used to render the secondary nav within the activity. E.g. mod_assign/local/views/secondary. Note: This is currently only possible on an activity and block level. <br />
=== Tertiary navigation ===<br />
=== New API functions ===<br />
==== Page API ====<br />
* Magic getters to fetch the primary and secondary navs and the primary output.<br />
* The secondarynav magic getter also checks whether a custom secondary class has been defined within the module's local\views directory. Use this if you want to deviate from the standard secondary nav structure/order.<br />
<br />
* set_secondary_nav - Force override the secondary navigation class<br />
<br />
* has_secondary_navigation_setter - Sets the ‘_hassecondarynavigation’ to indicate whether a page should render the secondary navigation<br />
==== Navigationlib ====<br />
* set_show_in_secondary_navigation - whether or not a node should be displayed in the secondary nav. Accepts a single boolean argument<br />
* set_force_into_more_menu- whether or not to force a node into the 'More' menu. Accepts a single boolean argument<br />
==== The activity header class ====<br />
There is a new activity header class that handles the display of information common to activities. 3rd party activities are not required to explicitly output this information as part of rendering individual pages.<br />
<br />
The common information that are currently handled by the class are:<br />
* title<br />
* description<br />
* completion information<br />
<br />
<br />
As part of the update it was required that the initial information to be displayed by the class be toggable at a theme and layout level. Taking this into account the following theme level configurable exists:<br />
* activityheaderconfig => An array that currently only enforces 'notitle' but can be expanded in the future NOTE: Boost has this set as true by default 'options'<br />
The following layout level options that can be defined:<br />
* noactivityheader - to remove the header in this specific layout.<br />
* activityheader - An array that enforces the following options:<br />
** notitle<br />
** nocompletion<br />
** nodescription<br />
The class has a page level getter which you can use to fetch the current version of the class. The base state is initialised within the constructor with the completion information only fetched when data is exported for the template.<br />
<br />
The class has setters for the following variables which can be leveraged to modify the header for a particular page in the format set_{variable_name}:<br />
* hidecompletion<br />
* description<br />
* title<br />
Alternately, bulk operations can also be done by passing the above variables in an array to 'set_attrs' which in turn calls the setters.<blockquote>'''Note: Any updates to the activityheader needs to be performed before the call to $OUTPUT->header'''</blockquote><br />
===== Theme updates: =====<br />
In order for 3rd party themes to use the class they need to export the activity_header and include the following into their base template :<syntaxhighlight lang="html"><br />
{{#headercontent}}<br />
{{> core/activity_header}}<br />
{{#headercontent}}<br />
</syntaxhighlight>** headercontent being the array element that contains the exported activity_header data <br />
===== Accessibility notes: =====<br />
The jump to ‘maincontent’ div is now rendered within the activity header when within an activity context<br />
== Component library ==<br />
Each Moodle installation now ships with a Moodle User Interface (UI) Component library, a documentation system used to describe all the Bootstrap components and the custom Moodle components. The component Library is a helper tool for developers when creating user interfaces, a testing tool for theme developers and a documentation tool for core developers. The ultimate goal of having a component library is to encourage developers to create consistent user interfaces to improve Moodle’s overall user experience.<br />
<br />
The library contains pages with documentation about User Interface components. It contains details on how to use the component, what variations are available and the JavaScript events / options are associated with the component.<br />
<br />
When writing on these pages it is possible to render core mustache templates using some custom syntax like this:<br />
<nowiki>{{< mustache template="core/notification_error" >}}</nowiki><br />
<nowiki>{{< /mustache >}}</nowiki><br />
You can also call core JavaScript or use HTML examples where the html code and the rendered result are visible in the Component Library. For more info visit the [http://componentlibrary.moodle.com/admin/tool/componentlibrary/docspage.php/library/moodle-templates/ Moodle templates] page or the [http://componentlibrary.moodle.com/admin/tool/componentlibrary/docspage.php/library/moodle-javascript/ Moodle JavaScript] page.<br />
<br />
Each page in the library uses the current css from the default theme in your Moodle installation, if you have multiple themes installed and enabled the setting "Allow theme changes on url", the component library will have a theme selector option.<br />
<br />
A hosted version of the Component Library can be found here. http://componentlibrary.moodle.com<br />
=== Enabling the Component Library ===<br />
Component library pages are written in the markdown language. These pages need to be compiled to HTML pages before the Component Library is visible. To compile the pages the server running Moodle needs to have the [[Javascript Modules#Install%20NVM%20and%20Node|JavaScript developer tools installed]] (nodeJs and Grunt)<br />
<br />
If your server meets all requirements you can enable the library running<br />
$ npm install<br />
$ grunt componentlibrary<br />
Further installation instructions can be found in the Component Library itself.<br />
=== Documenting new UI Components ===<br />
There are no set rules for adding new pages in the component library yet. These rules will need to be written and adopted in the integration process for Moodle code.<br />
<br />
As a guideline for making this rules consideration are:<br />
<br />
The component library is not about single use components, for example the Moodle grade book (a huge component with many custom features). Or about very common components like buttons, these are already covered by the Bootstrap section of the component library.<br />
<br />
New features should be build keeping in mind the UI part needs to be customisable and if possible (and making sense) reusable. And example would be the new page drawers that we are introducing for the Navigation project. Or the custom primary navigation menus where overflowing items are pushed into a More section.<br />
== Theme changes ==<br />
=== Edit switch ===<br />
On theme boost the “Turn editing on” and “Customise this page” buttons have been replaced by an edit switch in the top navbar. Theme Classic will keep using the old buttons. Child themes can choose to use the edit switch if the theme config.php is using this variable<br />
$THEME->haseditswitch = true;<br />
The languague menu, which used to be rendered in place of the custom menu has moved to the user dropdown when the user is logged in. If not logged in it will be placed next to the search / notification / messaging icon in the top navbar.<br />
=== Login page ===<br />
The login page has been redesigned and allows the admin to configure a background image for the login page only in the theme settings page. This change is available in both Boost and Classic. The login page still has all the features with an improved layout. <br />
=== The page footer ===<br />
In large screens, the page footer button is only visible when clicking a help button at the bottom right of the screen.<br />
=== User initials as profile picture placeholder ===<br />
If users do not upload a profile picture the user initials are displayed on a rounded gray background as a placeholder picture in the top navbar or any other page using a placeholder image. This change will be available in both Boost and Classic. <br />
<br />
With the introduction of this placeholder image the full username will no longer be displayed in the top navbar.<br />
=== Removal of back to top link ===<br />
The "back to top" link will be removed for theme boost since the new course index reduced the dependence on page scrolling. Also, the new footer is positioned where this component used to be.<br />
=== Styling changes ===<br />
By default rounded edges will be used for UI components, for the page header and main content area the borders will be removed. <br />
=== New layout page ===<br />
Theme boost now uses the drawers.php layout for the course index and blocks.<br />
== Question bank changes ==<br />
There was a big project to deliver [[Question bank improvements for Moodle 4.0]] which added a new plugin type for adding features to the question banks, tracking the version history for each question as it is edited (question table has been split into <code>question</code>, <code>question_versions</code> and <code>question_bank_entries</code>), and tracking where each question is going to be used, with new tables <code>question_references</code> and <code>question_set_references</code>. This work was done in Epic MDL-70329 if you want to track down the details of any of the core changes.<br />
=== Question type plugins ===<br />
Amazingly, we (Safat and colleagues at Catalyst AU) managed to implement this without breaking most question type plugins.<br />
<br />
However, the changes to the question bank, and the other Moodle 4.0 changes, probably broke the Behat tests for your plugin. To help with fixing that, MDL-74130 adds navigation to key question type pages (Preview and Edit for a question, and standard question bank pages like the bank itself, import and export) which should let you fix your test efficiently, and in a way that will work in all Moodle versions since 3.9.<br />
<br />
The 'most' in the first paragraph here is becuase more advance question types may require more effort to fix. (For example qtype_combined which creates multi-part qusetions like the core qtype_multianswer; or qtype_pmatch or qtype_stack, which store additional data - questions tests - alongside the question itseld. How should that work with versionning?) But, if you have not done weird things like that, you are probably safe. If you find anything else that causes problems, please list it here.<br />
<br />
The same thing should apply to question behaviour and question import/export format plugings: no significant changes required (probably just fixing the Behat tests because of the navigation changes).<br />
=== New plugin type: qbank plugins ===<br />
This is not something that will cause problems for people upgrading from 3.x. Rather, it is an exciting possibility you can explore once you have survived process of upgrading to 4.0. There is a whole new plugin type which you can create to add new features to the question bank. For example extra columns, new actions and bulk actions, and so on. See [[Question_bank_plugins]].<br />
=== Activities that use questions ===<br />
The probable bad news is if you have an activity module which uses questions. So far, the only activity which has been fixed is mod_quiz in Moodle core, so we don't yet have a good picture of what fixes will be necessary in other activities. Work is about to start fixing [https://github.com/studentquiz/moodle-mod_studentquiz mod_studentquiz], so watching that should give more clues. As we do that, we will try to update this section of this page. Other help writing the information required here would also be greatly appreciated.<br />
== The course format system ==<br />
Most of the logic for rendering and editing a course has been moved to a new subsystem called courseformat. The subsystem is located in "course/format" folder so it includes all the format plugins inside. The methods and modules which are distributed between the course and the course/format folders are now rearranged or refactored to be aligned with the current Moodle coding style.<br />
=== Mandatory renderer in course formats ===<br />
Now format plugins renderer is not optional anymore. Legacy formats without a renderer will get a deprecation message but it will continue working however, they should create a new renderer as soon as possible. The section-based format can do it by extending the provided core_courseformat\output\section_renderer class which includes all the necessary methods.<br />
=== New format base class ===<br />
The old base_format class (which all plugins extend) is now renamed as core_courseformat\base. The new class provides all the functionally of the previous base_format but it has been refactored to be used as a centralized source of truth for the course rendering. Legacy formats should extend the new class to avoid the deprecation message.<br />
<br />
Now, the plugin format class provides information such as:<br />
* If the page is displaying a single or multiple section<br />
* Give access to other related format objects like the modinfo, the course record, maximum number of sections...<br />
* If the format is compatible with features like course index, reactive components, ajax...<br />
* Other format specifics like the page title, the default section name, default blocks...<br />
<br />
<br />
The format instance is now the main object output components will use to render a course (see next section for more information).<br />
=== New course output classes and mustache files ===<br />
Traditionally, section-based course formats uses print_single_section_page and print_multiple_section_page to render the course content. In Moodle 4.0 most of the course rendering methods are migrated to output components and mustache templates. The old methods will get deprecation messages if they use the old renderer methods.<br />
<br />
This is an example of a format rendering a course:<syntaxhighlight lang="php-brief"><br />
// Get the course format instance.<br />
$format = course_get_format($course);<br />
<br />
// Get the specific format renderer.<br />
$renderer = $format->get_renderer($PAGE);<br />
<br />
if (!empty($displaysection)) {<br />
// Setup the format instance to display a single section.<br />
$format->set_section_number($displaysection);<br />
}<br />
<br />
// Create the ouptut instance and render it.<br />
$outputclass = $format->get_output_classname('content');<br />
$widget = new $outputclass($format);<br />
<br />
echo $renderer->render($widget);<br />
</syntaxhighlight>Format plugins are free to use its own output classes to render a course, or they could override the existing output classes by providing their own implementation. For example, the default output for "content" (as in the previous example) is "core_courseformat\output\local\|content", however, if the plugin has a "format_XXX\output\courseformat\content" class, the $format->class the get_output_class will return the overridden one.<br />
Another important update on course rendering is that now all course structure is rendered using mustache templates instead of the original html_writer methods. Now themes are able to override the course format by providing alternative versions of the mustache files. All core course templates are located in "course/format/templates".<br />
<br />
All the new output classes and a guide on how to migrate the current third-party plugins will be available soon.<br />
=== Course editor javascript modules and frontend components ===<br />
The majority of the javascript logic related to the course editing is replaced by AMD modules. Because this is a major change in the way courses are edited and rendered, by default format plugins will continue using the previous YUI modules for now. However, formats can start using the new libraries overriding the "$format->supports_components()" method.<br />
<br />
Some Moodle 4.0 new features are only available for courses using the new editor library:<br />
* Edit the course via the course index<br />
* Creating sections without reloading the course page<br />
* The new move section/activity modal<br />
* Native browser drag&drop implementation<br />
The new course editor uses a component-based reactive pattern to keep track of the course changes. The pattern highlights are:<br />
* The main AMD module "core_crouseformat\courseeditor" maintains a data structure called state.<br />
* Each UI element is implemented as a Component that observes the course state data and reacts to any data change<br />
* When any reactive component needs to modify the course, it asks the course editor to execute a mutation. Mutations encapsulate all web services calls and alter the course state data.<br />
<br />
<br />
The reactive library documentation, as well as the format plugin migration guide, will be available soon.<br />
=== Other course related 4.0 changes ===<br />
Two new web services have been added:<br />
* core_courseformat_get_state: user by the new javascript course editor to get the current course state data (containing the list of sections, activities, and other course-related data)<br />
* core_courseformat_update_course: to alter the current course content. Each call returns the parts of the course state altered by the action<br />
== Behat changes ==<br />
<br />
=== New steps ===<br />
Moodle 4.0 introduces some new behat steps.<br />
<br />
Sometimes you want to create a bulk number of activities. In that case you can use:<syntaxhighlight lang="gherkin"><br />
:count :entitytype exist with the following data:<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
Given 100 "mod_lti > tool types" exist with the following data:<br />
|name |Test tool [count] |<br />
|description |Example description [count] |<br />
|baseurl |https://www.example.com/tool[count]|<br />
</syntaxhighlight><br />
<br />
<br />
Dynamic (AJAX) tabs is a new feature contributed to Moodle 4.0 by the Workplace team (MDL-71943). You can use the following step to navigate between the tabs.<syntaxhighlight lang="gherkin"><br />
And I click on the "tab title" dynamic tab<br />
</syntaxhighlight><br />
<br />
<br />
To make sure that edit mode is (or is not) available on the current page, the following steps can be used.<syntaxhighlight lang="gherkin"><br />
And edit mode should be available on the current page<br />
And edit mode should not be available on the current page<br />
</syntaxhighlight><br />
<br />
<br />
There are new aliases for the existing steps <code>I turn editing mode on</code> and <code>I turn editing mode off</code>.<syntaxhighlight lang="gherkin"><br />
And I switch editing mode on<br />
And I switch editing mode off<br />
</syntaxhighlight><br />
<br />
<br />
In addition to the existing step to go to a course with editing mode on, we now have the following step to do the same but with editing mode being off.<syntaxhighlight lang="gherkin"><br />
And I am on "course full name" course homepage with editing mode off<br />
</syntaxhighlight><br />
<br />
<br />
The following step is similar to the old <code>following "link string" should download between "min bytes" and "max bytes" bytes</code> step, with more flexibility.<syntaxhighlight lang="gherkin"><br />
And following "element string" "element type" in the "container string" "container type" should download between "min bytes" and "max bytes" bytes<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And following "Download" "link" in the "Starter" "table_row" should download between "0" and "5000" bytes<br />
</syntaxhighlight><br />
<br />
<br />
The following step can be used to hover the mouse over the trigger area.<syntaxhighlight lang="gherkin"><br />
And I hover over the "element string" "element type" in the "container string" "container type"<br />
</syntaxhighlight><br />
<br />
<br />
The following step enables an installed plugin.<syntaxhighlight lang="gherkin"><br />
And I enable "plugin name" "plugin type" plugin<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And I enable "course_summary" "block" plugin<br />
</syntaxhighlight><br />
<br />
<br />
The following is a special variation of 'I click on "<page name>" "link" in the "page" "region"'. It first checks to see if we are on the given page via the breadcrumb. If not we then attempt to follow the link name given.<syntaxhighlight lang="gherkin"><br />
And I follow the breadcrumb "page name"<br />
</syntaxhighlight><br />
<br />
<br />
You can use the following step to ensure a node is active in the navbar.<syntaxhighlight lang="gherkin"><br />
And I should see "Node" is active in navigation<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And I should see "My courses" is active in navigation<br />
</syntaxhighlight><br />
<br />
<br />
The following step can be used to navigate to a given node in the primary navigation.<syntaxhighlight lang="gherkin"><br />
And I select "Node" from primary navigation<br />
</syntaxhighlight><br />
<br />
<br />
The following steps are to check whether an item exists in the user menu or not.<syntaxhighlight lang="gherkin"><br />
And "item text" "selector type" should exist in the user menu<br />
And "item text" "selector type" should not exist in the user menu<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And "Language" "link" should exist in the user menu<br />
</syntaxhighlight><br />
<br />
<br />
The following steps are to check if a submenu of the user menu is shown, and if an item exists or does not exist in a given user submenu.<syntaxhighlight lang="gherkin"><br />
And I should see "submenu name" user submenu<br />
And "item text" "selector type" should exist in the "submenu name" user submenu<br />
And "item text" "selector type" should not exist in the "submenu name" user submenu<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
When I follow "Language" in the user menu<br />
Then I should see "Language selector" user submenu<br />
And "English &lrm;(en)&lrm;" "link" should exist in the "Language selector" user submenu<br />
And "English (pirate) &lrm;(en_ar)&lrm;" "link" should not exist in the "Language selector" user submenu<br />
</syntaxhighlight><br />
<br />
<br />
To add enrolment methods to courses you can use the following new step. The data that you provide in the next lines are used to fill the enrolment method form.<syntaxhighlight lang="gherkin"><br />
And I add "enrolment method" in "course identifier" with:<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
When I add "Self enrolment" enrolment method in "Course 1" with:<br />
| Custom instance name | Test student enrolment |<br />
| Enrolment key | moodle_rules |<br />
| Use group enrolment keys | Yes |<br />
</syntaxhighlight><br />
<br />
<br />
There are 3 new steps specific to the calendar component. These steps can be used to hover over a day in the mini-calendar or the full calendar.<syntaxhighlight lang="gherkin"><br />
And I hover over day "day of month" of this month in the full calendar page<br />
And I hover over day "day of month" of this month in the mini-calendar block<br />
And I hover over today in the mini-calendar block<br />
</syntaxhighlight><br />
<br />
<br />
Some new steps are added to question bank to be able to add comment to questions, verify the existence of a comment, and deleting comments form questions. Please note that the steps for adding comments only write the comment text in the comment field. You still need to click on the "Add comment" button to save the comment.<syntaxhighlight lang="gherkin"><br />
And I add "comment text" comment to question<br />
And I add "comment text" comment to question preview<br />
And I delete "comment text" comment from question<br />
And I delete "comment text" comment from question preview<br />
And I should see "number of comments" on the comments column<br />
And I click "number of comments" on the row on the comments column<br />
<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And I navigate to "Question bank" in current page administration<br />
And I should see "0" on the comments column<br />
And I click "0" on the row on the comments column<br />
And I add "test comment 01" comment to question<br />
And I click on "Add comment" "button" in the ".modal-dialog" "css_element"<br />
And I click on "Close" "button" in the ".modal-dialog" "css_element"<br />
And I should see "1" on the comments column<br />
And I click "1" on the row on the comments column<br />
And I delete "test comment 01" comment from question<br />
</syntaxhighlight><br />
<br />
<br />
Similar to the steps for comments, the following steps are to verify the number of a question's usage and to click on it in order to open the question usage modal.<syntaxhighlight lang="gherkin"><br />
And I should see "usage count" on the usage column<br />
And I click "usage count" on the usage column<br />
</syntaxhighlight><br />
<br />
<br />
The following new steps are related to bulk actions in the question bank UI.<syntaxhighlight lang="gherkin"><br />
And I click on question bulk action "action"<br />
And I should see question bulk action "action"<br />
And I should not see question bulk action "action"<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And I click on "First question" "checkbox"<br />
And I click on "Second question" "checkbox"<br />
And I click on "With selected" "button"<br />
And I should see question bulk action "deleteselected"<br />
And I click on question bulk action "deleteselected"<br />
And I click on "Delete" "button" in the "Confirm" "dialogue"<br />
</syntaxhighlight><br />
<br />
<br />
[https://docs.moodle.org/en/Report_builder Report builder] is a new feature contributed to Moodle 4.0 by the Workplace team. The following new step is added to Moodle 4.0 to select an action from the action menu in the list of custom reports table.<syntaxhighlight lang="gherkin"><br />
And I press "action" action in the "report name" report row<br />
</syntaxhighlight><br />
<br />
<br />
There's another step related to the report builder to set a column's aggregation in the report editor.<syntaxhighlight lang="gherkin"><br />
And I set the "column title" column aggregation to "aggregation method"<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And I set the "First name" column aggregation to "Comma separated values"<br />
</syntaxhighlight><br />
<br />
<br />
The following step needs to be used in scenarios that involve testing BigBlueButton. For this to work, you need to have a [https://github.com/moodlehq/bigbluebutton_mock BigBlueButton Mock API Server] and set <code>TEST_MOD_BIGBLUEBUTTONBN_MOCK_SERVER</code> to point to that in config.php.<syntaxhighlight lang="gherkin"><br />
And a BigBlueButton mock server is configured<br />
</syntaxhighlight><br />
<br />
<br />
The following step replicates receiving a callback from the BigBlueButton server indicating the recordings for meetings are ready for viewing.<syntaxhighlight lang="gherkin"><br />
And the BigBlueButtonBN server has sent recording ready notifications<br />
</syntaxhighlight><br />
<br />
<br />
The following steps are specific to the lesson activity. Note that in 4.0, some links (such as the "edit" and the "grade essays" links) are replaced by buttons, so you need to update your old steps with the new ones.<syntaxhighlight lang="gherkin"><br />
And I edit the lesson<br />
</syntaxhighlight>A new step is added to be used in lesson activities to edit them. This step navigates the user to the lesson edit page.<br />
<br />
<syntaxhighlight lang="gherkin"><br />
And I grade lesson essays<br />
</syntaxhighlight>It's a new step to go to the "Grade essays" page of the lesson we are currently in.<br />
<br />
<syntaxhighlight lang="gherkin"><br />
And I select edit type "edit type"<br />
</syntaxhighlight>Select the lesson edit type when we are in the the lesson's edit page. "edit type" can either be "Collapsed" or "Expanded".<br />
<br />
<br />
The following new step can be used to navigate to the exports page in the course gradebook and select the specified export type from the grade exports navigation selector.<syntaxhighlight lang="gherkin"><br />
And I navigate to "export option" export page in the course gradebook<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And I navigate to "XML file" export page in the course gradebook<br />
</syntaxhighlight><br />
<br />
<br />
Similarly, there's a new step to navigate to the imports page in the course gradebook and select the specified import type from the grade imports navigation selector.<syntaxhighlight lang="gherkin"><br />
And I navigate to "import option" import page in the course gradebook<br />
</syntaxhighlight><br />
<br />
=== Boost steps ===<br />
In addition to the steps listed in the previous section, there are also some Boost specific steps coming with Moodle 4.0. These steps only work in Boost or Boost child themes, so you need to make sure they are not used in scenarios that may be run by non-Boost themes.<br />
<br />
<br />
The following step checks whether a node is active in the secondary navigation.<syntaxhighlight lang="gherkin"><br />
And I should see :name is active in secondary navigation<br />
</syntaxhighlight><br />
<br />
<br />
The Boost theme shows the language selector menu in the primary navigation when not logged in, and within the user menu when logged in. The following steps are to check if the primary navigation includes the language selector menu.<syntaxhighlight lang="gherkin"><br />
And language selector menu should exist in the navbar<br />
And language selector menu should not exist in the navbar<br />
</syntaxhighlight><br />
<br />
<br />
And the following steps can be used to check whether an item exists in the language selector menu in the Boost theme.<syntaxhighlight lang="gherkin"><br />
And "item text" "selector type" should exist in the language selector menu<br />
And "item text" "selector type" should not exist in the language selector menu<br />
</syntaxhighlight>For example:<syntaxhighlight lang="gherkin"><br />
And "English &lrm;(en)&lrm;" "link" should exist in the language selector menu<br />
</syntaxhighlight><br />
<br />
=== Modified steps ===<br />
The step <code>I change the (window|viewport) size to "size"</code> now supports 2 new values for the size argument. The size argument now accepts <code>mobile</code> and <code>tablet</code> values in addition to <code>small</code>, <code>medium</code> and <code>large</code>.<br />
<br />
=== Removed steps ===<br />
Some behat steps are removed or replaced with new steps.<br />
<br />
<br />
As a result of some design changes, hidden or restricted activities are no longer dimmed. Therefore the step<syntaxhighlight lang="gherkin"><br />
And "Activity or resource name" activity should be dimmed<br />
</syntaxhighlight>is now removed.<br />
<br />
Depending on what you were using that step for, you may be able to use these steps:<syntaxhighlight lang="gherkin"><br />
And "Label name" label should be hidden<br />
</syntaxhighlight><syntaxhighlight lang="gherkin"><br />
And "Activity or resource name" activity should be hidden<br />
</syntaxhighlight><syntaxhighlight lang="gherkin"><br />
And I should see "Activity or resource name"<br />
And "Activity or resource name" "link" should not exist in the "region-main" "region"<br />
</syntaxhighlight><br />
<br />
=== Other things to consider ===<br />
To make behat tests more readable and easy to maintain, it is recommended to use the most direct steps to get what the test needs. It is highly recommended to use<br />
I am on the "Activity name" "[modname] activity" page <br />
or<br />
I am on the "Activity name" "[modname] activity" page logged in as "user"<br />
instead of navigating to the activity via<br />
I am on "Course" course homepage<br />
I follow "Activity name"<br />
Now that [https://docs.moodle.org/dev/Prototypes#Course_creation_improvements Course index] is integrated these behat steps<br />
I am on "Course" course homepage<br />
I follow "Activity name"<br />
will fail using Boost theme.<br />
<br />
The reason for it is that the drawer used in Boost is hiding the course index. So when the test is trying to follow an "Activity name" link, it finds two different links:<br />
* one in the course index<br />
* another one in the course main content.<br />
But the first one, the one in the course index, is hidden by the drawer, and the test fails.<br />
<br />
However the recommended behat steps<br />
I am on the "Activity name" "[modname] activity" page <br />
or<br />
I am on the "Activity name" "[modname] activity" page logged in as "user"<br />
Old behat steps that may now fail can be updated to the new steps.<br />
For example:<br />
And I am on the "Test assignment name" "assign activity" page logged in as teacher1<br />
instead of:<br />
When I log in as "teacher1"<br />
And I am on "Course" course homepage<br />
And I follow "Test assignment name"<br />
There are also similar stream-lined navigation steps for accessing question bank pages. See MDL-74130.<br />
== Other ==<br />
=== Core plugins review ===<br />
A few plugins from core Moodle LMS which are no longer or hardly used have been removed and, if appropriate, added to the Moodle plugins directory.<br />
<br />
More information about this project, the list of plugins to be removed and the process to follow for keeping them before upgrading to 4.0 can be found in the [[Core plugins review]] page.<br />
=== Site admin presets plugin ===<br />
The third-party plugin [https://moodle.org/plugins/block_admin_presets Admin presets], created by David Monllaó and maintained by developers from [https://pimenko.com/ Pimenko] has been adapted and integrated into Moodle 4.0. It stores settings and plugins status (enabled/disabled) in what's called "presets" to let admins quickly switch between different configurations.<br />
<br />
More information about this project can be found in the [[Site admin presets|Site admin presets plugin]] page.<br />
=== JavaScript browser support changes ===<br />
From Moodle 4.0, Internet Explorer is no longer supported. See MDL-73915 and MDLSITE-6109 for further information on this change.<br />
<br />
This change means that changes built on 4.0 onwards (including the master branch) will be different to older versions of Moodle.<br />
<br />
For plugin developers supporting multiple versions of Moodle using a single plugin version, the compiled javascript files are backwards compatible and will _work_ on all supported versions, however if you run the `grunt` command on multiple versions you will see unbuilt changes. Running grunt on all versions of Moodle is not necessary and this check can be safely disabled for Moodle versions 3.9 - 4.0, as long as only at least you run `grunt` against at least one version of Moodle.<br />
<br />
If you need to support Internet Explorer and do not wish to fork your plugin for Moodle 4.0 onwards, then it is recommended that you run `grunt` on an older version of Moodle.<br />
=== The course index element ===<br />
The new course index feature can be themed using a set of scss variables. Use them to change the look and feel instead of adding custom css<br />
/theme/boost/scss/moodle/courseindex.scss<br />
With the introduction of the course index component, the previous and next links shown underneath each activity are no longer needed and they will be removed.<br />
=== Activity icons ===<br />
The icons used for activities have been redesigned and updated for all core moodle activities.<br />
<br />
When viewing the new icons in a file manager, for example for the quiz activity, you will see a simple black monochrome icon with a transparent background.<br />
<br />
On the course page, or in the activity chooser, the icon will display as a white icon on a coloured background. Styling of the icons on the coursepage is controlled by the css in theme/boost/scss/moodle/icons.scss.<br />
<br />
The background colour for activity icons is set using a new variable in function [modname]_supports(). The quiz activity is of type assessment, so in function quiz_supports() there is a new line defining the purpose:<br />
case FEATURE_MOD_PURPOSE: return MOD_PURPOSE_ASSESSMENT;<br />
Available purposes are:<br />
* MOD_PURPOSE_COMMUNICATION<br />
* MOD_PURPOSE_ASSESSMENT<br />
* MOD_PURPOSE_COLLABORATION<br />
* MOD_PURPOSE_CONTENT<br />
* MOD_PURPOSE_ADMINISTRATION<br />
* MOD_PURPOSE_INTERFACE<br />
The background colours linked to these purposes are set in theme/boost/scss/moodle/variables.scss<br />
$activity-icon-colors: map-merge(<br />
(<br />
"administration": #5d63f6,<br />
"assessment": #eb66a2,<br />
"collaboration": #f7634d,<br />
"communication": #11a676,<br />
"content": #399be2,<br />
"interface": #a378ff<br />
),<br />
$activity-icon-colors<br />
);<br />
If activity plugins do not define FEATURE_MOD_PURPOSE the activity icon will be rendered against a light grey background. There is no requirement to define the purpose of activity plugins, it will only affect the icon styling.<br />
<br />
Plugins implementing the variable FEATURE_MOD_PURPOSE are only supported on Moodle 4.0 and newer.<br />
<br />
Customising the activity icon can be done in an alternative way. For example using the styles.css in mod/[pluginname/styles.css<br />
<br />
In the example below the activity plugin developer chooses to keep the coloured icon for the activity and render it as large as the coloured background on the core activities<br />
.modicon_subcourse.activityiconcontainer {<br />
background-color: transparent;<br />
padding: 0;<br />
}<br />
<br />
.modicon_subcourse.activityiconcontainer img {<br />
width: 50px;<br />
height: 50px;<br />
}<br />
To customize all icon colours use this scss array and add it to the ‘Raw initial SCSS’ in the theme Boost advanced settings page. The complete array of icon background colours can be overridden using the ‘Raw initial SCSS’ in the theme settings page. The example below changes the colours of each activity type.<br />
$activity-icon-colors: (<br />
"administration": #5D63F6,<br />
"assessment": #11A676,<br />
"collaboration": #EB66A2,<br />
"communication": #F7634D,<br />
"content": #399BE2,<br />
"interface": #A378FF<br />
)</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60510Question bank2021-07-27T09:19:02Z<p>Finns: </p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
===Categories are shared in contexts===<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png|link=Special:FilePath/NewQuestionEditIcons1.png]]<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png|link=Special:FilePath/FilterByTag.png]]<br />
<br />
==Question tags==<br />
<br />
==Question versions==<br />
<br />
==Question comments==<br />
<br />
==Question statistics==<br />
<br />
==Sharing and Managing Question banks==<br />
<br />
==Tips and tricks==<br />
<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60509Question bank2021-07-27T09:18:25Z<p>Finns: </p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
===Categories are shared in contexts===<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png|link=Special:FilePath/NewQuestionEditIcons1.png]]<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png|link=Special:FilePath/FilterByTag.png]]<br />
<br />
==Question tags==<br />
<br />
==Question versions==<br />
<br />
==Question comments==<br />
<br />
==Question statistics==<br />
<br />
==Tips and tricks==<br />
<br />
==Sharing and Managing Question banks==<br />
<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60508Question bank2021-07-27T09:17:40Z<p>Finns: /* Sharing and Managing Question banks */</p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
===Categories are shared in contexts===<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png|link=Special:FilePath/NewQuestionEditIcons1.png]]<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png|link=Special:FilePath/FilterByTag.png]]<br />
==Question versions==<br />
==Question comments==<br />
==Tips and tricks==<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.<br />
==Sharing and Managing Question banks==</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60507Question bank2021-07-27T09:17:02Z<p>Finns: /* Tips and tricks */</p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
===Categories are shared in contexts===<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png|link=Special:FilePath/NewQuestionEditIcons1.png]]<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png|link=Special:FilePath/FilterByTag.png]]<br />
==Question versions==<br />
==Question comments==<br />
==Tips and tricks==<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.<br />
==Sharing and Managing Question banks==<br />
Be default, teachers can manage only the questions in the context of the courses they are in. You can set up a role to allow teachers to share and manager questions on a larger scale. <br />
<br />
You can also use this role to create a special system-wide "Question bank Manager" instead of giving admin level or site-wide Manager access to a person managing the Questions.<br />
<br />
See:<br />
*[[How to let teachers share questions between courses]]<br />
*[[How to minimize the question bank when doing backup/restore]] <br />
*Quiz Question Bank: Quiz level vs Course level - Forum Discussion: https://moodle.org/mod/forum/discuss.php?d=405646</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60506Question bank2021-07-27T09:16:07Z<p>Finns: </p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
<br />
===Categories are shared in contexts===<br />
<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png]]<br />
<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png]]<br />
<br />
==Question versions==<br />
<br />
==Question comments==<br />
<br />
==Tips and tricks==<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.<br />
*Do a copy and paste from a PDF file into the question content area. Reduces "other" hidden code which Word, Open Office and other programs can insert.<br />
<br />
==Sharing and Managing Question banks==<br />
<br />
Be default, teachers can manage only the questions in the context of the courses they are in. You can set up a role to allow teachers to share and manager questions on a larger scale. <br />
<br />
You can also use this role to create a special system-wide "Question bank Manager" instead of giving admin level or site-wide Manager access to a person managing the Questions.<br />
<br />
See:<br />
<br />
*[[How to let teachers share questions between courses]]<br />
*[[How to minimize the question bank when doing backup/restore]] <br />
*Quiz Question Bank: Quiz level vs Course level - Forum Discussion: https://moodle.org/mod/forum/discuss.php?d=405646</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60460Question bank2021-07-20T08:22:41Z<p>Finns: </p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
<br />
===Categories are shared in contexts===<br />
<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png]]<br />
<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png]]<br />
<br />
==Tips and tricks==<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.<br />
*Do a copy and paste from a PDF file into the question content area. Reduces "other" hidden code which Word, Open Office and other programs can insert.<br />
<br />
==Sharing and Managing Question banks==<br />
<br />
Be default, teachers can manage only the questions in the context of the courses they are in. You can set up a role to allow teachers to share and manager questions on a larger scale. <br />
<br />
You can also use this role to create a special system-wide "Question bank Manager" instead of giving admin level or site-wide Manager access to a person managing the Questions.<br />
<br />
See:<br />
<br />
*[[How to let teachers share questions between courses]]<br />
*[[How to minimize the question bank when doing backup/restore]] <br />
*Quiz Question Bank: Quiz level vs Course level - Forum Discussion: https://moodle.org/mod/forum/discuss.php?d=405646</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank&diff=60459Question bank2021-07-20T08:19:01Z<p>Finns: </p>
<hr />
<div>{{Note|Let's use this page as an intermediary one for the documentation of the Moodle 4.0 question bank features.}}<br />
<br />
{{Managing questions}}<br />
This feature allows a teacher to create, preview, and edit questions in a database of question categories. The categories can be limited to being used on the site, course or quiz level. The questions in a category can be added to a [[Quiz module|Quiz]] or to a [[Lesson module|lesson activity]] via an export process. The teacher enters the question bank by creating or editing a quiz activity or via ''Course administration > Question bank''<br />
<br />
==Select a category==<br />
Questions are organised into categories. Initially each course has only one category called "Default". It is good practice to create more categories to organize your questions. This not only makes it easier to find questions, but makes the use of random questions and matching question easier. You can create a hierarchy of categories because you can create subcategories inside parent categories. To add or edit categories click on the "[[Question categories|Categories]]" tab.<br />
<br />
The question editing screen shows the questions from the currently selected category. You choose this category from the '''Category:''' drop-down menu. Using the tick box below that menu you determine whether to also show the questions from all subcategories.<br />
<br />
If a question is deleted when it is still being used by a quiz, then it is not removed from the database, because that would cause all sorts of problems. Instead it is just set to hidden. 'Also show old questions' is for showing these hidden questions.<br />
<br />
===Categories are shared in contexts===<br />
<br />
There are separate question category trees in each different 'context' in which questions are shared. The contexts available to you depend on whether you access the question bank from an activity or from a course and depend on the permissions assigned you for access to questions. See [[Question contexts]] for more information on these contexts.<br />
<br />
==Add a new question==<br />
# Click the ''Questions'' tab to access the Question Bank page, if not there already.<br />
# From the '''Category''' drop-down menu, select a category you want to add a question to.<br />
# The page will change to show the questions already in that category<br />
# Select the question type you want to create from the '''Create new question''' drop-down menu.<br />
# Fill in the form for the question type you are creating. Each [[Question types|question type]] has its own form and has its own options.<br />
# Click ''Save Changes'' at the bottom of the form.<br />
<br />
==Edit, duplicate, preview, delete, move and tag==<br />
[[File:NewQuestionEditIcons1.png]]<br />
<br />
<br />
<br />
Each question in the question bank has four icons which allow you to tag, edit, quickly duplicate, preview and delete the question. (The question may not be deleted if it is already in use elsewhere.) To duplicate a question, click the duplicate icon (second from the left) and a copy of the question editing screen will appear. You can either edit this new copy or simply scroll down and click "Save changes."To move a question into a different category or subcategory, click into the box on its left; scroll down to "With Selected..." and choose "Move to.."<br />
<br />
<br />
A new tag icon allows you to tag questions directly from the question bank. You can then search and filter by tagged questions.<br />
<br />
[[File:FilterByTag.png]]<br />
<br />
==Tips and tricks==<br />
*Put the answer into the question name so you can quickly see the answers when students are asking for answers. This is especially useful if you're dealing with large sets of questions! (No option yet for viewing category or answer of question in the list of questions.)<br />
*Export questions in GIFT or Moodle XML formats, then import them into a Lesson. (Future versions of Moodle will make Question bank available to both Lesson and Quiz activities.)<br />
*Remember that while some of the same question types can be found in both the Quiz and Lesson modules, they can be very different. Scoring and grading each student's choice is more robust in a Quiz. On the other hand, each Lesson question answer also has a [[Jumps|jump]] associated it.<br />
*Use GIFT or other export modes to print questions and answers in a category. Hint, clever use of word processor macros, using search and replace, can tidy up a GIFT file for printing.<br />
*The question title is useful in sorting and making notes. For example, "ZZ remove 2010-3 Why did the Moodler cross", will put this question at the bottom of the list. Or where you want a 'the' questions in a category to appear in a specific order, use letters or numbers, knowing that AA will come first, AB will be second in the list.<br />
*Do a copy and paste from a PDF file into the question content area. Reduces "other" hidden code which Word, Open Office and other programs can insert.<br />
<br />
==Sharing and Managing Question banks==<br />
<br />
Be default, teachers can manage only the questions in the context of the courses they are in. You can set up a role to allow teachers to share and manager questions on a larger scale. <br />
<br />
You can also use this role to create a special system-wide "Question bank Manager" instead of giving admin level or site-wide Manager access to a person managing the Questions.<br />
<br />
See:<br />
<br />
*[[How to let teachers share questions between courses]]<br />
*[[How to minimize the question bank when doing backup/restore]] <br />
*Quiz Question Bank: Quiz level vs Course level - Forum Discussion: https://moodle.org/mod/forum/discuss.php?d=405646</div>Finnshttps://docs.moodle.org/dev/index.php?title=Talk:Moodle_App_Remote_Themes_Upgrade_Guide&diff=59022Talk:Moodle App Remote Themes Upgrade Guide2021-06-29T12:04:05Z<p>Finns: </p>
<hr />
<div>Thanks for that great guide.<br />
<br />
Finally, I do struggle on how to implement at the end. Because to use it with Chromium something like<br />
<br />
<code css><br />
/* 3.9.5 ionic styles */<br />
<br />
:root {<br />
--core-header-toolbar-background: #64788b;<br />
--core-header-toolbar-border-color: #64788b;<br />
--core-header-toolbar-color: #fff;<br />
--core-bottom-tabs-background: #64788b;<br />
--core-bottom-tabs-color: #eff1f3;<br />
--core-bottom-tabs-color-selected: #fac301;<br />
--drop-shadow: 0, 0, 0, 0.00;<br />
--brand-color: #fac301;<br />
--color: #fac301;<br />
--loading-text-color: #fac301;<br />
}<br />
</code><br />
<br />
works perfectly well.<br />
<br />
But is that the form it can be shipped in a custom css file?<br />
A minimal simple enough sample css file would be much appreciated.<br />
Thanks!<br />
<br />
[[User:Luca Bösch|Luca Bösch]] ([[User talk:Luca Bösch|talk]]) 10:55, 29 June 2021 (UTC)<br />
<br />
<br />
I added a Full example at the end of the page, :root is ok but if you feel more comfortable, you can use body.ionic5 instead.<br />
<br />
Thanks heaps, Pau!<br />
In our site it is productive but for some reason it does not propagate to the beta Moodle 3.9.5 (3.9.5.0) iOS version, but that might just be temporary.<br />
We have the Premium subscription plan, the "Basic branding" colors are coming through, but the rest of the style is not. I did incrase a #2 at the end of the css URL in order to 'count up'.<br />
<br />
[[User:Luca Bösch|Luca Bösch]] ([[User talk:Luca Bösch|talk]]) 12:04, 29 June 2021 (UTC)</div>Finnshttps://docs.moodle.org/dev/index.php?title=Talk:Moodle_App_Remote_Themes_Upgrade_Guide&diff=59016Talk:Moodle App Remote Themes Upgrade Guide2021-06-29T10:55:23Z<p>Finns: </p>
<hr />
<div>Thanks for that great guide.<br />
<br />
Finally, I do struggle on how to implement at the end. Because to use it with Chromium something like<br />
<br />
<code css><br />
/* 3.9.5 ionic styles */<br />
<br />
:root {<br />
--core-header-toolbar-background: #64788b;<br />
--core-header-toolbar-border-color: #64788b;<br />
--core-header-toolbar-color: #fff;<br />
--core-bottom-tabs-background: #64788b;<br />
--core-bottom-tabs-color: #eff1f3;<br />
--core-bottom-tabs-color-selected: #fac301;<br />
--drop-shadow: 0, 0, 0, 0.00;<br />
--brand-color: #fac301;<br />
--color: #fac301;<br />
--loading-text-color: #fac301;<br />
}<br />
</code><br />
<br />
works perfectly well.<br />
<br />
But is that the form it can be shipped in a custom css file?<br />
A minimal simple enough sample css file would be much appreciated.<br />
Thanks!<br />
<br />
[[User:Luca Bösch|Luca Bösch]] ([[User talk:Luca Bösch|talk]]) 10:55, 29 June 2021 (UTC)</div>Finnshttps://docs.moodle.org/dev/index.php?title=Talk:Moodle_App_Remote_Themes_Upgrade_Guide&diff=59015Talk:Moodle App Remote Themes Upgrade Guide2021-06-29T10:55:08Z<p>Finns: Created page with "Thanks for that great guide. Finally, I do struggle on how to implement at the end. Because to use it with Chromium something like /* 3.9.5 ionic styles */ <code css> :root..."</p>
<hr />
<div>Thanks for that great guide.<br />
<br />
Finally, I do struggle on how to implement at the end. Because to use it with Chromium something like<br />
<br />
/* 3.9.5 ionic styles */<br />
<br />
<code css><br />
:root {<br />
--core-header-toolbar-background: #64788b;<br />
--core-header-toolbar-border-color: #64788b;<br />
--core-header-toolbar-color: #fff;<br />
--core-bottom-tabs-background: #64788b;<br />
--core-bottom-tabs-color: #eff1f3;<br />
--core-bottom-tabs-color-selected: #fac301;<br />
--drop-shadow: 0, 0, 0, 0.00;<br />
--brand-color: #fac301;<br />
--color: #fac301;<br />
--loading-text-color: #fac301;<br />
}<br />
</code><br />
<br />
works perfectly well.<br />
<br />
But is that the form it can be shipped in a custom css file?<br />
A minimal simple enough sample css file would be much appreciated.<br />
Thanks!<br />
<br />
[[User:Luca Bösch|Luca Bösch]] ([[User talk:Luca Bösch|talk]]) 10:55, 29 June 2021 (UTC)</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=59000Question bank improvements for Moodle 4.02021-06-25T10:28:02Z<p>Finns: /* Contributors (financially) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Development in progress<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
<br />
== Technical overview of the plans ==<br />
<br />
What we are planning to do is outlined in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread]. That thread is quite long, with discussion of the plan, but the key posts which describe the plan are:<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1682674 Setting the scope]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683127 Question bank will be made up of plugins]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1687624 List of the plugins that will be created initially]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1683186 Question bank will store the version history of each question]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1688163 How the question bank will track the places (quizzes) where questions are used]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1685143 Some initial UI wireframes]<br />
* [https://moodle.org/mod/forum/discuss.php?d=417599#p1705076 Question (and following discussion) about how complicated the filtering/searching system needs to be at first]<br />
<br />
== Project support ==<br />
<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
<br />
== Work-in-progress ==<br />
<br />
In time, we will and more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* RWTH Aachen University, Germany<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
These institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=58946Question bank improvements for Moodle 4.02021-06-04T15:09:07Z<p>Finns: /* Contributors (financially) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Development in progress<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
<br />
The project has been explained in detail in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread], so for more details, please read that.<br />
<br />
== Project support ==<br />
<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
<br />
== Work-in-progress ==<br />
<br />
In time, we will and more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Office for Middle and vocational schools, Switzerland<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
This institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=58828Question bank improvements for Moodle 4.02021-05-18T13:35:41Z<p>Finns: </p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Development in progress<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by [[User:Thomas_Korner|Thomas Korner]], [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
<br />
The project has been explained in detail in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread], so for more details, please read that.<br />
<br />
== Project support ==<br />
<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
<br />
== Work-in-progress ==<br />
<br />
In time, we will and more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Canton of Zurich Middle Schools and Vocational Training Office, Switzerland<br />
* Dublin City University, Ireland<br />
* ETH (Swiss Federal Institute of Technology) Zurich, Department of Medicine, Switzerland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
This institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Process&diff=58627Process2021-04-05T21:46:47Z<p>Finns: </p>
<hr />
<div>This document summarises the various development processes used in developing Moodle. There are four main processes that overlap.<br />
<br />
==Integration workflow in the tracker==<br />
<br />
The Moodle tracker keeps track of the status of all bug fixes and new features. <br />
<br />
We use a workflow that ensures that new code receives multiple reviews by different people before it is included into the core Moodle code.<br />
<br />
[[Image:Workflow.jpg]]<br />
<br />
A number of roles make this work:<br />
<br />
===Users===<br />
<br />
Users report bugs and make feature requests directly in the tracker, by creating new issues with a summary and a description.<br />
<br />
===Developers===<br />
<br />
Developers work on the issues in the tracker to specify solutions and write code that implements these solutions. They will often ask other developers to "peer review" their code in the early stages to avoid problems later on.<br />
<br />
While many of the developers work for Moodle.com, a large number are part of the global development community around Moodle. If you're interested in becoming a recognised developer, see [[Tracker_guide#Tracker_groups_and_permissions|Tracker groups and permissions]].<br />
<br />
===CiBoT===<br />
<br />
CiBoT is not a person but a bot who monitors the tracker and performs the [[Automated code review]] when issue is submitted for Peer review or when developer added ''cime'' label.<br />
<br />
===Component leads===<br />
<br />
[https://tracker.moodle.org/projects/MDL?selectedItem=com.atlassian.jira.jira-projects-plugin:components-page Component leads] are developers with some responsibility for particular components (plugins or modules) in Moodle. They have authority to decide that a particular fix is suitable and complete enough to be considered for integration in Moodle core and should be called upon to complete peer reviews for code in their components. Note that, apart from that, every component also has some [[Component Leads|HQ Component leads]] that will specifically work on associated issues, triaging, monitoring, reviewing, fixing them.<br />
<br />
===Integrators===<br />
<br />
On Monday and Tuesday of each week, the integration team (a small team of senior developers employed by Moodle HQ) conducts a code-level review of all issues in the integration queue. This is often called the "pull" process. If the fix is judged appropriate they will integrate the code into our git integration repository for further testing and it gets added to the testing queue.<br />
<br />
If they find problems they reject the issue and send it back to the developer for further work.<br />
<br />
===Testers===<br />
<br />
On Wednesday each week, testers look at all the issues in the testing queue, trying each fix and feature to make sure that it does actually fix the problem it was supposed to, and that there are no regressions in the web version and the Moodle mobile app.<br />
<br />
If they find problems they reject the issue and integrators may remove it from the integration repository and push it back to the developer for further work.<br />
<br />
See [[Testing of integrated issues]] for more details.<br />
<br />
===Production maintainers===<br />
<br />
On Thursday each week, production maintainers merge all the issues that passed testing into the git production repository, and it becomes available for use on production systems via git and download packages.<br />
<br />
==Stable maintenance cycles==<br />
<br />
Moodle releases regular updates of the stable version of the software to fix bugs and other issues. Releases like 2.2.1, 2.2.2, 2.2.3 etc only include fixes based on the latest major release (2.2) and never any significant new features or database changes.<br />
<br />
At Moodle HQ there are teams of developers using the [http://www.scrum.org/ Scrum framework] to work on these issues (as well as new features for [[#Major_release_cycles|major releases]]). <br />
<br />
===Minor release (point release) timing===<br />
<br />
After [[#Major_release_cycles|major releases]] there will be minor releases.<br />
* x.x.1 will occur approximately two months after each major release (eg. 2.x).<br />
* There will then be another point release every two months after that.<br />
<br />
See the [[Releases#General_release_calendar|General release calendar]] for details.<br />
<br />
===Issue triage===<br />
<br />
[[Bug_triage|Issue triage]] involves evaluating new issues, making sure that they are recorded correctly. One of the most important jobs triagers do is to identify issues that should be fixed in the stable branch. These are set with a priority ranging from "Trivial" up to "Blocker" and other features are checked.<br />
<br />
At Moodle HQ there are currently teams working on stable issues (mostly bugs reported by users) and improvements and new features (Partners, Moodle Association, user suggestions and Martin Dougiamas).<br />
<br />
===Scrum===<br />
<br />
At Moodle HQ, every three weeks, the stable team takes a number of the most urgent issues from the backlog to work on during a period known as a ''sprint''.<br />
<br />
At the start of a sprint there is a period of planning and estimation. All issues on the backlog are given a relative rank that is based on issue features including priority, security, Partner interest, patches and votes. Issues are given a relative size in Story Points and these points are summed to allow the teams to determine how many issues they can work on in the sprint.<br />
<br />
During the sprint, the team meets daily to discuss solutions and progress, as well as to organise testing and peer reviews of code. The team has a ''Scrum master'' to help everyone stay organised, to "unblock" any barriers to progress and to protect the team from distracting influences (mostly people attempting to add to the developers' workloads) during the sprint. The teams' work is documented publicly in the tracker.<br />
<br />
Whenever a solution for an issue is finished, it is submitted to the standard integration workflow process described above.<br />
<br />
==Major release cycles==<br />
<br />
Since Moodle 2.0, we have a policy of release major versions (eg 2.1, 2.2) every six months in May and November. See the [[Releases#General_release_calendar|General release calendar]] for more details.<br />
<br />
Each release can be different, but generally the cycles work as follows.<br />
<br />
===Define roadmap===<br />
<br />
The product owner (Martin Dougiamas) defines the likely roadmap based on community wishes, third-party developments and important issues within the existing code. <br />
<br />
Sometimes new features might be based on earlier features, sometimes they may be something developed by a third party that needs to be evaluated and sometimes it might be something completely new.<br />
<br />
===Planning and development===<br />
<br />
The UX team, employed at Moodle HQ, work on specifications of major new features throughout the cycle, specifying project ahead of development time.<br />
<br />
New features are worked on by the "Dev" team. The process of [[#New_feature_development|new feature development]] is described below. When specifications are in place, new code is developed during sprints and goes through the standard weekly integration workflow described above.<br />
<br />
===Testing===<br />
<br />
During development, as new code is integrated, automated testing conducted at the [[PHPUnit|code]] and [[Acceptance_testing|interface]] levels, to make sure there are no regressions caused by new features.<br />
<br />
In the last month before the release, a feature freeze is called (no new features can be added) and volunteer testers from the Moodle community perform manual QA testing of Moodle features. The current set of functional tests is listed in MDLQA-1. The list of tests is extended as new features are added, though we're also trying to reduce the number as more automated [[Acceptance_testing|acceptance tests]] are developed.<br />
<br />
There is also a set of tests for manually testing any major theme changes - MDLQA-11592.<br />
<br />
For more details, see [[Testing]].<br />
<br />
===Sprints===<br />
<br />
At Moodle HQ, development takes place in sprints. The sprints are three-week periods during which developers to focus on a fixed list of issues. Sprints are arranged within each release cycle as shown in the diagram below.<br />
<br />
===Events during cycle===<br />
<br />
During each cycle there are a periods and events that occur between and around sprints.<br />
<br />
[[Image:Dev sprint calendar.png|800px]]<br />
<br />
; '''Planning and bug fixing'''<br />
: A period during which the Roadmap is explored, specs are written and prototypes are created. Regressions in the recent release are fixed as they arise.<br />
; '''End sync period'''<br />
: During the [[Integration Review#On-sync period|on-sync period]], the recent release and master versions are kept synchronised. No new code is added during this period, which ensures regressions are fixed rapidly. This also allows for planning and provides relief for developers after a release.<br />
; '''Personal projects'''<br />
: Affecting full-time HQ developers only, this period allows for individual creations to be explored and provides a break from sprints.<br />
; '''Code freeze'''<br />
: A point after which no new code (only fixes to existing code) is accepted until beyond the release. This stabilisation allows for QA testing.<br />
; '''QA, bug fixing, continuous integration'''<br />
: A period after the code freeze where quality assurance testing takes place. No new code is added, which means developers are able to respond rapidly to bugs found. Integration becomes [[Integration Review#During continuous integration/Freeze/QA period|continuous]], meaning that failed QA tests can be re-run within days rather than having to wait for the weekly release.<br />
; '''Release candidate'''<br />
: A point prior to the full release where a candidate is made public for wider testing.<br />
<br />
==New feature development==<br />
<br />
Major new features in Moodle usually should go through the following process.<br />
<br />
===Specification===<br />
<br />
The User Experience (UX) team should create detailed wireframes and features and goals for the new feature. It should be agreed upon and as final as possible before development starts.<br />
<br />
Developers should create a detailed spec (here in the developer docs) outlining their goals for the development and their design for meeting those goals. The more detail the better.<br />
<br />
Developers should also create an issue in the tracker (linking to your docs) to keep track of the project status.<br />
<br />
===Community consultation===<br />
<br />
Get the community involved in looking at the spec to see if it meets their needs and to get further feedback. Please post in the [http://moodle.org/mod/forum/view.php?id=8052 Future major features forum] on moodle.org. You could also blog/tweet about it etc.<br />
<br />
Community developers proposing a new feature will want to talk with HQ core developers to make sure the ideas make sense, and possibly get some review on database design, architecture and so on.<br />
<br />
===Develop the code using Git===<br />
<br />
Develop your code on an open Git repository, like github.com. That enables people to see your code and to help you as it develops. Testers and early adopters also have the opportunity to try it early in the process and give you more valuable feedback.<br />
<br />
Coverage with automated tests ([[PHPUnit]] or [[Behat|Behat_integration]]) is mandatory for new features.<br />
<br />
It is essential that your code follows the [[Coding|Moodle Coding Guide]].<br />
<br />
===Submit your code for peer review===<br />
<br />
Click on "Request peer review" button in the tracker.<br />
<br />
You need to fill in the information about your public git repository and which branches the fixes are on. Make sure you are listed as Assignee.<br />
<br />
This would be a good time to fill in the testing instructions (read the [[Testing instructions guide|instructions guide]]) for how to verify your fix is correct. You may also wish to add a comment in the bug.<br />
<br />
Component leads should put issues, which affect code in their components, up for peer review to allow interested parties to provide feedback. However, if it is not reviewed in a week, a component lead may send the issue to integration. If integrators consider that the issue has not been given proper chance for peer review (e.g. is extremely large or complex...) it can be decided to move the issue back in the process.<br />
<br />
All other developers, including people who are component leads but working outside their component, should have their issues peer reviewed before they are sent to integration.<br />
<br />
===Peer review===<br />
<br />
The [http://tracker.moodle.org/browse/MDL#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponents-panel component lead] should peer-review the change. If there is no component lead for an affected component, any other recognised developer may complete the peer review. The peer reviewer will either give you comments on the code and if it needs more work.<br />
<br />
Process and the list of things to check are described in [[Peer reviewing]].<br />
<br />
===Submit the code for integration===<br />
<br />
The developer is responsible for acting on the feedback from the peer reviewer. If changes have been made and the developer is satisfied that this has accommodated the feedback from the peer reviewer, then the developer can submit the issue for integration. If there have been significant changes after the peer review, or if the peer reviewer has raised concerns about the approach taken, then the developer should offer the issue up for peer review again, most often to the same peer reviewer, but not necessarily.<br />
<br />
Submitting an issue to integration is much the same as for any Moodle code. See [[Integration Review]] and the information about the integration workflow above.<br />
<br />
==Fixing a bug==<br />
<br />
Bug fixes, and minor features or enhancements should go through the following process. (The only exception is English language string typo fixes or suggested improvements, which may be contributed to the en_fix language pack on the [http://lang.moodle.org/ Moodle translation site].)<br />
<br />
===Make sure there is a tracker issue===<br />
<br />
Every change must have an issue in the tracker. If you are fixing a bug, there is probably one there already, but if not, create one. [[Tracker tips|Tips for searching tracker]].<br />
<br />
===Decide which branches the fix is required on===<br />
<br />
Bugs should normally be fixed on all the supported stable branches that are affected. New features should just go into master, but sometimes minor enhancements are made on the most recent stable branch.<br />
<br />
===Develop your change using git===<br />
<br />
Develop your fix and push the change to an open git repository, for example on github.com. See also [[Git for developers]]<br />
<br />
It is essential that your code follows the [[Coding|Moodle Coding Guide]].<br />
<br />
You will need to push one commit for each branch the fix needs to be applied to. Often people use branch names like MDL-12345-31_brief_name so it is clear what each branch is. [http://kernel.org/pub/software/scm/git/docs/git-cherry-pick.html git cherry-pick] can help with replicating the fix onto different branches.<br />
<br />
Consider setting up [[Travis integration]] with your repository so tests will be automatically run for you whenever you push work on your fix.<br />
<br />
===Submit your code for peer review===<br />
<br />
Once your fix is done, it should be submitted for a peer review.<br />
<br />
The following information is necessary for this:<br />
* Information about your public git repository<br />
** repository URL<br />
** branch name(s)<br />
** diff URL<br />
* [[Testing instructions guide|Testing instructions]] for how to verify your fix is correct.<br />
<br />
If you have never contributed to Moodle and don't see a button "Request peer review", just comment on the issue with the above information. The component lead or another user with sufficient privileges will then send the issue up for peer review for you.<br />
<br />
After your first fix is integrated you will be added to developers group and will be able to send issues for peer review yourself. In this case make sure you are listed as Assignee and click on "Request peer review" button in the tracker.<br />
<br />
If you've set up [[Travis integration]], the issue will automatically show the Travis build status for the branch(es) you've submitted for peer review.<br />
<br />
===Peer review===<br />
<br />
The [https://tracker.moodle.org/projects/MDL?selectedItem=com.atlassian.jira.jira-projects-plugin:components-page component lead] should peer-review the change. If there is no component lead for an affected component, any other recognised developer may complete the peer review. The peer reviewer will either give you comments on the code and if it needs more work.<br />
<br />
Process and the list of things to check are described in [[Peer reviewing]].<br />
<br />
===Submit your code for integration===<br />
<br />
It will then be reviewed the following week by one of the integration team and either integrated or rejected. Once integrated, the fix will be tested, and then included in the next weekly release. For details see [[Integration Review]].<br />
<br />
==Security issues==<br />
<br />
Issues identified as [[Security|security issues]] are resolved in a slightly different way, in order to achieve responsible disclosure as described in [[Moodle security procedures]].<br />
<br />
* Security issues should be labelled as "Minor" or "Serious" in order control visibility of the issue.<br />
** An issue reported with a security level of "Could be a security issue" should be evaluated as soon as possible and either set as "Minor" or "Serious" or the security level should be set to "None".<br />
* Solutions to security issues should not:<br />
** be made available in public repositories.<br />
*** If a developer has shared a solution as Git branches via Github, they should be asked to provide the solutions as [[How_to_create_a_patch|stand-alone patches]] attached to the issue and to [[#How to remove a branch from Github|remove the solution from Github]].<br />
** contain details about the security problem in the commit message.<br />
*** Instead use generic terms like, "improve", "better handling of" ..<br />
* The solution will not be integrated until the week before a [[Process#Stable_maintenance_cycles|minor release]] following the normal [[Release process|Release process]]. In short, the issue will be incorporated into the integration version, rebased, tested and made ready for release as a normal issue would, but not until as late as possible.<br />
* Details of security issues will be shared with registered admins with the minor release.<br />
* Details of security issues will not be publicly announced until one week after a minor release to allow admins to update.<br />
<br />
Note that not all the labelled (minor) security issues are always handled following the procedure above. It's possible that, after discussion, it's decided a given issue is not a real Moodle security problem (say external disclosures/potential attacks using Moodle as vector, not as target, discussions revealing some private details...). Those issues will be processed as normal issues, generating the needed user documentation if necessary and will be part of the habitual weekly releases.<br />
<br />
====How to remove a branch from Github====<br />
<br />
To remove a branch from Github, you can use the following command.<br />
<br />
git push github :remote_branch<br />
<br />
Where ''remote_branch'' is the name of your remote branch, for example 'wip-mdl-1234'. This effectively replaces the remote branch with nothing, removing the remote branch, but leaving the branch intact in your local Git repository. Please note that its likely that your commit will still exist on github due to the nature of git, so its best to avoid doing this in the first place.<br />
<br />
==Policy issues==<br />
<br />
Occasionally within Moodle we run into policy issues where a high-level decision needs to be made about how things are to be done.<br />
<br />
In these cases the process is as follows:<br />
* Create an issue in the tracker with a [https://tracker.moodle.org/browse/MDL/component/12733 Policy component] and put "POLICY:" as a prefix on the summary.<br />
* In the description describe the problem clearly as well as all the options. If it's long then make a page here in Moodle Dev Docs and link to it.<br />
* Do not use this issue for code. If there are issues that depend on this policy decision, then add tracker links to them as dependencies.<br />
* Feel free to encourage people to come and talk about the policy to support various points of view. The more evidence we have (from everyone in the community) the better.<br />
<br />
Some time has been scheduled in the weekly Moodle HQ meeting to look at Policy issues and try to make decisions on them. We discuss all the evidence and try to achieve a high amount of consensus. Deadlocked issues can be resolved by a decision from Martin Dougiamas (this is rarely needed).<br />
<br />
Decisions will be posted on the issue and that issue will be closed, allowing any dependent issues to continue to integration (or not). Decisions are final and bribes hardly ever work.<br />
<br />
==See also==<br />
<br />
* [[Release process]]<br />
* [[Deprecation]]<br />
* [http://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11350 Integration dashboard]<br />
<br />
Walks-though of the process for contributors:<br />
* By Dan Poltawski, Integrator: http://www.slideshare.net/poltawski/how-to-guarantee-your-change-is-integrated-to-moodle-core, https://www.youtube.com/watch?v=836WtnM2YpM<br />
* By Tim Hunt, contributor: http://tjhunt.blogspot.co.uk/2012/03/fixing-bug-in-moodle-core-mechanics.html and https://www.youtube.com/watch?v=gPPA3h7OGQU and https://youtu.be/Hu8ne0NCRAg?t=11659<br />
<br />
[[Category:Processes]]<br />
[[Category:Quality Assurance]]<br />
[[Category:Git]]<br />
[[Category:Core development]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Tracker_tips&diff=58626Tracker tips2021-04-05T21:34:24Z<p>Finns: /* Useful queries */</p>
<hr />
<div>=Searching=<br />
<br />
==Quick search==<br />
<br />
On every tracker page you can find search box. Quick search is much more powerful than you might think.<br />
<br />
Examples of the quick searches:<br />
<br />
{| class="nicetable"<br />
|-<br />
! Quick search<br />
! Advanced search equivalent<br />
|-<br />
| colspan="2" | Find all unresolved Bugs in Moodle project that contain words abra cadabra<br />
|-<br />
| '''MDL Unresolved Bug abra cadabra'''<br />
[[{{ns:file}}:trackerquicksearch.png]]<br />
| project = MDL AND issuetype = Bug AND resolution = Unresolved AND text ~ "abra cadabra"<br />
[[{{ns:file}}:advancedsearch.png]]<br />
|-<br />
| colspan="2" | Find all ongoing issues assigned to me:<br />
|-<br />
| '''my Unresolved'''<br />
| resolution = Unresolved AND assignee = currentUser()<br />
|}<br />
<br />
Quick search can pick up many other keywords, see more information on page [https://confluence.atlassian.com/display/JIRA062/Using+Quick+Search Using quick search]<br />
<br />
==Advanced search==<br />
<br />
To get here either enter something in quick search or go to the link [https://tracker.moodle.org/issues/?jql= Tracker search page] and switch it to “Advanced” mode.<br />
Now you can enter queries in the Jira Query Language (JQL). Use as many AND, OR and parenthesis as you want. Some examples and interesting subqueries:<br />
<br />
{| class="nicetable"<br />
|-<br />
! JQL<br />
! Explanation<br />
|-<br />
| project = MDL<br />
| only issues inside project Moodle<br />
|-<br />
| resolution = Unresolved<br />
| Best way to search for open issues<br />
|-<br />
| type in (Improvement, "New Feature")<br />
| <br />
|-<br />
| votes > 50<br />
| <br />
|-<br />
| component in (Assignment, Gradebook)<br />
| where component is either Assignment or Gradebook<br />
|-<br />
| component = Assignment AND component = Gradebook<br />
| where both Assignement and Gradebook are listed as components<br />
|-<br />
| labels = patch<br />
| issues containing particular label<br />
|-<br />
| labels is empty OR labels not in (triaged, triaging_in_progress)<br />
| issues NOT containing particular label(s)<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=updatedDate%20%3E%20-7d updatedDate > -7d]<br />
| updated in the last week<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=assignee%20%3D%20currentUser%28%29%20AND%20resolution%20%3D%20Unresolved assignee = currentUser() AND resolution = Unresolved]<br />
| open issues where you are an assignee<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=reporter%20%3D%20currentUser%28%29 reporter = currentUser()]<br />
| issues reported by you<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=Participants%20%20%3D%20currentUser() Participants = currentUser()]<br />
| issues where you commented, edited or otherwise participated<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=%22Component%20watchers%22%20%3D%20currentUser()%20and%20resolution%20%3D%20Unresolved "Component watchers" = currentUser() and resolution = Unresolved]<br />
| open issues in the components where you are an automatic watcher (only tracker admins can assign automatic watchers)<br />
|-<br />
| assignee in membersOf("hq-developers")<br />
| issues assigned to members of hq-developers group<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=status%20changed%20to%20%22Waiting%20for%20peer%20review%22%20before%20startofday%28-7%29%20and%20status%20%3D%20%22Waiting%20for%20peer%20review%22 status changed to "Waiting for peer review" before startofday(-7) and status = "Waiting for peer review"]<br />
| issues waiting for peer review for over a week<br />
|-<br />
| status WAS NOT "Development in progress" BEFORE "2011/02/02"<br />
| <br />
|-<br />
| <nowiki>issue in linkedIssues("MDL-12345")</nowiki> <br />
| issues linked to particular issue<br />
|-<br />
| <nowiki>issue in linkedIssues("MDL-12345","duplicated by")</nowiki> <br />
| <nowiki>Returns all the issues directly and indirectly duplicated by 'MDL-12345'. i.e. if there is 'MDL-12222' duplicated by 'MDL-12345' and 'MDL-11111' duplicated by 'MDL-12222', both 'MDL-11111' and 'MDL-12222' will be returned as search results.</nowiki><br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=issue%20in%20favouriteIssues%28%29 issue in favouriteIssues()]<br />
| issues that you marked as favourite<br />
|}<br />
<br />
<br />
More documentation on [https://confluence.atlassian.com/jirasoftwareserver071/advanced-searching-800707146.html Advanced searching]<br />
<br />
=Using filters=<br />
<br />
To create a filter click on "Save as" button above the search:<br />
<br />
[[{{ns:file}}:savefilter1.png]]<br />
<br />
Now you can quickly access your filters but also you can subscribe to it, Click on "Details":<br />
<br />
[[{{ns:file}}:savefilter3.jpg]]<br />
<br />
and then on "New subscription":<br />
<br />
[[{{ns:file}}:savefilter4.png]]<br />
<br />
Now you will be notified daily about new issues in Assignment component. You can manage your filters and subscriptions on [https://tracker.moodle.org/secure/ManageFilters.jspa Manage filters] page.<br />
Watchers automatically receive notifications about the updates of the issues they are watching. Using filter subscription you can either monitor issues that you are not watching or monitor issues that are in particular state and were not updated.<br />
<br />
==Useful queries==<br />
# [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20and%20resolution%20%3D%20unresolved%20and%20type%20in%20%28bug%29%20and%20%22Affected%20Branches%22%20!~%20MOODLE_310_STABLE%20and%20%22Affected%20Branches%22%20!~%20MOODLE_311_STABLE%20and%20reporter%20%3D%20currentUser%28%29 Issues reported by me not against current versions] - make sure that you keep track of your own issues!<br />
# [https://tracker.moodle.org/issues/?jql=component%20in%20%28componentsLeadByUser%28%29%29%20AND%20resolution%20%3D%20Unresolved%20AND%20updatedDate%20%3E%20-14d%20AND%20project%20%3D%20MDL%20AND%20%28%20labels%20is%20EMPTY%20OR%20labels%20not%20in%20%28triaged%2C%20triaging_in_progress%29%29%20ORDER%20BY%20updatedDate%20ASC Untriaged issues in my components] (works only for component leads)<br />
# [https://tracker.moodle.org/issues/?jql=status%20changed%20to%20%22Waiting%20for%20peer%20review%22%20before%20startofday(-21)%20and%20status%20%3D%20%22Waiting%20for%20peer%20review%22 Waiting for peer review for 21 days]<br />
# [https://tracker.moodle.org/issues/?filter=19324 Integrated this week] - subscribe to this filter on Fridays and keep yourself up-to-date with what is happening in Moodle<br />
<br />
[[Category:Tracker]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Tracker_tips&diff=58625Tracker tips2021-04-05T21:32:37Z<p>Finns: /* Advanced search */</p>
<hr />
<div>=Searching=<br />
<br />
==Quick search==<br />
<br />
On every tracker page you can find search box. Quick search is much more powerful than you might think.<br />
<br />
Examples of the quick searches:<br />
<br />
{| class="nicetable"<br />
|-<br />
! Quick search<br />
! Advanced search equivalent<br />
|-<br />
| colspan="2" | Find all unresolved Bugs in Moodle project that contain words abra cadabra<br />
|-<br />
| '''MDL Unresolved Bug abra cadabra'''<br />
[[{{ns:file}}:trackerquicksearch.png]]<br />
| project = MDL AND issuetype = Bug AND resolution = Unresolved AND text ~ "abra cadabra"<br />
[[{{ns:file}}:advancedsearch.png]]<br />
|-<br />
| colspan="2" | Find all ongoing issues assigned to me:<br />
|-<br />
| '''my Unresolved'''<br />
| resolution = Unresolved AND assignee = currentUser()<br />
|}<br />
<br />
Quick search can pick up many other keywords, see more information on page [https://confluence.atlassian.com/display/JIRA062/Using+Quick+Search Using quick search]<br />
<br />
==Advanced search==<br />
<br />
To get here either enter something in quick search or go to the link [https://tracker.moodle.org/issues/?jql= Tracker search page] and switch it to “Advanced” mode.<br />
Now you can enter queries in the Jira Query Language (JQL). Use as many AND, OR and parenthesis as you want. Some examples and interesting subqueries:<br />
<br />
{| class="nicetable"<br />
|-<br />
! JQL<br />
! Explanation<br />
|-<br />
| project = MDL<br />
| only issues inside project Moodle<br />
|-<br />
| resolution = Unresolved<br />
| Best way to search for open issues<br />
|-<br />
| type in (Improvement, "New Feature")<br />
| <br />
|-<br />
| votes > 50<br />
| <br />
|-<br />
| component in (Assignment, Gradebook)<br />
| where component is either Assignment or Gradebook<br />
|-<br />
| component = Assignment AND component = Gradebook<br />
| where both Assignement and Gradebook are listed as components<br />
|-<br />
| labels = patch<br />
| issues containing particular label<br />
|-<br />
| labels is empty OR labels not in (triaged, triaging_in_progress)<br />
| issues NOT containing particular label(s)<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=updatedDate%20%3E%20-7d updatedDate > -7d]<br />
| updated in the last week<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=assignee%20%3D%20currentUser%28%29%20AND%20resolution%20%3D%20Unresolved assignee = currentUser() AND resolution = Unresolved]<br />
| open issues where you are an assignee<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=reporter%20%3D%20currentUser%28%29 reporter = currentUser()]<br />
| issues reported by you<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=Participants%20%20%3D%20currentUser() Participants = currentUser()]<br />
| issues where you commented, edited or otherwise participated<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=%22Component%20watchers%22%20%3D%20currentUser()%20and%20resolution%20%3D%20Unresolved "Component watchers" = currentUser() and resolution = Unresolved]<br />
| open issues in the components where you are an automatic watcher (only tracker admins can assign automatic watchers)<br />
|-<br />
| assignee in membersOf("hq-developers")<br />
| issues assigned to members of hq-developers group<br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=status%20changed%20to%20%22Waiting%20for%20peer%20review%22%20before%20startofday%28-7%29%20and%20status%20%3D%20%22Waiting%20for%20peer%20review%22 status changed to "Waiting for peer review" before startofday(-7) and status = "Waiting for peer review"]<br />
| issues waiting for peer review for over a week<br />
|-<br />
| status WAS NOT "Development in progress" BEFORE "2011/02/02"<br />
| <br />
|-<br />
| <nowiki>issue in linkedIssues("MDL-12345")</nowiki> <br />
| issues linked to particular issue<br />
|-<br />
| <nowiki>issue in linkedIssues("MDL-12345","duplicated by")</nowiki> <br />
| <nowiki>Returns all the issues directly and indirectly duplicated by 'MDL-12345'. i.e. if there is 'MDL-12222' duplicated by 'MDL-12345' and 'MDL-11111' duplicated by 'MDL-12222', both 'MDL-11111' and 'MDL-12222' will be returned as search results.</nowiki><br />
|-<br />
| [https://tracker.moodle.org/issues/?jql=issue%20in%20favouriteIssues%28%29 issue in favouriteIssues()]<br />
| issues that you marked as favourite<br />
|}<br />
<br />
<br />
More documentation on [https://confluence.atlassian.com/jirasoftwareserver071/advanced-searching-800707146.html Advanced searching]<br />
<br />
=Using filters=<br />
<br />
To create a filter click on "Save as" button above the search:<br />
<br />
[[{{ns:file}}:savefilter1.png]]<br />
<br />
Now you can quickly access your filters but also you can subscribe to it, Click on "Details":<br />
<br />
[[{{ns:file}}:savefilter3.jpg]]<br />
<br />
and then on "New subscription":<br />
<br />
[[{{ns:file}}:savefilter4.png]]<br />
<br />
Now you will be notified daily about new issues in Assignment component. You can manage your filters and subscriptions on [https://tracker.moodle.org/secure/ManageFilters.jspa Manage filters] page.<br />
Watchers automatically receive notifications about the updates of the issues they are watching. Using filter subscription you can either monitor issues that you are not watching or monitor issues that are in particular state and were not updated.<br />
<br />
==Useful queries==<br />
# [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20and%20resolution%20%3D%20unresolved%20and%20type%20in%20%28bug%29%20and%20%22Affected%20Branches%22%20!~%20MOODLE_31_STABLE%20and%20%22Affected%20Branches%22%20!~%20MOODLE_30_STABLE%20and%20reporter%20%3D%20currentUser%28%29 Issues reported by me not against current versions] - make sure that you keep track of your own issues!<br />
# [https://tracker.moodle.org/issues/?jql=component%20in%20%28componentsLeadByUser%28%29%29%20AND%20resolution%20%3D%20Unresolved%20AND%20updatedDate%20%3E%20-14d%20AND%20project%20%3D%20MDL%20AND%20%28%20labels%20is%20EMPTY%20OR%20labels%20not%20in%20%28triaged%2C%20triaging_in_progress%29%29%20ORDER%20BY%20updatedDate%20ASC Untriaged issues in my components] (works only for component leads)<br />
# [https://tracker.moodle.org/issues/?jql=status%20changed%20to%20%22Waiting%20for%20peer%20review%22%20before%20startofday(-21)%20and%20status%20%3D%20%22Waiting%20for%20peer%20review%22 Waiting for peer review for 21 days]<br />
# [https://tracker.moodle.org/issues/?filter=19324 Integrated this week] - subscribe to this filter on Fridays and keep yourself up-to-date with what is happening in Moodle<br />
<br />
[[Category:Tracker]]</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=58624Question bank improvements for Moodle 4.02021-04-01T12:49:31Z<p>Finns: /* Contributors (workforce) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Development in progress<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by Thomas Korner, [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
<br />
The project has been explained in detail in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread], so for more details, please read that.<br />
<br />
== Project support ==<br />
<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
<br />
== Work-in-progress ==<br />
<br />
In time, we will and more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Dublin City University, Ireland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
* Yvonne Wolf<br />
<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
This institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finnshttps://docs.moodle.org/dev/index.php?title=Question_bank_improvements_for_Moodle_4.0&diff=58620Question bank improvements for Moodle 4.02021-03-30T08:14:05Z<p>Finns: /* Contributors (financially) */</p>
<hr />
<div>{{Infobox Project<br />
|name = Question bank improvements for Moodle 4.0<br />
|state = Development in progress<br />
|tracker = MDL-70329<br />
|discussion = https://moodle.org/mod/forum/discuss.php?d=417599<br />
|assignee = Project instigated by Thomas Korner, [[User:Luca_B%C3%B6sch|Luca Bösch]], [[User:Tim Hunt|Tim Hunt]], Antonia Bonaccorso. Implementation by Catalyst AU<br />
}}<br />
{{Moodle_4.0}}<br />
<br />
This is a project to largely re-develop the question bank for Moodle 4.0 (if possible). The aim is to<br />
<br />
* add some important new features, like question versioning, and making it easier to track where each question is used.<br />
* improve how the code is organised, for example by introducing a new 'Question bank plugin' type (qbank_).<br />
* and fix some long-standing bugs, for example the problems with question backup and restore.<br />
<br />
The project has been explained in detail in [https://moodle.org/mod/forum/discuss.php?d=417599 this forum thread], so for more details, please read that.<br />
<br />
== Project support ==<br />
<br />
This project is proceeding thanks to the support of [[Question_bank_improvements_for_Moodle_4.0#Contributors|a number of universities and other organisations]] who crowd-funded the development.<br />
<br />
== Work-in-progress ==<br />
<br />
In time, we will and more information here, for example links to a prototype site.<br />
<br />
== Contributors ==<br />
<br />
=== Contributors (initiators) ===<br />
* The Open University<br />
* ETH Zurich<br />
* BFH Bern University of Applied Sciences<br />
<br />
=== Contributors (financially) ===<br />
* Berlin Institute of Technology (Technische Universität Berlin), Germany<br />
* Dublin City University, Ireland<br />
* Hochschule Hannover - University of Applied Sciences and Arts, Germany <sup>*</sup><br />
* Johannes Kepler University Linz, Austria<br />
* University of Applied Sciences and Arts Northwestern Switzerland, Switzerland<br />
* Zurich University of Applied Sciences, Switzerland <sup>*</sup><br />
<br />
=== Contributors (workforce) ===<br />
* Catalyst Australia<br />
<br />
=== Overflowing funds from the SEB deeper integration project ===<br />
This institutions are credited here since they participated in the Safe Exam Browser deeper integration project. The remaining funds were allowed to be used in this project here.<br />
<br />
* Berlin School of Economics and Law, Germany<br />
* Neubrandenburg University of Applied Sciences, Germany<br />
* Ruhr-University Bochum, Germany<br />
* University of Applied Sciences Upper Austria, Austria<br />
<br />
<sup>*</sup> Institutions funding in both SEB deeper integration as well as Question bank improvements for Moodle 4.0 project</div>Finns