MoodleDocs - User contributions [en]

sandbox

2025-08-25T13:23:44Z

Tsala:

{{Template:WillNotMigrate}}
For playing around in....

Testing math tags...

<math>\int_{-\infty}^\infty \psi^{-x^{tim}}\,dx = \sqrt{hunt^4}</math>

<math>\int_{-\infty}^\infty \psi^{-x^{tim}}\,dx = \sqrt{hunt^3}</math>

<style>
.page-sandbox #siteNotice {
display: none;
}
</style>

MediaWiki:Sidebar

2025-08-25T13:21:44Z

Tsala: removing 4.4 link

* mainpage | mainpage | fas fa-angle-left

Availability API for items within a module

2025-06-18T15:10:50Z

Tsala: removing migrated template as page is linked from https://moodledev.io/docs/5.1/apis/subsystems/availability#using-availability-conditions-in-other-areas

{{Moodle 2.7}}

== Introduction ==

The [[Availability API]] provides availability controls for activity modules (course-modules) and sections. It can also be used, with some limitations, to implement an interface for availability restrictions within a module (if you wanted to add different restrictions to different pages within a Book, for example).

== Limitations ==

The following limitations currently apply:

* The editing interface must be within a Moodle form.
* You may only have a single 'Restrict access' control on a page. (This means that you can't have a second one on your main module settings form, as that already has one; you would have to put this on a separate form.)
* The API only works within a course. You can't use it for system-level items.
* '''None of this has been tested for real.''' The API wasn't really designed for this so although it seems to work perfectly well, there may be some catch.

== How to implement ==

To implement the API for an item within your module, assuming that item has its own editing form, you need to do the following:

* Editing interface:
** Add code to the form definition to add the 'restrict access' field and JavaScript.
** Add code to the form validation to check its results.
** Store the returned 'availabiltyconditionsjson' value in a suitable database location when the form is saved, and ensure this value is provided in the normal form data when displaying the form.
* Back-end class:
** Implement a new class that extends \core_availability\info with regard to your type of item.
** This class needs to provide the availability settings value to the parent class, supply a name for debugging purposes, have a mechanism to set the value in the database, and return a Moodle context relating to the item.
* Implement backup and restore:
** Include the availabilityconditionsjson value in backup and restore as usual.
** After restore completes (NOT during restore of your individual module - must be after all modules were restored), create an instance of your class and call the update_after_restore function.
* Check availability:
** Check Moodle capabilities that may mean the current user bypasses the restrictions.
** Construct an object of your class and call the is_available function.
** Use the returned data to control whether your item displays (or whether we show information about when it will be available, or whether we don't show anything at all).

== Example ==

This example is a complete script, demonstrating everything except backup/restore. If you save it as silly.php within mod/page, and then call it as silly.php?id=1234 where 1234 is a valid page id, you'll be able to set an availability condition with the form and see the result.

Note: For real use you would probably create several suitably namespaced classes, rather than slinging everything into one script. The single script here is just an example.

<syntaxhighlight lang="php">
require(__DIR__ . '/../../config.php');
require_once($CFG->libdir . '/formslib.php');

// Standard Moodle setup for module access.
$id = required_param('id', PARAM_INT);
$course = $DB->get_record_sql("
SELECT c.*
FROM {course_modules} cm
JOIN {course} c ON c.id = cm.course
WHERE cm.id = ?", array($id), MUST_EXIST);
$modinfo = get_fast_modinfo($course);
$cm = $modinfo->get_cm($id);
require_login($course, true, $cm);

// Set up page stuff.
$pageurl = new moodle_url('/mod/page/silly.php', array('id' => $id));
$PAGE->set_url($pageurl);
$PAGE->set_context(context_module::instance($id));

// Define a form that includes availability settings.
class mod_mymodule_silly_form extends moodleform {
public function definition() {
global $COURSE;

$mform = $this->_form;
$cm = $this->_customdata->cm;
$mform->addElement('hidden', 'id', $cm->id);
$mform->setType('id', PARAM_INT);

// Use this code to add the 'Restrict access' section.
// NOTE: Due to limitations in the JavaScript and CSS, you may only
// have one of these fields on a page! Sorry.
$mform->addElement('header', 'availabilityconditionsheader',
get_string('restrictaccess', 'availability'));
$mform->addElement('textarea', 'availabilityconditionsjson',
get_string('accessrestrictions', 'availability'));
\core_availability\frontend::include_all_javascript($COURSE, $cm);

$this->add_action_buttons(false);
}

public function validation($data, $files) {
$errors = array();

// Use this code to validate the 'Restrict access' section.
\core_availability\frontend::report_validation_errors($data, $errors);

return $errors;
}
}

// Custom availability class. You need one of these for each type of items that
// can have availability, so there's one in core for modules and one for
// sections, and you make a new one if you put availability on anything else.
class mod_mymodule_availability_info extends \core_availability\info {
protected $cm;

// You would probably define more suitable parameters here about the
// specific thing you're controlling availability for.
public function __construct(\cm_info $cm, $availability) {
// You should probably set the $visible parameter to 'true' unless
// you want to implement a separate eye icon for your thingy.
parent::__construct($cm->get_course(), true, $availability);
$this->cm = $cm;
}

protected function get_thing_name() {
// This may be used in error messages etc. You would probably use
// the name of the thing you're controlling availability for.
return 'Special thing within module';
}

protected function set_in_database($availability) {
// This function should save the availability settings back to database.
// It's needed if doing an update after restore, so you do need to
// implement it.
}

public function get_context() {
return \context_module::instance($this->cm->id);
}

// I didn't bother to implement filter_user_list, so it's using the default
// which considers only this condition. You might want to make a
// filter_user_list that takes into account the course-module's permissions
// too (like how the info_module class includes the section), if you expect
// to actually use the 'list users who can access this' APIs.
}

$mform = new mod_mymodule_silly_form('silly.php', (object)array('cm' => $cm));
if ($data = $mform->get_data()) {
// Because this is a silly test, we're not going to store the availability
// settings in the database, instead we put it in user session.
$SESSION->mod_mymodule_silly_availability = $data->availabilityconditionsjson;
redirect($pageurl);
}

echo $OUTPUT->header();

// If there is some availability data...
if (isset($SESSION->mod_mymodule_silly_availability)) {
// Set form data.
$mform->set_data(array('availabilityconditionsjson' => $SESSION->mod_mymodule_silly_availability));

// Check availability. Note that this does NOT take into account any
// capabilities the user might have - you probably want to check for
// viewhiddenactivities capability and skip availability checks in that
// case.
$info = new mod_mymodule_availability_info($cm, $SESSION->mod_mymodule_silly_availability);
$information = '';
$available = $info->is_available($information);

// Because this is a test page, we'll just display whether it's available or
// not, and the message(s) if it isn't.
echo html_writer::start_tag('ul');
echo html_writer::tag('li', $available ? 'This page IS available to you' :
'This page IS NOT available to you');
if (!$available) {
echo html_writer::tag('li', $information === '' ?
'No information displayed (hide entirely)' :
'Information displayed (show info)');
}
echo html_writer::end_tag('ul');
if (!$available) {
echo html_writer::start_div();
echo $information;
echo html_writer::end_div();
}
}

$mform->display();
echo $OUTPUT->footer();
</syntaxhighlight>

Main Page

2025-03-12T15:29:19Z

Tsala:

{{#addbodyclass:moodledocs-mainpage}}
{{#addbodyclass:moodledocs-logo}}
<div class="navtrail">[https://docs.moodle.org/overview/ Docs overview] ► [[{{PAGENAME}}|Dev docs]]</div>
__NOTOC__
'''Welcome to our old Developer Documentation.''' This site has been replaced by the [https://moodledev.io Moodle Developer Resource] site.

If you manage a Moodle site, or if you teach using Moodle, try the [[:en:Main_page|User documentation]].

<div class="card-deck">
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Overview]]</h4>
<p class="card-text">
* [[Mission]]
* [[Roadmap]]
* [[Releases]]
* [[Process|Development processes]]
* [[:Category:Processes]]
* [[Developer meetings]]
* [https://moodle.org/mod/forum/view.php?id=55 General developer forum]
* [https://docs.moodle.org/dev/Chat Telegram Moodle Dev Chat room]
* [http://moodle.org/dev Developer credits/statistics]
* [https://moodle.org/ux Moodle User Experience (UX)]
* [[Moodle_research|Research]]
* [[Testing]]
</p>
</div>
<div class="card-footer">
: [[Overview|More overview info <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Plugins|Plugin development]]</h4>
<p class="card-text">
* [[Activity modules]]
* [[Blocks]]
* [[Themes]]
* [[Course formats]]
* [[Enrolment plugins]]
* [[Authentication plugins]]
* [[Repository plugins]]
* [[Filters]]
</p>
</div>
<div class="card-footer">
: [[Plugins|Full list of plugin types <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Core APIs]]</h4>
<p class="card-text">
* [[Access API]]
* [[Data manipulation API]]
* [[Exporter|Exporter API]]
* [[File API]]
* [[Form API]]
* [[Migrating logging calls in plugins|Logging]]
* [[Navigation API]]
* [[Page API]]
* [[Persistent|Persistent API]]
* [[Output API]]
* [[String API]]
* [[Web service API functions]]
</p>
</div>
<div class="card-footer">
: [[Core APIs|Full list of core APIs <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
</div>
<div class="card-deck mt-3">
<div class="card">
<div class="card-body">
<h4 class="card-title">Guidelines</h4>
<p class="card-text">
* [[Moodle 4.0 developer update]]
* [[Coding|Coding guidelines]]
* [[Git_for_developers|Git use]]
* [[Plugin contribution|Contributing plugins]]
* [[How_to_create_a_patch|Creating patches]]
* [[PHPUnit|PHPUnit tests]]
* [[Acceptance testing]]
* [[Writing_PHPUnit_tests|Writing tests with PHPUnit]]
* [[Testing_instructions_guide|Writing manual testing instructions for an issue]]
* [[Aria Guidelines]]
* [[HTML Guidelines]]
* [[Automatic class loading]]
* [[Templates]]
* [[Javascript Modules]]
* [[AJAX]]
* [[Communication Between Components]]
</p>
</div>
<div class="card-footer">
: [[:Category:Guidelines|More guidelines <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[:Category:Developer tools|Developer tools]]</h4>
<p class="card-text">
* [[Linting]]
* [[Setting up Eclipse]]
* [[Setting up Netbeans]]
* [[:Category:Firefox extensions|Firefox extensions]]
</p>
</div>
<div class="card-footer">
: [[:Category:Developer tools|Full list of developer tools <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Moodle App]]</h4>
<p class="card-text">
* [[Moodle App Overview]]
* [[Moodle App Development Guide]]
* [[Moodle App Plugins Development Guide]]
* [[Moodle App Customization]]
* [[Moodle App FAQ]]
</p>
</div>
<div class="card-footer">
: [[:Category:Mobile|Full list of Moodle App documentation <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
</div>

MediaWiki:Sitenotice

2025-03-12T15:27:02Z

Tsala: Update - site in read-only mode

{| class="alert alert-info"
|style="padding: 0.7em 0.5em 0.5em;" | '''Note:'''
This site is no longer used and is in read-only mode. Instead please go to our new '''[https://moodledev.io Moodle Developer Resource]''' site.

|}

Main Page

2025-03-12T15:25:17Z

Tsala: Update - site in read-only mode

{{#addbodyclass:moodledocs-mainpage}}
{{#addbodyclass:moodledocs-logo}}
<div class="navtrail">[https://docs.moodle.org/overview/ Docs overview] ► [[{{PAGENAME}}|Dev docs]]</div>
__NOTOC__
'''Welcome to our old Developer Documentation site.'''

This site is no longer used and is in read-only mode. Instead please go to our new '''[https://moodledev.io Moodle Developer Resource]''' site.

If you manage a Moodle site, or if you teach using Moodle, try the [[:en:Main_page|User documentation]].

<div class="card-deck">
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Overview]]</h4>
<p class="card-text">
* [[Mission]]
* [[Roadmap]]
* [[Releases]]
* [[Process|Development processes]]
* [[:Category:Processes]]
* [[Developer meetings]]
* [https://moodle.org/mod/forum/view.php?id=55 General developer forum]
* [https://docs.moodle.org/dev/Chat Telegram Moodle Dev Chat room]
* [http://moodle.org/dev Developer credits/statistics]
* [https://moodle.org/ux Moodle User Experience (UX)]
* [[Moodle_research|Research]]
* [[Testing]]
</p>
</div>
<div class="card-footer">
: [[Overview|More overview info <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Plugins|Plugin development]]</h4>
<p class="card-text">
* [[Activity modules]]
* [[Blocks]]
* [[Themes]]
* [[Course formats]]
* [[Enrolment plugins]]
* [[Authentication plugins]]
* [[Repository plugins]]
* [[Filters]]
</p>
</div>
<div class="card-footer">
: [[Plugins|Full list of plugin types <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Core APIs]]</h4>
<p class="card-text">
* [[Access API]]
* [[Data manipulation API]]
* [[Exporter|Exporter API]]
* [[File API]]
* [[Form API]]
* [[Migrating logging calls in plugins|Logging]]
* [[Navigation API]]
* [[Page API]]
* [[Persistent|Persistent API]]
* [[Output API]]
* [[String API]]
* [[Web service API functions]]
</p>
</div>
<div class="card-footer">
: [[Core APIs|Full list of core APIs <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
</div>
<div class="card-deck mt-3">
<div class="card">
<div class="card-body">
<h4 class="card-title">Guidelines</h4>
<p class="card-text">
* [[Moodle 4.0 developer update]]
* [[Coding|Coding guidelines]]
* [[Git_for_developers|Git use]]
* [[Plugin contribution|Contributing plugins]]
* [[How_to_create_a_patch|Creating patches]]
* [[PHPUnit|PHPUnit tests]]
* [[Acceptance testing]]
* [[Writing_PHPUnit_tests|Writing tests with PHPUnit]]
* [[Testing_instructions_guide|Writing manual testing instructions for an issue]]
* [[Aria Guidelines]]
* [[HTML Guidelines]]
* [[Automatic class loading]]
* [[Templates]]
* [[Javascript Modules]]
* [[AJAX]]
* [[Communication Between Components]]
</p>
</div>
<div class="card-footer">
: [[:Category:Guidelines|More guidelines <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[:Category:Developer tools|Developer tools]]</h4>
<p class="card-text">
* [[Linting]]
* [[Setting up Eclipse]]
* [[Setting up Netbeans]]
* [[:Category:Firefox extensions|Firefox extensions]]
</p>
</div>
<div class="card-footer">
: [[:Category:Developer tools|Full list of developer tools <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
<div class="card">
<div class="card-body">
<h4 class="card-title">[[Moodle App]]</h4>
<p class="card-text">
* [[Moodle App Overview]]
* [[Moodle App Development Guide]]
* [[Moodle App Plugins Development Guide]]
* [[Moodle App Customization]]
* [[Moodle App FAQ]]
</p>
</div>
<div class="card-footer">
: [[:Category:Mobile|Full list of Moodle App documentation <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
</div>

XMLDB Documentation

2024-12-13T13:26:51Z

Tsala:

__NOTOC__

XMLDB is Moodle's database abstraction layer -- it is the library of code that lets Moodle interact with and access the database.

In this page you will find links to all the XMLDB-related documentation.

=== Introduction ===

* [[XMLDB introduction|Introduction]]: Where the general idea of XMLDB is explained.
* [[XMLDB roadmap|Roadmap]]: An overall view of the process of implementing the XMLDB subsystem, with details for each point of the process.
* [[XMLDB problems|Problems]]: A comprehensive list of issues that need to be determined/solved prior to incorporate them into the [[XMLDB roadmap|roadmap]].

=== Installation ===

* [[:en:Installing MSSQL for PHP|Installing MSSQL for PHP]]: One short manual about the steps needed to successfully add MSSQL support to PHP.
* [[:en:Installing Moodle|Installing Moodle]]: The guide to install Moodle (once you have the [[:en:Installing AMP|AMP platform]] working on your server).

=== Developing ===

* [[DDL functions|DDL functions]]: One list of the new XMLDB Data Definition functions and their usage.
* [[DML functions|DML functions]]: One list of the available Data Manipulation functions and their usage.
* [[XMLDB defining an XML structure|XMLDB Usage]]: Explanation about the XML schema basis, the [[XMLDB defining an XML structure#The XMLDB editor|XML editor]] embedded within Moodle, its [[XMLDB defining an XML structure#Conventions|naming conventions]] and one simple but illustrative [[XMLDB defining an XML structure#One example: the assignment module|example]].
* [[Installing and upgrading plugin database tables]]
* [[Coding|Coding guidelines]]: The main coding guidelines and, more exactly, the [[Database|database structures section]] that you must follow carefully in order to produce good cross-db code.
* [[Database Schema|Database schema]]: Moodle database diagrams in [http://fabforce.net/dbdesigner4/ DBDesigner4] format.

=== Bugs and new features ===

* [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&&type=1&pid=10011&resolution=-1&component=10131&sorter/field=issuekey&sorter/order=DESC XMLDB known bugs]
* [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&&type=4&type=2&type=3&type=5&pid=10011&resolution=-1&component=10131&sorter/field=issuekey&sorter/order=DESC XMLDB pending improvements and features]
* [http://moodle.org/mod/forum/view.php?id=55 Developers forum]: For general development discussions.

=== Database engine documentation ===

Here are convenient links to the reference documentation of the various database engines we support, should you need to check that something is supported by all of them:

* [http://www.postgresql.org/docs/8.4/interactive/index.html Postgres]
* [http://dev.mysql.com/doc/refman/5.0/en/index.html MySQL]
* [http://msdn.microsoft.com/en-us/library/ms189826.aspx MSSQL]

=== See also ===
* [[XMLDB column types|DB column types]] - Some links about column types inside every RDBMS and their characteristics.
* [[XMLDB key and index naming|DB key and index naming]] - Some info about automatic naming of keys/indexes and other objects.
* [[XMLDB reserved words|DB reserved words]] - A collection of reserver words inside each RDBMS.

[[Category:XMLDB]]
[[Category:DB]]

[[ja:XMLデータベーススキーマ]]

MediaWiki:Sidebar

2024-03-26T10:19:13Z

Tsala: version update

String API

2024-01-16T09:08:24Z

Tsala: /* Help strings */ stringname_link update - MDLSITE-7236

==Overview==
The String API is how you get language text strings to use in the user interface. It handles internationalisation issues, and will use a number of settings and environment variables to present the best text to every user. Moodle has a mechanism that allows a number of places to be searched (in order) to find language strings. This enables language strings to be packaged with plugins and avoids the step of having to copy the language files over to the language directory when a plugin is installed.

Moodle also provide general string functions like substr, strlen etc. for multibyte safe, string operations. It uses mbstring or iconv for UTF-8 strings and falls back to typo3.
==Basic concepts==
When it is required to lookup a string, two basic items of information are required.
# The component providing the string.
# The identifier of the string.
Example: The function call <tt>get_string('editingquiz', 'mod_quiz')</tt> will return "Editing quiz" if the current language is English, or relevant translation of the text. Here the string identifier is "editingquiz" and the string is provided by the "mod_quiz" component (that is the Quiz activity module).
===Adding language file to plugin===
Language support for plugin(s) is added by creating a '''lang/en/''' subdirectory in the plugin directory and putting the plugin's English string file there. The name of the string file is supposed to follow the plugin's [[Frankenstyle|component name]], so that it is something like <tt>plugintype_pluginname.php</tt>.

The default "en" language is the [[:en:Language FAQ#Which_is_the_official_language_for_Moodle.3F|Australian English]] which is same as the British English when it comes to spelling and grammar. American English is a separate language pack "en_us".

There is no need to include languages other than the default English, as almost all approved [https://lang.moodle.org/mod/forum/discuss.php?d=2485 plugin strings will be automatically imported into AMOS] for translation by the language packs translators.
===Adding a string to the language file===
Strings are defined via the associative array <tt>$string</tt> provided by the string file. The array key is the string identifier, the value is the string text in the given language.
<syntaxhighlight lang="php">
$string['editingquiz'] = 'Editing quiz';
$string['editingquiz_help'] = 'Help for editing quiz';
</syntaxhighlight>
===Run-time parameters===
Strings can define placeholders like <tt>{$a}</tt> or <tt>{$a->foobar}</tt>. These placeholders are replaced with a value passed to the <tt>get_string()</tt> function call.
<syntaxhighlight lang="php">
// Strings defined in the language file.
$string['greeting'] = 'Dear {$a}';
$string['info'] = 'There are {$a->count} new messages from {$a->from}.';

// Passing values for the placeholders.
echo get_string('greeting', 'tool_example', 'Mr. Anderson');
echo get_string('info', 'tool_example', ['count' => 42, 'from' => 'Mr. Smith']);
</syntaxhighlight>
== Help strings ==
Help strings are texts that are displayed in the help tooltips. There are certain conventions on how to define them.
[[Image:Roles help popup.png|thumb|Help popup containing "More help" link]] Help strings names start with the string name of the setting to which they apply, so that they are kept together in the language file.
* ''stringname'' - identifier of the string we provide the help for, may be used as a title of the help popup
* ''stringname_help'' - string with the help text
* ''stringname_link'' - an optional string naming a path in Moodle Docs, only if required, calculated just like the link in the footer to go to the right language etc, and shown after the help text in the popup as a link with an icon to "More help...". These strings don't usually need to be translated. (They were previously hidden in the AMOS UI then unhidden in 2023. See MDLSITE-7236 for details.)
* ''stringname_desc'' - an admin setting description replacing the legacy ''configstringname''
Example:
<syntaxhighlight lang="php">
$string['submissionsize'] = 'Submission size';
$string['submissionsize_help'] = 'Blah blah blah some useful text, optionally using Markdown syntax';
$string['submissionsize_link'] = 'mod/workshop/submission';
$string['submissionsize_desc'] = 'Default value for submission size. This value will be pre-filled and can be blah blah ...';
</syntaxhighlight>
Help string text should be short and simple - two small paragraphs maximum with no headings, no links, no bold, no tables etc.

[[:en:Markdown|Markdown]] can be used for some basic formatting of strings with the "_help" suffix. It is recommended to stick to paragraphs and lists only. Markdown can only be used for help strings, not for other language strings.
=== More help links ===
To display the optional ''More help...'' link at the bottom of the help popup, a string with the "_link" suffix must exist beside the relevant "_help" string. These link strings should consist of a short relative path like 'component/thing' (eg. 'mod/folder/view' or 'group/import'). This gets turned into a link to MoodleDocs in the user's language, and for the appropriate Moodle version.

Example:
<syntaxhighlight lang="php">
$string['groupimport_link'] = 'group/import';
</syntaxhighlight>
will make a link to something like <nowiki>'https://docs.moodle.org/32/en/group/import'</nowiki> (if you are an English user of Moodle 3.2). This page in turn should be a redirect page to the actual page providing the info. Note the <nowiki>'https://docs.moodle.org'</nowiki> part comes from $CFG->docroot.

The second option is that you can give an absolute link, if you want, and that will be used unmodified.
<syntaxhighlight lang="php">
$string['patronising_link'] = <nowiki>'http://lmgtfy.com/?q=Moodle+for+dummies';</nowiki>
</syntaxhighlight>
This case is detected by seeing if the string starts with <nowiki>http:// or https://</nowiki>. This option is useful if the documentation for your plugin is hosted at Github wiki, for example.

The third option is to start the link with <tt>%%WWWROOT%%</tt>. That is replaced by <tt>$CFG->wwwroot</tt>. This is useful for contributed plugins that want to keep the help within the plugin.
=== Words for roles ===
The following words should be used in the English (en) help strings whenever it is necessary to refer to people with particular roles in a generic sense.
* Participants - all people with a role
* Teachers - people with some sort of a facilitation/editing role
* Students - people primarily there to learn
* Users - people across the site
([[User:Martin Dougiamas|Martin Dougiamas]] 16:13, 20 April 2010 (UTC): I'm not entirely comfortable with this choice even though I just re-confirmed it, as I'd prefer to be using words like facilitator/moderator to subtly and continually promote a less transmissionist pedgagogy and I know many Moodle users would agree. However, I think these terms are far more commonly used in the community and in discussion, and from the point of view that we need to build a consistent system for usability they are less distracting and better for documentation.)

==Files==
String functions are defined in
# lib/moodlelib.php - locale related functions
# lib/textlib.class.php - general string functions (substr, strlen etc.)
==Functions and examples==
There are three main functions, used in moodle for getting/displaying the localised string, based on user preferred language.
===get_string()===
Returns a localised string for current user.

Example for displaying string "This is my plug-in" in any language that supports on your site, then you need to use the following identifier in language file (located in appropriate lang directory)
$string['plugintitle'] = 'This is my plug-in';
If you want to display this string in any supported language, then you would use this function.
echo get_string('plugintitle', 'module_pluginlangfilename');
If you want to substitute value in the language string then use '''{$a}''' for substituting value. $a is an object, string or number that can be used within translation strings. The variable has to be $a, and it has to be in single quotes. For example, if you want to display answer number in Drag & drop plugin then add
$string['answerno1'] = 'Answer {$a}'; //Substituting string/integer
$string['answerno2'] = 'Answer {$a->name}'; //Substituting object member
in qtype_dragdrop.php (Drag & Drop language file). And call it using
//Get string by substituting integer.
get_string('answerno1', 'qtype_dragdrop', $number);
//Get string by substituting object member integer
$user->number = 10;
get_string('answerno2', 'qtype_dragdrop', $user);
In Moodle 2.3 there is a new argument to this function $lazyload. Setting $lazyload to true causes get_string to return a lang_string object rather than the string itself.
$stringobject = get_string('answerno', 'qtype_dragdrop', $number, true);
The fetching of the string is then put off until the string object is first used. The object can be used by calling it's out method or by casting the object to a string, either directly e.g.
(string)$stringobject
or indirectly by using the string within another string or echoing it out e.g.
echo $stringobject;
return "<p>{$stringobject}</p>";
Note: using $lazyload and attempting to use the string as an array key will cause a fatal error as objects cannot be used as array keys.
===get_strings()===
Converts an array of string names to localised strings for a specific plugin. lazy loading is not supported in this function.
$txt = get_strings(array('enable', 'disable', 'up', 'down', 'none'), 'qtype_dragdrop');
echo $txt->up; //Display localised string for up
echo $txt->down //Display localised string for down
===print_string()===
Prints out a translated string by using '''get_string()''' function
===lang_string class===
In Moodle 2.3 a special class (lang_string) is used to create an object representation of a string request. In this case string processing doesn't occur until the object is first used. The class was created especially to aid performance in areas where strings were required to be generated but were not necessarily used. As an example the admin navigation tree when generated uses over 1500 strings, of which normally only 1/3 are ever actually printed at any time. The performance advantage is achieved by not actually processing strings that aren't being used, as such reducing the processing required for the page.

lang_string class can be used in two ways
# Setting $lazyload (fourth argument of the get_string function), to true.
$string = get_string('yes', 'qtype_dragdrop', null, true);
# Direct instantiation
$string = new lang_string('yes', 'qtype_dragdrop', null, 'en');
== String manager ==
Most of function listed above are just handful wrappers for the methods provided by the string manager class. Some strings related functionality is available only via directly calling the manager's methods.
<syntaxhighlight lang="php">
$stringman = get_string_manager();
</syntaxhighlight>
The factory function get_string_manager() returns singleton instance of <tt>core_string_manager_install</tt> in early stages of the site installation, or instance of <tt>core_string_manager_standard</tt> in all normal situations. These managers implement interface <tt>core_string_manager</tt>. Methods provided by the interface are
;get_string():Returns the given component string localised in the given language. Can be used to obtain the translation of the string in the other language than the current user's language.
;string_exists():Does the given string actually exist? This is typically checked by a code like
<syntaxhighlight lang="php">
if (get_string_manager()->string_exists('stringidentifier', 'component_name')) {
// Do something.
}
</syntaxhighlight>
;string_deprecated():Has the string been deprecated? See [[String deprecation]] for details.
;get_list_of_countries():Returns a localised list of all country names, sorted by country keys.
;get_list_of_languages():Returns a localised list of languages, sorted by code keys.
;translation_exists():Checks if the translation exists for the given language.
;get_list_of_translations():Returns localised list of installed language packs.
;get_list_of_currencies():Returns localised list of known currencies.
;load_component_strings():Loads all strings for one component.
;reset_caches():Invalidates all caches, should the manager use some.
;get_revision():Returns string revision counter.
=== Custom string managers ===
{{Moodle 2.9}}Plugins can provide custom implementation of the string manager. This is supposed to be used in experimental and/or development scenarios only, not in typical production environment. See MDL-49361 for use cases and implementation details. An example of such an implementation can be found at [https://github.com/mudrd8mz/moodle-local_stringman moodle-local_stringman.git] repository.
<syntaxhighlight lang="php">
// Custom string manager class can be defined in the main config.php file.
$CFG->customstringmanager = '\local_stringman\dummy_string_manager';
</syntaxhighlight>
==textlib (core_text) class==
textlib class provide pool of safe functions to operate on UTF-8 text. textlib provide set of static functions to operate on strings and gets included in setup.php

{{Moodle 2.6}}In Moodle 2.6 the textlib class was renamed to '''core_text'''.
===asort()===
Locale aware sorting, the key associations are kept, values are sorted alphabetically.
===code2utf8===
Returns the utf8 string corresponding to the unicode value
===convert===
Converts the text between different encodings. It uses iconv extension with //TRANSLIT parameter, fall back to typo3
===encode_mimeheader===
Generate a correct base64 encoded header to be used in MIME mail messages.
===entities_to_utf8===
Converts all the numeric entities &#nnnn; or &#xnnn; to UTF-8
===specialtoascii===
Converts upper unicode characters to plain ascii, the returned string may contain unconverted unicode characters.
===strlen===
Multibyte safe strlen() function, uses iconv for utf-8, falls back to typo3.
===strpos===
Find the position of the first occurrence of a substring in a string. UTF-8 ONLY safe strpos(), uses iconv.
===strrpos===
Find the position of the last occurrence of a substring in a string. UTF-8 ONLY safe strrpos(), uses iconv.
===strtolower===
Multibyte safe strtolower() function, uses mbstring, falls back to typo3.
===strtotitle===
Makes first letter of each word capital - words must be separated by spaces.
===strtoupper===
Multibyte safe strtoupper() function, uses mbstring, falls back to typo3.
===substr===
Multibyte safe substr() function, uses iconv for utf-8, falls back to typo3.
===trim_utf8_bom===
Removes the BOM from unicode string. [http://unicode.org/faq/utf_bom.html more info]
===utf8_to_entities===
Converts all Unicode chars > 127 to numeric entities &#nnnn; or &#xnnn;
==FAQ==
===When should I use a lang_string object?===
The lang_string object is designed to be used in any situation where a string may not be needed, but needs to be generated. The admin navigation tree is a good example of where lang_string objects should be used. A more practical example would be any class that requires strings that may not be printed (after all classes get renderer by renderers and who knows what they will do ;))
===When should I not use a lang_string object?===
Don't use lang_strings when you are going to use a string immediately. There is no need as it will be processed immediately and there will be no advantage, and in fact perhaps a negative hit as a class has to be instantiated for a lang_string object, however get_string won't require that.
===Limitation of lang_string===
lang_string object cannot be used as an array offset. Doing so will result in PHP throwing an error. (You can use it as an object property!)
===How to compare strings properties in two object===
collatorlib_property_comparison class can be used to compare properties of two objects
===Should the colon sign be hard-coded or included in a language string?===
The colon sign should not be hard-coded because languages may use a different symbol, or have a space before or after the colon sign. Instead, the colon sign may be included in a language string, though please consider first if it is really necessary. A colon sign in a field label is not recommended. (MDL-12192 is for removing existing hard-coded colon signs.)<syntaxhighlight lang="php">
// Do NOT hard code any punctuation:
$string['fieldname'] = 'Name';

echo get_string('fieldname', 'mod_foobar') . ': ' . $somevalue;

// Slightly better with no hard coded colon:
$string['fieldname'] = 'Name: ';

echo get_string('fieldname', 'mod_foobar') . $somevalue;

// Better with no assumed word order:
$string['fieldname'] = 'Name: {$a->name}';

echo get_string('fieldname', 'mod_foobar', ['name' => $somevalue]);

</syntaxhighlight>

===Changing or creating a new lang string?===
New strings were required in 1.x times when we did not have branches for translations. Since 2.0, for changes in master, structural and/or semantic modification of a string (such as adding or removing {$a} placeholders etc) is acceptable as such strings are highlighted in AMOS as outdated. Of course, if lang pack maintainers do not pay attention to it, mismatch can happen - but this is considered to be the lang pack bug.

When a new string is introduced, the old one should be [[String deprecation | deprecated or removed]] so that unused strings do not accumulate.
:A) Basically I see it as (for master only issues):
:
:# Any change is allowed (semantic or structural). It does not have sense to keep the old string because there won't be use for it when the new Moodle version is released. So we can forget about the old one 100%. Of course if the string is radically different, then it may have sense to create a new, completely different string (and proceed with next point).
:# If for any reason we stop using any string (because a feature is out or because we have decided to create a new different string instead of change existing)), then:
:#* if the old string is really specific (not suitable for reuse) we can safely proceed to delete it,.
:#* If the string belongs to a plugin, IMO we can also proceed to delete it (reuse of plugin strings should not be allowed).
:#* But, if the string is generic (may be reused) and it's not part of a plugin then the string must be deprecated.

:B) And, for issues involving stables, only small semantic changes are allowed. No structural, no deprecation and no deletion. Ever. If still something different must be shown it will be, always, via new string. When applied to master, these changes will also imply the [[String deprecation | standard old string deprecation]]. No CPY instruction will be performed between the old and the new strings (safest, easier, consistent behavior, no matter there are some cases where the instruction may be acceptable. Stop overthinking. Now!).
===User names placeholders===
Some strings may contain placeholders to display the user's name. Common examples include various email templates or welcome messages. Developers may be tempted to use just the user's firstname in such cases, to make the text feel informal and friendlier:
<syntaxhighlight lang="php">
// Do NOT do this.
$string['welcome'] = 'Hello {$a}! Welcome to the course.';
</syntaxhighlight>
But some cultures or institutions may want the full name or last name to be used, rather than the first name. To enable sites to easily customise such strings and have lastname and alternatename placeholders available, the following pattern should be used.

Let the language strings file for the given component define the default display of the name:
<syntaxhighlight lang="php">
$string['welcome'] = 'Hello {$a->firstname}! Welcome to the course.';
</syntaxhighlight>
Then in the file making use of the string:
<syntaxhighlight lang="php">
$namefields = [
'fullname' => fullname($USER),
'alternativefullname' => fullname($USER, true),
];

foreach (\core_user\fields::get_name_fields() as $namefield) {
$namefields[$namefield] = $USER->{$namefield};
}

echo get_string('welcome', 'xyz_component', $namefields);
</syntaxhighlight>
That way, the string can be locally customised and use any combination of the following placeholders as needed: firstnamephonetic, lastnamephonetic, middlename, alternatename, firstname, lastname, fullname and alternativefullname.
<syntaxhighlight lang="php">
// Locally customised variant of the string.
$string['welcome'] = 'Welcome to the course, {$a->fullname}';
</syntaxhighlight>
==See also==
* [[Output_functions]]
* [[Core APIs]]
* [[AMOS]]
* The section 'Language strings' in [[Coding style]]
* [[String deprecation]]
* [[Improving English language strings]]
[[Category:API]]
[[Category:Language]]

String API

2023-05-03T05:38:41Z

Tsala: /* Help strings */ _link strings hidden in AMOS (MDLSITE-7236)

==Overview==
The String API is how you get language text strings to use in the user interface. It handles internationalisation issues, and will use a number of settings and environment variables to present the best text to every user. Moodle has a mechanism that allows a number of places to be searched (in order) to find language strings. This enables language strings to be packaged with plugins and avoids the step of having to copy the language files over to the language directory when a plugin is installed.

Moodle also provide general string functions like substr, strlen etc. for multibyte safe, string operations. It uses mbstring or iconv for UTF-8 strings and falls back to typo3.
==Basic concepts==
When it is required to lookup a string, two basic items of information are required.
# The component providing the string.
# The identifier of the string.
Example: The function call <tt>get_string('editingquiz', 'mod_quiz')</tt> will return "Editing quiz" if the current language is English, or relevant translation of the text. Here the string identifier is "editingquiz" and the string is provided by the "mod_quiz" component (that is the Quiz activity module).
===Adding language file to plugin===
Language support for plugin(s) is added by creating a '''lang/en/''' subdirectory in the plugin directory and putting the plugin's English string file there. The name of the string file is supposed to follow the plugin's [[Frankenstyle|component name]], so that it is something like <tt>plugintype_pluginname.php</tt>.

The default "en" language is the [[:en:Language FAQ#Which_is_the_official_language_for_Moodle.3F|Australian English]] which is same as the British English when it comes to spelling and grammar. American English is a separate language pack "en_us".

There is no need to include languages other than the default English, as almost all approved [https://lang.moodle.org/mod/forum/discuss.php?d=2485 plugin strings will be automatically imported into AMOS] for translation by the language packs translators.
===Adding a string to the language file===
Strings are defined via the associative array <tt>$string</tt> provided by the string file. The array key is the string identifier, the value is the string text in the given language.
<syntaxhighlight lang="php">
$string['editingquiz'] = 'Editing quiz';
$string['editingquiz_help'] = 'Help for editing quiz';
</syntaxhighlight>
===Run-time parameters===
Strings can define placeholders like <tt>{$a}</tt> or <tt>{$a->foobar}</tt>. These placeholders are replaced with a value passed to the <tt>get_string()</tt> function call.
<syntaxhighlight lang="php">
// Strings defined in the language file.
$string['greeting'] = 'Dear {$a}';
$string['info'] = 'There are {$a->count} new messages from {$a->from}.';

// Passing values for the placeholders.
echo get_string('greeting', 'tool_example', 'Mr. Anderson');
echo get_string('info', 'tool_example', ['count' => 42, 'from' => 'Mr. Smith']);
</syntaxhighlight>
== Help strings ==
Help strings are texts that are displayed in the help tooltips. There are certain conventions on how to define them.
[[Image:Roles help popup.png|thumb|Help popup containing "More help" link]] Help strings names start with the string name of the setting to which they apply, so that they are kept together in the language file.
* ''stringname'' - identifier of the string we provide the help for, may be used as a title of the help popup
* ''stringname_help'' - string with the help text
* ''stringname_link'' - an optional string naming a path in Moodle Docs, only if required, calculated just like the link in the footer to go to the right language etc, and shown after the help text in the popup as a link with an icon to "More help...". These strings don't need to be translated, so are hidden in the AMOS UI (with the exception of some TinyMCE strings).
* ''stringname_desc'' - an admin setting description replacing the legacy ''configstringname''
Example:
<syntaxhighlight lang="php">
$string['submissionsize'] = 'Submission size';
$string['submissionsize_help'] = 'Blah blah blah some useful text, optionally using Markdown syntax';
$string['submissionsize_link'] = 'mod/workshop/submission';
$string['submissionsize_desc'] = 'Default value for submission size. This value will be pre-filled and can be blah blah ...';
</syntaxhighlight>
Help string text should be short and simple - two small paragraphs maximum with no headings, no links, no bold, no tables etc.

[[:en:Markdown|Markdown]] can be used for some basic formatting of strings with the "_help" suffix. It is recommended to stick to paragraphs and lists only. Markdown can only be used for help strings, not for other language strings.
=== More help links ===
To display the optional ''More help...'' link at the bottom of the help popup, a string with the "_link" suffix must exist beside the relevant "_help" string. These link strings should consist of a short relative path like 'component/thing' (eg. 'mod/folder/view' or 'group/import'). This gets turned into a link to MoodleDocs in the user's language, and for the appropriate Moodle version.

Example:
<syntaxhighlight lang="php">
$string['groupimport_link'] = 'group/import';
</syntaxhighlight>
will make a link to something like <nowiki>'https://docs.moodle.org/32/en/group/import'</nowiki> (if you are an English user of Moodle 3.2). This page in turn should be a redirect page to the actual page providing the info. Note the <nowiki>'https://docs.moodle.org'</nowiki> part comes from $CFG->docroot.

The second option is that you can give an absolute link, if you want, and that will be used unmodified.
<syntaxhighlight lang="php">
$string['patronising_link'] = <nowiki>'http://lmgtfy.com/?q=Moodle+for+dummies';</nowiki>
</syntaxhighlight>
This case is detected by seeing if the string starts with <nowiki>http:// or https://</nowiki>. This option is useful if the documentation for your plugin is hosted at Github wiki, for example.

The third option is to start the link with <tt>%%WWWROOT%%</tt>. That is replaced by <tt>$CFG->wwwroot</tt>. This is useful for contributed plugins that want to keep the help within the plugin.
=== Words for roles ===
The following words should be used in the English (en) help strings whenever it is necessary to refer to people with particular roles in a generic sense.
* Participants - all people with a role
* Teachers - people with some sort of a facilitation/editing role
* Students - people primarily there to learn
* Users - people across the site
([[User:Martin Dougiamas|Martin Dougiamas]] 16:13, 20 April 2010 (UTC): I'm not entirely comfortable with this choice even though I just re-confirmed it, as I'd prefer to be using words like facilitator/moderator to subtly and continually promote a less transmissionist pedgagogy and I know many Moodle users would agree. However, I think these terms are far more commonly used in the community and in discussion, and from the point of view that we need to build a consistent system for usability they are less distracting and better for documentation.)

==Files==
String functions are defined in
# lib/moodlelib.php - locale related functions
# lib/textlib.class.php - general string functions (substr, strlen etc.)
==Functions and examples==
There are three main functions, used in moodle for getting/displaying the localised string, based on user preferred language.
===get_string()===
Returns a localised string for current user.

Example for displaying string "This is my plug-in" in any language that supports on your site, then you need to use the following identifier in language file (located in appropriate lang directory)
$string['plugintitle'] = 'This is my plug-in';
If you want to display this string in any supported language, then you would use this function.
echo get_string('plugintitle', 'module_pluginlangfilename');
If you want to substitute value in the language string then use '''{$a}''' for substituting value. $a is an object, string or number that can be used within translation strings. The variable has to be $a, and it has to be in single quotes. For example, if you want to display answer number in Drag & drop plugin then add
$string['answerno1'] = 'Answer {$a}'; //Substituting string/integer
$string['answerno2'] = 'Answer {$a->name}'; //Substituting object member
in qtype_dragdrop.php (Drag & Drop language file). And call it using
//Get string by substituting integer.
get_string('answerno1', 'qtype_dragdrop', $number);
//Get string by substituting object member integer
$user->number = 10;
get_string('answerno2', 'qtype_dragdrop', $user);
In Moodle 2.3 there is a new argument to this function $lazyload. Setting $lazyload to true causes get_string to return a lang_string object rather than the string itself.
$stringobject = get_string('answerno', 'qtype_dragdrop', $number, true);
The fetching of the string is then put off until the string object is first used. The object can be used by calling it's out method or by casting the object to a string, either directly e.g.
(string)$stringobject
or indirectly by using the string within another string or echoing it out e.g.
echo $stringobject;
return "<p>{$stringobject}</p>";
Note: using $lazyload and attempting to use the string as an array key will cause a fatal error as objects cannot be used as array keys.
===get_strings()===
Converts an array of string names to localised strings for a specific plugin. lazy loading is not supported in this function.
$txt = get_strings(array('enable', 'disable', 'up', 'down', 'none'), 'qtype_dragdrop');
echo $txt->up; //Display localised string for up
echo $txt->down //Display localised string for down
===print_string()===
Prints out a translated string by using '''get_string()''' function
===lang_string class===
In Moodle 2.3 a special class (lang_string) is used to create an object representation of a string request. In this case string processing doesn't occur until the object is first used. The class was created especially to aid performance in areas where strings were required to be generated but were not necessarily used. As an example the admin navigation tree when generated uses over 1500 strings, of which normally only 1/3 are ever actually printed at any time. The performance advantage is achieved by not actually processing strings that aren't being used, as such reducing the processing required for the page.

lang_string class can be used in two ways
# Setting $lazyload (fourth argument of the get_string function), to true.
$string = get_string('yes', 'qtype_dragdrop', null, true);
# Direct instantiation
$string = new lang_string('yes', 'qtype_dragdrop', null, 'en');
== String manager ==
Most of function listed above are just handful wrappers for the methods provided by the string manager class. Some strings related functionality is available only via directly calling the manager's methods.
<syntaxhighlight lang="php">
$stringman = get_string_manager();
</syntaxhighlight>
The factory function get_string_manager() returns singleton instance of <tt>core_string_manager_install</tt> in early stages of the site installation, or instance of <tt>core_string_manager_standard</tt> in all normal situations. These managers implement interface <tt>core_string_manager</tt>. Methods provided by the interface are
;get_string():Returns the given component string localised in the given language. Can be used to obtain the translation of the string in the other language than the current user's language.
;string_exists():Does the given string actually exist? This is typically checked by a code like
<syntaxhighlight lang="php">
if (get_string_manager()->string_exists('stringidentifier', 'component_name')) {
// Do something.
}
</syntaxhighlight>
;string_deprecated():Has the string been deprecated? See [[String deprecation]] for details.
;get_list_of_countries():Returns a localised list of all country names, sorted by country keys.
;get_list_of_languages():Returns a localised list of languages, sorted by code keys.
;translation_exists():Checks if the translation exists for the given language.
;get_list_of_translations():Returns localised list of installed language packs.
;get_list_of_currencies():Returns localised list of known currencies.
;load_component_strings():Loads all strings for one component.
;reset_caches():Invalidates all caches, should the manager use some.
;get_revision():Returns string revision counter.
=== Custom string managers ===
{{Moodle 2.9}}Plugins can provide custom implementation of the string manager. This is supposed to be used in experimental and/or development scenarios only, not in typical production environment. See MDL-49361 for use cases and implementation details. An example of such an implementation can be found at [https://github.com/mudrd8mz/moodle-local_stringman moodle-local_stringman.git] repository.
<syntaxhighlight lang="php">
// Custom string manager class can be defined in the main config.php file.
$CFG->customstringmanager = '\local_stringman\dummy_string_manager';
</syntaxhighlight>
==textlib (core_text) class==
textlib class provide pool of safe functions to operate on UTF-8 text. textlib provide set of static functions to operate on strings and gets included in setup.php

{{Moodle 2.6}}In Moodle 2.6 the textlib class was renamed to '''core_text'''.
===asort()===
Locale aware sorting, the key associations are kept, values are sorted alphabetically.
===code2utf8===
Returns the utf8 string corresponding to the unicode value
===convert===
Converts the text between different encodings. It uses iconv extension with //TRANSLIT parameter, fall back to typo3
===encode_mimeheader===
Generate a correct base64 encoded header to be used in MIME mail messages.
===entities_to_utf8===
Converts all the numeric entities &#nnnn; or &#xnnn; to UTF-8
===specialtoascii===
Converts upper unicode characters to plain ascii, the returned string may contain unconverted unicode characters.
===strlen===
Multibyte safe strlen() function, uses iconv for utf-8, falls back to typo3.
===strpos===
Find the position of the first occurrence of a substring in a string. UTF-8 ONLY safe strpos(), uses iconv.
===strrpos===
Find the position of the last occurrence of a substring in a string. UTF-8 ONLY safe strrpos(), uses iconv.
===strtolower===
Multibyte safe strtolower() function, uses mbstring, falls back to typo3.
===strtotitle===
Makes first letter of each word capital - words must be separated by spaces.
===strtoupper===
Multibyte safe strtoupper() function, uses mbstring, falls back to typo3.
===substr===
Multibyte safe substr() function, uses iconv for utf-8, falls back to typo3.
===trim_utf8_bom===
Removes the BOM from unicode string. [http://unicode.org/faq/utf_bom.html more info]
===utf8_to_entities===
Converts all Unicode chars > 127 to numeric entities &#nnnn; or &#xnnn;
==FAQ==
===When should I use a lang_string object?===
The lang_string object is designed to be used in any situation where a string may not be needed, but needs to be generated. The admin navigation tree is a good example of where lang_string objects should be used. A more practical example would be any class that requires strings that may not be printed (after all classes get renderer by renderers and who knows what they will do ;))
===When should I not use a lang_string object?===
Don't use lang_strings when you are going to use a string immediately. There is no need as it will be processed immediately and there will be no advantage, and in fact perhaps a negative hit as a class has to be instantiated for a lang_string object, however get_string won't require that.
===Limitation of lang_string===
lang_string object cannot be used as an array offset. Doing so will result in PHP throwing an error. (You can use it as an object property!)
===How to compare strings properties in two object===
collatorlib_property_comparison class can be used to compare properties of two objects
===Should the colon sign be hard-coded or included in a language string?===
The colon sign should not be hard-coded because languages may use a different symbol, or have a space before or after the colon sign. Instead, the colon sign may be included in a language string, though please consider first if it is really necessary. A colon sign in a field label is not recommended. (MDL-12192 is for removing existing hard-coded colon signs.)<syntaxhighlight lang="php">
// Do NOT hard code any punctuation:
$string['fieldname'] = 'Name';

echo get_string('fieldname', 'mod_foobar') . ': ' . $somevalue;

// Slightly better with no hard coded colon:
$string['fieldname'] = 'Name: ';

echo get_string('fieldname', 'mod_foobar') . $somevalue;

// Better with no assumed word order:
$string['fieldname'] = 'Name: {$a->name}';

echo get_string('fieldname', 'mod_foobar', ['name' => $somevalue]);

</syntaxhighlight>

===Changing or creating a new lang string?===
New strings were required in 1.x times when we did not have branches for translations. Since 2.0, for changes in master, structural and/or semantic modification of a string (such as adding or removing {$a} placeholders etc) is acceptable as such strings are highlighted in AMOS as outdated. Of course, if lang pack maintainers do not pay attention to it, mismatch can happen - but this is considered to be the lang pack bug.

When a new string is introduced, the old one should be [[String deprecation | deprecated or removed]] so that unused strings do not accumulate.
:A) Basically I see it as (for master only issues):
:
:# Any change is allowed (semantic or structural). It does not have sense to keep the old string because there won't be use for it when the new Moodle version is released. So we can forget about the old one 100%. Of course if the string is radically different, then it may have sense to create a new, completely different string (and proceed with next point).
:# If for any reason we stop using any string (because a feature is out or because we have decided to create a new different string instead of change existing)), then:
:#* if the old string is really specific (not suitable for reuse) we can safely proceed to delete it,.
:#* If the string belongs to a plugin, IMO we can also proceed to delete it (reuse of plugin strings should not be allowed).
:#* But, if the string is generic (may be reused) and it's not part of a plugin then the string must be deprecated.

:B) And, for issues involving stables, only small semantic changes are allowed. No structural, no deprecation and no deletion. Ever. If still something different must be shown it will be, always, via new string. When applied to master, these changes will also imply the [[String deprecation | standard old string deprecation]]. No CPY instruction will be performed between the old and the new strings (safest, easier, consistent behavior, no matter there are some cases where the instruction may be acceptable. Stop overthinking. Now!).
===User names placeholders===
Some strings may contain placeholders to display the user's name. Common examples include various email templates or welcome messages. Developers may be tempted to use just the user's firstname in such cases, to make the text feel informal and friendlier:
<syntaxhighlight lang="php">
// Do NOT do this.
$string['welcome'] = 'Hello {$a}! Welcome to the course.';
</syntaxhighlight>
But some cultures or institutions may want the full name or last name to be used, rather than the first name. To enable sites to easily customise such strings and have lastname and alternatename placeholders available, the following pattern should be used.

Let the language strings file for the given component define the default display of the name:
<syntaxhighlight lang="php">
$string['welcome'] = 'Hello {$a->firstname}! Welcome to the course.';
</syntaxhighlight>
Then in the file making use of the string:
<syntaxhighlight lang="php">
$namefields = [
'fullname' => fullname($USER),
'alternativefullname' => fullname($USER, true),
];

foreach (\core_user\fields::get_name_fields() as $namefield) {
$namefields[$namefield] = $USER->{$namefield};
}

echo get_string('welcome', 'xyz_component', $namefields);
</syntaxhighlight>
That way, the string can be locally customised and use any combination of the following placeholders as needed: firstnamephonetic, lastnamephonetic, middlename, alternatename, firstname, lastname, fullname and alternativefullname.
<syntaxhighlight lang="php">
// Locally customised variant of the string.
$string['welcome'] = 'Welcome to the course, {$a->fullname}';
</syntaxhighlight>
==See also==
* [[Output_functions]]
* [[Core APIs]]
* [[AMOS]]
* The section 'Language strings' in [[Coding style]]
* [[String deprecation]]
* [[Improving English language strings]]
[[Category:API]]
[[Category:Language]]

XMLDB Problems

2023-01-25T05:23:26Z

Tsala: link edit

#redirect [[XMLDB problems]]

XMLDB Problems

2023-01-25T05:22:58Z

Tsala: restoring redirect

#redirect [[Development:XMLDB problems]]

Themes

2022-10-10T14:00:41Z

Tsala: themes template

{{Template:Themes}}
This page is a starting point for Moodle theme developers.

For documentation on installing and using themes, please see the [[:en:Themes|Themes user documentation]] and [[:en:Themes FAQ|Themes FAQ]].

Moodle has a powerful themes system that allows for a variety of effects through the use of HTML and CSS.

* [[Themes overview]]
* [[Creating a theme based on boost]]
* [[Creating a theme based on classic]]
* [[Moving your theme to use boost as a parent theme]]
* [[Updating a boost based theme]]
* [[Using images in a theme|Using images]]
* [[Creating a theme settings page|Theme settings page]]
* [[Adding theme upgrade code]]
* [[Extending the theme custom menu|Extending the custom menu]]
* [[Overriding a renderer]]
* [[Theme checklist]]
* [[Templates]]

==See also==

* [[:Category:Themes|List of all themes-related developer documentation]]

[[Category:Themes]]

Translation

2022-09-05T11:34:14Z

Tsala: rewording

This page is now located in the user docs: [[:en:Translation|Translation]]

Translation

2022-09-05T11:19:03Z

Tsala: link fix

{{Note|[[:en:Translation|Translation documentation]] is available in the user documentation.}}

Translation

2022-09-05T07:27:47Z

Tsala: link edit

{{Note|[[:Translation|Translation documentation]] is available in the user documentation.}}

Translation

2022-09-02T09:59:46Z

Tsala: removing migrated template

{{Translation}}
==So you'd like to help with translating Moodle?==

Great! :-) All translation happens on our '''[http://lang.moodle.org Moodle translation site]''', so you'll need to start by creating an account there.

Perhaps you've found some words or phrases not yet translated into your language? Or you've spotted a mistake? If so, please see the guide to [[Contributing a translation]].

Note: If you'd like to help translate more than just a few strings, please contact the maintainer of your language pack as listed in the [http://lang.moodle.org/local/amos/credits.php Translation credits] and ask where you can help.

==Wish to take on responsibility for a language pack?==

Please see [[Maintaining a language pack]] and the [[AMOS manual]] for further information about the AMOS translation toolkit.

==Is Moodle not yet translated into your language?==

Please see [[Starting a new language pack]].

==Any questions?==

Please check the [[Translation FAQ]] and join us in the [http://lang.moodle.org/mod/forum/view.php?id=5 Using AMOS forum].

==See also==

* [https://download.moodle.org/langpack/3.8/ Language packs for Moodle 3.8] for the percentage of language strings translated in each language pack for the current Moodle branch

[[fr:Traduction]]
[[de:Übersetzung]]
[[es:Traducción]]

QA testing

2022-07-15T04:44:21Z

Tsala: removing QA testing latest

{{Template:Migrated|newDocId=/general/development/process/testing/qa}}
'''Quality Assurance''' tests look at the functionality of Moodle from a user's point of view.

Real users systematically try each feature in Moodle and test that it works in the current version of the Moodle code. These tests are repeated in series of cycles, around 4 - 6 weeks before a major release, once all major features have landed.

==Getting involved==
Would you like to help with QA testing? If so, please make sure you have created an account in the [[Tracker_introduction|Moodle tracker]] and you're subscribed to the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum] in order to receive QA testing news updates.
==Running tests==
# Go to the [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 Moodle QA testing dashboard] and choose a test from the list of current QA cycle open issues. When viewing a test, if you wish, you can click the 'Assign to me' link on the right, so that nobody else chooses the same test to run. (If you then find you are unable to run the test, you can click the Assign button and set the assignee as 'Unassigned'.) Please note:
#* Only assign an issue to yourself which no one else is testing (Assignee = Unassigned).
#* Only assign one issue at a time unless you plan to test a number of related issues within the next 24 hours. In other words, don't assign several issues to yourself then do nothing for several days. ;-)
#* The label ''test_server_required'' indicates issues that can't be tested on the QA testing site. The label ''credentials_required'' indicates that credentials such as an OAuth 2 service client ID and secret are required.
# Using either the [https://qa.moodledemo.net/ Moodle QA Testing Site] or your own test site running the latest Moodle 4.0dev (available from Git on the integration/master branch ''<nowiki>git://git.moodle.org/integration.git</nowiki>'') with [[:en:Debugging|debugging]] set to developer, perform each of the steps listed in the test.
# ''Please attach screenshots of the steps where you verify or check something.''
# If it makes sense, please test using the currently supported themes, Boost and Classic.
# Choose an appropriate workflow action:
#* ''Pass'' - Test runs perfectly. Add comment such as feedback about a new feature, browsers used for testing (if applicable; example: "This test passes on Q&A site with Teacher role using Boost theme"), or simply "This test passes - yippee!"
#* ''Fail'' - Something doesn't work, or you obtain debugging messages. Add comment describing the step that doesn't work. If in doubt whether to pass a test, give it a fail and add a comment describing your doubts.
#* ''Obsolete'' - Test is no longer relevant in the current Moodle version. Add comment explaining why.
If you notice that the test description is out-of-date, add a comment mentioning that it needs updating. Alternatively, if you'd like to help with updating the test yourself, see below.
==Any questions?==
If there is anything you are unsure of, such as whether to mark a test as failed, or you have any other questions, please ask in one of the following places:
* [https://t.me/moodleqa Moodle QA Telegram chat room] - To join the room for the first time, please use the [https://t.me/+cXneE_ZeZ_A4ODRk Moodle QA Telegram invite link].
* [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum]
==Moodle QA Testing Site==
The [https://qa.moodledemo.net/ Moodle QA Testing Site] is updated daily at around 13:00 UTC with the latest bug fixes to enable you to re-run QA tests.

To prevent the site being used for sending spam, no emails are sent from it. Thus, tests involving email cannot be run using the Moodle QA Testing Site. (If such tests are attempted, an email debug message is displayed. This is not a bug but rather expected behaviour.)

Teacher and student accounts are provided. If you would like admin access to the Moodle QA Testing Site for running certain tests, please ask in the Moodle QA Telegram chat room or the Testing and QA forum for someone to send you the account credentials via private message.
==<div id="failedTests">Failed tests</div>==
So you ran a test and it failed? Congratulations on finding a bug! Please do the following.
# Click the Fail button at the top of the page.
# Add a comment to the QA test stating that there was a problem and that you will report it as a Moodle bug.
# Note the MDLQA number; it will be something like <nowiki>MDLQA-448</nowiki>.
# Try searching for whether the bug has been reported previously, and if not create a new issue for it (as described in [[Tracker introduction]]).
# In the new Moodle (MDL) issue select 'Link' from the 'More actions' dropdown menu. <br />[[Image:LinkIssue.png|150px|Linking to the QA issue in the tracker]]
# Link to the QA test by selecting 'blocks' as the link type, entering the MDLQA number that you noted earlier, and optionally adding a comment. <br />[[Image:LinkDetails.png|150px|Adding details for a link to the QA issue]]
# Give the issue the label 'mdlqa'.
# (Optional) Add yourself as a watcher to the MDL issue so that you receive email notification when the issue is fixed.
# When the MDL issue is fixed, hopefully within a day or two, the QA test can be reset and can then be run again.
==Resetting tests==
''Note for integrators:''

After integrating a fix,
# Reset the MDLQA test, adding a comment.
# Remove the 'mdlqa' label from the MDL issue.
# If the issue doesn't have testing instructions, pass it with message "Will be tested by MDLQA-XXXX".
The tester will then receive email notification that the bug is fixed and will hopefully decide to run the test again soon.
==Fixing existing bugs==
At the beginning of the QA cycle, all bugs identified (both new and existing) are investigated promptly and hopefully fixed.

When we are close to the scheduled release date (1-2 weeks prior), developers must focus on fixing new bugs (which affect the upcoming release version) only.

Thus, at this point in the QA cycle, any bugs which also affect existing versions of Moodle are labelled qa_identified (and the label mdlqa removed) for investigation after the release.
==Testing tips==
When entering text into a form, try things like:
* <syntaxhighlight lang="php">&</syntaxhighlight> (ampersand), <syntaxhighlight lang="php">></syntaxhighlight> (greater than) or <syntaxhighlight lang="php"><</syntaxhighlight> (less than) e.g. <syntaxhighlight lang="php">x < 1 && x > 0</syntaxhighlight>
* <syntaxhighlight lang="php">0</syntaxhighlight> (the single digit 0)
* <syntaxhighlight lang="php">'</syntaxhighlight> (single quote) e.g. <syntaxhighlight lang="php">Fergal.O'Brien@example.com</syntaxhighlight>
* special characters e.g. <syntaxhighlight lang="php">café</syntaxhighlight> or <syntaxhighlight lang="php">囲碁</syntaxhighlight>
* very long strings
* different languages, such as a RTL language
==New QA tests required==
''Note for developers:''

If an issue fix cannot be covered by automated tests,
# Add the label 'qa_test_required' to the issue.
# Add a comment explaining why it can't be covered by automated tests and suggesting which steps of the testing instructions should be included in a QA test e.g. steps 6-10 or all steps.
QA tests will then be written and included in the next QA cycle. For issues with long testing instructions, several QA tests will be written to cover the issue. If appropriate, activities etc. will be set up on the [https://qa.moodledemo.net/ Moodle QA Testing Site] to enable the issue to be easily tested in future.

Similarly, for new features and improvements which would benefit from exploratory testing,
# Add the label 'qa_test_required' to the issue.
# Add a comment mentioning that exploratory testing is required.
Exploratory QA tests will then be written and included in the next QA cycle and then removed.
==Updating tests==
QA tests often become out-of-date due to new developments. If you would like to help with updating tests, you'll need to be a member of the test writers group in the Tracker.

To update a QA test original:
# Search for the test in MDLQA-1.
# Edit the test description.
If a test in the current QA cycle is marked as failed because it is out-of-date, the description should be updated (as well as the test original) before resetting the test. If the test in the current QA cycle is marked as passed, then only the test original needs to be updated.
==Writing new tests==
Would you like to help with writing new QA tests? If so, as for updating tests, you'll need to be a member of the test writers group in the Tracker.

QA tests are needed for any features which can't be tested with automated testing, such as connecting to an external system, drag and drop functionality or a CLI script. Also if it requires a person to detect if something is 'correct' vs. present/absent on the page.

In addition, new features can benefit from exploratory testing by community volunteers.

To create a new QA test:
# If appropriate, do a quick search of MDLQA-1 to check if there is an existing test which can be updated.
# If not, in MDLQA-1 from the More menu select 'Create sub-task'.
# Enter a summary such as 'A teacher can ...'.
# Select 'Original' as affected version and select appropriate components.
# In the description field add the test steps (usually between 3 and 10), similar to the issue's [[Testing instructions guide|testing instructions]], starting with 'Log in as a teacher...' or similar. It's a good idea to try doing the steps yourself as you write the test.
# Start some steps with 'Verify that ...' or similar.
# Click the Create button.
# Go to the MDL issue and create a ‘has a QA test’ link to the new QA test, adding a comment “This feature is now covered by the QA test MDLQA....”.

Notes:
* Add the label ''new''
* For tests which can’t be run on the QA testing site, such as ones where you need to check an email, label ''test_server_required''.
* For OAuth 2 tests and any other tests which require a client ID or secret to be entered, label ''credentials_required''.
* For issues which specifically mention in the testing instructions to test in different browsers, use the phrase "Test in as many browsers as possible and mention in a comment which ones you’ve used."
* For an exploratory test, begin the test description with "This is an exploratory test of a new feature or improvement, so please feel free to try anything you like and not just the test steps!"
* For a test requiring admin access which can be run on the QA site, add:
This test requires admin access. If you would like to use the [QA testing site|https://qa.moodledemo.net/] for running it, please see the [QA testing guide|https://docs.moodle.org/dev/QA_testing] for details of how to request admin access. Begin just after the hourly reset to give yourself plenty of time to complete the test!
==Feedback==
Feedback on all aspects of our QA testing process is welcome. If you have any questions or comments, please post in the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum].
==See also==
* [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 QA testing dashboard]
* [[Testing credits]]
* [[MDLQA-features]]
* [https://moodle.org/mod/forum/discuss.php?d=351302 Useful tips for QA testing]
Comments on tests from previous QA cycles:
* [https://tracker.moodle.org/browse/MDLQA-150 Moodle 2.0 QA Cycle 1]
* [https://tracker.moodle.org/browse/MDLQA-328 Moodle 2.0 QA Cycle 2]
* [https://tracker.moodle.org/browse/MDLQA-540 Moodle 2.0.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-944 Moodle 2.1 QA Cycle 1]
* [https://tracker.moodle.org/browse/MDLQA-1190 Moodle 2.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-1814 Moodle 2.3 QA]
* [https://tracker.moodle.org/browse/MDLQA-4602 Moodle 2.4 QA]
* [https://tracker.moodle.org/browse/MDLQA-5267 Moodle 2.5 QA]
* [https://tracker.moodle.org/browse/MDLQA-5740 Moodle 2.6 QA]
* [https://tracker.moodle.org/browse/MDLQA-6693 Moodle 2.7 QA]
* [https://tracker.moodle.org/browse/MDLQA-7170 Moodle 2.8 QA]
* [https://tracker.moodle.org/browse/MDLQA-7660 Moodle 2.9 QA]
* [https://tracker.moodle.org/browse/MDLQA-8205 Moodle 3.0 QA]
* [https://tracker.moodle.org/browse/MDLQA-9267 Moodle 3.1 QA]
* [https://tracker.moodle.org/browse/MDLQA-9827 Moodle 3.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-10403 Moodle 3.3 QA]
* [https://tracker.moodle.org/browse/MDLQA-10999 Moodle 3.4 QA]
* [https://tracker.moodle.org/browse/MDLQA-11698 Moodle 3.5 QA]
* [https://tracker.moodle.org/browse/MDLQA-12282 Moodle 3.6 QA]
* [https://tracker.moodle.org/browse/MDLQA-12911 Moodle 3.7 QA]
* [https://tracker.moodle.org/browse/MDLQA-13517 Moodle 3.8 QA]
* [https://tracker.moodle.org/browse/MDLQA-14131 Moodle 3.9 QA]
* [https://tracker.moodle.org/browse/MDLQA-14813 Moodle 3.10 QA]
* [https://tracker.moodle.org/browse/MDLQA-15457 Moodle 3.11 QA]
* [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 Moodle 4.0 QA]
[[Category:Quality Assurance]]

Translation credits archive

2022-05-27T19:47:28Z

Tsala: note

{{Template:WillNotMigrate}}
<p class="note">Note: This page will not be migrated to new devdocs. Please see '''[http://lang.moodle.org/local/amos/credits.php Translation credits]''' for the up-to-date list of language pack maintainers and contributors (Moodle 2.0 onwards).</p>

If you'd like to contact a language pack maintainer, please create an account on the [http://lang.moodle.org Moodle translation site] then click on their name in the [http://lang.moodle.org/local/amos/credits.php Translation credits] and send them a message.

Many language pack maintainers are active in the forums on moodle.org. A translators icon (a book) under a user's name in forum posts identifies them as a member of the translators group, for example [http://moodle.org/user/index.php?id=5&group=173 Translators in Moodle in English].

==Translation credits since the beginning of the project==

From the very beginning, Moodle was [[Translation|designed to be translated]] into many languages. This page lists translators from the beginning of the project (pre-Moodle 2.0).

__TOC__

===Afrikaans===
* Riaan De Villiers

===Albanian===
* Bejo Duka

===Arabic===
* Dr. Ali H. Abureesh
* (Original translation by Ahmed Nabil)

===Armenian===
* Lusine Khachatryan
* Tygran Terteryan
* Andranik Markosyan

===Asturian===
* Xosé Nel Caldevilla Vega

===Bangla===
* Razib Mustafiz

===Basque===
* Santurtziko Udal Euskaltegia (CVS)
* Jose Sanchez

===Belarusian===
* Maryia Davidouskaia

===Bosnian===
* Tihomir Veselinovic
* red_eye

===Bulgarian===
* Tihomir Veselinovic

===Catalan===
* Carles Bellver (CVS)
* cent
* Joan Queralt

===Chinese (simplified)===
* Ling Li (CVS)
* sunner
''Original translator:''
* ctbxz
* cncoolbit

===Chinese (traditional)===
* Finjon Kiang (CVS)
* Fu-Kwun Hwang

===Croatian===
* Jasmin Klindzic (CVS)

===Czech===
* David Mudrák (CVS)
* Daniel Mikšík (CVS)
* Jindřich Jindřich
* Jiří Rambousek
* Zdeněk Pytela
* Jarmila Fictumová
* Petr Sudický
* Kamila Králíková

===Danish===
* Bente Olsen (CVS)

Based on the work of

* Vinther Hansen
* Kristian Nielsen

===Dutch===
* Koen Roggemans (CVS)
* Hans De Zwart (initial translation)
* Leo Vandijck (revisions)

===Dhivehi===
* Ahmed Shareef
* Moosa Ali
* Amir Hussein

===English===
* Maintained by Moodle developers as default language

===English (US)===
* Maintained by Moodle developers

===Estonian===

* Erkki Laaneoks (CVS)
* Initial translation Ahti Paju

===Filipino===
* Julian Lilio

===Finnish===
* Petri Asikainen (CVS)

===French===
* Nicolas Martignoni (CVS)

''Contributors:''

* Séverin Terrier
* Thomas Poinsot
* Valéry Frémaux
* Didier Rambeau
* Étienne Rozé
* Nicolas Galante
* Joseph Rézeau
* Jean-François Nadeau
* Sébastien Namèche

Thanks to Sébastien Namèche, French was the first non-English localisation of Moodle in September 2002.

===French Canadian===
* Sébastien Namèche

===Galician===

* Forem Galicia - CC.OO

Based on work from:
* Luz Castro
* Sonia Álvarez López

===Georgian===
* Lasha Altunashvili and his team

===German===
* Ralf Hilgenstock (CVS)
* Ralf Krause (CVS)
* Andre Krüger (previously)

===German (modification)===
* Ralf Hilgenstock (CVS)
* Ralf Krause (CVS)
Based on the work of
* Christian Borowski
* Franz Horvath (initial version)

===Greek===
* University of Ioannina
* Georgios Papaioannou
* Nikolaos Kyrgios
* Ioannis Kyriakidis
* Theodoros Koukoulis
* Dimitrios Mixail
* Ioannis Sofronis
Based on the work of
* Christos Sintoris
* George Fousekis

===Gujarati===
* Amit Mali

===Hebrew===
* Emanuel Gruengard (CVS)

Additional Contributors:

* Lev Abramov
* Anat Martkovich
* Miki Alliel
* Shahar Dolev
* Dovix

===Hindi===

* Stallon Selvan (GHOP)

Translation based on the work of
* Utkarshraj Atmaram

===Hungarian===
* Karoly Fabricz
* Istvan Bozsa

===Icelandic===
* S.Fjalar

===Indonesion===
* Arfan Hidayat
* Fajrin Azis (GHOP)

===Italian===
* Andrea Bicciolo (CVS)
* Roberto Pinna
* Paolo Lariccia
* Davide Suraci

===Irish===
* Cathal Ó Foirréidh

===Japanese===
* Mitsuhiro Yoshida (CVS)

''Contributors:''

* Timothy Takemoto
* Toshihiro Kita
* Paul Tsuchido Shew
* Haruhiko Okumura
* Tatsuya Aoyagi
* Masataka Nakaue
* Hiroto Kagotani
* Thomas N. Robb
* Takahiro Kagoya
* Takahito Kashiwagi
* Naoko Ueda
* Shinya Ichikawa

===Kannada===
* Hari Prasad Nadig and his team

===Kazakh===
* Туенбаева Калима - Tuyenbayeva Kalima
* Туенбаев Дархан - Tuyenbayev Darkhan
* Айжан Арғынбаева - Aizhan Argynbayeva
* Жандос Байжұма - Zhandos Baizhuma

===Khmer===
''Original translator''
* Vichika
''KhmerOS Localization and E-Learning Team of the Open Institute:''
* Khem Sokhem (CVS)
* Auk Piseth
* Eng Vannak
* Leang Chumsoben

===Korean===
* Lee ChanYoung (CVS)
* Timothy Allen
* Kui In Keem
* Park Min-jeong
* Park Wang Kyu
* Lee Yong-keun

===Lao===
* Somsack

===Latin===
* Nicholas Sinnott-Armstrong

===Latvian===
* Arnis Voitkans
Translation has been carried out by University of Latvia, Riga Technical University and company Tilde.

Based on work of:
* Girts Ozolins
* Ivan Ribakov (GHOP)

===Lithuanian===
* Aidas Smaizys

===Macedonian===
* Dimitar Talevski

Contributors:
* Jovan Naumovski
* Pavle Jonoski
* Vlatko Trajkov
* Zoran Lazarevski

Based on the work of:
Institute for informatics - Skopje

===Malayalam===
* George Varghese

===Malaysian===
* Mohamad Ghazaly Abdul Rahman

===Maori (Ngai Tahu)===
* Jeremy Fitzpatrick
* The OSCINZ project

===Māori (WaikatoUni)===

* Translation team (based at the University of Waikato, Hamilton, New Zealand)

* Tom Roa (Waikato - Maniapoto)
* Roger Lewis (Hunaonga o Ngāti Raukawa)
* Hariru Roa (Waikato - Maniapoto)
* Joeliee Seed-Pihama (Taranaki, Ngāti Moeahu; Te Atiawa)
* Damen Pitiroa (Ngāti Tūwharetoa)
* Te Taka Keegan (Waikato-Maniapoto)

This translation was carried out as part of the "Mäori language in e-learning" project, funded through the elearning Collaborative Development Fund (eCDF) by the Tertiary Education Commission of New Zealand.

===Marathi===

* Usha Deo

===Mongolian===
* Khadbaatar.G

===Norwegian===
Current translator
* Alf Martin Johnsen (CVS)

Translation based on the work of
* John Harald Gartland
* Solveig Bjørnestad
* Tormod Aagaard
* Stig Bjarne Haugen (initial translation)

===Norwegian (Nynorsk)===
* Alf Martin Johnsen (CVS)

Original translation based on the work of
* John Harald Gartland
* Tormod Aagaard

===Norwegian translation for primary schools===
* Alf Martin Johnsen (CVS)

Original translation based on the work of
* John Harald Gartland
* Anders Bjerkholt
* Stig Bjarne Haugen

===Persian===
* Shamim Rezaie (CVS)
* Adel Ghazikhani
* Ali Hosseini
* Mehran Talaee

===Polish===
* Adam PaweÅ‚czak (CVS)
* Przemyslaw Polanski
* Luiza Budzynska
* gadulix (GHOP)
* Szymon Kałasz (GHOP)

===Portuguese===
* Jaime E. Villate, University of Porto (CVS)

''Contributors:''
* Paulo Figueira, Portugal
* Guida Querido, Portugal
* Manuel Padilha, University of Porto
* José Soeiro de Carvalho, University of Porto

===Portuguese (Brasil)===
* Gilvan Marques (CVS)
* Paula de Waal (CVS)

===Romanian===

* Alexandru Diaconu (CVS)

based on the work of
* Mihai Cotu
* Eugen Tanul

===Russian===
Initial translator: Andrew Redkin

Currently maintained by:
* Alex Djachenko (CVS)
* Dmitry Pupinin (CVS)
* Maryia Davidouskaia
* Evgenij Cigancov

===Samoan===
Translated by the OSCINZ project

* Jeremy Fitzpatrick

===Serbian===
Initial translation Serbian Cyrilic for Bosnia and Herzegovina
* Dragan Simic

Current Serbian translation
* Zivana Komlenov (CVS)

Grammar sensitive Serbian language pack
* Bojan Milosavljevic

===Sinhala===
Initial Translators (two independent translations)
* Harsha Balasooriya et alia
* Malinda Siriwardena et alia

Significant assistance for the Sinhala language translation of Moodle was
facilitated by Distance Education Modernisation Project (DEMP) of Ministry of
Higher Education of Sri Lanka

Major contribution for quality improvements:
e-learning Centre, University of Colombo School of Computing

Maintainers:
* Rashan Anushka, University of Colombo School of Computing (CVS)
* Malinda Siriwardene, University of Colombo School of Computing (CVS)
* Harsha Balasooriya, The Open University of Sri Lanka (CVS)

===Slovak===

* Miroslav Fikar (MF), FCHPT STU (CVS)
* Zuzana Jakubcová (ZJ), FCHPT STU
* Martina Majorová (MM), CIT FEM SPU
* Juraj Chlebec (JCH), CIT FEM SPU
* Radik Kalakay, Projekt VECIT 9-2003 - ISO-8859-2

===Slovenian===

*Mitja Podreka (CVS)

Based on the work of
* Robert Leskovar (CVS)
* Sandra Bajde
* Damjan Crnič
* Daša Delavec
* Bojan Janeš
* Aleš Kecman
* Matic Kožuh
* Miha Kramar
* Grega Lebar
* Boštjan Lukša
* Renata Mohorič
* Vid Ogris
* Gašper Osredkar
* Gregor Rekar
* Maruška Spasovski
* Žiga Vuk
* Tomaz Savodniki
* Robert Leskovar

===Somali===
* Mohamed Abdi

===Spanish international===
''Coordination and Interface''
* Benito Arias (CVS)

''Help and documentation:''
* Antonio Navarro
* Antonio Vicent
* Eloy Lafuente (CVS)
* Fermín Cueva

''Cooperators:''
* Claudio Tavares
* Sergio Alfaro
* Pedro Benito
* Ricardo Dalton
* David Delgado
* Emmanuelle Gutiérrez y Restrepo
* Mauricio Latorre
* Facundo Ortiz
* Raúl Vernengo
* Sergio Zúñiga
* Juan David Martinez Pavony

===Swedish===
* Anders Berggren

===Tagalog===
* Roel Cantada

===Tamil===
* Nagarajan Vadivel

===Tamil (Sri Lanka)===
* M A Kaleelur Rahuman (CVS)
* T.Gnanakumar
* Kengatharaiyer Sarveswaran (Sarves)

Significant assistance for the Tamil (LK) language translation of Moodle was facilitated by the National Online Distance Education Service (NODES) established by the Distance Education Modernisation Project (DEMP) of Ministry of Higher Education of Sri Lanka.

===Thai===
* M.Minkowski
* Worrapat Boonyaritipong (GHOP)

===Tongan===

Translated by the OSCINZ project
* Jeremy Fitzpatrick

===Turkish===
* Ethem Evlice (CVS)
* Dr. Gultekin Cetiner

===Ukrainian===
* Andriv Olefirenko

===Urdu===
* Faisal Kaleem

===Uzbek===
* Tokhir Akhmedjanov
ESDP DE project UZB 1961 Component B

Initial translation
* Orif N. Ruzimurodov
Center of the Development Multimedium Education Programms (CDMEP)

===Vietnamese===
* Đinh Lư Giang (CVS)
* Vu Thanh Hung

===Welsh===
* Karen Coyle

===Zulu===
* iCyber E-Learning Solutions on initiative of Gerrit Botha
* Coordination Lionel Redelinghuys
* Translation Mr. Nhlanhla Ndlovu

[[Category:Credits]]
[[Category:Translation]]

Translation credits archive

2022-05-27T19:46:24Z

Tsala: This page will not be migrated to new devdocs

{{Template:WillNotMigrate}}
<p class="note">Please see '''[http://lang.moodle.org/local/amos/credits.php Translation credits]''' for the up-to-date list of language pack maintainers and contributors (Moodle 2.0 onwards).</p>

If you'd like to contact a language pack maintainer, please create an account on the [http://lang.moodle.org Moodle translation site] then click on their name in the [http://lang.moodle.org/local/amos/credits.php Translation credits] and send them a message.

Many language pack maintainers are active in the forums on moodle.org. A translators icon (a book) under a user's name in forum posts identifies them as a member of the translators group, for example [http://moodle.org/user/index.php?id=5&group=173 Translators in Moodle in English].

==Translation credits since the beginning of the project==

From the very beginning, Moodle was [[Translation|designed to be translated]] into many languages. This page lists translators from the beginning of the project (pre-Moodle 2.0).

__TOC__

===Afrikaans===
* Riaan De Villiers

===Albanian===
* Bejo Duka

===Arabic===
* Dr. Ali H. Abureesh
* (Original translation by Ahmed Nabil)

===Armenian===
* Lusine Khachatryan
* Tygran Terteryan
* Andranik Markosyan

===Asturian===
* Xosé Nel Caldevilla Vega

===Bangla===
* Razib Mustafiz

===Basque===
* Santurtziko Udal Euskaltegia (CVS)
* Jose Sanchez

===Belarusian===
* Maryia Davidouskaia

===Bosnian===
* Tihomir Veselinovic
* red_eye

===Bulgarian===
* Tihomir Veselinovic

===Catalan===
* Carles Bellver (CVS)
* cent
* Joan Queralt

===Chinese (simplified)===
* Ling Li (CVS)
* sunner
''Original translator:''
* ctbxz
* cncoolbit

===Chinese (traditional)===
* Finjon Kiang (CVS)
* Fu-Kwun Hwang

===Croatian===
* Jasmin Klindzic (CVS)

===Czech===
* David Mudrák (CVS)
* Daniel Mikšík (CVS)
* Jindřich Jindřich
* Jiří Rambousek
* Zdeněk Pytela
* Jarmila Fictumová
* Petr Sudický
* Kamila Králíková

===Danish===
* Bente Olsen (CVS)

Based on the work of

* Vinther Hansen
* Kristian Nielsen

===Dutch===
* Koen Roggemans (CVS)
* Hans De Zwart (initial translation)
* Leo Vandijck (revisions)

===Dhivehi===
* Ahmed Shareef
* Moosa Ali
* Amir Hussein

===English===
* Maintained by Moodle developers as default language

===English (US)===
* Maintained by Moodle developers

===Estonian===

* Erkki Laaneoks (CVS)
* Initial translation Ahti Paju

===Filipino===
* Julian Lilio

===Finnish===
* Petri Asikainen (CVS)

===French===
* Nicolas Martignoni (CVS)

''Contributors:''

* Séverin Terrier
* Thomas Poinsot
* Valéry Frémaux
* Didier Rambeau
* Étienne Rozé
* Nicolas Galante
* Joseph Rézeau
* Jean-François Nadeau
* Sébastien Namèche

Thanks to Sébastien Namèche, French was the first non-English localisation of Moodle in September 2002.

===French Canadian===
* Sébastien Namèche

===Galician===

* Forem Galicia - CC.OO

Based on work from:
* Luz Castro
* Sonia Álvarez López

===Georgian===
* Lasha Altunashvili and his team

===German===
* Ralf Hilgenstock (CVS)
* Ralf Krause (CVS)
* Andre Krüger (previously)

===German (modification)===
* Ralf Hilgenstock (CVS)
* Ralf Krause (CVS)
Based on the work of
* Christian Borowski
* Franz Horvath (initial version)

===Greek===
* University of Ioannina
* Georgios Papaioannou
* Nikolaos Kyrgios
* Ioannis Kyriakidis
* Theodoros Koukoulis
* Dimitrios Mixail
* Ioannis Sofronis
Based on the work of
* Christos Sintoris
* George Fousekis

===Gujarati===
* Amit Mali

===Hebrew===
* Emanuel Gruengard (CVS)

Additional Contributors:

* Lev Abramov
* Anat Martkovich
* Miki Alliel
* Shahar Dolev
* Dovix

===Hindi===

* Stallon Selvan (GHOP)

Translation based on the work of
* Utkarshraj Atmaram

===Hungarian===
* Karoly Fabricz
* Istvan Bozsa

===Icelandic===
* S.Fjalar

===Indonesion===
* Arfan Hidayat
* Fajrin Azis (GHOP)

===Italian===
* Andrea Bicciolo (CVS)
* Roberto Pinna
* Paolo Lariccia
* Davide Suraci

===Irish===
* Cathal Ó Foirréidh

===Japanese===
* Mitsuhiro Yoshida (CVS)

''Contributors:''

* Timothy Takemoto
* Toshihiro Kita
* Paul Tsuchido Shew
* Haruhiko Okumura
* Tatsuya Aoyagi
* Masataka Nakaue
* Hiroto Kagotani
* Thomas N. Robb
* Takahiro Kagoya
* Takahito Kashiwagi
* Naoko Ueda
* Shinya Ichikawa

===Kannada===
* Hari Prasad Nadig and his team

===Kazakh===
* Туенбаева Калима - Tuyenbayeva Kalima
* Туенбаев Дархан - Tuyenbayev Darkhan
* Айжан Арғынбаева - Aizhan Argynbayeva
* Жандос Байжұма - Zhandos Baizhuma

===Khmer===
''Original translator''
* Vichika
''KhmerOS Localization and E-Learning Team of the Open Institute:''
* Khem Sokhem (CVS)
* Auk Piseth
* Eng Vannak
* Leang Chumsoben

===Korean===
* Lee ChanYoung (CVS)
* Timothy Allen
* Kui In Keem
* Park Min-jeong
* Park Wang Kyu
* Lee Yong-keun

===Lao===
* Somsack

===Latin===
* Nicholas Sinnott-Armstrong

===Latvian===
* Arnis Voitkans
Translation has been carried out by University of Latvia, Riga Technical University and company Tilde.

Based on work of:
* Girts Ozolins
* Ivan Ribakov (GHOP)

===Lithuanian===
* Aidas Smaizys

===Macedonian===
* Dimitar Talevski

Contributors:
* Jovan Naumovski
* Pavle Jonoski
* Vlatko Trajkov
* Zoran Lazarevski

Based on the work of:
Institute for informatics - Skopje

===Malayalam===
* George Varghese

===Malaysian===
* Mohamad Ghazaly Abdul Rahman

===Maori (Ngai Tahu)===
* Jeremy Fitzpatrick
* The OSCINZ project

===Māori (WaikatoUni)===

* Translation team (based at the University of Waikato, Hamilton, New Zealand)

* Tom Roa (Waikato - Maniapoto)
* Roger Lewis (Hunaonga o Ngāti Raukawa)
* Hariru Roa (Waikato - Maniapoto)
* Joeliee Seed-Pihama (Taranaki, Ngāti Moeahu; Te Atiawa)
* Damen Pitiroa (Ngāti Tūwharetoa)
* Te Taka Keegan (Waikato-Maniapoto)

This translation was carried out as part of the "Mäori language in e-learning" project, funded through the elearning Collaborative Development Fund (eCDF) by the Tertiary Education Commission of New Zealand.

===Marathi===

* Usha Deo

===Mongolian===
* Khadbaatar.G

===Norwegian===
Current translator
* Alf Martin Johnsen (CVS)

Translation based on the work of
* John Harald Gartland
* Solveig Bjørnestad
* Tormod Aagaard
* Stig Bjarne Haugen (initial translation)

===Norwegian (Nynorsk)===
* Alf Martin Johnsen (CVS)

Original translation based on the work of
* John Harald Gartland
* Tormod Aagaard

===Norwegian translation for primary schools===
* Alf Martin Johnsen (CVS)

Original translation based on the work of
* John Harald Gartland
* Anders Bjerkholt
* Stig Bjarne Haugen

===Persian===
* Shamim Rezaie (CVS)
* Adel Ghazikhani
* Ali Hosseini
* Mehran Talaee

===Polish===
* Adam PaweÅ‚czak (CVS)
* Przemyslaw Polanski
* Luiza Budzynska
* gadulix (GHOP)
* Szymon Kałasz (GHOP)

===Portuguese===
* Jaime E. Villate, University of Porto (CVS)

''Contributors:''
* Paulo Figueira, Portugal
* Guida Querido, Portugal
* Manuel Padilha, University of Porto
* José Soeiro de Carvalho, University of Porto

===Portuguese (Brasil)===
* Gilvan Marques (CVS)
* Paula de Waal (CVS)

===Romanian===

* Alexandru Diaconu (CVS)

based on the work of
* Mihai Cotu
* Eugen Tanul

===Russian===
Initial translator: Andrew Redkin

Currently maintained by:
* Alex Djachenko (CVS)
* Dmitry Pupinin (CVS)
* Maryia Davidouskaia
* Evgenij Cigancov

===Samoan===
Translated by the OSCINZ project

* Jeremy Fitzpatrick

===Serbian===
Initial translation Serbian Cyrilic for Bosnia and Herzegovina
* Dragan Simic

Current Serbian translation
* Zivana Komlenov (CVS)

Grammar sensitive Serbian language pack
* Bojan Milosavljevic

===Sinhala===
Initial Translators (two independent translations)
* Harsha Balasooriya et alia
* Malinda Siriwardena et alia

Significant assistance for the Sinhala language translation of Moodle was
facilitated by Distance Education Modernisation Project (DEMP) of Ministry of
Higher Education of Sri Lanka

Major contribution for quality improvements:
e-learning Centre, University of Colombo School of Computing

Maintainers:
* Rashan Anushka, University of Colombo School of Computing (CVS)
* Malinda Siriwardene, University of Colombo School of Computing (CVS)
* Harsha Balasooriya, The Open University of Sri Lanka (CVS)

===Slovak===

* Miroslav Fikar (MF), FCHPT STU (CVS)
* Zuzana Jakubcová (ZJ), FCHPT STU
* Martina Majorová (MM), CIT FEM SPU
* Juraj Chlebec (JCH), CIT FEM SPU
* Radik Kalakay, Projekt VECIT 9-2003 - ISO-8859-2

===Slovenian===

*Mitja Podreka (CVS)

Based on the work of
* Robert Leskovar (CVS)
* Sandra Bajde
* Damjan Crnič
* Daša Delavec
* Bojan Janeš
* Aleš Kecman
* Matic Kožuh
* Miha Kramar
* Grega Lebar
* Boštjan Lukša
* Renata Mohorič
* Vid Ogris
* Gašper Osredkar
* Gregor Rekar
* Maruška Spasovski
* Žiga Vuk
* Tomaz Savodniki
* Robert Leskovar

===Somali===
* Mohamed Abdi

===Spanish international===
''Coordination and Interface''
* Benito Arias (CVS)

''Help and documentation:''
* Antonio Navarro
* Antonio Vicent
* Eloy Lafuente (CVS)
* Fermín Cueva

''Cooperators:''
* Claudio Tavares
* Sergio Alfaro
* Pedro Benito
* Ricardo Dalton
* David Delgado
* Emmanuelle Gutiérrez y Restrepo
* Mauricio Latorre
* Facundo Ortiz
* Raúl Vernengo
* Sergio Zúñiga
* Juan David Martinez Pavony

===Swedish===
* Anders Berggren

===Tagalog===
* Roel Cantada

===Tamil===
* Nagarajan Vadivel

===Tamil (Sri Lanka)===
* M A Kaleelur Rahuman (CVS)
* T.Gnanakumar
* Kengatharaiyer Sarveswaran (Sarves)

Significant assistance for the Tamil (LK) language translation of Moodle was facilitated by the National Online Distance Education Service (NODES) established by the Distance Education Modernisation Project (DEMP) of Ministry of Higher Education of Sri Lanka.

===Thai===
* M.Minkowski
* Worrapat Boonyaritipong (GHOP)

===Tongan===

Translated by the OSCINZ project
* Jeremy Fitzpatrick

===Turkish===
* Ethem Evlice (CVS)
* Dr. Gultekin Cetiner

===Ukrainian===
* Andriv Olefirenko

===Urdu===
* Faisal Kaleem

===Uzbek===
* Tokhir Akhmedjanov
ESDP DE project UZB 1961 Component B

Initial translation
* Orif N. Ruzimurodov
Center of the Development Multimedium Education Programms (CDMEP)

===Vietnamese===
* Đinh Lư Giang (CVS)
* Vu Thanh Hung

===Welsh===
* Karen Coyle

===Zulu===
* iCyber E-Learning Solutions on initiative of Gerrit Botha
* Coordination Lionel Redelinghuys
* Translation Mr. Nhlanhla Ndlovu

[[Category:Credits]]
[[Category:Translation]]

Documentation credits

2022-05-17T11:47:34Z

Tsala: /* Documentation writers */ date updated

{{Template:Migrated|newDocId=/general/community/credits/documentation}}
==Documentation writers==

The following people have made valuable contributions to the Moodle documentation:

Iñaki Arenaza, Dominique Bauer, Luca Bösch, Éric Bugnet, Abel Camacho, Chris Collman, Nicolas Connault, Mary Cooch, Manuel de la Torre, Martin Dougiamas, Mary Evans, Miroslav Fikar, Giuseppe Fiorentino, Helen Foster, Colin Fraser, John Harald Gartland, Gisela Hillenbrand, Tim Hunt, Art Lader, Eloy Lafuente (stronk7), Simey Lameze, Nicolas Martignoni, Michael Milette, Howard Miller, Ulrike Montgomery, Jérôme Mouneyrac, David Mudrak, Mark Nelson, Jamie Pratt, Frank Ralf, Emma Richardson, Koen Roggemans, Daniela Rotelli, David Scotson, Petr Škoda (škoďák), Séverin Terrier, Michael Tesar, Randy Thornton, Itamar Tzadok, German Valero, Paul Verrall, Antonio Vicent, Ken Wilson, Mitsuhiro Yoshida

(List updated 11:47, 17 May 2022 (UTC))

Apologies if anyone has been missed out from the above list. Please add their name to the [[Talk:Documentation credits|page comments]].

==See also==

* [http://moodle.org/user/index.php?id=5&group=178 Current Documentation writers in Moodle in English]

[[Category:Credits]]

Documentation credits

2022-05-17T10:27:29Z

Tsala: /* Documentation writers */ Michael Milette many thanks

{{Template:Migrated|newDocId=/general/community/credits/documentation}}
==Documentation writers==

The following people have made valuable contributions to the Moodle documentation:

Iñaki Arenaza, Dominique Bauer, Luca Bösch, Éric Bugnet, Abel Camacho, Chris Collman, Nicolas Connault, Mary Cooch, Manuel de la Torre, Martin Dougiamas, Mary Evans, Miroslav Fikar, Giuseppe Fiorentino, Helen Foster, Colin Fraser, John Harald Gartland, Gisela Hillenbrand, Tim Hunt, Art Lader, Eloy Lafuente (stronk7), Simey Lameze, Nicolas Martignoni, Michael Milette, Howard Miller, Ulrike Montgomery, Jérôme Mouneyrac, David Mudrak, Mark Nelson, Jamie Pratt, Frank Ralf, Emma Richardson, Koen Roggemans, Daniela Rotelli, David Scotson, Petr Škoda (škoďák), Séverin Terrier, Michael Tesar, Randy Thornton, Itamar Tzadok, German Valero, Paul Verrall, Antonio Vicent, Ken Wilson, Mitsuhiro Yoshida

(List updated 10:53, 15 November 2018 (UTC))

Apologies if anyone has been missed out from the above list. Please add their name to the [[Talk:Documentation credits|page comments]].

==See also==

* [http://moodle.org/user/index.php?id=5&group=178 Current Documentation writers in Moodle in English]

[[Category:Credits]]

Developer meeting April 2022

2022-05-02T12:15:37Z

Tsala: recording link available

[[Developer meetings]] > April 2022 meeting

{| class="wikitable"
|-
| Date
| Tuesday 12 April 2022 at 08:00 UTC
|-
| Meeting recording
| [https://moodle.org/mod/bigbluebuttonbn/view.php?id=8596 Developer meetings BBB on moodle.org]
|-
| Discussion
| [https://moodle.org/mod/forum/discuss.php?d=432769 Developer meeting Tuesday 12 April 2022]
|}

== Agenda ==

# Introducing Moodle 4.0 - Moodle HQ developers
# Developer Documentation update

Roadmap

2022-04-29T07:04:42Z

Tsala: /* Moodle 4.1 (November 2022) */

{{Template:Migrated|newDocId=/general/community/roadmap}}
= Introduction =
The Moodle Project is designed to have a positive effect on the world by supporting and empowering the educators who are teaching students in all sectors, in all countries.

To do this, our team at Moodle HQ looks to the world, talks with our community, and creates solutions in the forms of products that fit our values of '''education''', '''openness''', '''respect''', '''integrity''' and '''innovation'''.

This document summarises, for a broad audience, the best current plans on the future technical development of the Moodle’s open source learning platform, consisting of Moodle LMS, Moodle Workplace LMS, MoodleCloud, MoodleNet, Moodle Apps, and Moodle Educator Certificates.
==Where this roadmap comes from==
Proposals for improvements and new features come from a variety of different places.

Feedback from the community is extremely important and you can reach us by
* creating new issues on [http://tracker.moodle.org tracker],
* joining the [https://moodleassociation.org/ Moodle Users Association] to vote on a new project for each release,
* discussing your ideas on the [https://moodle.org/forums forums],
* creating new solutions as a plugin in the [https://moodle.org/plugins Moodle Plugins directory],
* or meeting us in person at one of our [https://moodle.com/events/ MoodleMoots]

Moodle also has an extensive network of [https://moodle.com/partners Moodle Partners]. Moodle Partners are service providers that are certified by Moodle HQ to provide high quality Moodle services for schools, institutions and organisations. We work closely with our partners to determine the needs of Moodle Users and improve the platform.

Our Roadmap is built via our [[Roadmap process]]. This process is continuously evolving but it always seeks to involve all our key stakeholders - students, teachers, admins, institutions, and of course our partners and supporters.
= The big picture =
Working on the Moodle learning platform involves millions of moving parts, and every release generally includes hundreds of improvements. However, there are '''four main goals''' that we are focussing on for the next two years:
=== User experience and flow ===
The entire user experience from onboarding, into daily teaching/learning and expert customisation of Moodle is the core value of what makes Moodle useful or not in the real world, in fully online and blended modes.

While we’re working on hundreds of smaller, annoying issues, we are also doing some major re-thinking around what an LMS should be in the next decade and beyond as a tool to empower educators and learners.
=== Enabling all our developers ===
Our significant community of engaged developers are an amazing group of over 1000 people - many of them make a living being part of the Moodle community.

We are of course working on ways to make Moodle programming easier and better, with better training and support as well as improved APIs, plugins, integrations and support for modern technologies.

However, a particularly exciting initiative is the new Moodle Plugins Service, due in 2021, which will provide an “app store” experience on which all developers can build financial sustainability for their work, while teachers will have easier access to use hundreds of new plugins in their courses via the web interface, without needing to convince their admins to install code. This will help the entire plugins ecosystem.
===Better integrations between Moodle products===
The current Moodle products already integrate with each other, of course, but there is much more to be done to make them work together more seamlessly, as part of one platform, so that our users have a better experience and also so that they become more aware of solutions to their problems.
=== Better integration with the world ===
Moodle is never used alone, and it is a part of many ecosystems at many levels. We must connect to all kinds of other systems, we must of course comply with new legislation such as the GDPR, Accessibility and much more.

In particular though, we are committed to helping to promote [https://openedtech.global/ <span class="underline">Open EdTech</span>] and to work closely with qualified Open EdTech products and major stakeholders to design and build an open architecture for a long-term future.

= Roadmap timeline =
{| class="wikitable" border="1"
|-
| '''2021'''
| '''Moodle LMS'''
| '''Moodle Workplace'''
| '''Moodle Apps'''
| '''MoodleCloud'''
| '''MoodleNet'''
| '''Moodle Academy'''
|-
| '''Q1'''
| '''Minor release(s)
| '''Dashboards
|
|
|
|
|-
| '''Q2'''
| '''Moodle 3.11
* Student activity completion (MUA)
* Open Badges v2.1 (Badge Connect API)
* Accessibility toolkit integration
'''Minor release(s)
|
|
|
|
|
* Learn Moodle Teaching Next Level.
* Learn Moodle 3.11 Basics (MOOC).
|-
| '''Q3'''
| '''Minor release(s)
|
|
|
|
|
* [https://moodle.academy Moodle.Academy] launched.

* [https://moodle.academy/mod/page/view.php?id=57&forceview=1 First Educator courses released].
|-
| '''Q4'''
| '''Minor release(s)'''
|
|
| '''<br />'''
<br />
|
|
* [https://moodle.academy/mod/page/view.php?id=57&forceview=1 Further Educator courses released].
|-
| '''2022'''
| '''Moodle LMS'''
| '''Moodle Workplace'''
| '''Moodle Apps'''
| '''MoodleCloud'''
| '''MoodleNet'''
| '''Moodle Academy'''
|-
| '''Q1'''
|'''Minor releases(s)'''
|
|
|
|
|
* [https://moodle.academy/mod/page/view.php?id=59&forceview=1 First Developer Beginner courses released].
|-
| '''Q2'''
|'''Moodle 4.0'''

'''UX improvements'''
* Navigation
* Course experience
* Onboarding
* Other wins (calendar / timeline block)
* UI consistency via component library

'''New:'''
* LTI 1.3 Advantage Tool / Provider implementation
* BigBlueButton integration
* Atto accessibility improvements (MUA)

* Workplace Report Builder integration
* Site admin presets
* Question bank improvements

'''Minor release(s)'''
| '''Release 4.0'''
| '''Release 4.0'''

'''Improved'''
Moodle LMS 4.0 compatibility

'''Moodle Workplace 4.0 compatibility'''

Classroom tools with friendly UX
| '''Release 4.0'''
|
|
* [https://moodle.academy/mod/page/view.php?id=57&forceview=1 Further Educator courses released]*.
* [https://moodle.academy/mod/page/view.php?id=58&forceview=1 First Administrator courses released]*.
* [https://moodle.academy/mod/page/view.php?id=59&forceview=1 Further Developer courses released]*.
* Learn Moodle courses migrated to [https://moodle.academy Moodle.Academy].
* Program certificates available for purchase.
* Translations in languages other than English.

<nowiki>*</nowiki>A course in each learning pathway (Educator, Administrator, Developer) will introduce changes in Moodle 4.0.
|-
| '''Q3'''
|'''Minor release(s)'''
|
|
|
|
|
|-
| '''Q4'''
| '''Moodle 4.1'''

'''UX improvements'''
* Course activities
* Gradebook
* Global UX (tables/filters)

'''New'''
* Improved integration with MoodleNet and other Moodle sites
* Improved integration with 3rd party platforms/tools
* Database improvements (MUA)
* Question bank improvements
|
| '''Release 4.1'''
| '''Release 4.1'''
|
|
|}
== Notes on the Moodle LMS releases ==
=== Moodle 4.1 (November 2022) ===
Moodle 4.1 (and following 4.x releases) will see a continuation of user experience (UX) improvements for the Moodle LMS platform. Moodle 4.0 focused on significant UX improvements for navigation and the main course page experience. In Moodle 4.1 we will focus on improving the UX for the course activities, commencing with the most widely used activities such as Assignment and Quiz. Improving the gradebook UX will be another main focus.

Other projects include:
* Improving the integration with MoodleNet
* Investigating and commencing the project to improve messaging in Moodle (likely integrating with [https://matrix.org/ Matrix] messaging)
* MUA projects to improve the Database and Assignment activities
* Continuing the [[Question bank improvements for Moodle 4.1|Question bank improvements]] project

===Moodle 4.0 (April 2022) ===
For our very large new releases such as 1.0, 2.0, 3.0 and now 4.0, we often take longer so that we can tackle more significant chunks of important core work, giving us the opportunity sometimes to make more serious changes to UX or architecture. Moodle 4.0 will focus on UX improvements.

As part of a significant UX and design change, the current focus is on three main UX projects:
* [[Moodle_4.0_navigation_improvements|Improved navigation]], search and menus - MDL-69588
* Making it easier to create and manage courses - MDL-70907
* Making it easier for students to know what they need to do to complete a course, and know what’s next

Other projects include:
* LTI 1.3 Advantage Tool / Provider implementation - MDL-69542
* BigBlueButton integration - MDL-70658
* a community proposal for the question bank being discussed and shaped by a consortium of universities - [[Question bank improvements for Moodle 4.0]].
* Integration of the [https://moodle.org/plugins/block_admin_presets admin presets] tool to enable saving, loading, and sharing of Moodle site configurations - [[Site admin presets]].
=== Moodle 3.11 (May 2021)===
In 2021 the majority of HQ developers will be focused on the UX improvements that are scheduled for Moodle 4.0. This means that the Moodle 3.11 release is anticipated to contain mostly community contributed improvements and a couple smaller HQ developments.

Note that while we will endeavour to include all community contributions in the 3.11 release, we may defer some improvements to a later release depending on the complexity, size, and impact on other scheduled work.

Scheduled projects for Moodle 3.11 are:
* [[Student activity completion]] (MUA) - MDL-70469
* Open Badges v2.1 (Badge Connect API) - MDL-71117
* Brickfield accessibility toolkit integration - MDL-71041
=== Release support timeframes ===
We are extending security support on Moodle 3.9 and Moodle 3.11 to November 2023. We are also extending general bug fix support on Moodle 3.11 by 6 months to November 2022. This will provide additional support and time for sites to make the transition to Moodle 4.0 or Moodle 4.1.
{| class="wikitable" border="1"
|-
! Version
! (Scheduled) Release date
! Full support period ends
! Security support period ends
|-
| Moodle 3.9 (LTS)
| 15 June 2020
| 10 May 2021
| 13 Nov 2023 (ext 6M)
|-
| Moodle 3.10
| 9 Nov 2020
| 8 Nov 2021
| 9 May 2022
|-
| Moodle 3.11
| 17 May 2021
| 14 Nov 2022 (ext 6M)
| 13 Nov 2023 (ext 12M)
|-
| Moodle 4.0
| Apr 2022
| May 2023
| Nov 2023
|-
| Moodle 4.1 (LTS)
| Nov 2022
| Nov 2023
| Nov 2025
|}
=Past releases=
See our [[Releases]] page for information about past releases.

After Moodle 2.0 we switched to time-based releases rather than feature-based releases (see our [https://docs.moodle.org/dev/Process development process]). Because of this, the details above on future releases are an indication of current priorities only, and are targeted to be released in the upcoming releases. Anything not ready by the next release date will generally be pushed to the following major release.
==See also==
* [[Releases]] - versions of Moodle that have already been released
* https://docs.moodle.org/dev/Releases#General_release_calendar Key dates relating to future releases.
[[es:Plan de desarrollo]]
[[fr:Planification]]
[[Category:Core development]]

Moodle 4.0 release notes

2022-04-28T12:23:12Z

Tsala: playlist link update

{{Template:Migrated|newDocId=/docs/release-notes}}
[[Releases]] > {{FULLPAGENAME}}

Release date: 19 April 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0].

See our [https://docs.moodle.org/400/en/New_features New features] page in the user documentation for an introduction to Moodle 4.0 with screenshots.
{{MediaPlayer | url = https://www.youtube.com/watch?v=sZxZ_YzsD_w&list=PLxcO_MFWQBDcI0BezfCOW8QRfJw6FblRn&ab_channel=Moodle | desc = Moodle 4.0 new features}}

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.
==Server requirements==
These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.
* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (see MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is recommended. It will be required in Moodle 4.2. For further details, see [https://docs.moodle.org/311/en/Environment_-_PHP_extension_sodium Environment - PHP extension sodium].
* PHP extension '''exif''' is recommended.
* PHP setting '''max_input_vars''' is recommended to be >= 5000 for PHP 7.x installations. It's a requirement for PHP 8.x installations. For further details, see [https://docs.moodle.org/311/en/Environment_-_max_input_vars Environment - max input vars].
=== Database requirements ===
Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.
{| class="wikitable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 10 (increased since Moodle 3.11)
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}
==Client requirements==
=== Browser support ===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
''Note: Moodle 4.0 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 4.0.

Mobile:
* MobileSafari
* Google Chrome
For the best experience and optimum security, we recommend that you keep your browser up to date.
==Major UX improvements==
===Navigation improvements===
* MDL-70208 - Implement frontend functionality for primary navigation
* MDL-70207 - Implement backend functionality for primary navigation
* MDL-70202 - Implement frontend functionality for secondary navigation
* MDL-70198 - Implement backend functionality for secondary navigation
* MDL-70196 - Create a module based navigation bar
* MDL-72352 - Ensure that secondary navigation is backwards compatible
* MDL-73462 - Course and category management secondary and tertiary navigation
* MDL-71977 - Define the secondary navigation nodes that should be always displayed in the more menu in the module context
* MDL-71901 - Allow plugins to define their own secondary nav ordering
* MDL-70844 - Update the secondary navigation view to send site administration information in tab form
* MDL-72396 - Allow easy setting of the active tab for navigation views
* MDL-71912 - Implement tertiary navigation for plugins (also see MDL-71913, MDL-71914 and MDL-71914)
* MDL-73863 - Tertiary navigation in course completion
* MDL-72875 - Add tertiary navigation to the participants page
* MDL-72904 - Add tertiary navigation to the badges pages
* MDL-72873 - Add tertiary navigation to the gradebook
* MDL-72094 - Update the course reports page styling and functionality
* MDL-71083 - Move the user menu in the top bar into the primary navigation menu in the mobile view
* MDL-73393 - Ensure that existing third party themes still work with latest navigation changes
* MDL-71943 - Dynamic (AJAX) tabs in Moodle LMS
* MDL-72090 - Convert course admin pages from link farms to dropdowns
* MDL-72413 - Move the activity modules title, description, and activity completion into a standard module API
* MDL-72736 - Remove section navigation on one section per page
* MDL-72834 - Move the calendar link into the user menu
* MDL-72450 - Remove the next and previous activity links from all activity modules in Boost
* MDL-71148 - Combine both the custom menu & primary navigation renderers
* MDL-71683 - Update language menu to move from the top navigation into the user menu when logged in
* MDL-72005 - Update the context_header in Boost to move the breadcrumb to the top
===Course index===
* MDL-71209 - Create the new course index list
* MDL-72660 - Add activity completion indicators to the course index
* MDL-71228 - Implement drag and drop option for sections and activities in the course index
* MDL-71211 - Keep the status of the course index collapsed and expanded sections per user and course
* MDL-71795 - Course index on activity view page
* MDL-71828 - Implement section links' behaviour in course index
* MDL-71664 - Enable drag & drop from course index to course content and vice versa
* MDL-72463 - Add 'highlighted' label to course index
* MDL-71727 - Sync course index and course content when an element is dragged
* MDL-72897 - Mark the current section in the course index
* MDL-73340 - Open course index by default first time a user access the course
* MDL-73310 - Show the course index on all pages within a course
===Course experience===
* MDL-71037 - Sections are now collapsible for Topics and Weekly course formats
* MDL-71691 - Created a new activity UI component
* MDL-71689 - Improvements to add activity and add section design
* MDL-71663 - Created a new "move" option in the sections and activity cog menu in the course editor
* MDL-71779 - Made 'Add a new topic/week' option client side on Topics and Weekly formats
* MDL-72311 - Proceed straight to course content when creating a new course
* MDL-71863 - Created core_courseformat subsystem
* MDL-72578 - Moved activity UI component to output classes and templates
* MDL-73343 - New quick access to create a new course from My courses page when there is no course available
===My Courses page and overview block===
* MDL-70801 - Implement "My courses" page
* MDL-58579 - Allow searching / filtering of courses in myoverview
* MDL-73231 - Provide option of having My courses as defaulthomepage
===Timeline block===
* MDL-72276 - Update timeline block dropdowns to display current selection
* MDL-72277 - Improve the layout and usability of the items in the timeline block
* MDL-73068 - Only display courses in the timeline block if they contain events
* MDL-72295 - Add text search to the timeline block
* MDL-72594 - Improve displaying of overdue items in the timeline block
* MDL-72603 - Replace timeline block pagination with "show more" lazy loading
* MDL-72543 - Change the display of the event names of the items on the timeline block
===Calendar usability===
* MDL-71817 - Render the calendar in the calendar block in month view
* MDL-72237 - Limit number of events shown per day in calendar month view
* MDL-71810 - Add a current date indicator and make calendar block responsive when switching between small and large views
* MDL-71808 - Move the import calendar form to its own page
* MDL-72045 - Improve help information provided on the calendar export page
* MDL-71790 - Revamp the manage subscriptions page
* MDL-71788 - Make it easier to copy the export URL
* MDL-71775 - Add footer links to the calendar block
* MDL-72810 - Remove 3-month calendar view
===Dashboard===
* MDL-72092 - Arrange blocks between My courses & My dashboard
* MDL-73114 - Display a title in the dashboard page
* MDL-71964 - Welcome message for users
* MDL-73233 - Provide option to disable the Dashboard
* MDL-72116 - Remove some of the default blocks from the Dashboard
===User tours===
* MDL-61674 - Allow user tours to be created using the Atto text editor
* MDL-72385 - Improve and simplify design of user tours
* MDL-71938 - Display number of steps in a user tour
* MDL-72783 - Add new user tours
* MDL-72781 - Remove previous user tours
* MDL-72557 - Implement customisable confirmation button for single step user tours
* MDL-71931 - Update user tours to emit events
===Other usability and user experience improvements===
* MDL-69371 - Redesign the Moodle login page (also see MDL-72928)
* MDL-71457 - Update the Moodle activity icons
* MDL-71963 - Turn confirmation page into modals
* MDL-71965 - New footer
* MDL-71456 - Create page drawers for the block and course index areas
* MDL-72095 - Set a main container width of Boost pages
* MDL-71610 - Move the turn editing on button into the navbar
* MDL-72305 - Show user initials as a placeholder for the user profile picture
* MDL-72278 - Fake blocks now in drawer are made visible on first visit
* MDL-72454 - Removal of back to top link
* MDL-72088 - Update styling across top level pages
* MDL-70888 - Update the layouts in Boost theme
* MDL-71292 - Update the page header and include course image / activity icon
* MDL-73608 - Provide a contact form which sends to the site support email and replace mailto link in footer
* MDL-73935 - Improved flexibility of site support form and consistency of site support info provided in Moodle
* MDL-61564 - Allow multiple cohort selection in cohort enrolment
* MDL-66539 - Better handling of link names and URLs with Atto
* MDL-73797 - Dialogues now have the action button on the right
* MDL-60917 - Add highest ranked results section to global search
* MDL-73917 - Notification preferences page improvements
* MDL-72500 - Easier to find a specific component in event list report
* MDL-32103 - Course completion is instant for activity based completion criteria (single user completions only)
==Other major features==
===Report builder integration (from Moodle Workplace)===
* MDL-70795 - Implement functionality for creating custom reports
* MDL-70794 - Implement functionality for creating system reports
* MDL-72588 - Implement custom report audiences
* MDL-72598 - Implement custom report schedules
* MDL-73598 - Allow Custom Reports to be disabled by site admin
* MDL-72280 - Create "Courses" custom report source
* MDL-73069 - Report condition to limit returned data to current user
* MDL-73180 - Improve definitions of previous/next relative date filters
* MDL-72662 - Implement relative date options in the Reportbuilder date filter
* MDL-72172 - Create "Cohort members" custom report source
* MDL-72962 - Format editable report elements (column, filters, etc)
* MDL-72826 - Custom report option to display unique row values
* MDL-71153 - Convert task logs report to a system report
* MDL-71070 - Convert configuration changes report to a system report
===BigBlueButton integration===
* MDL-70658 - Integrate the BigBlueButton plugin into Moodle LMS
===Quiz and Questions===
* MDL-71516 - Create new plugin type - Qbank (for the full list of qbank plugins added to core, see MDL-70329)
* MDL-71679 - Update mod_quiz for new question bank
* MDL-71636 - Add a columnsortorder settings page
* MDL-71696 - Add question versions
* MDL-72076 - Question bank bulk action UI
* MDL-72553 - Add custom fields to questions
* MDL-52206 - Move "Require passing grade" completion option to core
* MDL-52456 - Add notification message for students after questions have been manually graded
* MDL-71984 - Add logging to quiz auto-save, process_attempt and redo_question
* MDL-73337 - Log editing quizzes in detail
* MDL-73699 - Question status UI/UX update
* MDL-72448 - Add qbank_history to core
* MDL-71614 - Add qbank_previewquestion to core
===Update LTI tool provider feature to support 1.3===
* MDL-69543 - Update tool to support 1.3 OAuth2/OIDC launch flow
* MDL-71371 - Provide upgrade path for 1.1 preconfigured tools
* MDL-72745 - Provide account provisioning options for LTI Advantage launches
* MDL-69547 - Update tool enrolment code so that a user is automatically created and enrolled when launching via 1.3
* MDL-69545 - Update user sync task to support 1.3 messages
* MDL-69544 - Update grade sync task to support 1.3 messages
* MDL-72288 - Update library and model code to support issuer and clientid uniqueness on registrations
* MDL-69862 - Add dynamic registration support to the tool
* MDL-70354 - Return line item information during content selection
===Assignment===
* MDL-68913 - Per attempt timing now available in assignments
===Admin configuration presets===
* MDL-72112 - Integrate admin_presets third-party plugin in Moodle LMS
* MDL-73145 - Add a $CFG setting to define the preset to be installed
* MDL-72114 - Include pre-installed admin presets
* MDL-72113 - Add feature to import/export plugins visibility from Admin presets tool
* MDL-73394 - Store the latest site admin preset applied
===Content bank and H5P===
* MDL-68394 - Integrate mod_h5pactivity with recent activity plugins
* MDL-72099 - Add navigation by contexts in the content bank
* MDL-71885 - Inline editing H5P content for mod_h5pactivity
* MDL-71956 - Inline editing H5P content anywhere
===Badges===
* MDL-72141 - Simplifying the external badge page
===Accessibility improvements===
* MDL-67853 - Remove online-offline options on notifications
* MDL-72078 - Give users an indication that they encountered an editor
* MDL-71604 - Move the screen reader helper button to the first row
* MDL-72896 - Make html_tables responsive by default
==Other Highlights==
===Functional changes===
* MDL-70456 - Add custom user field support to all places that display user identity [0,Minor] Improvement
* MDL-73342 - Disable some blocks by default (such as feedback, RSS and self-completion)
* MDL-70905 - Updated media default width/height to use 16:9
* MDL-72118 - Rename "HTML block" to the more easily understood "Text block"
* MDL-72706 - Change default value of "Hidden sections" course format setting
* MDL-72115 - Rename "Miscellaneous" category to "Category 1"
* MDL-72119 - Make “Enable xxxxx” features consistent (hide menus for disabled features)
===For administrators===
* MDL-71347 - Add a filter to "browse list of users" for date of user account creation
* MDL-72031 - Separate out max_time for audio and video files in Atto/RecordRTC
* MDL-71515 - Improve the test outgoing mail configuration admin page
* MDL-67686 - Add more filters to task log (/admin/tasklogs.php)
* MDL-72984 - Ensure support email address is mandatory
* MDL-73592 - MoodleNet integration now enabled by default
* MDL-71621 - Parent role cannot edit custom fields in child profile
* MDL-73918 - Allow admins to change the page width using custom SCSS
* MDL-71927 - Logs and question attempt history now show time to the second, to help investigate issues
* MDL-71466 - Custom user field support: Admin role screens (check permissions, assign)
* MDL-72619 - Provide admin page to view cache size estimates
* MDL-67822 - New check_database_schema performance check
* MDL-70271 - Dropbox token and Permission Updates
* MDL-58395 - LDAP auth sync now skip and report problematic user accounts
* MDL-72251 - Tasks admin UI now shows time to nearest second
===Mobile===
* MDL-67807 - Return concurrent sessions information to apply concurrent login limit in the mobile app
* MDL-69555 - Make duration of QR login and auto-login time between requests configurable
* MDL-73794 - Update the footer in the mobile view
===Performance===
* MDL-72596 - Caching: Track cache I/O size in perfdebug
* MDL-69088 - Make file cache store purges instant with a safe and async purge
* MDL-68164 - Additional caching of pg_field_type postgres field metadata
* MDL-63983 - Improve the performance of non-contact searches in messaging when site-wide messaging is disabled (default)
* MDL-71014 - Cache the siteidentifier and site contextid in local cache
* MDL-72328 - Add TTL support for Redis caches
* MDL-72837 - Cache API should support versioned data
==Security improvements==
* MDL-56873 - Set more secure defaults for the cURL allow/deny lists
* MDL-66776 - Send notifications when new devices are used to log in into the site
* MDL-71627 - Add check API for anti virus and optionally remove admin notifications
* MDL-71806 - Improved the UX of the Moodle security report
* MDL-71176 - New password and change forms should have autocomplete="new-password"
==For developers==
* MDL-61460 - Introduce the UI components library
* MDL-74229 - Add navigation node keys to allow themers to hide navigation tabs
* MDL-74235 - Rename the icons for activities to allow support of multiple icons for multiple versions
* MDL-74033 - Allow full customisation of the primary navigation
* MDL-72779 - Set more than one value on a persistent at the same time
* MDL-70862 - Implement a new callback to extend gradebook plugininfo
* MDL-72289 - Allow callers to customise the rendered icon of inplace editable elements
* MDL-73347 - Allow themes to define un-addable blocks
* MDL-46778 - Allow use a separate DB configuration (not just prefix) for Behat similar to PHPUnit
* MDL-73270 - Warn where XMLRPC is currently in use
* MDL-67228 - Tool_replace maturity set
===Web service additions and updates===
* MDL-71135 - Create core_course_get_state web service
* MDL-71165 - Create core_course_update_course web service
===Core plugins removed===
* MDL-71473 - Jabber removed as a standard notification plugin
* MDL-58939 - Picasa repository and portfolio removed from core
* MDL-72335 - Tool_health removed from core
* MDL-72615 - Boxnet plugins removed from core
* MDL-72616 - Quiz results block removed from core
* MDL-72348 - Microsoft OneDrive (legacy) repository (repository_skydrive) removed from core
* MDL-72347 - Word censorship filter (filter_censor) removed from core
* MDL-72407 - VideoJS Flash plugin removed from core
* MDL-72042 - Flash animation media player removed from core
* MDL-72041 - WebCT question import format removed from core
* MDL-72517 - Examview question import format removed from core
===Deprecations===
* MDL-53544 - Typo3 library removed
* MDL-72004 - Quiz 4.0 Class renaming and deprecation
* MDL-73756 - Deprecate $modinfo param to completion_info::get_data()
* MDL-65799 - Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
* MDL-71175 - Deprecate some plagiarism functions that are not used, or have replacements
* MDL-66266 - Remove deprecated functions in messages/classes/api.php
* MDL-72098 - deprecate grade_grade::insert method that just calls its parent
* MDL-72433 - Final deprecation of get_grades() in lib/classes/grades_external.php
* MDL-71476 - Remove mysql_engine.php
* MDL-65252 - Final deprecations of forum_count_replies and get_forum_discussion_posts
* MDL-67412 - Remove deprecated functions in lib/setuplib.php
* MDL-65801 - Remove strings deprecated in 3.8
===Component API updates===
* admin/tool/generator/upgrade.txt
* admin/tool/log/upgrade.txt
* admin/tool/mobile/upgrade.txt
* admin/tool/upgrade.txt
* admin/tool/usertours/upgrade.txt
* admin/upgrade.txt
* analytics/upgrade.txt
* auth/shibboleth/upgrade.txt
* availability/upgrade.txt
* backup/upgrade.txt
* badges/upgrade.txt
* blocks/section_links/upgrade.txt
* blocks/tag_youtube/upgrade.txt
* blocks/timeline/upgrade.txt
* blocks/upgrade.txt
* cache/upgrade.txt
* calendar/upgrade.txt
* completion/upgrade.txt
* contentbank/upgrade.txt
* course/format/upgrade.txt
* course/upgrade.txt
* customfield/upgrade.txt
* dataformat/upgrade.txt
* enrol/database/upgrade.txt
* enrol/upgrade.txt
* filter/upgrade.txt
* grade/grading/form/upgrade.txt
* grade/upgrade.txt
* group/upgrade.txt
* h5p/upgrade.txt
* lib/upgrade.txt
* media/upgrade.txt
* message/upgrade.txt
* mod/assign/upgrade.txt
* mod/book/upgrade.txt
* mod/feedback/upgrade.txt
* mod/forum/upgrade.txt
* mod/glossary/upgrade.txt
* mod/h5pactivity/upgrade.txt
* mod/lesson/upgrade.txt
* mod/lti/upgrade.txt
* mod/page/upgrade.txt
* mod/quiz/upgrade.txt
* mod/resource/upgrade.txt
* mod/scorm/upgrade.txt
* mod/upgrade.txt
* mod/url/upgrade.txt
* mod/wiki/upgrade.txt
* mod/workshop/upgrade.txt
* my/upgrade.txt
* payment/upgrade.txt
* plagiarism/upgrade.txt
* portfolio/upgrade.txt
* question/bank/upgrade.txt
* question/behaviour/upgrade.txt
* question/engine/upgrade.txt
* question/format/upgrade.txt
* question/type/multichoice/upgrade.txt
* question/type/upgrade.txt
* question/upgrade.txt
* report/eventlist/upgrade.txt
* report/upgrade.txt
* repository/upgrade.txt
* search/upgrade.txt
* theme/upgrade.txt
* user/upgrade.txt
* webservice/upgrade.txt

==See also==
*[[Moodle 3.11 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0]]
[[es:Notas de Moodle 4.0]]

Moodle 4.0 release notes

2022-04-28T09:24:34Z

Tsala:

{{Template:Migrated|newDocId=/docs/release-notes}}
[[Releases]] > {{FULLPAGENAME}}

Release date: 19 April 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0].

See our [https://docs.moodle.org/400/en/New_features New features] page in the user documentation for an introduction to Moodle 4.0 with screenshots.
{{MediaPlayer | url = https://youtu.be/sZxZ_YzsD_w | desc = Moodle 4.0 new features}}

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.
==Server requirements==
These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.
* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (see MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is recommended. It will be required in Moodle 4.2. For further details, see [https://docs.moodle.org/311/en/Environment_-_PHP_extension_sodium Environment - PHP extension sodium].
* PHP extension '''exif''' is recommended.
* PHP setting '''max_input_vars''' is recommended to be >= 5000 for PHP 7.x installations. It's a requirement for PHP 8.x installations. For further details, see [https://docs.moodle.org/311/en/Environment_-_max_input_vars Environment - max input vars].
=== Database requirements ===
Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.
{| class="wikitable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 10 (increased since Moodle 3.11)
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}
==Client requirements==
=== Browser support ===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
''Note: Moodle 4.0 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 4.0.

Mobile:
* MobileSafari
* Google Chrome
For the best experience and optimum security, we recommend that you keep your browser up to date.
==Major UX improvements==
===Navigation improvements===
* MDL-70208 - Implement frontend functionality for primary navigation
* MDL-70207 - Implement backend functionality for primary navigation
* MDL-70202 - Implement frontend functionality for secondary navigation
* MDL-70198 - Implement backend functionality for secondary navigation
* MDL-70196 - Create a module based navigation bar
* MDL-72352 - Ensure that secondary navigation is backwards compatible
* MDL-73462 - Course and category management secondary and tertiary navigation
* MDL-71977 - Define the secondary navigation nodes that should be always displayed in the more menu in the module context
* MDL-71901 - Allow plugins to define their own secondary nav ordering
* MDL-70844 - Update the secondary navigation view to send site administration information in tab form
* MDL-72396 - Allow easy setting of the active tab for navigation views
* MDL-71912 - Implement tertiary navigation for plugins (also see MDL-71913, MDL-71914 and MDL-71914)
* MDL-73863 - Tertiary navigation in course completion
* MDL-72875 - Add tertiary navigation to the participants page
* MDL-72904 - Add tertiary navigation to the badges pages
* MDL-72873 - Add tertiary navigation to the gradebook
* MDL-72094 - Update the course reports page styling and functionality
* MDL-71083 - Move the user menu in the top bar into the primary navigation menu in the mobile view
* MDL-73393 - Ensure that existing third party themes still work with latest navigation changes
* MDL-71943 - Dynamic (AJAX) tabs in Moodle LMS
* MDL-72090 - Convert course admin pages from link farms to dropdowns
* MDL-72413 - Move the activity modules title, description, and activity completion into a standard module API
* MDL-72736 - Remove section navigation on one section per page
* MDL-72834 - Move the calendar link into the user menu
* MDL-72450 - Remove the next and previous activity links from all activity modules in Boost
* MDL-71148 - Combine both the custom menu & primary navigation renderers
* MDL-71683 - Update language menu to move from the top navigation into the user menu when logged in
* MDL-72005 - Update the context_header in Boost to move the breadcrumb to the top
===Course index===
* MDL-71209 - Create the new course index list
* MDL-72660 - Add activity completion indicators to the course index
* MDL-71228 - Implement drag and drop option for sections and activities in the course index
* MDL-71211 - Keep the status of the course index collapsed and expanded sections per user and course
* MDL-71795 - Course index on activity view page
* MDL-71828 - Implement section links' behaviour in course index
* MDL-71664 - Enable drag & drop from course index to course content and vice versa
* MDL-72463 - Add 'highlighted' label to course index
* MDL-71727 - Sync course index and course content when an element is dragged
* MDL-72897 - Mark the current section in the course index
* MDL-73340 - Open course index by default first time a user access the course
* MDL-73310 - Show the course index on all pages within a course
===Course experience===
* MDL-71037 - Sections are now collapsible for Topics and Weekly course formats
* MDL-71691 - Created a new activity UI component
* MDL-71689 - Improvements to add activity and add section design
* MDL-71663 - Created a new "move" option in the sections and activity cog menu in the course editor
* MDL-71779 - Made 'Add a new topic/week' option client side on Topics and Weekly formats
* MDL-72311 - Proceed straight to course content when creating a new course
* MDL-71863 - Created core_courseformat subsystem
* MDL-72578 - Moved activity UI component to output classes and templates
* MDL-73343 - New quick access to create a new course from My courses page when there is no course available
===My Courses page and overview block===
* MDL-70801 - Implement "My courses" page
* MDL-58579 - Allow searching / filtering of courses in myoverview
* MDL-73231 - Provide option of having My courses as defaulthomepage
===Timeline block===
* MDL-72276 - Update timeline block dropdowns to display current selection
* MDL-72277 - Improve the layout and usability of the items in the timeline block
* MDL-73068 - Only display courses in the timeline block if they contain events
* MDL-72295 - Add text search to the timeline block
* MDL-72594 - Improve displaying of overdue items in the timeline block
* MDL-72603 - Replace timeline block pagination with "show more" lazy loading
* MDL-72543 - Change the display of the event names of the items on the timeline block
===Calendar usability===
* MDL-71817 - Render the calendar in the calendar block in month view
* MDL-72237 - Limit number of events shown per day in calendar month view
* MDL-71810 - Add a current date indicator and make calendar block responsive when switching between small and large views
* MDL-71808 - Move the import calendar form to its own page
* MDL-72045 - Improve help information provided on the calendar export page
* MDL-71790 - Revamp the manage subscriptions page
* MDL-71788 - Make it easier to copy the export URL
* MDL-71775 - Add footer links to the calendar block
* MDL-72810 - Remove 3-month calendar view
===Dashboard===
* MDL-72092 - Arrange blocks between My courses & My dashboard
* MDL-73114 - Display a title in the dashboard page
* MDL-71964 - Welcome message for users
* MDL-73233 - Provide option to disable the Dashboard
* MDL-72116 - Remove some of the default blocks from the Dashboard
===User tours===
* MDL-61674 - Allow user tours to be created using the Atto text editor
* MDL-72385 - Improve and simplify design of user tours
* MDL-71938 - Display number of steps in a user tour
* MDL-72783 - Add new user tours
* MDL-72781 - Remove previous user tours
* MDL-72557 - Implement customisable confirmation button for single step user tours
* MDL-71931 - Update user tours to emit events
===Other usability and user experience improvements===
* MDL-69371 - Redesign the Moodle login page (also see MDL-72928)
* MDL-71457 - Update the Moodle activity icons
* MDL-71963 - Turn confirmation page into modals
* MDL-71965 - New footer
* MDL-71456 - Create page drawers for the block and course index areas
* MDL-72095 - Set a main container width of Boost pages
* MDL-71610 - Move the turn editing on button into the navbar
* MDL-72305 - Show user initials as a placeholder for the user profile picture
* MDL-72278 - Fake blocks now in drawer are made visible on first visit
* MDL-72454 - Removal of back to top link
* MDL-72088 - Update styling across top level pages
* MDL-70888 - Update the layouts in Boost theme
* MDL-71292 - Update the page header and include course image / activity icon
* MDL-73608 - Provide a contact form which sends to the site support email and replace mailto link in footer
* MDL-73935 - Improved flexibility of site support form and consistency of site support info provided in Moodle
* MDL-61564 - Allow multiple cohort selection in cohort enrolment
* MDL-66539 - Better handling of link names and URLs with Atto
* MDL-73797 - Dialogues now have the action button on the right
* MDL-60917 - Add highest ranked results section to global search
* MDL-73917 - Notification preferences page improvements
* MDL-72500 - Easier to find a specific component in event list report
* MDL-32103 - Course completion is instant for activity based completion criteria (single user completions only)
==Other major features==
===Report builder integration (from Moodle Workplace)===
* MDL-70795 - Implement functionality for creating custom reports
* MDL-70794 - Implement functionality for creating system reports
* MDL-72588 - Implement custom report audiences
* MDL-72598 - Implement custom report schedules
* MDL-73598 - Allow Custom Reports to be disabled by site admin
* MDL-72280 - Create "Courses" custom report source
* MDL-73069 - Report condition to limit returned data to current user
* MDL-73180 - Improve definitions of previous/next relative date filters
* MDL-72662 - Implement relative date options in the Reportbuilder date filter
* MDL-72172 - Create "Cohort members" custom report source
* MDL-72962 - Format editable report elements (column, filters, etc)
* MDL-72826 - Custom report option to display unique row values
* MDL-71153 - Convert task logs report to a system report
* MDL-71070 - Convert configuration changes report to a system report
===BigBlueButton integration===
* MDL-70658 - Integrate the BigBlueButton plugin into Moodle LMS
===Quiz and Questions===
* MDL-71516 - Create new plugin type - Qbank (for the full list of qbank plugins added to core, see MDL-70329)
* MDL-71679 - Update mod_quiz for new question bank
* MDL-71636 - Add a columnsortorder settings page
* MDL-71696 - Add question versions
* MDL-72076 - Question bank bulk action UI
* MDL-72553 - Add custom fields to questions
* MDL-52206 - Move "Require passing grade" completion option to core
* MDL-52456 - Add notification message for students after questions have been manually graded
* MDL-71984 - Add logging to quiz auto-save, process_attempt and redo_question
* MDL-73337 - Log editing quizzes in detail
* MDL-73699 - Question status UI/UX update
* MDL-72448 - Add qbank_history to core
* MDL-71614 - Add qbank_previewquestion to core
===Update LTI tool provider feature to support 1.3===
* MDL-69543 - Update tool to support 1.3 OAuth2/OIDC launch flow
* MDL-71371 - Provide upgrade path for 1.1 preconfigured tools
* MDL-72745 - Provide account provisioning options for LTI Advantage launches
* MDL-69547 - Update tool enrolment code so that a user is automatically created and enrolled when launching via 1.3
* MDL-69545 - Update user sync task to support 1.3 messages
* MDL-69544 - Update grade sync task to support 1.3 messages
* MDL-72288 - Update library and model code to support issuer and clientid uniqueness on registrations
* MDL-69862 - Add dynamic registration support to the tool
* MDL-70354 - Return line item information during content selection
===Assignment===
* MDL-68913 - Per attempt timing now available in assignments
===Admin configuration presets===
* MDL-72112 - Integrate admin_presets third-party plugin in Moodle LMS
* MDL-73145 - Add a $CFG setting to define the preset to be installed
* MDL-72114 - Include pre-installed admin presets
* MDL-72113 - Add feature to import/export plugins visibility from Admin presets tool
* MDL-73394 - Store the latest site admin preset applied
===Content bank and H5P===
* MDL-68394 - Integrate mod_h5pactivity with recent activity plugins
* MDL-72099 - Add navigation by contexts in the content bank
* MDL-71885 - Inline editing H5P content for mod_h5pactivity
* MDL-71956 - Inline editing H5P content anywhere
===Badges===
* MDL-72141 - Simplifying the external badge page
===Accessibility improvements===
* MDL-67853 - Remove online-offline options on notifications
* MDL-72078 - Give users an indication that they encountered an editor
* MDL-71604 - Move the screen reader helper button to the first row
* MDL-72896 - Make html_tables responsive by default
==Other Highlights==
===Functional changes===
* MDL-70456 - Add custom user field support to all places that display user identity [0,Minor] Improvement
* MDL-73342 - Disable some blocks by default (such as feedback, RSS and self-completion)
* MDL-70905 - Updated media default width/height to use 16:9
* MDL-72118 - Rename "HTML block" to the more easily understood "Text block"
* MDL-72706 - Change default value of "Hidden sections" course format setting
* MDL-72115 - Rename "Miscellaneous" category to "Category 1"
* MDL-72119 - Make “Enable xxxxx” features consistent (hide menus for disabled features)
===For administrators===
* MDL-71347 - Add a filter to "browse list of users" for date of user account creation
* MDL-72031 - Separate out max_time for audio and video files in Atto/RecordRTC
* MDL-71515 - Improve the test outgoing mail configuration admin page
* MDL-67686 - Add more filters to task log (/admin/tasklogs.php)
* MDL-72984 - Ensure support email address is mandatory
* MDL-73592 - MoodleNet integration now enabled by default
* MDL-71621 - Parent role cannot edit custom fields in child profile
* MDL-73918 - Allow admins to change the page width using custom SCSS
* MDL-71927 - Logs and question attempt history now show time to the second, to help investigate issues
* MDL-71466 - Custom user field support: Admin role screens (check permissions, assign)
* MDL-72619 - Provide admin page to view cache size estimates
* MDL-67822 - New check_database_schema performance check
* MDL-70271 - Dropbox token and Permission Updates
* MDL-58395 - LDAP auth sync now skip and report problematic user accounts
* MDL-72251 - Tasks admin UI now shows time to nearest second
===Mobile===
* MDL-67807 - Return concurrent sessions information to apply concurrent login limit in the mobile app
* MDL-69555 - Make duration of QR login and auto-login time between requests configurable
* MDL-73794 - Update the footer in the mobile view
===Performance===
* MDL-72596 - Caching: Track cache I/O size in perfdebug
* MDL-69088 - Make file cache store purges instant with a safe and async purge
* MDL-68164 - Additional caching of pg_field_type postgres field metadata
* MDL-63983 - Improve the performance of non-contact searches in messaging when site-wide messaging is disabled (default)
* MDL-71014 - Cache the siteidentifier and site contextid in local cache
* MDL-72328 - Add TTL support for Redis caches
* MDL-72837 - Cache API should support versioned data
==Security improvements==
* MDL-56873 - Set more secure defaults for the cURL allow/deny lists
* MDL-66776 - Send notifications when new devices are used to log in into the site
* MDL-71627 - Add check API for anti virus and optionally remove admin notifications
* MDL-71806 - Improved the UX of the Moodle security report
* MDL-71176 - New password and change forms should have autocomplete="new-password"
==For developers==
* MDL-61460 - Introduce the UI components library
* MDL-74229 - Add navigation node keys to allow themers to hide navigation tabs
* MDL-74235 - Rename the icons for activities to allow support of multiple icons for multiple versions
* MDL-74033 - Allow full customisation of the primary navigation
* MDL-72779 - Set more than one value on a persistent at the same time
* MDL-70862 - Implement a new callback to extend gradebook plugininfo
* MDL-72289 - Allow callers to customise the rendered icon of inplace editable elements
* MDL-73347 - Allow themes to define un-addable blocks
* MDL-46778 - Allow use a separate DB configuration (not just prefix) for Behat similar to PHPUnit
* MDL-73270 - Warn where XMLRPC is currently in use
* MDL-67228 - Tool_replace maturity set
===Web service additions and updates===
* MDL-71135 - Create core_course_get_state web service
* MDL-71165 - Create core_course_update_course web service
===Core plugins removed===
* MDL-71473 - Jabber removed as a standard notification plugin
* MDL-58939 - Picasa repository and portfolio removed from core
* MDL-72335 - Tool_health removed from core
* MDL-72615 - Boxnet plugins removed from core
* MDL-72616 - Quiz results block removed from core
* MDL-72348 - Microsoft OneDrive (legacy) repository (repository_skydrive) removed from core
* MDL-72347 - Word censorship filter (filter_censor) removed from core
* MDL-72407 - VideoJS Flash plugin removed from core
* MDL-72042 - Flash animation media player removed from core
* MDL-72041 - WebCT question import format removed from core
* MDL-72517 - Examview question import format removed from core
===Deprecations===
* MDL-53544 - Typo3 library removed
* MDL-72004 - Quiz 4.0 Class renaming and deprecation
* MDL-73756 - Deprecate $modinfo param to completion_info::get_data()
* MDL-65799 - Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
* MDL-71175 - Deprecate some plagiarism functions that are not used, or have replacements
* MDL-66266 - Remove deprecated functions in messages/classes/api.php
* MDL-72098 - deprecate grade_grade::insert method that just calls its parent
* MDL-72433 - Final deprecation of get_grades() in lib/classes/grades_external.php
* MDL-71476 - Remove mysql_engine.php
* MDL-65252 - Final deprecations of forum_count_replies and get_forum_discussion_posts
* MDL-67412 - Remove deprecated functions in lib/setuplib.php
* MDL-65801 - Remove strings deprecated in 3.8
===Component API updates===
* admin/tool/generator/upgrade.txt
* admin/tool/log/upgrade.txt
* admin/tool/mobile/upgrade.txt
* admin/tool/upgrade.txt
* admin/tool/usertours/upgrade.txt
* admin/upgrade.txt
* analytics/upgrade.txt
* auth/shibboleth/upgrade.txt
* availability/upgrade.txt
* backup/upgrade.txt
* badges/upgrade.txt
* blocks/section_links/upgrade.txt
* blocks/tag_youtube/upgrade.txt
* blocks/timeline/upgrade.txt
* blocks/upgrade.txt
* cache/upgrade.txt
* calendar/upgrade.txt
* completion/upgrade.txt
* contentbank/upgrade.txt
* course/format/upgrade.txt
* course/upgrade.txt
* customfield/upgrade.txt
* dataformat/upgrade.txt
* enrol/database/upgrade.txt
* enrol/upgrade.txt
* filter/upgrade.txt
* grade/grading/form/upgrade.txt
* grade/upgrade.txt
* group/upgrade.txt
* h5p/upgrade.txt
* lib/upgrade.txt
* media/upgrade.txt
* message/upgrade.txt
* mod/assign/upgrade.txt
* mod/book/upgrade.txt
* mod/feedback/upgrade.txt
* mod/forum/upgrade.txt
* mod/glossary/upgrade.txt
* mod/h5pactivity/upgrade.txt
* mod/lesson/upgrade.txt
* mod/lti/upgrade.txt
* mod/page/upgrade.txt
* mod/quiz/upgrade.txt
* mod/resource/upgrade.txt
* mod/scorm/upgrade.txt
* mod/upgrade.txt
* mod/url/upgrade.txt
* mod/wiki/upgrade.txt
* mod/workshop/upgrade.txt
* my/upgrade.txt
* payment/upgrade.txt
* plagiarism/upgrade.txt
* portfolio/upgrade.txt
* question/bank/upgrade.txt
* question/behaviour/upgrade.txt
* question/engine/upgrade.txt
* question/format/upgrade.txt
* question/type/multichoice/upgrade.txt
* question/type/upgrade.txt
* question/upgrade.txt
* report/eventlist/upgrade.txt
* report/upgrade.txt
* repository/upgrade.txt
* search/upgrade.txt
* theme/upgrade.txt
* user/upgrade.txt
* webservice/upgrade.txt

==See also==
*[[Moodle 3.11 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0]]
[[es:Notas de Moodle 4.0]]

Template:MediaPlayer

2022-04-28T09:14:09Z

Tsala: div

<includeonly>
<div class="right">{{#evt:
service=youtube
|id={{{url}}}
|description={{{desc|{{{url}}}}}}
|urlargs=modestbranding=1&rel=0
}}</div></includeonly><noinclude>

Displays an embedded media player of the given YouTube video.

== Syntax ==

<nowiki>{{MediaPlayer | url = https://www.youtube.com/watch?v=U7M3sZL6wts | desc = Video description}}</nowiki>

</noinclude>

Moodle 4.0 release notes

2022-04-28T09:00:23Z

Tsala: Moodle 4.0 new features video

{{Template:Migrated|newDocId=/docs/release-notes}}
[[Releases]] > {{FULLPAGENAME}}

Release date: 19 April 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0].

See our [https://docs.moodle.org/400/en/New_features New features] page in the user documentation for an introduction to Moodle 4.0 with screenshots.

{{MediaPlayer | url = https://youtu.be/sZxZ_YzsD_w | desc = Moodle 4.0 new features}}

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.
==Server requirements==
These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.
* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (see MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is recommended. It will be required in Moodle 4.2. For further details, see [https://docs.moodle.org/311/en/Environment_-_PHP_extension_sodium Environment - PHP extension sodium].
* PHP extension '''exif''' is recommended.
* PHP setting '''max_input_vars''' is recommended to be >= 5000 for PHP 7.x installations. It's a requirement for PHP 8.x installations. For further details, see [https://docs.moodle.org/311/en/Environment_-_max_input_vars Environment - max input vars].
=== Database requirements ===
Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.
{| class="wikitable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 10 (increased since Moodle 3.11)
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}
==Client requirements==
=== Browser support ===
Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge
''Note: Moodle 4.0 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 4.0.

Mobile:
* MobileSafari
* Google Chrome
For the best experience and optimum security, we recommend that you keep your browser up to date.
==Major UX improvements==
===Navigation improvements===
* MDL-70208 - Implement frontend functionality for primary navigation
* MDL-70207 - Implement backend functionality for primary navigation
* MDL-70202 - Implement frontend functionality for secondary navigation
* MDL-70198 - Implement backend functionality for secondary navigation
* MDL-70196 - Create a module based navigation bar
* MDL-72352 - Ensure that secondary navigation is backwards compatible
* MDL-73462 - Course and category management secondary and tertiary navigation
* MDL-71977 - Define the secondary navigation nodes that should be always displayed in the more menu in the module context
* MDL-71901 - Allow plugins to define their own secondary nav ordering
* MDL-70844 - Update the secondary navigation view to send site administration information in tab form
* MDL-72396 - Allow easy setting of the active tab for navigation views
* MDL-71912 - Implement tertiary navigation for plugins (also see MDL-71913, MDL-71914 and MDL-71914)
* MDL-73863 - Tertiary navigation in course completion
* MDL-72875 - Add tertiary navigation to the participants page
* MDL-72904 - Add tertiary navigation to the badges pages
* MDL-72873 - Add tertiary navigation to the gradebook
* MDL-72094 - Update the course reports page styling and functionality
* MDL-71083 - Move the user menu in the top bar into the primary navigation menu in the mobile view
* MDL-73393 - Ensure that existing third party themes still work with latest navigation changes
* MDL-71943 - Dynamic (AJAX) tabs in Moodle LMS
* MDL-72090 - Convert course admin pages from link farms to dropdowns
* MDL-72413 - Move the activity modules title, description, and activity completion into a standard module API
* MDL-72736 - Remove section navigation on one section per page
* MDL-72834 - Move the calendar link into the user menu
* MDL-72450 - Remove the next and previous activity links from all activity modules in Boost
* MDL-71148 - Combine both the custom menu & primary navigation renderers
* MDL-71683 - Update language menu to move from the top navigation into the user menu when logged in
* MDL-72005 - Update the context_header in Boost to move the breadcrumb to the top
===Course index===
* MDL-71209 - Create the new course index list
* MDL-72660 - Add activity completion indicators to the course index
* MDL-71228 - Implement drag and drop option for sections and activities in the course index
* MDL-71211 - Keep the status of the course index collapsed and expanded sections per user and course
* MDL-71795 - Course index on activity view page
* MDL-71828 - Implement section links' behaviour in course index
* MDL-71664 - Enable drag & drop from course index to course content and vice versa
* MDL-72463 - Add 'highlighted' label to course index
* MDL-71727 - Sync course index and course content when an element is dragged
* MDL-72897 - Mark the current section in the course index
* MDL-73340 - Open course index by default first time a user access the course
* MDL-73310 - Show the course index on all pages within a course
===Course experience===
* MDL-71037 - Sections are now collapsible for Topics and Weekly course formats
* MDL-71691 - Created a new activity UI component
* MDL-71689 - Improvements to add activity and add section design
* MDL-71663 - Created a new "move" option in the sections and activity cog menu in the course editor
* MDL-71779 - Made 'Add a new topic/week' option client side on Topics and Weekly formats
* MDL-72311 - Proceed straight to course content when creating a new course
* MDL-71863 - Created core_courseformat subsystem
* MDL-72578 - Moved activity UI component to output classes and templates
* MDL-73343 - New quick access to create a new course from My courses page when there is no course available
===My Courses page and overview block===
* MDL-70801 - Implement "My courses" page
* MDL-58579 - Allow searching / filtering of courses in myoverview
* MDL-73231 - Provide option of having My courses as defaulthomepage
===Timeline block===
* MDL-72276 - Update timeline block dropdowns to display current selection
* MDL-72277 - Improve the layout and usability of the items in the timeline block
* MDL-73068 - Only display courses in the timeline block if they contain events
* MDL-72295 - Add text search to the timeline block
* MDL-72594 - Improve displaying of overdue items in the timeline block
* MDL-72603 - Replace timeline block pagination with "show more" lazy loading
* MDL-72543 - Change the display of the event names of the items on the timeline block
===Calendar usability===
* MDL-71817 - Render the calendar in the calendar block in month view
* MDL-72237 - Limit number of events shown per day in calendar month view
* MDL-71810 - Add a current date indicator and make calendar block responsive when switching between small and large views
* MDL-71808 - Move the import calendar form to its own page
* MDL-72045 - Improve help information provided on the calendar export page
* MDL-71790 - Revamp the manage subscriptions page
* MDL-71788 - Make it easier to copy the export URL
* MDL-71775 - Add footer links to the calendar block
* MDL-72810 - Remove 3-month calendar view
===Dashboard===
* MDL-72092 - Arrange blocks between My courses & My dashboard
* MDL-73114 - Display a title in the dashboard page
* MDL-71964 - Welcome message for users
* MDL-73233 - Provide option to disable the Dashboard
* MDL-72116 - Remove some of the default blocks from the Dashboard
===User tours===
* MDL-61674 - Allow user tours to be created using the Atto text editor
* MDL-72385 - Improve and simplify design of user tours
* MDL-71938 - Display number of steps in a user tour
* MDL-72783 - Add new user tours
* MDL-72781 - Remove previous user tours
* MDL-72557 - Implement customisable confirmation button for single step user tours
* MDL-71931 - Update user tours to emit events
===Other usability and user experience improvements===
* MDL-69371 - Redesign the Moodle login page (also see MDL-72928)
* MDL-71457 - Update the Moodle activity icons
* MDL-71963 - Turn confirmation page into modals
* MDL-71965 - New footer
* MDL-71456 - Create page drawers for the block and course index areas
* MDL-72095 - Set a main container width of Boost pages
* MDL-71610 - Move the turn editing on button into the navbar
* MDL-72305 - Show user initials as a placeholder for the user profile picture
* MDL-72278 - Fake blocks now in drawer are made visible on first visit
* MDL-72454 - Removal of back to top link
* MDL-72088 - Update styling across top level pages
* MDL-70888 - Update the layouts in Boost theme
* MDL-71292 - Update the page header and include course image / activity icon
* MDL-73608 - Provide a contact form which sends to the site support email and replace mailto link in footer
* MDL-73935 - Improved flexibility of site support form and consistency of site support info provided in Moodle
* MDL-61564 - Allow multiple cohort selection in cohort enrolment
* MDL-66539 - Better handling of link names and URLs with Atto
* MDL-73797 - Dialogues now have the action button on the right
* MDL-60917 - Add highest ranked results section to global search
* MDL-73917 - Notification preferences page improvements
* MDL-72500 - Easier to find a specific component in event list report
* MDL-32103 - Course completion is instant for activity based completion criteria (single user completions only)
==Other major features==
===Report builder integration (from Moodle Workplace)===
* MDL-70795 - Implement functionality for creating custom reports
* MDL-70794 - Implement functionality for creating system reports
* MDL-72588 - Implement custom report audiences
* MDL-72598 - Implement custom report schedules
* MDL-73598 - Allow Custom Reports to be disabled by site admin
* MDL-72280 - Create "Courses" custom report source
* MDL-73069 - Report condition to limit returned data to current user
* MDL-73180 - Improve definitions of previous/next relative date filters
* MDL-72662 - Implement relative date options in the Reportbuilder date filter
* MDL-72172 - Create "Cohort members" custom report source
* MDL-72962 - Format editable report elements (column, filters, etc)
* MDL-72826 - Custom report option to display unique row values
* MDL-71153 - Convert task logs report to a system report
* MDL-71070 - Convert configuration changes report to a system report
===BigBlueButton integration===
* MDL-70658 - Integrate the BigBlueButton plugin into Moodle LMS
===Quiz and Questions===
* MDL-71516 - Create new plugin type - Qbank (for the full list of qbank plugins added to core, see MDL-70329)
* MDL-71679 - Update mod_quiz for new question bank
* MDL-71636 - Add a columnsortorder settings page
* MDL-71696 - Add question versions
* MDL-72076 - Question bank bulk action UI
* MDL-72553 - Add custom fields to questions
* MDL-52206 - Move "Require passing grade" completion option to core
* MDL-52456 - Add notification message for students after questions have been manually graded
* MDL-71984 - Add logging to quiz auto-save, process_attempt and redo_question
* MDL-73337 - Log editing quizzes in detail
* MDL-73699 - Question status UI/UX update
* MDL-72448 - Add qbank_history to core
* MDL-71614 - Add qbank_previewquestion to core
===Update LTI tool provider feature to support 1.3===
* MDL-69543 - Update tool to support 1.3 OAuth2/OIDC launch flow
* MDL-71371 - Provide upgrade path for 1.1 preconfigured tools
* MDL-72745 - Provide account provisioning options for LTI Advantage launches
* MDL-69547 - Update tool enrolment code so that a user is automatically created and enrolled when launching via 1.3
* MDL-69545 - Update user sync task to support 1.3 messages
* MDL-69544 - Update grade sync task to support 1.3 messages
* MDL-72288 - Update library and model code to support issuer and clientid uniqueness on registrations
* MDL-69862 - Add dynamic registration support to the tool
* MDL-70354 - Return line item information during content selection
===Assignment===
* MDL-68913 - Per attempt timing now available in assignments
===Admin configuration presets===
* MDL-72112 - Integrate admin_presets third-party plugin in Moodle LMS
* MDL-73145 - Add a $CFG setting to define the preset to be installed
* MDL-72114 - Include pre-installed admin presets
* MDL-72113 - Add feature to import/export plugins visibility from Admin presets tool
* MDL-73394 - Store the latest site admin preset applied
===Content bank and H5P===
* MDL-68394 - Integrate mod_h5pactivity with recent activity plugins
* MDL-72099 - Add navigation by contexts in the content bank
* MDL-71885 - Inline editing H5P content for mod_h5pactivity
* MDL-71956 - Inline editing H5P content anywhere
===Badges===
* MDL-72141 - Simplifying the external badge page
===Accessibility improvements===
* MDL-67853 - Remove online-offline options on notifications
* MDL-72078 - Give users an indication that they encountered an editor
* MDL-71604 - Move the screen reader helper button to the first row
* MDL-72896 - Make html_tables responsive by default
==Other Highlights==
===Functional changes===
* MDL-70456 - Add custom user field support to all places that display user identity [0,Minor] Improvement
* MDL-73342 - Disable some blocks by default (such as feedback, RSS and self-completion)
* MDL-70905 - Updated media default width/height to use 16:9
* MDL-72118 - Rename "HTML block" to the more easily understood "Text block"
* MDL-72706 - Change default value of "Hidden sections" course format setting
* MDL-72115 - Rename "Miscellaneous" category to "Category 1"
* MDL-72119 - Make “Enable xxxxx” features consistent (hide menus for disabled features)
===For administrators===
* MDL-71347 - Add a filter to "browse list of users" for date of user account creation
* MDL-72031 - Separate out max_time for audio and video files in Atto/RecordRTC
* MDL-71515 - Improve the test outgoing mail configuration admin page
* MDL-67686 - Add more filters to task log (/admin/tasklogs.php)
* MDL-72984 - Ensure support email address is mandatory
* MDL-73592 - MoodleNet integration now enabled by default
* MDL-71621 - Parent role cannot edit custom fields in child profile
* MDL-73918 - Allow admins to change the page width using custom SCSS
* MDL-71927 - Logs and question attempt history now show time to the second, to help investigate issues
* MDL-71466 - Custom user field support: Admin role screens (check permissions, assign)
* MDL-72619 - Provide admin page to view cache size estimates
* MDL-67822 - New check_database_schema performance check
* MDL-70271 - Dropbox token and Permission Updates
* MDL-58395 - LDAP auth sync now skip and report problematic user accounts
* MDL-72251 - Tasks admin UI now shows time to nearest second
===Mobile===
* MDL-67807 - Return concurrent sessions information to apply concurrent login limit in the mobile app
* MDL-69555 - Make duration of QR login and auto-login time between requests configurable
* MDL-73794 - Update the footer in the mobile view
===Performance===
* MDL-72596 - Caching: Track cache I/O size in perfdebug
* MDL-69088 - Make file cache store purges instant with a safe and async purge
* MDL-68164 - Additional caching of pg_field_type postgres field metadata
* MDL-63983 - Improve the performance of non-contact searches in messaging when site-wide messaging is disabled (default)
* MDL-71014 - Cache the siteidentifier and site contextid in local cache
* MDL-72328 - Add TTL support for Redis caches
* MDL-72837 - Cache API should support versioned data
==Security improvements==
* MDL-56873 - Set more secure defaults for the cURL allow/deny lists
* MDL-66776 - Send notifications when new devices are used to log in into the site
* MDL-71627 - Add check API for anti virus and optionally remove admin notifications
* MDL-71806 - Improved the UX of the Moodle security report
* MDL-71176 - New password and change forms should have autocomplete="new-password"
==For developers==
* MDL-61460 - Introduce the UI components library
* MDL-74229 - Add navigation node keys to allow themers to hide navigation tabs
* MDL-74235 - Rename the icons for activities to allow support of multiple icons for multiple versions
* MDL-74033 - Allow full customisation of the primary navigation
* MDL-72779 - Set more than one value on a persistent at the same time
* MDL-70862 - Implement a new callback to extend gradebook plugininfo
* MDL-72289 - Allow callers to customise the rendered icon of inplace editable elements
* MDL-73347 - Allow themes to define un-addable blocks
* MDL-46778 - Allow use a separate DB configuration (not just prefix) for Behat similar to PHPUnit
* MDL-73270 - Warn where XMLRPC is currently in use
* MDL-67228 - Tool_replace maturity set
===Web service additions and updates===
* MDL-71135 - Create core_course_get_state web service
* MDL-71165 - Create core_course_update_course web service
===Core plugins removed===
* MDL-71473 - Jabber removed as a standard notification plugin
* MDL-58939 - Picasa repository and portfolio removed from core
* MDL-72335 - Tool_health removed from core
* MDL-72615 - Boxnet plugins removed from core
* MDL-72616 - Quiz results block removed from core
* MDL-72348 - Microsoft OneDrive (legacy) repository (repository_skydrive) removed from core
* MDL-72347 - Word censorship filter (filter_censor) removed from core
* MDL-72407 - VideoJS Flash plugin removed from core
* MDL-72042 - Flash animation media player removed from core
* MDL-72041 - WebCT question import format removed from core
* MDL-72517 - Examview question import format removed from core
===Deprecations===
* MDL-53544 - Typo3 library removed
* MDL-72004 - Quiz 4.0 Class renaming and deprecation
* MDL-73756 - Deprecate $modinfo param to completion_info::get_data()
* MDL-65799 - Phase 2 of deprecation of functions in lib/deprecatedlib.php initially deprecated in 3.8
* MDL-71175 - Deprecate some plagiarism functions that are not used, or have replacements
* MDL-66266 - Remove deprecated functions in messages/classes/api.php
* MDL-72098 - deprecate grade_grade::insert method that just calls its parent
* MDL-72433 - Final deprecation of get_grades() in lib/classes/grades_external.php
* MDL-71476 - Remove mysql_engine.php
* MDL-65252 - Final deprecations of forum_count_replies and get_forum_discussion_posts
* MDL-67412 - Remove deprecated functions in lib/setuplib.php
* MDL-65801 - Remove strings deprecated in 3.8
===Component API updates===
* admin/tool/generator/upgrade.txt
* admin/tool/log/upgrade.txt
* admin/tool/mobile/upgrade.txt
* admin/tool/upgrade.txt
* admin/tool/usertours/upgrade.txt
* admin/upgrade.txt
* analytics/upgrade.txt
* auth/shibboleth/upgrade.txt
* availability/upgrade.txt
* backup/upgrade.txt
* badges/upgrade.txt
* blocks/section_links/upgrade.txt
* blocks/tag_youtube/upgrade.txt
* blocks/timeline/upgrade.txt
* blocks/upgrade.txt
* cache/upgrade.txt
* calendar/upgrade.txt
* completion/upgrade.txt
* contentbank/upgrade.txt
* course/format/upgrade.txt
* course/upgrade.txt
* customfield/upgrade.txt
* dataformat/upgrade.txt
* enrol/database/upgrade.txt
* enrol/upgrade.txt
* filter/upgrade.txt
* grade/grading/form/upgrade.txt
* grade/upgrade.txt
* group/upgrade.txt
* h5p/upgrade.txt
* lib/upgrade.txt
* media/upgrade.txt
* message/upgrade.txt
* mod/assign/upgrade.txt
* mod/book/upgrade.txt
* mod/feedback/upgrade.txt
* mod/forum/upgrade.txt
* mod/glossary/upgrade.txt
* mod/h5pactivity/upgrade.txt
* mod/lesson/upgrade.txt
* mod/lti/upgrade.txt
* mod/page/upgrade.txt
* mod/quiz/upgrade.txt
* mod/resource/upgrade.txt
* mod/scorm/upgrade.txt
* mod/upgrade.txt
* mod/url/upgrade.txt
* mod/wiki/upgrade.txt
* mod/workshop/upgrade.txt
* my/upgrade.txt
* payment/upgrade.txt
* plagiarism/upgrade.txt
* portfolio/upgrade.txt
* question/bank/upgrade.txt
* question/behaviour/upgrade.txt
* question/engine/upgrade.txt
* question/format/upgrade.txt
* question/type/multichoice/upgrade.txt
* question/type/upgrade.txt
* question/upgrade.txt
* report/eventlist/upgrade.txt
* report/upgrade.txt
* repository/upgrade.txt
* search/upgrade.txt
* theme/upgrade.txt
* user/upgrade.txt
* webservice/upgrade.txt

==See also==
*[[Moodle 3.11 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0]]
[[es:Notas de Moodle 4.0]]

Template:MediaPlayer

2022-04-28T08:59:21Z

Tsala: Adding code from MDLSITE-4989

<includeonly>{{#evt:
service=youtube
|id={{{url}}}
|description={{{desc|{{{url}}}}}}
|urlargs=modestbranding=1&rel=0
}}</includeonly><noinclude>

Displays an embedded media player of the given YouTube video.

== Syntax ==

<nowiki>{{MediaPlayer | url = https://www.youtube.com/watch?v=U7M3sZL6wts | desc = Video description}}</nowiki>

</noinclude>

QA testing

2022-04-22T12:27:30Z

Tsala: removing reference to contacting me

{{Template:Migrated|newDocId=/general/development/process/testing/qa}}
'''Quality Assurance''' tests look at the functionality of Moodle from a user's point of view.

Real users systematically try each feature in Moodle and test that it works in the current version of the Moodle code. These tests are repeated in series of cycles, around 4 - 6 weeks before a major release, once all major features have landed.
<p class="note">'''QA testing latest''': ''We're currently QA testing Moodle 4.0. More testers are always welcome (see below).''</p>
==Getting involved==
Would you like to help with QA testing? If so, please make sure you have created an account in the [[Tracker_introduction|Moodle tracker]] and you're subscribed to the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum] in order to receive QA testing news updates.
==Running tests==
# Go to the [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 Moodle QA testing dashboard] and choose a test from the list of current QA cycle open issues. When viewing a test, if you wish, you can click the 'Assign to me' link on the right, so that nobody else chooses the same test to run. (If you then find you are unable to run the test, you can click the Assign button and set the assignee as 'Unassigned'.) Please note:
#* Only assign an issue to yourself which no one else is testing (Assignee = Unassigned).
#* Only assign one issue at a time unless you plan to test a number of related issues within the next 24 hours. In other words, don't assign several issues to yourself then do nothing for several days. ;-)
#* The label ''test_server_required'' indicates issues that can't be tested on the QA testing site. The label ''credentials_required'' indicates that credentials such as an OAuth 2 service client ID and secret are required.
# Using either the [https://qa.moodledemo.net/ Moodle QA Testing Site] or your own test site running the latest Moodle 4.0dev (available from Git on the integration/master branch ''<nowiki>git://git.moodle.org/integration.git</nowiki>'') with [[:en:Debugging|debugging]] set to developer, perform each of the steps listed in the test.
# ''Please attach screenshots of the steps where you verify or check something.''
# If it makes sense, please test using the currently supported themes, Boost and Classic.
# Choose an appropriate workflow action:
#* ''Pass'' - Test runs perfectly. Add comment such as feedback about a new feature, browsers used for testing (if applicable; example: "This test passes on Q&A site with Teacher role using Boost theme"), or simply "This test passes - yippee!"
#* ''Fail'' - Something doesn't work, or you obtain debugging messages. Add comment describing the step that doesn't work. If in doubt whether to pass a test, give it a fail and add a comment describing your doubts.
#* ''Obsolete'' - Test is no longer relevant in the current Moodle version. Add comment explaining why.
If you notice that the test description is out-of-date, add a comment mentioning that it needs updating. Alternatively, if you'd like to help with updating the test yourself, see below.
==Any questions?==
If there is anything you are unsure of, such as whether to mark a test as failed, or you have any other questions, please ask in one of the following places:
* [https://t.me/moodleqa Moodle QA Telegram chat room] - To join the room for the first time, please use the [https://t.me/+cXneE_ZeZ_A4ODRk Moodle QA Telegram invite link].
* [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum]
==Moodle QA Testing Site==
The [https://qa.moodledemo.net/ Moodle QA Testing Site] is updated daily at around 13:00 UTC with the latest bug fixes to enable you to re-run QA tests.

To prevent the site being used for sending spam, no emails are sent from it. Thus, tests involving email cannot be run using the Moodle QA Testing Site. (If such tests are attempted, an email debug message is displayed. This is not a bug but rather expected behaviour.)

Teacher and student accounts are provided. If you would like admin access to the Moodle QA Testing Site for running certain tests, please ask in the Moodle QA Telegram chat room or the Testing and QA forum for someone to send you the account credentials via private message.
==<div id="failedTests">Failed tests</div>==
So you ran a test and it failed? Congratulations on finding a bug! Please do the following.
# Click the Fail button at the top of the page.
# Add a comment to the QA test stating that there was a problem and that you will report it as a Moodle bug.
# Note the MDLQA number; it will be something like <nowiki>MDLQA-448</nowiki>.
# Try searching for whether the bug has been reported previously, and if not create a new issue for it (as described in [[Tracker introduction]]).
# In the new Moodle (MDL) issue select 'Link' from the 'More actions' dropdown menu. <br />[[Image:LinkIssue.png|150px|Linking to the QA issue in the tracker]]
# Link to the QA test by selecting 'blocks' as the link type, entering the MDLQA number that you noted earlier, and optionally adding a comment. <br />[[Image:LinkDetails.png|150px|Adding details for a link to the QA issue]]
# Give the issue the label 'mdlqa'.
# (Optional) Add yourself as a watcher to the MDL issue so that you receive email notification when the issue is fixed.
# When the MDL issue is fixed, hopefully within a day or two, the QA test can be reset and can then be run again.
==Resetting tests==
''Note for integrators:''

After integrating a fix,
# Reset the MDLQA test, adding a comment.
# Remove the 'mdlqa' label from the MDL issue.
# If the issue doesn't have testing instructions, pass it with message "Will be tested by MDLQA-XXXX".
The tester will then receive email notification that the bug is fixed and will hopefully decide to run the test again soon.
==Fixing existing bugs==
At the beginning of the QA cycle, all bugs identified (both new and existing) are investigated promptly and hopefully fixed.

When we are close to the scheduled release date (1-2 weeks prior), developers must focus on fixing new bugs (which affect the upcoming release version) only.

Thus, at this point in the QA cycle, any bugs which also affect existing versions of Moodle are labelled qa_identified (and the label mdlqa removed) for investigation after the release.
==Testing tips==
When entering text into a form, try things like:
* <syntaxhighlight lang="php">&</syntaxhighlight> (ampersand), <syntaxhighlight lang="php">></syntaxhighlight> (greater than) or <syntaxhighlight lang="php"><</syntaxhighlight> (less than) e.g. <syntaxhighlight lang="php">x < 1 && x > 0</syntaxhighlight>
* <syntaxhighlight lang="php">0</syntaxhighlight> (the single digit 0)
* <syntaxhighlight lang="php">'</syntaxhighlight> (single quote) e.g. <syntaxhighlight lang="php">Fergal.O'Brien@example.com</syntaxhighlight>
* special characters e.g. <syntaxhighlight lang="php">café</syntaxhighlight> or <syntaxhighlight lang="php">囲碁</syntaxhighlight>
* very long strings
* different languages, such as a RTL language
==New QA tests required==
''Note for developers:''

If an issue fix cannot be covered by automated tests,
# Add the label 'qa_test_required' to the issue.
# Add a comment explaining why it can't be covered by automated tests and suggesting which steps of the testing instructions should be included in a QA test e.g. steps 6-10 or all steps.
QA tests will then be written and included in the next QA cycle. For issues with long testing instructions, several QA tests will be written to cover the issue. If appropriate, activities etc. will be set up on the [https://qa.moodledemo.net/ Moodle QA Testing Site] to enable the issue to be easily tested in future.

Similarly, for new features and improvements which would benefit from exploratory testing,
# Add the label 'qa_test_required' to the issue.
# Add a comment mentioning that exploratory testing is required.
Exploratory QA tests will then be written and included in the next QA cycle and then removed.
==Updating tests==
QA tests often become out-of-date due to new developments. If you would like to help with updating tests, you'll need to be a member of the test writers group in the Tracker.

To update a QA test original:
# Search for the test in MDLQA-1.
# Edit the test description.
If a test in the current QA cycle is marked as failed because it is out-of-date, the description should be updated (as well as the test original) before resetting the test. If the test in the current QA cycle is marked as passed, then only the test original needs to be updated.
==Writing new tests==
Would you like to help with writing new QA tests? If so, as for updating tests, you'll need to be a member of the test writers group in the Tracker.

QA tests are needed for any features which can't be tested with automated testing, such as connecting to an external system, drag and drop functionality or a CLI script. Also if it requires a person to detect if something is 'correct' vs. present/absent on the page.

In addition, new features can benefit from exploratory testing by community volunteers.

To create a new QA test:
# If appropriate, do a quick search of MDLQA-1 to check if there is an existing test which can be updated.
# If not, in MDLQA-1 from the More menu select 'Create sub-task'.
# Enter a summary such as 'A teacher can ...'.
# Select 'Original' as affected version and select appropriate components.
# In the description field add the test steps (usually between 3 and 10), similar to the issue's [[Testing instructions guide|testing instructions]], starting with 'Log in as a teacher...' or similar. It's a good idea to try doing the steps yourself as you write the test.
# Start some steps with 'Verify that ...' or similar.
# Click the Create button.
# Go to the MDL issue and create a ‘has a QA test’ link to the new QA test, adding a comment “This feature is now covered by the QA test MDLQA....”.

Notes:
* Add the label ''new''
* For tests which can’t be run on the QA testing site, such as ones where you need to check an email, label ''test_server_required''.
* For OAuth 2 tests and any other tests which require a client ID or secret to be entered, label ''credentials_required''.
* For issues which specifically mention in the testing instructions to test in different browsers, use the phrase "Test in as many browsers as possible and mention in a comment which ones you’ve used."
* For an exploratory test, begin the test description with "This is an exploratory test of a new feature or improvement, so please feel free to try anything you like and not just the test steps!"
* For a test requiring admin access which can be run on the QA site, add:
This test requires admin access. If you would like to use the [QA testing site|https://qa.moodledemo.net/] for running it, please see the [QA testing guide|https://docs.moodle.org/dev/QA_testing] for details of how to request admin access. Begin just after the hourly reset to give yourself plenty of time to complete the test!
==Feedback==
Feedback on all aspects of our QA testing process is welcome. If you have any questions or comments, please post in the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum].
==See also==
* [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 QA testing dashboard]
* [[Testing credits]]
* [[MDLQA-features]]
* [https://moodle.org/mod/forum/discuss.php?d=351302 Useful tips for QA testing]
Comments on tests from previous QA cycles:
* [https://tracker.moodle.org/browse/MDLQA-150 Moodle 2.0 QA Cycle 1]
* [https://tracker.moodle.org/browse/MDLQA-328 Moodle 2.0 QA Cycle 2]
* [https://tracker.moodle.org/browse/MDLQA-540 Moodle 2.0.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-944 Moodle 2.1 QA Cycle 1]
* [https://tracker.moodle.org/browse/MDLQA-1190 Moodle 2.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-1814 Moodle 2.3 QA]
* [https://tracker.moodle.org/browse/MDLQA-4602 Moodle 2.4 QA]
* [https://tracker.moodle.org/browse/MDLQA-5267 Moodle 2.5 QA]
* [https://tracker.moodle.org/browse/MDLQA-5740 Moodle 2.6 QA]
* [https://tracker.moodle.org/browse/MDLQA-6693 Moodle 2.7 QA]
* [https://tracker.moodle.org/browse/MDLQA-7170 Moodle 2.8 QA]
* [https://tracker.moodle.org/browse/MDLQA-7660 Moodle 2.9 QA]
* [https://tracker.moodle.org/browse/MDLQA-8205 Moodle 3.0 QA]
* [https://tracker.moodle.org/browse/MDLQA-9267 Moodle 3.1 QA]
* [https://tracker.moodle.org/browse/MDLQA-9827 Moodle 3.2 QA]
* [https://tracker.moodle.org/browse/MDLQA-10403 Moodle 3.3 QA]
* [https://tracker.moodle.org/browse/MDLQA-10999 Moodle 3.4 QA]
* [https://tracker.moodle.org/browse/MDLQA-11698 Moodle 3.5 QA]
* [https://tracker.moodle.org/browse/MDLQA-12282 Moodle 3.6 QA]
* [https://tracker.moodle.org/browse/MDLQA-12911 Moodle 3.7 QA]
* [https://tracker.moodle.org/browse/MDLQA-13517 Moodle 3.8 QA]
* [https://tracker.moodle.org/browse/MDLQA-14131 Moodle 3.9 QA]
* [https://tracker.moodle.org/browse/MDLQA-14813 Moodle 3.10 QA]
* [https://tracker.moodle.org/browse/MDLQA-15457 Moodle 3.11 QA]
* [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 Moodle 4.0 QA]
[[Category:Quality Assurance]]

Template:Translation

2022-04-22T10:45:32Z

Tsala: Removing Translating Moodle video subtitles as it is no longer possible to do so

<div class="sideblock right">
<div class="header">[[Translation]]</div>
<div class="content">
*[[Contributing a translation]]
*[[Maintaining a language pack]]
*[[AMOS manual]]
*[[Starting a new language pack]]
*[[Translating plugins]]
*[[Translating Moodle Docs]]
*[[Translating the Moodle app]]
*[[Translating User tours from Moodle.net]]
*[[Translation FAQ]]
</div>
</div>

<includeonly>[[Category:Translation]]</includeonly>
<noinclude>This template will categorize articles that include it into [[:Category:Translation]].</noinclude>

Tracker guide

2022-04-22T10:25:11Z

Tsala: /* Tracker groups and permissions */ removing testers group as everyone with a tracker account can help with QA testing

{{Template:Migrated|newDocId=/general/development/tracker}}
The [http://tracker.moodle.org/ Moodle Tracker] is our database for recording and managing all Moodle development issues - bugs, improvements and feature requests.

''For an intro guide to the tracker, see [[Tracker introduction]].''

To do anything more than browsing and searching in the tracker, you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create an account] and then login.

==Integration workflow==

The following diagram illustrates the integration workflow in the tracker and lists the different statuses of an issue.

[[File:Workflow.jpg]]

==Tracker fields==

===When creating an issue===

{| class="wikitable"
! Field
! Values
! Notes
|-
| valign=top | '''Project'''
| valign=top |
; Moodle
: For an issue relating to the Moodle codebase
; Moodle Community Sites
: For an issue on tracker.moodle.org, docs.moodle.org, demo.moodle.org, download.moodle.org, moodle.org, etc..
; Non-core contributed modules
: For an issue with a contributed plugin
(There are a few more projects, but these are the main ones.)
| valign=top |
* Tracker is used for multiple projects.
|-
| valign=top | '''Issue Type'''
| valign=top |
; Bug
: A problem which impairs or prevents Moodle from functioning correctly.
; Improvement''
: An enhancement to an existing Moodle feature.
; New Feature''
: A new Moodle feature which has yet to be developed.
; Task
: A task that needs to be completed, usually apart from coding.
; Sub-Task
: Part of a greater task
|-
| valign=top | '''Summary'''
| valign=top | A brief, concise description of the problem.
| valign=top |
* When the issue is about applying an existing solution to another, usually older, branch (namely "backport"), please use the summary of the existing solution plus its issue number (i.e. "Fix forum alignment (backport of MDL-99999)").
|-
| valign=top | '''Description'''
| valign=top |
A full and complete description of the issue including:
* replication steps,
* the expected result,
* the actual result,
* any error messages shown with [[:en:Debugging|Debugging]] turned on, and
* any other relevant information.
| valign=top |
* Please provide as much detail as possible.
* More detail means an issue will be easier to resolve.
|-
| valign=top | '''Affects Version/s'''
|
* For bugs: the latest ''released'' version in which the bug is found
* For improvements: the latest ''released'' version
* For new features: Use 'Future dev'
|
|-
| valign=top | '''Component/s'''
| valign=top | The area(s) in Moodle which is affected by the issue.
| valign=top |
* Select 'Unknown' if you are unsure.
|-
| valign=top | '''Security Level'''
| valign=top |
; None
: Viewable by everyone, including non-logged-in users
; Could be a security issue
: Viewable by members of the jira-developers group
; Minor security issue
: Viewable by members of the security team only
; Serious security issue
: Viewable by members of the security team only
| valign=top |
* The reporter can view the issue they reported, regardless of the security level set.
* The higher the security level, the fewer people who can view the issue.
* The 'Could be a security issue' should only be used temporarily when the issue is reported. A decision should be made as soon as possible to set another level.
|}

===When editing an issue===

Once an issue has been created, the following additional fields are able to be changed/set by editing the issue. Not all users can edit all fields.

{| class="wikitable"
! Field
! Values
! Notes
|-
| valign=top | '''Fixed Version/s'''
| valign=top |
* Prior to integration, this will be set to a backlog (a queue of development work), for example STABLE Backlog, Dev Sprint 2.
* After integration, this will be set to the Moodle version the bug was fixed in, for example 2.4.1.
|
* This is usually set during triage, or later by a developer or integrator.
* If you resolve the bug as anything but "Fixed" (Cannot Reproduce, Won't Fix, etc.) leave Fix Version/s blank.
* Fix version/s are used to automatically build release notes (see the tabs on http://tracker.moodle.org/browse/MDL).
|-
| valign=top | '''Priority'''
| valign=top |
; Blocker
: Blocks development and/or testing, prevents Moodle from running
: Applicable to bugs only
; Critical
: Crashes server, loss of data, severe memory leak
; Major
: Major loss of function, incorrect output
; Minor
: Minor loss of function where workaround is possible
; Trivial
: Cosmetic problem like misspelt words or misaligned text
| valign=top |
* When it is reported, the priority level represents the severity of an bug.
* After being reported, the priority may be promoted by HQ developers and component leads as an issue escalates.
* Other users wishing to influence the priority of issues should do so by voting for the issue.
* The priority of new features and improvements should generally remain at the default (Minor) level.
|-
| valign=top | '''Reporter'''
| valign=top | The person who logs the bug. This field is automatically filled by Tracker.
|
|-
| valign=top | '''Assignee'''
| valign=top | The person who will fix the issue. Prior to May 2013, developers were [[Changes to issue assignment|automatically assigned]]. Currently, the assignee should be set when there is a definite intention to complete the issue.
|
* Developers or QA Testers can reassign issues.
* Please note that even though a person may be assigned to an issue, this does not mean they are currently working on the issue, although they are likely to in future.
|-
| valign=top | '''Peer reviewer'''
| valign=top | The person who will check the fix at the code level.
|
|-
| valign=top | '''Integrator'''
| valign=top | The person who will integrate the code into the Moodle codebase.
|
|-
| valign=top | '''Tester'''
| valign=top | The person who will test the solution at a functional level, according to the test instructions provided.
|
|-
| valign=top | '''Environment'''
| valign=top | The operating system, server and/or browser specifications if applicable to this bug.
|
* Note that the database is specified separately in the database field below.
|-
| valign=top | '''Database'''
| valign=top | If applicable to the bug, identify the database type.
|
|-
| valign=top | '''Testing instructions'''
| valign=top | The steps that a tester should follow to achieve the expected behaviour after the issue has been resolved.
| valign=top |
* This may be different to the replication steps reported in the description.
* These instructions are written by the developer working on the issue.
|-
| valign=top | '''Workaround'''
| valign=top | A way to achieve the desired functionality by other means.
| valign=top |
* This will be very useful to other Moodle users who have the same problem, until the issue is resolved.
* If the issue can be resolved by a simple code change, say one line, then you can give that as a workaround, although patches and Git branches are preferred.
|-
| '''Attachment'''
| valign=top | Patch files, Screenshots, example backups or other related files
| valign=top |
* Attaching a file will help developers and testers better understand the bug.
* Maximum attachment size is 512Kb.
|-
| valign=top | '''URL'''
| valign=top | If possible, provide a URL address that demonstrates an example of this bug.
|
|-
| valign=top | '''Epic Name'''
| valign=top | A short name given to an issue of type Epic so that linked issues can be grouped by this name. It should only be a few words at most.
| valign=top | Only applies to issues of type Epic.
|-
| valign=top | '''Epic Link'''
| valign=top | A link to an Epic issue. This can be added by providing the issue ID or Epic name. It is a way of organising related issues as part of a project.
| valign=top | Only applies to issues that need to be collected together for a project.
|-
| valign=top | '''Labels'''
| valign=top | See [[Tracker issue labels]]
|
* Labels should be specific values used in filters and searches.
* This is not a field for including generic keywords.
|-
| valign=top | '''Pull...'''
| valign=top | Links to a code solution in a Git repository.
|
* These fields are used by developers.
* There may be multiple solutions if the problem affects multiple Moodle versions.
|-
| valign=top | '''Documentation link'''
| valign=top | URL of related documentation.
| valign=top |
* When changes require documentation to be updated, this field should be filled.
|-
| valign=top | '''Comment'''
| valign=top |
* Notes made by all interested parties.
* A detailed register of all changes that relate to this bug.
|
|}

===When closing an issue===

{| class="wikitable"
! Field
! Values
! Notes
|-
| valign=top | '''Resolution'''
| valign=top |
; Fixed
: Bug has been fixed; a code change has been integrated into Moodle code.
; Won't Fix
: The problem described is an issue which will never be fixed. Specific reasons should be given.
; Not a bug
: This issue is not a bug. The issue may have been logged in error. Use this code if the bug was fixed by another bug report or in some earlier Moodle version.
; Duplicate
: The problem is a duplicate of an existing issue.
; Incomplete
: More information was needed to understand this bug, but it was not provided.
; Can't Reproduce
: Attempts at reproduce the issue failed. If more information appears later, please open a new issue.
; Deferred
: The resolution to this bug will be deferred to a later release or to a fix in a third-party plugin used in Moodle.
| valign=top |
* This field is only displayed when resolving or closing a bug.
|}

== Tracker groups and permissions ==

There are a number of groups used to define the potential of users in Tracker. Here are some important ones.

{| class="wikitable"
! Name
! Jira group
! Potential
! How to become one
|-
| valign=top | '''Users'''
| valign=top | jira-users
| valign=top | Users can create new issues, comment on issues, vote for issues, link issues, attach files, create sub-tasks and watch issues.
| valign=top | Anyone who creates a tracker account becomes a member of the Users group.
|-
| valign=top | '''Moodle Security'''
| valign=top | moodle-security
| valign=top | Trusted developers and administrators who need to work on security issues that are hidden from normal users. (See [[Moodle security procedures]].)
| valign=top | This is generally limited to developers at Moodle HQ and Partner organisations. People wishing join the Moodle Security group should email [mailto:security@moodle.org security@moodle.org] with the reasons for your request.
|-
| valign=top | '''Developers'''
| valign=top | jira-developers
| valign=top | Developers can edit issues and assign issues to themselves. They are also able to request peer reviews from HQ staff and component leads. They cannot submit code directly for integration review, but an HQ staff member or component lead can do this after a satisfactory peer review. (See [[Process]].)
| valign=top | People wishing to join the Developers group should be able to demonstrate a history of contributing patches to issues.

When a developer's first patch is integrated, tested and the issue is closed, they are added to the group and set as issue assignee.

If that doesn't happen automatically, please send an email to [mailto:integration@moodle.com integration@moodle.com] with your tracker username and links to issues where you have contributed patches.
|-
| valign=top | '''Integration requesters'''
| valign=top | pull-requesters
| valign=top | Developers can send issues for integration review. (See [[Process]].)
| valign=top | This role is reserved for Moodle HQ developers and component leads.
|-
| valign=top | '''Integration testers'''
| valign=top | pull-testers
| valign=top | Users that can tests issues under integration and pass/fail them. (See [[Process]].)
| valign=top | Usually reserved for HQ developers and external testers.
|}

Note that you can browse a project without being logged in to Tracker, however you will be unable edit or comment on bugs.

==See also==

*[[Tracker introduction]] - less scary version of this page for new users.
*[[Process]]
*[[Bug triage]]
*[[Tracker issue labels]]
*[[Testing of integrated issues]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=43952 How to manipulate Moodle developers] forum discussion
*Wikipedia [http://en.wikipedia.org/wiki/Software_bug Definition of a bug]

[[Category:Tracker]]
[[Category:Quality Assurance]]

Plugin documentation

2022-04-21T13:48:08Z

Tsala: /* Which version of the user docs should the documentation be added to? */ link update

Plugin developers, maintainers and users are welcome to include documentation about their plugin in the [https://docs.moodle.org English Moodle Docs]. Of course it is fine to have documentation elsewhere, such as the Github wiki, however one advantage of including documentation in the English Moodle Docs is that 'Moodle Docs for this page' links in Moodle (when logged in as a teacher or admin) can lead directly to your plugin documentation (as explained in [[:en:Header and footer]]). And, very important, it will then be very easy for translators of Moodle Docs to add translations for this information.

==Where should the documentation go?==

To create a page for your documentation, type in the browser address bar: <code><nowiki>https://docs.moodle.org/en/Plugin_name</nowiki></code> (where ''Plugin name'' is the name of the plugin in the plugins directory).

If your plugin has a page in Moodle, you can redirect this page to your documentation page as follows:

# Log in to your Moodle site as admin and go to the page for your plugin.
# Follow the 'Help and documentation' link in the footer to ''docs.moodle.org/en/mod/pluginname'' (or similar).
# Create this page and add a redirect by adding the text <code><nowiki>#redirect [[Plugin_name]]</nowiki></code>.

==What should the documentation include?==

[[File:infobox plugin.png|thumb|Example infobox: Stamp collection module]]
'''*New*''': Copy and complete the following template code to obtain an infobox listing details of the plugin:
<pre style="width:40em">
{{Infobox plugin
|type = Enter the plugin type e.g. activity, block, filter
|entry = Enter the plugins directory link
|tracker = Enter the bug tracker URL
|discussion = Enter the link to the forum or discussion thread
|maintainer = [[User:Maintainer name|Maintainer name]]
|float = Enter left or right to make the box float to that side (optional)
}}
</pre>

Note: If there is not yet a discussion thread about your plugin, please create one in the [http://moodle.org/mod/forum/view.php?id=44 General plugins forum].

Note: Please make sure that the page linked in 'User:Maintainer name|Maintainer name' actually has your relevant details (profile), or a link to an existing profile in Moodle or elsewhere.

The documentation may also include

* A features overview with screenshots or videos.
* Installation instructions

Plugin documentation examples: [[:en:Stamp collection module]], [[:en:Profile switches]].

==Which version of the user docs should the documentation be added to?==

Plugin documentation should be added to the most recent version wiki in which the plugin works, for example if the plugin works in Moodle 4.0, it should be added to the [https://docs.moodle.org/400/en/ Moodle 4.0 docs wiki].

==I need help!==

If any of the above sounds too complicated, please don't worry - just email Moodle Docs wiki admin Helen ([mailto:helen@moodle.org helen@moodle.org]) who will be happy to help you :-) (Restoring and redirecting pages etc. are quick and easy for a wiki admin to do!)

==See also==

* [[:en:Help:Editing|Wiki editing help]]
* MDL-34035 A way to have more help links relative to wwwroot

[[Category:Plugins]]
[[Category:Plugin documentation]]

New docs version process

2022-04-21T10:01:37Z

Tsala: /* Day of release */ formatting

This page describes the procedures for creating a new Moodle Docs version wiki.

==4 weeks prior==

Tidying up in current latest version wiki:

# Delete https://docs.moodle.org/en/Special:BrokenRedirects
# Edit https://docs.moodle.org/en/Special:DoubleRedirects (ignoring redirects to dev docs)
# Check and delete as necessary https://docs.moodle.org/en/Special:NewFiles
# Check and delete as necessary https://docs.moodle.org/en/Special:ListDuplicatedFiles
# Check and delete as necessary https://docs.moodle.org/en/Special:UnusedFiles
# (Check and delete as necessary https://docs.moodle.org/en/Special:ShortPages )

Create a tracker issue for creating new en and de version wikis similar to MDLSITE-6265.
==3 weeks prior==

In new version wiki:

# Edit MediaWiki:MoodleDocsVersionLinks
# Edit Main_page
# Add message to MediaWiki:Sitenotice
# Remove new features template from all pages in Category:New_features
# Edit Template:New_features and Category:New_features
# Go through [https://tracker.moodle.org/issues/?jql=labels%20%3D%20docs_required tracker issues with the docs_required label] and the release notes for the upcoming release and add documentation on new features plus the new features template
# Create Upgrading_to_Moodle_3.x and redirect to Upgrading
# Update version number in Template:Version and Template:Version2 and Git for Administrators
# Review Special:WantedPages
# Review Special:LonelyPages
# Review instances of "(new in 3.x)" text (not always necessary to remove them)
# Add link to new version wiki to https://docs.moodle.org/dev/MediaWiki:Sidebar
# Add link to new version wiki to https://docs.moodle.org/en/MoodleDocs:Overview
# Post on moodle.org in the Moodle community sites forum about the new version wikis e.g. [https://moodle.org/mod/forum/discuss.php?d=404029 Moodle Docs 3.9 wikis now available]

==1 week prior==

In new wiki:

* Remove message in MediaWiki:Sitenotice
* Check (and update if needed) Upgrading and Upgrade overview pages

In all older version wikis:

* Edit https://docs.moodle.org/en/MediaWiki:MoodleDocsVersionLinks to add the new version and remove older versions (though keeping 3.9 as [[Releases|LTS release]])

==Day of release==

Request for the new version wiki to be made default and email notification of watched pages to be enabled.

In previous latest version wiki:

* Edit https://docs.moodle.org/en/MediaWiki:Noarticletext to make it like https://docs.moodle.org/2x-1/en/MediaWiki:Noarticletext
* Edit https://docs.moodle.org/en/Creating_SCORM_Content to make it like https://docs.moodle.org/2x-1/en/Creating_SCORM_Content
* Go through Special:RecentChanges in the previous most recent version wiki and add relevant changes to the new version wiki
* Edit https://docs.moodle.org/en/Awards and add <code><nowiki>#redirect [[:en:Awards]]</nowiki></code> so it redirects to the latest version of the page
* Edit https://docs.moodle.org/en/MoodleDocs:Overview and add <code><nowiki>#redirect [[:en:MoodleDocs:Overview]]</nowiki></code> so it redirects to the latest version of the page
* For no longer supported versions, create MediaWiki:Sitenotice by copying content from https://docs.moodle.org/37/en/MediaWiki:Sitenotice

==Final checks==

* Email notification of watched pages enabled
* Links without version number e.g. https://docs.moodle.org/en/Main_page redirect to the new version wiki
* Docs links from a dev site, such as the QA testing site, redirect to the correct page in the new version wiki
* New version wiki listed in https://docs.moodle.org/overview/

[[Category:Documentation]]
[[Category:Processes]]
[[Category:Moodle Docs]]

Add a block cleanup

2022-03-26T13:44:32Z

Tsala: /* Disabling less useful blocks */ improved wording

{{Infobox Project
|name = Add a block cleanup
|state = Completed
|tracker = MDL-73299 (epic)
|discussion = [https://moodle.org/mod/forum/discuss.php?d=429959 Add a block cleanup for Moodle 4.0]
|assignee = Sara Arjona
}}
{{Template:Moodle 4.0}}

In the Add a block menu, the list of blocks is really long. This project is about figuring out how to reduce the list.
==Disabling blocks if the feature is disabled==
Blocks such as the blog menu, blog tags and recent blog entries will be disabled if blogs are disabled in advanced features.

Blocks this applies to:
* Accessibility review
* Blog menu
* Blog tags
* Recent blog entries
* Comments
* Course completion status
* Global search
* Latest badges
* Learning plans
* Network servers
* Random glossary entry
* Tags
==Disabling less useful blocks==
Some blocks that we have disabled by default are:
* Course summary
* Feedback - as the block only works if a Feedback activity is added to the site home page
* Remote RSS feeds - as RSS feeds are not used as much these days
* Self completion - as the block is only needed if self completion is enabled in the course completion settings (as mentioned in the setting).

For new installs, the above blocks will disabled by default.

For upgraded sites, we check if there are any instances of the block and if not, disable it.

==Letting themes define "unneeded" blocks==
The Administration and Navigation blocks are only needed if the Classic theme is used.

A new theme setting has been added to let themes mark blocks as "unneeded" (to avoid them being displayed in the "Add a block" list). This will allow Boost to mark the following blocks as unneeded:
* Navigation
* Administration
* Courses - as we have My courses in 4.0
* Section links - as the course index in 4.0 provides access to sections

As it's a theme setting, admins can still remove them from this "unneeded" blocks list, if, for any reason, they want the block to be available in the "Add a block" list.

Add a block cleanup

2022-03-26T13:41:59Z

Tsala: /* Letting themes define "unneeded" blocks */ improved wording

{{Infobox Project
|name = Add a block cleanup
|state = Completed
|tracker = MDL-73299 (epic)
|discussion = [https://moodle.org/mod/forum/discuss.php?d=429959 Add a block cleanup for Moodle 4.0]
|assignee = Sara Arjona
}}
{{Template:Moodle 4.0}}

In the Add a block menu, the list of blocks is really long. This project is about figuring out how to reduce the list.
==Disabling blocks if the feature is disabled==
Blocks such as the blog menu, blog tags and recent blog entries will be disabled if blogs are disabled in advanced features.

Blocks this applies to:
* Accessibility review
* Blog menu
* Blog tags
* Recent blog entries
* Comments
* Course completion status
* Global search
* Latest badges
* Learning plans
* Network servers
* Random glossary entry
* Tags
==Disabling less useful blocks==
Some blocks that we have disabled by default are:
* Course summary
* Feedback - as the block only works if a Feedback activity is added to the site home page
* Remote RSS feeds - as RSS feeds are not used as much these days
* Self completion - as the block is only needed if self completion is enabled in the course completion settings. Instead we can mention in the interface that for self completion, the block needs to be enabled by an administrator.

For new installs, the above blocks will disabled by default.

For upgraded sites, we check if there are any instances of the block and if not, disable it.
==Letting themes define "unneeded" blocks==
The Administration and Navigation blocks are only needed if the Classic theme is used.

A new theme setting has been added to let themes mark blocks as "unneeded" (to avoid them being displayed in the "Add a block" list). This will allow Boost to mark the following blocks as unneeded:
* Navigation
* Administration
* Courses - as we have My courses in 4.0
* Section links - as the course index in 4.0 provides access to sections

As it's a theme setting, admins can still remove them from this "unneeded" blocks list, if, for any reason, they want the block to be available in the "Add a block" list.

Site admin presets

2022-03-26T13:03:08Z

Tsala: /* Introduction */ rewording

{{Infobox Project
|state = Completed
|name = Site admin presets
|tracker = MDL-72112
|discussion = [https://moodle.org/mod/forum/discuss.php?d=429512 Site admin presets in Moodle 4.0]
|assignee = Pimenko, Sara Arjona and Amaia Anabitarte
}}
{{Template:Moodle 4.0}}
==Introduction==
As an admin
*I want to load administration presets
*So I can easily switch between different site admin configurations

This feature is partially implemented by 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]. The plugin lets admins import/export admin settings. This project adds enabled/disabled plugins data too.

==Acceptance criteria==
* The block should be converted to an admin tool.
** A link "Site admin presets" (pointing to 3rd-party plugin main page) should be displayed in the Site administration.
* The admin tool should follow the Moodle coding style and policy rules.
* The “Auto exclude sensitive settings” setting should be checked by default.
** The tool_admin_presets setting should be reviewed to confirm it includes all the sensitive settings that have been added recently.
* Presets should also include plugins visibility in order to let admins export/preview/load the list of plugins and their visibility (the original third-party plugin only includes settings).
* Moodle LMS should include, by default, 2 site admin presets, Starter and Full.
** Starter will disable most of the settings and plugins in order to make it easier for users to find the most common features.
** Full will include settings and plugins configuration as in Moodle 4.0
== Starter preset setting changes ==
{| class="wikitable"
|+
!Site administration
!Action
|-
|Advanced features
|Disable comments, tags, notes, blogs, badges, analytics, competencies
|-
|Users / Privacy and policies
|Disable Show data retention summary
|-
|Courses / Activity chooser / Activity chooser settings
|Set Activity chooser tabs to "Starred, All, Recommended"
|-
|Plugins / Activity modules / Manage activities
|Hide chat, database, external tool, IMS content package, lesson, SCORM, survey, wiki, workshop
|-
|Plugins / Activity modules / Forum
|Maximum number of attachments = 3
|-
|Plugins / Authentication / Manage authentication
|Hide Guest login button
|-
|Plugins / Availability restrictions / Manage restrictions
|Hide Grouping, User profile
|-
|Plugins / Activity modules / Manage blocks
|Hide Activities, Blog menu, Blog tags, Comments, Course completion status, Courses, Flickr, Global search, Latest badges, Learning plans, Logged in user, Login, Main menu, Mentees, Network servers, Online users, Private files, Recent blog entries, Recently accessed courses, Search forums, Section links, Social activities, Starred courses, Tags, YouTube

Hidden by default since Moodle 4.0: Course/site summary, RSS feeds, Self completion, Feedback.
|-
|Plugins / Course formats / Manage course formats
|Disable Social format
|-
|Plugins / Data formats / Manage data formats
|Disable Javascript Object Notation (.json)
|-
|Plugins / Enrolments / Manage enrol plugins
|Disable Cohort sync, Guest access
|-
|Plugins / Filters / Manage filters
|Disable MathJax, Activity names auto-linking
|-
|Plugins / Question behaviours / Manage question behaviours
|Disable Adaptive mode (no penalties), Deferred feedback with CBM, Immediate feedback with CBM
|-
|Plugins / Question types / Manage question types
|Disable Calculated, Calculated multichoice, Calculated simple, Drag and drop into text, Drag and drop markers, Drag and drop onto image, Embedded answers (Cloze), Numerical, Random short-answer matching
|-
|Plugins / Repositories / Manage repositories
|Disable Server files, URL downloader, Wikimedia
|-
|Plugins / Text editors / Manage editors
|Disable TinyMCE HTML editor
|}
== Migrating from block_admin_preset to tool_admin_preset ==
There are no plans to create any migration tool or similar. However, the tool_admin_preset follows the same XML than the block_admin_preset so users can export their presets from the block_admin_preset and import them in the tool_admin_preset.
==Defining the preset to be installed==
A $CFG setting in the config.php file allows you to specify the preset which will be installed during the install process (MDL-73145):<syntaxhighlight lang="php">
// The site admin presets plugin has been integrated in Moodle LMS. You can use a setting in case you
// want to apply a preset during the installation:
//
// $CFG->setsitepresetduringinstall = 'starter';

</syntaxhighlight>

Add a block cleanup

2022-03-25T09:18:17Z

Tsala: /* Letting themes define "un-addable" blocks */ unneeded

{{Infobox Project
|name = Add a block cleanup
|state = Completed
|tracker = MDL-73299 (epic)
|discussion = [https://moodle.org/mod/forum/discuss.php?d=429959 Add a block cleanup for Moodle 4.0]
|assignee = Sara Arjona
}}
{{Template:Moodle 4.0}}

In the Add a block menu, the list of blocks is really long. This project is about figuring out how to reduce the list.
==Disabling blocks if the feature is disabled==
Blocks such as the blog menu, blog tags and recent blog entries will be disabled if blogs are disabled in advanced features.

Blocks this applies to:
* Accessibility review
* Blog menu
* Blog tags
* Recent blog entries
* Comments
* Course completion status
* Global search
* Latest badges
* Learning plans
* Network servers
* Random glossary entry
* Tags
==Disabling less useful blocks==
Some blocks that we have disabled by default are:
* Course summary
* Feedback - as the block only works if a Feedback activity is added to the site home page
* Remote RSS feeds - as RSS feeds are not used as much these days
* Self completion - as the block is only needed if self completion is enabled in the course completion settings. Instead we can mention in the interface that for self completion, the block needs to be enabled by an administrator.

For new installs, the above blocks will disabled by default.

For upgraded sites, we check if there are any instances of the block and if not, disable it.
==Letting themes define "unneeded" blocks==
The Administration and Navigation blocks are only needed if the Classic theme is used.

A new theme setting has been added to let themes mark blocks as "unneeded" (to avoid them being displayed in the "Add a block" list page). This will allow Boost to mark the following blocks as unneeded:
* Navigation - as it has been improved in 4.0
* Administration - as navigation has been improved in 4.0
* Courses - as we have My courses in 4.0
* Section links - as the course index in 4.0 provides access to sections

As it's a theme setting, admins can still remove them from this "unneeded" blocks list, if, for any reason, they want to get them displayed in the "Add a block" page.

Core plugins review for Moodle 4.0

2022-03-25T09:14:56Z

Tsala: /* Plugins to be removed from core and added to the plugins directory */ quiz results block

{{Infobox Project
|name = Core plugins review
|state = Completed
|tracker = MDL-72046 (epic)
|discussion = [https://moodle.org/mod/forum/discuss.php?d=426053 Moodle core plugins review]
|assignee = Sara Arjona
}}
{{Template:Moodle 4.0}}
==Introduction==
This project is about reviewing the plugins in core Moodle LMS with the aim of removing any which are no longer or hardly used, and if appropriate, adding them to the Moodle plugins directory.
==Plugins to be deleted from core==
The following plugins will be deleted from core but not put in the plugins directory because the technology is discontinued.
* WebCT question import/export format (qformat_webct)
* Examview question import/export format (qformat_examview)
* Flash animation media player (media_swf)
* VideoJS Flash plugin
* Picasa repository (repository_picasa)
* Picasa portfolio (portfolio_picasa)
* Microsoft OneDrive (legacy) (repository_skydrive)
==Plugins to be removed from core and added to the plugins directory==
Plugins which have been removed from core and added to the plugins directory will initially be listed with Moodle HQ as maintainer while we seek new maintainers via the [[Plugins adoption programme]].
* Word censorship filter (filter_censor)
* Health center admin tool (tool_health)
* Jabber notification (message_jabber)
* Quiz results block (block_quiz_results)
* Box repository (repository_boxnet)
* Box portfolio (portfolio_boxnet)
Note the plugins can be added to the Plugins directory only once the target version 4.0 is registered there, which happens on beta release.

==Plugins we are thinking about removing from core in the future and adding to the plugins directory==
We still need to decide which of the following plugins should be removed from core and added to the plugins directory. It will be done in MDL-73136 (epic). Please let us know your thoughts by posting in the discussion on moodle.org [https://moodle.org/mod/forum/discuss.php?d=426053 Moodle core plugins review]. We will collate all your feedback and review what to do with each plugin.
* Algebra notation filter (filter_algebra)
* Assignment 2.2 module (mod_assignment): MDL-72350
* Equella repository (repository_equella)
* Flickr block (block_tag_flickr): MDL-72614
* Flickr portfolio (portfolio_flickr): MDL-72614
* Flickr repository (repository_flickr): MDL-72614
* Flickr public repository (repository_flickr_public): MDL-72614
* HTML tidy filter (filter_tidy)
* Legacy course files repository (repository_coursefiles)
* Mahara ePortfolio (portfolio_mahara)
* Merlot.org repository (repository_merlot)
* Survey activity (mod_survey)
* URL downloader repository (repository_url)
== How will these plugins be removed from core? ==
* The plugin folder (for instance, question/format/webct/ for qformat_webct), will be completely removed from Moodle core. IMPORTANT: if you want to keep any of the plugins removed from core in your Moodle site, you will need to download and copy the plugin folder to the right place BEFORE running the upgrading process.
* Each plugin will be removed from the standard_plugins_list() method and added to the is_deleted_standard_plugin() method (both placed in lib/classes/plugin_manager.php).
[[File:jabber tobedeleted.png|center|thumb|The plugins will be marked as "To be deleted" if their code is not placed again in the Moodle folder.]]
* The upgrading steps will be added to lib/db/upgrade.php, to remove specific tables and settings (when it applies).

The plugins data will be removed only if the plugins files are not present anymore in the code. So, if a site wants to keep any of the plugins removed from core, they should download and copy the plugin folder to the right place (as they use to do with third-party plugins) BEFORE running the upgrading process.

Moodle 4.0 release notes

2022-03-24T16:47:11Z

Tsala: scheduled release date update

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for the week of 18 April 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%224.0%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 4.0].

If you are upgrading from a previous version, please see [[:en:Upgrading|Upgrading]] in the user docs.

==Server requirements==

''Note: Requirements still to be reviewed and updated as necessary!''

These are just the minimum supported versions. We recommend keeping all of your software and operating systems up-to-date.

* Moodle upgrade: Moodle 3.6 or later
* PHP version: minimum PHP 7.3.0 ''Note: minimum PHP version has increased since Moodle 3.10''. PHP 7.4.x is supported too. [[Moodle and PHP|PHP 8.0 support]] is being implemented (see MDL-70745) and '''not ready for production''' yet.
* PHP extension '''sodium''' is recommended. It will be required in Moodle 4.2. For further details, see [https://docs.moodle.org/311/en/Environment_-_PHP_extension_sodium Environment - PHP extension sodium].
* PHP extension '''exif''' is recommended.
* PHP setting '''max_input_vars''' is recommended to be >= 5000 for PHP 7.x installations. It's a requirement for PHP 8.x installations. For further details, see [https://docs.moodle.org/311/en/Environment_-_max_input_vars Environment - max input vars].

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="wikitable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 10 (increased since Moodle 3.11)
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.7
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 10.2.29
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2017 (increased since Moodle 3.10)
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 11.2
| Latest
|}

==Client requirements==

=== Browser support ===

Moodle is compatible with any standards compliant web browser. We regularly test Moodle with the following browsers:

Desktop:
* Chrome
* Firefox
* Safari
* Edge

''Note: Moodle 4.0 does NOT support Internet Explorer 11.''

Safari 7 and below has known compatibility issues with Moodle 4.0.

Mobile:
* MobileSafari
* Google Chrome

For the best experience and optimum security, we recommend that you keep your browser up to date.
==Major features==

==Other highlights==

==Security issues==

A number of security related issues were resolved. Details of these issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.11 release notes]]

[[Category:Release notes]]
[[Category:Moodle 4.0]]

[[fr:Notes de version de Moodle 4.0]]
[[es:Notas de Moodle 4.0]]

Translating Moodle Docs

2022-03-21T13:56:11Z

Tsala: /* Contributing to the documentation */ removing link to manuals page

{{Translation}}
==Contributing to the documentation==
Moodle Docs pages, such as the page you are reading right now, are wiki pages available in [https://docs.moodle.org/overview/ several languages]. Any registered Moodle user can contribute to Moodle Docs and improve or translate these wiki pages. Please make sure to follow the [[:en:Guidelines_for_Contributors|guidelines for contributors]].

You might find it useful to add the original English documentation pages that you have just translated to your watchlist (alt-shift-w), so that you will know when your translation might need to be re-checked for a possible update.

==Translating the screen images used in Moodle Docs==
* If you want to recreate the bright orange-coloured screen images used in the Documentation pages (eg, [https://docs.moodle.org/30/en/New_features Moodle 3.0 New features Docs page]), you can replicate the [http://school.demo.moodle.net/ Mount Orange school] theme in your local server by following the details outlined [https://docs.moodle.org/30/en/Standard_themes#Mount_Orange:_example_of_a_customised_More_theme here for Moodle 3.0] and [https://docs.moodle.org/34/en/Standard_themes#Example_of_a_customised_Boost_theme here for the Boost theme in more recent Moodle branches].

===Replicating the Mount Orange theme look in a local server with the Boost theme===
* You will need to download the cloudy background from [https://docs.moodle.org/34/en/File:bg6.png here] and the Mount Orange image from [https://docs.moodle.org/30/en/File:Mount_Orange_Front_page_image.jpg here].
* You may insert these two images in a label in a Moodle course and notice (write down) the paths that references where these images have been stored, as you will need to input these paths later.

* Go to your site home and edit the site home summary.

[[File:Edit_Site_home_01.png]]

** You need to click on the very first tool button in order to show all the tools buttons in the Atto editor.

[[File:Edit_Site_home_02.png]]

** You need to click on the </> button in order to input HTML code:

[[File:Edit_Site_home_03.png]]

** You must input the code described in 'Front page topic section' of https://docs.moodle.org/34/en/Standard_themes#Example_of_a_customised_Boost_theme. Do NOT click the 'Save' button yet:

[[File:Edit Site home 04.png]]
** Replace 'YOUR UPLOADED FRONT PAGE IMAGE.jpg' with the path to your recently uploaded front page image, that you carefully wrote down earlier.
** Now is the time when you replace the 'YOUR HEADING' text with the translated text for your Orange-coloured School ('Escuela Monte Naranja' for this Spanish language example).
** Replace the 'SMALLER HEADING' text in both places with your language text strings.
** Replace 'Paragraph of text' in both places.
** Replace 'BUTTON TEXT' in both cases-
* When you click again on the <> button, the HTML code will be interpreted and you will see the graphics displayed and the texts rendered in a nice orange-colored style:

[[File:Edit_Site_home_05.png]]
** Check the result, and correct if necessary.
** You can now save your changes.

* Go to Administration, Appearance, Themes, Boost, advanced settings
* Paste the 'Boost theme Advanced settings - Raw initial CSS:' and 'Boost theme Advanced settings - Raw SCSS:' codes from https://docs.moodle.org/34/en/Standard_themes#Example_of_a_customised_Boost_theme.
** In the 'Boost theme Advanced settings - Raw SCSS:' section, replace 'YOUR UPLOADED BACKGROUND IMAGE.jpg' with the path to your recently uploaded cloudy background image.
* Replace the original English language text with the appropiate text for your language pack.
* Check that your Mount Orange clone site looks good.
* Compare your site's front page with the image of [https://docs.moodle.org/34/en/File:MountOrangeFrontPage.png Mount Orange 3.4 front page], or better yet, compare your site with [http://school.demo.moodle.net/ the current Mount Orange] page.
** Correct if necessary.
* If all is fine, save the changes.

* You can now use your emulated translated Orange site to replicate the beautiful images Moodle HQ used to illustrate [https://docs.moodle.org/33/en/New_features Moodle 3.3 new features] (or newer branches) in Moodle Docs.

==Which documentation pages are most important or useful to translate?==

Many Moodle users will start reading the [[:en:Main Page|English docs main page]]. This might be a good page to have translated.

The [[:en:New_features|new features in the latest version]] would surely be of interest to the users of previous Moodle versions that want to catch up with the new available features.

The [[:en:Category:Quick_guide|quick guides]] are very short pages (that hopefully you can very quickly translate) that teachers can quickly check, in order to grasp how an important Moodle feature works, without having to read the standard detailed (long) Moodle full documentation pages.

The [[:en:Table_of_Contents|Table of contents]] has a very comprehensive and organized list of important Moodle topics. This might be a worthy addition to your language documentation.

If you see a post which has been rated as 'Useful' several times in a [https://moodle.org/course/ Forum in a language other than English], which links to an untranslated English documentation page, it might be a good idea to translate this page.

The English Documentation Special Page with the [https://docs.moodle.org/30/en/index.php?title=Special:MostLinkedPages&limit=100&offset=0 Most linked-to pages] shows the English pages that have the highest number of links and (except for all the User: pages) you will find there many pages highly useful for Moodlers of all languages and worth translating to your language (eg, [https://docs.moodle.org/30/en/Managing_a_Moodle_site Managing a Moodle site] & [https://docs.moodle.org/30/en/Managing_a_Moodle_course Managing a Moodle course]).

''If you are a Moodle site admin or teacher, using a language other than English, and you use the 'Moodle Docs for this page' link in your daily work, please consider translating the English pages that helped you most to do your job and solve your problems.'' See below.

==Translating the Documentation pages for 'Mooodle Docs for this page' and 'More help' links==

* When logged in as an admin or teacher, 'Moodle Docs for this page' links at the bottom of each page in Moodle take you to documentation about that page in your language, if it exists, otherwise in English.
[[File:Moodle Docs for this page.png|300px]]
* You might be tempted to start typing the documentation in your own language (if such a page exists), but please don't do it. Instead, change your language to English and then click in the 'Moodle Docs for this page' link.
* In the English documentation page that just opened, add a language link for your language (see [https://docs.moodle.org/dev/Starting_a_new_docs_wiki Interlanguage-linking]), save it and then open the given translation page.
* If the English Documentation page has only a redirect instruction, please add a translation for the redirection and then save the English page with the redirection
[[File:Redirected page.png|400px]]
[[File:Redirected page in English.png|400px]]
* Make sure that you add a translation link for the redirection, check that it works (create the page if it did not exist) and save the page.
[[File:Redirected page in English with Spanish translation link.png|400px]]
* You can now jump to the redirected page in your own language and work on it.
[[File:Redirected page in Spanish.png|400px]]
* The 'More help' links have the same icon (i) and work the same way as the 'Moodle Docs for this page' links.

==Is it important to translate English Documentation pages that only have one #Redirect instruction?==
Yes, it is very, very fast and it will make your translated wiki more efficient, because you will replicate all the automatic redirections that exist in the English Docs in your own language Docs, specially with the Docs pages related to online help for specific pages in your Moodle server (see the example above).

If you have translated Documentation pages with #Redirect instructions, it will then be a good idea to go to the TOOLS column at the bottom of the page (in your language wiki documentation) and click on 'Special pages'. There, check the 'Broken redirects' and 'Double redirects' links and fix any pages that might show up there.

==Which English documentation pages will change when there is a new Moodle version release==

* If you have a translation of [https://docs.moodle.org/dev/Releases https://docs.moodle.org/dev/Releases] you will need to update it
* The [[:en:New_features|new features in the latest version]] mentioned above must now have the new available features.
* You might need to update the version numbers in your translated documentation for these pages:
** [https://docs.moodle.org/en/Upgrading https://docs.moodle.org/en/Upgrading]
** [https://docs.moodle.org/en/Installation_Quickstart https://docs.moodle.org/en/Installation_Quickstart]
** [https://docs.moodle.org/en/Installing_Moodle https://docs.moodle.org/en/Installing_Moodle]
** [https://docs.moodle.org/en/Git_for_Administrators https://docs.moodle.org/en/Git_for_Administrators]
** [https://docs.moodle.org/en/Upgrade_overview https://docs.moodle.org/en/Upgrade_overview]
** [https://docs.moodle.org/en/Language_packs https://docs.moodle.org/en/Language_packs]

==See also==

* [[Starting a new docs wiki]]
* [[Help strings]] in the developers documentation

[[Category:Moodle Docs]]
[[Category:Translation]]

Starting a new docs wiki

2022-03-21T13:42:38Z

Tsala: /* Starting a documentation wiki in another language */ moodle.com contact form

{{Translation}}
==Starting a documentation wiki in another language==

Would you like Moodle Docs in your language?

''Please check first whether all of the help files included in Moodle have been translated into your language.'' If not, perhaps you could offer to help your language pack maintainer(s) - see the [http://lang.moodle.org/local/amos/credits.php translation credits] for contact details.

Moodle Docs in a new language needs:

*'''An administrator''' (or two)
:The administrator should understand MediaWiki features such as page redirects, [[Special:Categories|categories]] and templates. Please browse this wiki to discover how these features work. When a new language wiki is started, an empty wiki will be set up for you to add documentation to.
*'''Lots of people wishing to contribute'''
:Please find out how many people are interested by discussing Moodle Docs in your moodle.org [https://moodle.org/community/ community discussion course]. You should also contact your language pack maintainer(s).

Note: Languages for which there is no documentation wiki link to the English Moodle Docs in the footer of each page. When a new language wiki is set up, all sites using the language will then link to the new language wiki and not to the English.

If you wish to start Moodle Docs in your language, are willing to take on administrator responsibility, and know of lots of people wishing to contribute, please get in touch via the [https://moodle.com/contact/support/?selection=community#form Moodle.com contact form].

Once your documentation wiki is set up, please announce it in your moodle.org community discussion course. Suggestions of what to do next are described below. Whilst everyone in your community may login and [[:en:MoodleDocs:Guidelines for contributors|contribute to the documentation]], [[:en:Special:Allmessages|system messages]] pages i.e. pages in the MediaWiki namespace are locked so that only administrators may edit them.

==Inter-language linking==

* Add inter-language links to pages by typing <syntaxhighlight lang="php"><nowiki>[[xx:Corresponding page title in the new language]]</nowiki></syntaxhighlight> in the English MoodleDocs, and <syntaxhighlight lang="php"><nowiki>[[en:Corresponding page title in English]]</nowiki></syntaxhighlight> in the new language Moodle Docs, at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.
===Example===
View the source at the bottom of the [https://docs.moodle.org/30/en/Main_page English Documentation main page] with many available inter-language links. Note that some pages (such as this) are protected and only English Moodle Docs administrators can edit them. If you need to add an inter-language link in a protected English Doc page, please comment in the corresponding talk page.

[[File:Inter-language links for Moodle Docs Main Page.png|200px]]

==Further links to the English documentation==

Note: [[:en:MediaWiki:Noarticletext]], containing the text below, automatically provides links for every page in Moodle to the corresponding English documentation page if they do not yet exist in your language.

<nowiki>This page does not exist yet. You are welcome to [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} create it]
or read ''[[:en:{{NAMESPACE}}:{{PAGENAME}}|the corresponding page in the English documentation]]''.</nowiki>

[[Category:Moodle Docs]]

Developer meeting April 2022

2022-03-15T10:38:07Z

Tsala: discussion link

[[Developer meetings]] > April 2022 meeting

{| class="wikitable"
|-
| Date
| Tuesday 12 April 2022 at 08:00 UTC ([https://www.timeanddate.com/worldclock/fixedtime.html?msg=Moodle+developer+meeting+April+2022&iso=20220412T08&p1=1440&ah=1 Check this time in your location])
|-
| Meeting room
| [https://moodle.org/mod/bigbluebuttonbn/view.php?id=8596 Developer meetings BBB on moodle.org]
|-
| Discussion
| [https://moodle.org/mod/forum/discuss.php?d=432769 Developer meeting Tuesday 12 April 2022]
|}

== Agenda ==

# Introducing Moodle 4.0 - Moodle HQ developers

----

If there is any topic that you would like to present or discuss at a developer meeting, please contact [https://moodle.org/user/profile.php?id=1601 David Mudrák].

Developer meeting April 2022

2022-03-15T10:24:50Z

Tsala: time confirmed, agenda

[[Developer meetings]] > April 2022 meeting

{| class="wikitable"
|-
| Date
| Tuesday 12 April 2022 at 08:00 UTC ([https://www.timeanddate.com/worldclock/fixedtime.html?msg=Moodle+developer+meeting+April+2022&iso=20220412T08&p1=1440&ah=1 Check this time in your location])
|-
| Meeting room
| [https://moodle.org/mod/bigbluebuttonbn/view.php?id=8596 Developer meetings BBB on moodle.org]
|-
| Discussion
| To be added
|}

== Agenda ==

# Introducing Moodle 4.0 - Moodle HQ developers

----

If there is any topic that you would like to present or discuss at a developer meeting, please contact [https://moodle.org/user/profile.php?id=1601 David Mudrák].

Moodle 3.11.6 release notes

2022-03-14T06:18:28Z

Tsala: version released

[[Releases]] > {{FULLPAGENAME}}

Release date: 14 March 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.11.6%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.11.6].

==General fixes and improvements==
* MDL-72762 - Backup fails if section name has only blank spaces
* MDL-72246 - 3.11 Dashboard Loads Slowly (30 seconds)
* MDL-72915 - Drag and Drop onto image: Issue moving draggable items with Unlimited option
* MDL-73846 - "Prepare submissions for annotation" task tries to process the whole queue in one go
* MDL-64770 - User profile fields uniqueness don't work while user importing
* MDL-72646 - MIME type headers for theme fonts are deprecated
* MDL-67428 - Performance issues with filters applied to course/category titles in navigation
* MDL-73824 - Decimal comma & PHP8.0
* MDL-66940 - 'View external Criteria URL' on Badgr links to badge awarded to somebody else
* MDL-69965 - MoodleNet profile field is displayed even when MoodleNet is disabled
* MDL-73915 - Bump NodeJS version, dependencies, and update JS build process, drop IE support
* MDL-73827 - URL blocked during OBv2.1 user authentication
* MDL-69966 - Quiz: start attempt button should be a primary button
* MDL-73450 - is_antelope_file_format_no_more_supported check should return true on Aurora MySQL 8.0+
* MDL-73588 - Unexpected content in the CURLOPT_FILE output stream on redirects
* MDL-73905 - Wrong coding_exception used on problems sending messages
* MDL-73954 - Quiz percentage should round the percentage the same way as the other grades
* MDL-73582 - Add endpoint to provide the Moodle version
* MDL-73868 - Remove multiple slashes in URL image for Open Badges services
* MDL-73636 - Activity "Mark as done" buttons contain unformatted module names
* MDL-73625 - Reorder and review the mobile settings for app 4.0
* MDL-72937 - Saving a user profile Moodlenet field > 255 characters causes exception
* MDL-73765 - Scheduled task are randomly allocated to 0 - 23 minutes range only
* MDL-72852 - If there are no course badges, students shouldn't have a link to a page saying there are no badges available
* MDL-73603 - Webservice token creation form throws exceptions during validation
* MDL-73561 - "Grades were set for X items" message displayed as alert-danger

==Accessibility improvements==
* MDL-73584 - Required ARIA children role not present: group, menuitemradio, menuitem, menuitemcheckbox
* MDL-70792 - CSS changes for the moremenu
* MDL-72412 - aria-label attribute is invalid for informative icon fonts

==Security improvements==
* MDL-72734 - Inconsistent checks used to determine whether to run task through web UI

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.11.5 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.11]]

[[fr:Notes de mise à jour de Moodle 3.11.6]]
[[es:Notas de Moodle 3.11.6]]

Moodle 3.10.10 release notes

2022-03-14T06:17:30Z

Tsala: version released

<p class="note">'''This version of Moodle is no longer supported for general bug fixes.''' You are encouraged to [[:en:Upgrading|upgrade]] to a supported version of Moodle.</p>

[[Releases]] > {{FULLPAGENAME}}

Release date: 14 March 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.10.10%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.10.10].

==Backported bug fixes==
* MDL-72762 - Backup fails if section name has only blank spaces
* MDL-73915 - Bump NodeJS version, dependencies, and update JS build process, drop IE support
* MDL-73588 - Unexpected content in the CURLOPT_FILE output stream on redirects

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.10.9 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.10]]

[[fr:Notes de mise à jour de Moodle 3.10.10]]
[[es:Notas de Moodle 3.10.10]]

Moodle 3.9.13 release notes

2022-03-14T06:17:06Z

Tsala: version released

<p class="note">'''This version of Moodle is no longer supported for general bug fixes.''' You are encouraged to [[:en:Upgrading|upgrade]] to a supported version of Moodle.</p>

[[Releases]] > {{FULLPAGENAME}}

Release date: 14 March 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.9.13%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.9.13].

==Backported bug fixes==
* MDL-73915 - Bump NodeJS version, dependencies, and update JS build process, drop IE support
* MDL-73588 - Unexpected content in the CURLOPT_FILE output stream on redirects

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.9.12 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.9]]

[[fr:Notes de mise à jour de Moodle 3.9.13]]
[[es:Notas de Moodle 3.9.13]]

Moodle 3.9.13 release notes

2022-03-10T07:59:38Z

Tsala: Backported bug fixes

<p class="note">'''This version of Moodle is no longer supported for general bug fixes.''' You are encouraged to [[:en:Upgrading|upgrade]] to a supported version of Moodle.</p>

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 14 March 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.9.13%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.9.13].

==Backported bug fixes==
* MDL-73915 - Bump NodeJS version, dependencies, and update JS build process, drop IE support
* MDL-73588 - Unexpected content in the CURLOPT_FILE output stream on redirects

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.9.12 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.9]]

[[fr:Notes de mise à jour de Moodle 3.9.13]]
[[es:Notas de Moodle 3.9.13]]

Moodle 3.10.10 release notes

2022-03-10T07:58:44Z

Tsala: Backported bug fixes

<p class="note">'''This version of Moodle is no longer supported for general bug fixes.''' You are encouraged to [[:en:Upgrading|upgrade]] to a supported version of Moodle.</p>

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 14 March 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.10.10%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.10.10].

==Backported bug fixes==
* MDL-72762 - Backup fails if section name has only blank spaces
* MDL-73915 - Bump NodeJS version, dependencies, and update JS build process, drop IE support
* MDL-73588 - Unexpected content in the CURLOPT_FILE output stream on redirects

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.10.9 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.10]]

[[fr:Notes de mise à jour de Moodle 3.10.10]]
[[es:Notas de Moodle 3.10.10]]

Moodle 3.11.6 release notes

2022-03-10T07:56:12Z

Tsala: General fixes and improvements, Accessibility improvements, Security improvements

[[Releases]] > {{FULLPAGENAME}}

Release date: Not yet released - scheduled for 14 March 2022

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.11.6%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.11.6].

==General fixes and improvements==
* MDL-72762 - Backup fails if section name has only blank spaces
* MDL-72246 - 3.11 Dashboard Loads Slowly (30 seconds)
* MDL-72915 - Drag and Drop onto image: Issue moving draggable items with Unlimited option
* MDL-73846 - "Prepare submissions for annotation" task tries to process the whole queue in one go
* MDL-64770 - User profile fields uniqueness don't work while user importing
* MDL-72646 - MIME type headers for theme fonts are deprecated
* MDL-67428 - Performance issues with filters applied to course/category titles in navigation
* MDL-73824 - Decimal comma & PHP8.0
* MDL-66940 - 'View external Criteria URL' on Badgr links to badge awarded to somebody else
* MDL-69965 - MoodleNet profile field is displayed even when MoodleNet is disabled
* MDL-73915 - Bump NodeJS version, dependencies, and update JS build process, drop IE support
* MDL-73827 - URL blocked during OBv2.1 user authentication
* MDL-69966 - Quiz: start attempt button should be a primary button
* MDL-73450 - is_antelope_file_format_no_more_supported check should return true on Aurora MySQL 8.0+
* MDL-73588 - Unexpected content in the CURLOPT_FILE output stream on redirects
* MDL-73905 - Wrong coding_exception used on problems sending messages
* MDL-73954 - Quiz percentage should round the percentage the same way as the other grades
* MDL-73582 - Add endpoint to provide the Moodle version
* MDL-73868 - Remove multiple slashes in URL image for Open Badges services
* MDL-73636 - Activity "Mark as done" buttons contain unformatted module names
* MDL-73625 - Reorder and review the mobile settings for app 4.0
* MDL-72937 - Saving a user profile Moodlenet field > 255 characters causes exception
* MDL-73765 - Scheduled task are randomly allocated to 0 - 23 minutes range only
* MDL-72852 - If there are no course badges, students shouldn't have a link to a page saying there are no badges available
* MDL-73603 - Webservice token creation form throws exceptions during validation
* MDL-73561 - "Grades were set for X items" message displayed as alert-danger

==Accessibility improvements==
* MDL-73584 - Required ARIA children role not present: group, menuitemradio, menuitem, menuitemcheckbox
* MDL-70792 - CSS changes for the moremenu
* MDL-72412 - aria-label attribute is invalid for informative icon fonts

==Security improvements==
* MDL-72734 - Inconsistent checks used to determine whether to run task through web UI

==Security fixes==

Details of any security issues will be released after a period of approximately one week to allow system administrators to safely update to the latest version.

==See also==
*[[Moodle 3.11.5 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.11]]

[[fr:Notes de mise à jour de Moodle 3.11.6]]
[[es:Notas de Moodle 3.11.6]]