MoodleDocs - User contributions [en]

Upgrading

2021-09-17T10:08:25Z

Tsala: /* Install the new Moodle software */ downloads link

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.5 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/35/en/Upgrading_to_Moodle_3.5 upgrade to 3.5] as a first step.

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can download the latest release from [https://download.moodle.org/ Moodle downloads].

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-latest-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.

chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

==Possible issues that may affect you in Moodle {{Version}}==

* MDL-67735 - The Bootstrap legacy css utilities from Bootstrap 2 and 4alpha have been removed. You may need to check your custom plugins and themes and make sure they used recent syntax. Please refer to <tt>theme/upgrade.txt</tt> for details.

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%203.10%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%203.10%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].

===New capabilities in Moodle {{Version}}===

* enrol/fee:config
* enrol/fee:manage
* enrol/fee:unenrol
* enrol/fee:unenrolself
* enrol/self:enrolself
* moodle/contentbank:downloadcontent
* moodle/course:configuredownloadcontent
* moodle/course:downloadcoursecontent
* moodle/payment:manageaccounts
* moodle/payment:viewpayments
* moodle/site:senderrormessage
* tool/customlang:export

=== Moodle 3.5, 3.6, 3.7, 3.8 and 3.9 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/35/en/Upgrading Upgrading to Moodle 3.5]
* [https://docs.moodle.org/36/en/Upgrading Upgrading to Moodle 3.6]
* [https://docs.moodle.org/37/en/Upgrading Upgrading to Moodle 3.7]
* [https://docs.moodle.org/38/en/Upgrading Upgrading to Moodle 3.8]
* [https://docs.moodle.org/39/en/Upgrading Upgrading to Moodle 3.9]

==Any questions about the process?==

Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.

==See also==

* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Upgrading

2021-08-05T09:37:06Z

Tsala: /* Possible issues that may affect you in Moodle {{Version}} */

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Before upgrading, check that your server meets all requirements for {{Version}} in ''Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for both [{{Release notes}}#Server_requirements server] and [{{Release notes}}#Client_requirements client] software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.5 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/35/en/Upgrading_to_Moodle_3.5 upgrade to 3.5] as a first step.

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

Consider setting the [[Upgrade key|upgrade key]] for your site.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a {{Version}} version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in. Then you should wait for any currently running cron processes to complete before proceeding.

== Install the new Moodle software ==
You can fetch the current version of the software at

wget http://sourceforge.net/projects/moodle/files/Moodle/stable39/moodle-latest-39.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree (Moodle directory structure) now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle and that you place the plugin folders in the correct directory (the same directory that they are in in the current installation.)
# Your moodledata folder should be located separately to your Moodle code folder and, as such, should not need anything done to it. Moodle 3.0 will throw a warning if it is located in a web accessible folder and the moodledata should never be located in the Moodle code folder. If you are moving your installation to a new server or new location on your server, then you will need to follow the [[Migration]] documents.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-latest-{{Version}}.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. For maximum security the files should not be writeable by your server. This is especially important on a 'production' server open to the public internet.

chown -R root:root moodle (Linux debian - or even create a user especially for moodle. '''Don't''' use the web server user, e.g. www-data)
chmod -R 755 moodle

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')
if necessary. However, for a simple upgrade, there should be no need to change anything with cron.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle {{Version}} supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

If you put your site into Maintenance mode earlier; take it out now!

To do this just go to ''Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a successful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

==Possible issues that may affect you in Moodle {{Version}}==

* MDL-67735 - The Bootstrap legacy css utilities from Bootstrap 2 and 4alpha have been removed. You may need to check your custom plugins and themes and make sure they used recent syntax. Please refer to <tt>theme/upgrade.txt</tt> for details.

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%203.10%20AND%20labels%20%3D%20upgrade_notes upgrade_notes-labelled issues] and [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Fixed%20AND%20fixVersion%20%3D%203.10%20AND%20labels%20%3D%20ui_change ui_change-labelled issues].

===New capabilities in Moodle {{Version}}===

* enrol/fee:config
* enrol/fee:manage
* enrol/fee:unenrol
* enrol/fee:unenrolself
* enrol/self:enrolself
* moodle/contentbank:downloadcontent
* moodle/course:configuredownloadcontent
* moodle/course:downloadcoursecontent
* moodle/payment:manageaccounts
* moodle/payment:viewpayments
* moodle/site:senderrormessage
* tool/customlang:export

=== Moodle 3.5, 3.6, 3.7, 3.8 and 3.9 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/35/en/Upgrading Upgrading to Moodle 3.5]
* [https://docs.moodle.org/36/en/Upgrading Upgrading to Moodle 3.6]
* [https://docs.moodle.org/37/en/Upgrading Upgrading to Moodle 3.7]
* [https://docs.moodle.org/38/en/Upgrading Upgrading to Moodle 3.8]
* [https://docs.moodle.org/39/en/Upgrading Upgrading to Moodle 3.9]

==Any questions about the process?==

Please post in the [https://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org.

==See also==

* [[dev:Moodle {{Version}} release notes|Moodle {{Version}} release notes]]
* [https://moodle.org/mod/forum/discuss.php?d=393570 Problem accessing dropdown such as personal profile since 3.8 (20191118) update] forum discussion

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

MediaWiki:Helplogin-url

2021-07-16T13:48:02Z

Tsala: link edit

https://docs.moodle.org/310/en/Help:Login

New features

2021-07-14T15:11:31Z

Tsala: New card-deck based layout

{{About Moodle}}

Read on for Moodle 3.10 highlights, or watch our [https://www.youtube.com/playlist?list=PLxcO_MFWQBDfOAMemSWqQrFJm4Ax0rmUb Youtube playlist of 3.10 New features].

Full details of the release with technical information can be found in the [[:dev:Moodle 3.10 release notes|Moodle 3.10 release notes]].
__NOTOC__

==For all users==
<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:DocsStudentDownloadCCPopup.png|class=img-fluid]]
<h4 class="card-title">
Download course content
</h4>
<p class="card-text">
[[Download course content]] (if allowed) at the click of a button.
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:DocsChooseBackPack.png|class=img-fluid]]
<h4 class="card-title">
Choose your backpack
</h4>
<p class="card-text">
Send your badges to your choice of backpack.
</p>
</div>
</div>

</div>
<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:DocsQuizScrollingTimer.png|class=img-fluid]]
<h4 class="card-title">
Scrolling timer for your quiz
</h4>
<p class="card-text">
Easily see remaining time with a new scrolling quiz timer.
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:Docs_Folder310.png|class=img-fluid]]
<h4 class="card-title">
Folder display
</h4>
<p class="card-text">
[[Folder resource]] images and HTML files may be viewed directly in the browser without downloading them.
</p>
</div>
</div>

</div>

==For teachers==
<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:DocsH5PReplaceDownload.png|class=img-fluid]]
<h4 class="card-title">
Content bank improvements
</h4>
<p class="card-text">
Download and/or replace H5P files in the [[Content bank|content bank]].
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:DocsTeacherDownloadCourse.png|class=img-fluid]]
<h4 class="card-title">
Download course content
</h4>
<p class="card-text">
Allow learners to [[Download course content|download course content.]]
</p>
</div>
</div>

</div>
<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:DocsPaymentTeacher.png|class=img-fluid]]
<h4 class="card-title">
Enrolment on payment
</h4>
<p class="card-text">
Offer paid courses with a variety of payment options.
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:Docs_QuizCompletion.png|class=img-fluid]]
<h4 class="card-title">
Quiz completion
</h4>
<p class="card-text">
Set quizzes to be marked complete based on one or more attempts. See [[Activity completion settings]].
</p>
</div>
</div>

</div>

==For administrators==

<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:Docs_AdminDownloadContent.png|class=img-fluid]]
<h4 class="card-title">
Download course content
</h4>
<p class="card-text">
This [https://moodleassociation.org/ Moodle Users Association] project allows admins to make a [[Download course content|download course content]] feature available for teachers to offer in courses.
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:DocsH5pCustomisation.png|class=img-fluid]]
<h4 class="card-title">
Customise H5P styles
</h4>
<p class="card-text">
Customise H5P styles in your theme to match your organisation's branding.
</p>
</div>
</div>

</div>
<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:DocsPaymentAdmin.png|class=img-fluid]]
<h4 class="card-title">
Payment gateways
</h4>
<p class="card-text">
Set up [[Payment gateways]] such as PayPal for use in [[Enrolment on payment]].
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:DocsLangCustom.png|class=img-fluid]]
<h4 class="card-title">
Language customisation
</h4>
<p class="card-text">
Import and export custom language strings. See [[Language customisation]].
</p>
</div>
</div>

</div>
<div class="card-deck mt-3">

<div class="card">
<div class="card-body">
[[File:DocsTasksRunning.png|class=img-fluid]]
<h4 class="card-title">
Better task management
</h4>
<p class="card-text">
A new Tasks running screen displays your current ongoing tasks. See [[Scheduled tasks]].
</p>
</div>
</div>

<div class="card">
<div class="card-body">
[[File:LTI310.png|class=img-fluid]]
<h4 class="card-title">
LTI improvements
</h4>
<p class="card-text">
LTI improvements include dynamic registration and multiple content item selection.
</p>
</div>
</div>

</div>

[[Category:New features]]

[[de:Neue Funktionalitäten]]
[[es:Nuevas características de Moodle 3.10]]
[[fr:Nouveautés de Moodle 3.10]]

MediaWiki:Helplogin-url

2021-07-14T14:13:00Z

Tsala: changing URL

https://docs.moodle.org/311/en/Help:Login

Main page

2021-07-14T12:38:42Z

Tsala: replace grid with BS4 Card decks

{{#addbodyclass:moodledocs-logo}}
<div class="navtrail">[https://docs.moodle.org/overview/ Docs overview] ► [[{{PAGENAME}}|Moodle Docs 3.10]]</div>

<div class="card-deck">
<div class="card">
<div class="card-body">
<h4 class="card-title">Get started</h4>
<p class="card-text">
* [[Features|Browse features]]
* [[Teacher quick guide]]
* [[Admin quick guide]]
* [[Installation quick guide]]
</p>
</div>
<div class="card-footer">
: [[:Category:Quick guide|More quick guides <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">Manage your course</h4>
<p class="card-text">
* [[Course homepage|Set up your course]]
* [[Add students|Add students]]
* [[Tracking progress|Track progress]]
* [[Working with files|Upload files]]
</p>
</div>
<div class="card-footer">
: [[Managing a Moodle course|More for teachers <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">Add activities</h4>
<p class="card-text">
* [[Assignment activity|Use assignments to assess]]
* [[Forum activity|Discuss in forums]]
* [[Quiz activity|Test students with a quiz]]
* [[Workshop activity|Peer-assess with a workshop]]
</p>
</div>
<div class="card-footer">
: [[Activities|More activities <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">What's new</h4>
<p class="card-text">
* [[New for teachers|For teachers]]
* [[New for students|For students]]
* [[New for administrators|For admins]]
* [[New for mobile|Mobile]]
</p>
</div>
<div class="card-footer">
: [[New features|New features list <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">Manage your site</h4>
<p class="card-text">
* [[Add users|Add users]]
* [[Adding a new course|Add courses]]
* [[Site appearance|Change the look and feel]]
* [[Installing plugins|Install plugins]]
</p>
</div>
<div class="card-footer">
: [[Managing a Moodle site|More for administrators <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 features|View app features]]
* [[Moodle app notifications|Keep up-to-date with notifications]]
* [[Creating Moodle-app-friendly courses|Create mobile-friendly courses]]
* [[Moodle app additional features|Add more app features]]
</p>
</div>
<div class="card-footer">
: [[Moodle app|More about the Moodle app <i class="fa fa-sm fa-arrow-right" aria-hidden="true"></i>]]
</div>
</div>
</div>

__NOTOC__

[[de:Hauptseite]]
[[es:Página Principal]]
[[eu:Azala]]
[[fr:Accueil]]
[[hr:Glavna stranica]]
[[it:Pagina_principale]]
[[ja:メインページ]]
[[pt-br:Página_principal]]
[[zh:首页]]

MediaWiki:Sidebar

2021-07-14T12:32:51Z

Tsala: Adding top menu

File:linkedin scopes defined.png

2021-07-05T13:57:27Z

Tsala:

File:linkedin auth page.png

2021-07-05T13:57:10Z

Tsala:

File:linkedin added products.png

2021-07-05T13:56:17Z

Tsala:

File:linkedin products prior selection.png

2021-07-05T13:55:58Z

Tsala:

File:linkedin app creation.png

2021-07-05T13:55:42Z

Tsala:

OAuth 2 LinkedIn service

2021-07-05T13:53:03Z

Tsala: Copying changes from 311 wiki - credit to Peter Dias (MDL-65637)

{{OAuth2}}
== LinkedIn setup ==
To setup an OAuth 2 client with LinkedIn, first we need to login to the [https://www.linkedin.com/developers/ LinkedIn Developers page] and create a new app.

On the 'Create an app' page, fill in the required fields:
* App name
* LinkedIn Page - The page that this app will be associated with
* App Logo
[[File:linkedin app creation.png]]

After you're done creating the app, you will be redirected to a screen where you can manage various settings related to the app.

=== Permissions / Scope requirements ===
For the client to function properly, it needs to be granted permissions to retrieve information from a user. LinkedIn does this easily by defining 'Products' that an app can be associated with. Each product defines the various use case that the API can be used for. For Moodle purposes, we only require the 'Sign In with LinkedIn' product.

Go to the Products tab and select the 'Sign In with LinkedIn' product

[[File:linkedin products prior selection.png]]

The product will be marked as 'Review in progress' and will take a few minutes to be approved. Once done, the product will be listed in the app's 'Added products' section.

[[File:linkedin added products.png]]

=== Client settings ===
Once the product have been successfully added, go to the 'Auth' tab. Here you will find the Authentication keys required to setup your issuer in Moodle. You will have to setup the authorised redirect URLs as is standard for OAuth2.

[[File:linkedin auth page.png]]

You will also find the OAuth2 scopes listed which was done as part of Scope requirements earlier.

[[File:linkedin scopes defined.png]]

== Issuer configuration ==
Authentication via LinkedIn is now a preconfigured service available for administrators. Go to 'Site Admin -> Server -> OAuth2 services' and click on the LinkedIn button.
All you need now is to enter and save the client id and secret and LinkedIn will now be an option for a user on the login page.

== See also ==
* MDL-65637

Talk:Arguments in favour of PostgreSQL

2021-05-26T07:55:24Z

Tsala: reply

The link called "Installing Postgres on Ubuntu(Debian)" takes you to a page that does not even mention Postgres. The link should either be fixed, the title should be updated or the link should be removed.

The linked page used to have a paragraph about PostgreSQL in the Documentation for Moodle 2.0. I have provisionally changed the link, but it would be very convenient that someone knowlegeable updates the page at https://docs.moodle.org/310/en/Step-by-step_Installation_Guide_for_Ubuntu. [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

== Delete this page? ==

Despite its title this page reads like someone with an axe to grind listing deficiencies in MySQL circa 2005, rather than presenting arguments in favour of PostgreSQL. I think this kind of page is more suited to a blog post or forum post and not Moodle Docs, so I think this page should be deleted. See also: forum thread [https://moodle.org/mod/forum/discuss.php?d=421937 Arguments in favour of PostgreSQL]. [[User:Leon Stringer|Leon Stringer]] ([[User talk:Leon Stringer|talk]]) 08:54, 11 May 2021 (UTC)

:Thanks Leon for your comment. I have redirected the page, rather than deleting it, to avoid broken links from moodle.org forum posts and elsewhere. --[[User:Helen Foster|Helen Foster]] ([[User talk:Helen Foster|talk]]) 07:55, 26 May 2021 (UTC)

Arguments in favour of PostgreSQL

2021-05-26T07:41:48Z

Tsala: redirecting page as content is out-of-date

#redirect [[PostgreSQL]]

Performance recommendations

2021-05-26T07:40:30Z

Tsala: removing out-of-date link

{{Performance}}
Moodle can be made to perform very well, at small usage levels or scaling up to many thousands of users. The factors involved in performance are basically the same as for any PHP-based database-driven system. When trying to optimize your server, try to focus on the factor which will make the most difference to the user. For example, if you have relatively more users browsing than accessing the database, look to improve the webserver performance.

==Obtain a baseline benchmark==

Before attempting any optimization, you should obtain a baseline benchmark of the component of the system you are trying to improve. For Linux try [http://lbs.sourceforge.net/ LBS] and for Windows use the Performance Monitor. Once you have quantitative data about how your system is performing currently, you'll be able to determine if the change you have made has had any real impact.

The overall aim of adjustments to improve performance is to use RAM (cacheing) and to reduce disk-based activity. It is especially important to try to eliminate swap file usage as much as you can. If your system starts swapping, this is a sign that you need more RAM.

The '''optimization order preference''' is usually: primary storage (more RAM), secondary storage (faster hard disks/improved hard disk configuration), processor (more and faster).

It can be interesting to install and use the [https://moodle.org/plugins/report_benchmark Benchmark plugin] in order to find the bottlenecks of your system that specifically affect Moodle.

==Scalability==

Moodle's design (with clear separation of application layers) allows for strongly scalable setups. (Please check the list of [[Large installations|large Moodle installations]].)

Large sites usually separate the web server and database onto separate servers, although for smaller installations this is typically not necessary.

It is possible to load-balance a Moodle installation, for example by using more than one webserver. The separate webservers should query the same database and refer to the same filestore and cache areas (see [[Caching]]), but otherwise the separation of the application layers is complete enough to make this kind of clustering feasible. Similarly, the database could be a cluster of servers (e.g. a MySQL cluster), but this is not an easy task and you should seek expert support, e.g. from a Moodle Partner.

On very large, load-balanced, systems the performance of the shared components become critical. It's important that your shared file areas are properly tuned and that you use an effective cache (Redis is highly recommended). A good understanding of these areas of system administration should be considered a minimum requirement.

===Server cluster===

Using Moodle forum discussions:

*[http://moodle.org/mod/forum/discuss.php?d=57202 Moodle clustering]
*[http://moodle.org/mod/forum/discuss.php?d=44470 Software load balancing]
*[http://moodle.org/mod/forum/discuss.php?d=49986 TCP load balancing]
*[http://moodle.org/mod/forum/discuss.php?d=88214 Installation for 3000 simultaneous users]

==Hardware configuration==
'''Note''': The fastest and most effective change that you can make to improve performance is to '''increase the amount of RAM on your web server''' - get as much as possible (e.g. 4GB or more). Increasing primary memory will reduce the need for processes to swap to disk and will enable your server to handle more users.
* Better performance is gained by obtaining the best '''processor capability''' you can, i.e. dual or dual core processors. A modern BIOS should allow you to enable hyperthreading, but check if this makes a difference to the overall performance of the processors by using a [http://en.wikipedia.org/wiki/Super_PI CPU benchmarking tool].
* If you can afford them, use '''SCSI hard disks''' instead of SATA drives. SATA drives will increase your system's CPU utilization, whereas SCSI drives have their own integrated processors and come into their own when you have multiple drives. If you must have SATA drives, check that your motherboard and the drives themselves support NCQ (Native Command Queuing).
* Purchase hard disks with a '''low seek time'''. This will improve the overall speed of your system, especially when accessing Moodle's reports.
* Size your '''swap file''' correctly. The general advice is to set it to 4 x physical RAM.
* Use a '''RAID disk system'''. Although there are many different RAID configurations you can create, the following generally works best:
** install a hardware RAID controller (if you can)
** the operating system and swap drive on one set of disks configured as RAID-1.
** Moodle, Web server and Database server on another set of disks configured as RAID-5.
* If your 'moodledata' area is going to be on relatively slow storage (e.g. NFS mount on to a NAS device) you will have performance issues with the default cache configuration (which writes to this storage). See the page on [[Caching]] and choose an alternative. Redis is recommended. Using [https://en.wikipedia.org/wiki/GlusterFS GlusterFS] / [https://en.wikipedia.org/wiki/OCFS2 OCFS2] / [https://en.wikipedia.org/wiki/GFS2 GFS2] on a [https://en.wikipedia.org/wiki/Storage_Area_Network SAN] device and [https://en.wikipedia.org/wiki/Fibre_Channel Fiber Channel] could improve performance (See more info on the Moodle [https://moodle.org/mod/forum/discuss.php?d=214680#p1123124 forum thread], [https://moodle.org/mod/forum/discuss.php?d=310501#p1242382 NFS performance tuing] )
* Use '''gigabit ethernet''' for improved latency and throughput. This is especially important when you have your webserver and database server separated out on different hosts.
* Check the settings on your '''network card'''. You may get an improvement in performance by increasing the use of buffers and transmit/receive descriptors (balance this with processor and memory overheads) and off-loading TCP checksum calculation onto the card instead of the OS.
* Read this [http://moodle.org/mod/forum/discuss.php?d=68579 Case Study] on a server stress test with 300 users.
* See this [http://elearning.sgu.ac.jp/doc/PT/ accompanying report] on network traffic and server loads.
* Also see this SFSU presentation at Educause (using VMWare): [http://www.educause.edu/Resources/AnOpenSourceLMSforaMissionCrit/162843]

==Operating System==
* You can use [http://en.wikipedia.org/wiki/Linux Linux](recommended), Unix-based, Windows or Mac OS X for the server '''operating system'''. *nix operating systems generally require less memory than Mac OS X or Windows servers for doing the same task as the server is configured with just a shell interface. Additionally Linux does not have licensing fees attached, but can have a big learning curve if you're used to another operating system. If you have a large number of processors running SMP, you may also want to consider using a highly tuned OS such as [http://en.wikipedia.org/wiki/Solaris_Operating_Environment Solaris].
* Check your own OS and '''vendor specific instructions''' for optimization steps.
** For Linux look at the [http://linuxperf.sourceforge.net/ Linux Performance Team] site.
** For Linux investigate the hdparm command, e.g. hdparm -m16 -d1 can be used to enable read/write on multiple sectors and DMA. Mount disks with the [https://moodle.org/mod/forum/discuss.php?d=310501#p1242382 "async" and "noatime"] options.
** For Windows set the sever to be optimized for network applications (Control Panel, Network Connections, LAN connection, Properties, File & Printer Sharing for Microsoft Networks, Properties, Optimization). You can also search the [http://technet.microsoft.com/ Microsoft TechNet site] for optimization documents.

==Web server performance==

Installing [http://www.mozilla.com/en-US/ Firefox] and the [https://addons.mozilla.org/en-US/firefox/addon/1843 firebug] extension will allow you to watch the time it takes for each page component to load. Also, the [https://addons.mozilla.org/en-US/firefox/addon/5369 Yslow] extension will evaluate your page against Yahoo's [http://www.skrenta.com/2007/05/14_rules_for_fast_web_pages_by_1.html 14 rules], full text [http://developer.yahoo.com/performance/rules.html Best Practices for Speeding Up Your Web Site], <strike>([http://video.yahoo.com/video/play?vid=1040890 video])</strike> for fast loading websites.

===PHP performance===
* PHP contains a built-in accelerator. Make sure it is enabled.
* Improvements in read/write performance can be improved by putting the cached PHP pages on a [[TMPFS]] filesystem - but remember that you'll lose the cache contents when there is a power failure or the server is rebooted.
* Performance of PHP is better when installed as an '''Apache/IIS6 ISAPI module''' (rather than a CGI). IIS 7.0/7.5 (Windows Server 2008/R2) users should choose a FastCGI installation for best performance.
* Also check the '''memory_limit''' in php.ini. The default value for the memory_limit directive is 128M. On some sites, it may need to be larger - especially for some backup operations.
* Also see [[PHP_settings_by_Moodle_version]]
* Use [http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html PHP-FPM] (with apache).

===Install HowTo===
==== APC ====
* [http://2bits.com/articles/installing-php-apc-gnulinux-centos-5.html APC on CentOS 5.x (linux)]
* [http://fplanque.com/dev/linux/install-apc-php-cache-debian-lenny APC on Debian (linux)]
==== eAccelerator ====
* [http://noveckg.blogspot.com/2010/02/installing-eaccelerator-cache-for-php.html Installing eAccelerator on CentOS 5.x (linux)]
* [https://docs.moodle.org/en/Installing_eAccelerator_In_Ubuntu_Server/ Installing eAccelerator on Ubuntu Server (linux)]
==== MemCached ====
Memcached server (daemon)
* [https://www.tecmint.com/install-memcached-on-centos-7/ Installing Memcached on CentOS 7.x (linux)] (as of php 7.x, only memcached is available)
* [https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-memcached-on-centos-7 How To Install and Secure Memcached on CentOS 7]
* [https://wiki.zimbra.com/wiki/Blocking_Memcached_Attack#Iptables_rules_for_Redhat_based_servers Iptables rules for Redhat based servers]
Memcached PHP 7.1 extension
* [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/php71u-pecl-memcached.html php71u-pecl-memcached] from IUS CentOS 7.x repository.

===Apache performance===
* If you are using Apache on a Windows server, use the build from [http://www.apachelounge.com Apache Lounge] which is reported to have [http://moodle.org/mod/forum/discuss.php?d=93358 performance and stability improvements] compared to the official Apache download. Note that this is an unofficial build, so may not keep up with official releases.
* Set the '''MaxRequestWorkers''' directive correctly ('''MaxClients''' before Apache 2.4). Use this formula to help (which uses 80% of available memory to leave room for spare):
MaxRequestWorkers = Total available memory * 80% / Max memory usage of apache process
:Memory usage of apache process is usually 10MB but Moodle can easily use up to 100MB per process, so a general rule of thumb is to divide your available memory in megabytes by 100 to get a conservative setting for MaxClients. You are quite likely to find yourself lowering the MaxRequestWorkers from its default of 150 on a Moodle server. To get a more accurate estimate read the value from the shell command:
#ps -ylC httpd --sort:rss

:If you need to increase the value of '''MaxRequestWorkers''' beyond 256, you will also need to set the '''ServerLimit''' directive.

:'''Warning''': Do not be tempted to set the value of MaxRequestWorkers higher than your available memory as your server will consume more RAM than available and start to swap to disk.
* Consider reducing the '''number of modules''' that Apache loads in the httpd.conf file to the minumum necessary to reduce the memory needed.
* Use the '''latest version of Apache''' - Apache 2 has an improved memory model which reduces memory usage further.
* For Unix/Linux systems, consider lowering '''MaxConnectionsPerChild''' ('''MaxRequestsPerChild''' before Apache 2.4) in httpd.conf to as low as 20-30 (if you set it any lower the overhead of forking begins to outweigh the benefits).
* For a heavily loaded server, consider setting '''KeepAlive Off''' (do this only if your Moodle pages do not contain links to resources or uploaded images) or lowering the '''KeepAliveTimeout''' to between 2 and 5. The default is 15 (seconds) - the higher the value the more server processes will be kept waiting for possibly idle connections. A more accurate value for KeepAliveTimeout is obtained by observing how long it takes your users to download a page. After altering any of the KeepAlive variables, monitor your CPU utilization as there may be an additional overhead in initiating more worker processes/threads.
* As an alternative to using KeepAlive Off, consider setting-up a '''Reverse Proxy server''' infront of the Moodle server to cache HTML files with images. You can then return Apache to using keep-alives on the Moodle server.
* If you do not use a .htaccess file, set the '''AllowOverride''' variable to AllowOverride None to prevent .htaccess lookups.
* Set '''DirectoryIndex''' correctly so as to avoid content-negotiation. Here's an example from a production server:
DirectoryIndex index.php index.html index.htm
* Unless you are doing development work on the server, set '''ExtendedStatus Off''' and disable mod_info as well as mod_status.
* Leave '''HostnameLookups Off''' (as default) to reduce DNS latency.
* Consider reducing the value of '''TimeOut''' to between 30 to 60 (seconds).
* For the '''Options directive''', avoid Options Multiviews as this performs a directory scan. To reduce disk I/O further use
Options -Indexes FollowSymLinks

* Compression reduces response times by reducing the size of the HTTP response
# Install and enable mod_deflate - refer to documentation or man pages
# Add this code to the virtual server config file within the <directory> section for the root directory (or within the .htaccess file if AllowOverrides is On):
<ifModule mod_deflate.c>
AddOutputFilterByType DEFLATE text/html text/plain text/xml text/x-js text/javascript text/css application/javascript
</ifmodule>
* Use Apache [http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html event] [http://httpd.apache.org/docs/current/mpm.html MPM] (and not the default Prefork or Worker)

===IIS performance===
All alter this location in the registry:
HKLM\SYSTEM\CurrentControlSet\Services\Inetinfo\Parameters\
* The equivalent to KeepAliveTimeout is '''ListenBackLog''' (IIS - registry location is HKLM\ SYSTEM\ CurrentControlSet\ Services\ Inetinfo\ Parameters). Set this to between 2 to 5.
*Change the '''MemCacheSize''' value to adjust the amount of memory (Mb) that IIS will use for its file cache (50% of available memory by default).
*Change the '''MaxCachedFileSize''' to adjust the maximum size of a file cached in the file cache in bytes. Default is 262,144 (256K).
*Create a new DWORD called '''ObjectCacheTTL''' to change the length of time (in milliseconds) that objects in the cache are held in memory. Default is 30,000 milliseconds (30 seconds).

===Lighttpd, NginX and Cherokee performance===
You can increase server performance by using a '''light-weight''' webserver like [http://www.lighttpd.net/ lighttpd], [http://nginx.net/ nginx] or [http://www.cherokee-project.com/ cherokee] in combination with PHP in FastCGI-mode. Lighttpd was originally created as a proof-of-concept[http://www.lighttpd.net/story] to address the [http://www.kegel.com/c10k.html C10k problem] and while primarily recommended for memory-limited servers, its design origins and asynchronous-IO model make it a suitable and proven[http://blog.lighttpd.net/articles/2006/12/28/lighttpd-powers-5-alexa-top-250-sites] alternative HTTP server for high-load websites and web apps, including Moodle. See the [[lighttpd | MoodleDocs Lighttpd page]] for additional information, configuration example and links.

Alternatively, both [http://www.lighttpd.net/ lighttpd] and [http://nginx.net/ nginx] are capable of performing as a load-balancer and/or reverse-proxy to alleviate load on back-end servers[http://www.linuxjournal.com/article/10108], providing benefit without requiring an actual software change on existing servers.

Do note that these are likely to be the least tested server environments of all particularly if you are using advanced features such as web services and/or Moodle Networking. They are probably best considered for heavily used Moodle sites with relatively simple configurations.

===X-Sendfile===

X-Sendfile modules improve performance when sending large files from Moodle. It is recommended to configure your web server and Moodle to use this feature of available.

Configure web server:
* Apache - https://tn123.org/mod_xsendfile/
* Lighttpd - http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file
* Nginx - http://wiki.nginx.org/XSendfile

Enable support in config.php (see config-dist.php):
<code php>
// $CFG->xsendfile = 'X-Sendfile'; // Apache {@see https://tn123.org/mod_xsendfile/}
// $CFG->xsendfile = 'X-LIGHTTPD-send-file'; // Lighttpd {@see http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file}
// $CFG->xsendfile = 'X-Accel-Redirect'; // Nginx {@see http://wiki.nginx.org/XSendfile}
</code>

Configure file location prefixes if your server implementation requires it:
<code php>
// $CFG->xsendfilealiases = array(
// '/dataroot/' => $CFG->dataroot,
// '/cachedir/' => '/var/www/moodle/cache', // for custom $CFG->cachedir locations
// '/localcachedir/' => '/var/local/cache', // for custom $CFG->localcachedir locations
// '/tempdir/' => '/var/www/moodle/temp', // for custom $CFG->tempdir locations
// '/filedir' => '/var/www/moodle/filedir', // for custom $CFG->filedir locations
// );
</code>

== Cron performance ==

Cron is a very important part of the overall performance of moodle as many asynchronous processes are offloaded to cron, so it needs to be running and have enough through put to handle the work being given to it by the front ends.

See [[Cron_with_Unix_or_Linux#High_performance_cron_tasks]]

==Database performance==

===MySQL performance===

The '''number one thing''' you can do to improve MySQL performance is to read, understand and implement the recommendations in the [https://dev.mysql.com/doc/refman/5.7/en/innodb-buffer-pool.html Innodb Buffer Pool] article.

The [https://dev.mysql.com/doc/refman/5.7/en/innodb-buffer-pool-resize.html buffer pool size] can safely be changed while your server is running, as long as your server has enough memory (RAM) to accommodate the value you set. On a machine that is dedicated to MySQL, you can safely set this value to 80% of available memory.

Consider setting [https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_buffer_pool_instances innodb_buffer_pool_instances] to the number of cores, vCPUs, or chips you have available. Adjust this value in accordance with the recommendations in the [https://dev.mysql.com/doc/refman/5.7/en/innodb-buffer-pool-resize.html MySQL documentation].

The following are MySQL specific settings which can be adjusted for better performance in your my.cnf (my.ini in Windows). The file contains a list of settings and their values. To see the current values use these commands
SHOW STATUS;
SHOW VARIABLES;
'''Important''': You must make backups of your database before attempting to change any MySQL server configuration. After any change to the my.cnf, restart mysqld.

If you are able, the [http://mysqltuner.pl/ MySQLTuner] tool can be run against your MySQL server and will calculate appropriate configuration values for most of the following settings based on your current load, status and variables automatically.

* Enable the '''query cache''' with
query_cache_type = 1.
For most Moodle installs, set the following:
query_cache_size = 36M
query_cache_min_res_unit = 2K.
The query cache will improve performance if you are doing few updates on the database.
* Set the '''table cache''' correctly. For Moodle 1.6 set
table_cache = 256 #(table_open_cache in MySQL > 5.1.2)
(min), and for Moodle 1.7 set
table_cache = 512 #(table_open_cache in MySQL > 5.1.2)
(min). The table cache is used by all threads (connections), so monitor the value of opened_tables to further adjust - if opened_tables > 3 * table_cache(table_open_cache in MySQL > 5.1.2) then increase table_cache upto your OS limit. Note also that the figure for table_cache will also change depending on the number of modules and plugins you have installed. Find the number for your server by executing the mysql statement below. Look at the number returned and set table_cache to this value.
mysql>SELECT COUNT(table_name) FROM information_schema.tables WHERE table_schema='yourmoodledbname';
* Set the '''thread cache''' correctly. Adjust the value so that your thread cache utilization is as close to 100% as possible by this formula:
thread cache utilization (%) = (threads_created / connections) * 100
* The '''key buffer''' can improve the access speed to Moodle's SELECT queries. The correct size depends on the size of the index files (.myi) and in Moodle 1.6 or later (without any additional modules and plugins), the recommendation for this value is key_buffer_size = 32M. Ideally you want the database to be reading once from the disk for every 100 requests so monitor that the value is suitable for your install by adjusting the value of key_buffer_size so that the following formulas are true:
key_read / key_read_requests < 0.01
key_write / key_write_requests <= 1.0
* Set the '''maximum number of connections''' so that your users will not see a "Too many connections" message. Be careful that this may have an impact on the total memory used. MySQL connections usually last for milliseconds, so it is unusual even for a heavily loaded server for this value to be over 200.
* Manage '''high burst activity'''. If your Moodle install uses a lot of quizzes and you are experiencing performance problems (check by monitoring the value of threads_connected - it should not be rising) consider increasing the value of back_log.
* '''Optimize your tables weekly and after upgrading Moodle'''. It is good practice to also optimize your tables after performing a large data deletion exercise, e.g. at the end of your semester or academic year. This will ensure that index files are up to date. Backup your database first and then use:
mysql>CHECK TABLE mdl_tablename;
mysql>OPTIMIZE TABLE mdl_tablename;
:The common tables in Moodle to check are mdl_course_sections, mdl_forum_posts, mdl_log and mdl_sessions (if using dbsessions). Any errors need to be corrected using REPAIR TABLE (see the [http://dev.mysql.com/doc/refman/5.0/en/repair-table.html MySQL manual] and this [http://moodle.org/mod/forum/discuss.php?d=58208#p279638 forum script]).
* '''Maintain the key distribution'''. Every month or so it is a good idea to stop the mysql server and run these myisamchk commands.
#myisamchk -a -S /pathtomysql/data/moodledir/*.MYI
:'''Warning''': You must stop the mysql database process (mysqld) before running any myisamchk command. If you do not, you risk data loss.
* Reduce the number of '''temporary tables saved to disk'''. Check this with the created_tmp_disk_tables value. If this is relatively large (>5%) increase tmp_table_size until you see a reduction. Note that this will have an impact on RAM usage.

===PostgreSQL performance===

There are some good papers around on tuning PostgreSQL (like [http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server this one]), and Moodle's case does not seem to be different to the general case.

The first thing to recognise is that if you really need to worry about tuning you should be using a separate machine for the database server. If you are not using a separate machine then the answers to many performance questions are substantially muddied by the memory requirements of the rest of the application.

You should probably '''enable autovacuum''', unless you know what you are doing. Many e-learning sites have predictable periods of low use, so disabling autovacuum and running a specific vacuum at those times can be a good option. Or perhaps leave autovacuum running but do a full vacuum weekly in a quiet period.

Set '''shared_buffers''' to something reasonable. For versions up to 8.1 my testing has shown that peak performance is almost always obtained with buffers < 10000, so if you are using such a version, and have more than 512M of RAM just set shared_buffers to 10,000 (8MB).

The buffer management had a big overhaul in 8.2 and "reasonable" is now a much larger number. I have not conducted performance tests with 8.2, but the recommendations from others are generally that you should now scale shared_buffers much more with memory and may continue to reap benefits even up to values like 100,000 (80MB). Consider using 1-2% of system RAM.

PostgreSQL will also assume that the operating system is caching its files, so setting '''effective_cache_size''' to a reasonable value is also a good idea. A reasonable value will usually be (total RAM - RAM in use by programs). If you are running Linux and leave the system running for a day or two you can look at 'free' and under the 'cached' column you will see what it currently is. Consider taking that number (which is kB) and dividing it by 10 (i.e. allow 20% for other programs cache needs and then divide by 8 to get pages). If you are not using a dedicated database server you will need to decrease that value to account for usage by other programs.

Some other useful parameters that can have positive effects, and the values I would typically set them to on a machine with 4G RAM, are:

work_mem = 10240

That's 10M of RAM to use instead of on-disk sorting and so forth. That can give a big speed increase, but it is per connection and 200 connections * 10M is 2G, so it can theoretically chew up a lot of RAM.

maintenance_work_mem = 163840

That's 160M of RAM which will be used by (e.g.) VACUUM, index rebuild, cluster and so forth. This should only be used periodically and should be freed when those processes exit, so I believe it is well worth while.

wal_buffers = 64

These buffers are used for the write-ahead log, and there have been a number of reports on the PostgreSQL mailing lists of improvement from this level of increase.

This is a little out of date now (version 8.0) but still worth a read: http://www.powerpostgresql.com/Docs

And there is lots of good stuff here as well: http://www.varlena.com/GeneralBits/Tidbits/index.php

''Based on Andrew McMillan's post at [http://moodle.org/mod/forum/discuss.php?d=68558 Tuning PostgreSQL] forum thread.''

* Splitting '''mdl_log''' to several tables and using a VIEW with UNION to read them as one. (See Tim Hunt [https://moodle.org/mod/forum/discuss.php?d=243531#p1104165 explanation] on the Moodle forums)

===Other database performance links===
* Consider using a '''distributed cacheing system''' like [http://en.wikipedia.org/wiki/Memcached memcached] but note that memcached does not have any security features so it should be used behind a firewall.
* Consider using PostgreSQL. See [http://moodle.org/mod/forum/discuss.php?d=49195 how to migrate from MySQL to PostgreSQL] (forum discussion).
* [http://dev.mysql.com/doc/refman/5.0/en/server-parameters.html General advice on tuning MySQL parameters] (advice from the MySQL manual)
* [http://www.mysqlperformanceblog.com/2007/11/01/innodb-performance-optimization-basics/ InnoDB performance optimization] taken from the [http://www.mysqlperformanceblog.com/ MySQL performance blog] site.

==Performance of different Moodle modules==

Moodle's activity modules, filters, and other plugins can be activated/deactivated. If necessary, you may wish to deactivate some features (such as chat) if not required - but this isn't necessary. Some notes on the performance of certain modules:

* The '''Chat''' module is [http://moodle.org/mod/forum/discuss.php?d=37979&parent=175079 said] to be a hog in terms of frequent HTTP requests to the main server. This can be reduced by setting the module to use ''Streamed'' updates, or, if you're using a Unix-based webserver, by running the chat in daemon mode. When using the Chat module use the configuration settings to tune for your expected load. Pay particular attention to the ''chat_old_ping'' and ''chat_refresh'' parameters as these can have greatest impact on server load.
* The Moodle '''Cron''' task is triggered by calling the script ''cron.php''. If this is called over HTTP (e.g. using wget or curl) it can take a large amount of memory on large installations. If it is called by directly invoking the php command (e.g. ''php -f /path/to/moodle/directory/admin/cli/cron.php'') efficiency can be much improved.
* The '''Recent activities''' block is consuming too many resources if you have huge number of records <code>mdl_log</code>. This is being tested to optimize the SQL query.
* The '''Quiz''' module is known to stretch database performance. However, it has been getting better in recent versions, and we don't know of any good, up-to-date performance measurements. (Here is a [http://moodle.org/mod/forum/discuss.php?d=68579 case study from 2007 with 300 quiz users].). The following suggestions were described by [https://moodle.org/user/view.php?id=94615&course=5 Al Rachels] in [https://moodle.org/mod/forum/discuss.php?d=347126 this forum thread]:
** make sure both Moodle, and the operating system, are installed on a [https://en.wikipedia.org/wiki/Solid-state_drive solid state drive]
** upgrade to and use [https://docs.moodle.org/dev/Moodle_and_PHP7 PHP 7]
** run MySQLTuner and implement its recommendations

See [[Performance settings]] for more information on performance-related Moodle settings.

==See also==

*Using Moodle: [http://moodle.org/mod/forum/view.php?f=94 Hardware and Performance] forum
*[http://opensourceelearning.blogspot.be/2012/10/why-your-moodle-site-is-slow-five.html Why Your Moodle Site is Slow: Five Simple Settings] blog post from Jonathan Moore
*I teach with Moodle perfomance testing: http://www.iteachwithmoodle.com/2012/11/17/moodle-2-4-beta-performance-test-comparison-with-moodle-2-3/
*[http://jfilip.ca/2013/08/20/moodle-2-4-5-vs-2-5-1-performance-and-muc-apc-cache-store/ Moodle 2.4.5 vs 2.5.2 performance and MUC APC cahe store]
*[http://jfilip.ca/2013/09/25/moodle-performance-testing-2-4-6-vs-2-5-2-vs-2-6dev/ Moodle performance testing 2.4.6 vs 2.5.2 vs 2.6dev]
*[http://jfilip.ca/2013/09/24/moodle-performance-analysis-revisted-now-with-mariadb/ Moodle performance analysis revisited (now with MariaDB)]
*[http://tjhunt.blogspot.ca/2013/05/performance-testing-moodle.html Tim Hunt's blog (May 2, 2013) on performance testing Moodle]
*[http://newrelic.com/ New Relic, Application Performance Monitoring]
*[http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html Performance enhacements for Apache and PHP (Apache Event MPM and PHP-FPM)]
*[https://scholarlms.net/performance-recommendations/ Performance recommendations]
*[https://enovation.ie/moodle-performance-investigation-using-performance-info/ Moodle performance investigation – using performance info ]

There have been a lot of discussions on moodle.org about performance, here are some of the more interesting and (potentially) useful ones:

* [http://moodle.org/mod/forum/discuss.php?d=83057 Performance woes!]
* [http://moodle.org/mod/forum/discuss.php?d=57028 Performance perspectives - a little script]
* [http://moodle.org/mod/forum/discuss.php?d=88927 Comments on planned server hardware]
* [http://moodle.org/mod/forum/discuss.php?d=102978#p461624 Moodle performance in a pil by Martin Langhoff]
* [https://moodle.org/mod/forum/discuss.php?d=240391#unread Advice on optimising php/db code in moodle2+]
* [https://moodle.org/mod/forum/discuss.php?d=243531 Moodle 2.5 performance testing at the OU]
* [https://moodle.org/mod/forum/discuss.php?d=273602 100 active users limit with 4vCPU]
* [https://moodle.org/mod/forum/discuss.php?d=336603#p1356423 Performance Tip ... shared...]

[[es:Recomendaciones sobre desempeño]]
[[fr:Recommandations_de_performance]]
[[ja:パフォーマンス]]
[[de:Geschwindigkeitsempfehlungen]]

PostgreSQL

2021-05-26T07:38:08Z

Tsala: /* See also */ removing out-of-date links

{{Installing Moodle}}
PostgreSQL is one of the five databases that is fully supported by Moodle. A database is a required component of any Moodle installation.

== Creating Moodle Database ==

These instructions assume that the database server and web server are on the same machine. If that is not the case you have some more work to do. See the PostgreSQL documentation for further details.

* Log into the PostgreSQL command line client. The exact form depends on how your PostgreSQL is configured but will be something like

$ psql -U postgres
Password for user postgres:

Enter the password for your 'postgres' user set during installation. After some preamble you should see the prompt ''postgres=#''.

* Create the user for the Moodle database and assign a password:

postgres=# CREATE USER moodleuser WITH PASSWORD 'yourpassword';

Provide a suitably strong password. Please note that the actual authentication method depends on your PostgreSQL server's pg_hba.conf file. Some authentication methods (like ident) do not require the password. See the 'Client Authentication' section below for further details.

* Create the database:

postgres=# CREATE DATABASE moodle WITH OWNER moodleuser;

== Character set and collation ==

If the PostgreSQL server's default collation does not suit your needs, you can provide explicit LC_CTYPE (character classification) and LC_COLLATE (string sort order) setting for your Moodle database. The following example creates new database called 'moodle' optimised for a Czech Moodle site:

postgres=# CREATE DATABASE moodle WITH OWNER moodleuser ENCODING 'UTF8' LC_COLLATE='cs_CZ.utf8' LC_CTYPE='cs_CZ.utf8' TEMPLATE=template0;

For more details refer to [http://www.postgresql.org/docs/9.1/static/multibyte.html Character Set Support] chapter in PostgreSQL manual.

To make sure the database was created correctly, use the ''\l'' at the psql console or execute ''psql -l'' shell command. You should get something like

postgres=# \l
List of databases
Name | Owner | Encoding | Collation | Ctype | Access privileges
-----------+------------+----------+-------------+-------------+-----------------------
moodle | moodleuser | UTF8 | cs_CZ.utf8 | cs_CZ.utf8 |
postgres | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
template0 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres
: postgres=CTc/postgres
template1 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres
: postgres=CTc/postgres

== Client Authentication ==

Client Authentication is how PostgreSQL decides which user accounts can connect to which databases from which hosts. PostgreSQL handles this in a very different way to MySQL, and this is a potential pitfall for system administrators who are used to MySQL and now find themselves setting up a PostgreSQL server.

If you've followed the instructions above, but find that Moodle just won't connect to your database and gives an 'Ident authentication failed' error, you should check your client authentication file.

In MySQL, access is controlled when user accounts are created or granted privileges on databases, by using the 'moodleuser'@'servername' syntax. PostgreSQL uses a client authentication file called 'pg_hba.conf' in PostgreSQL's 'data' folder. In this file, you'll find a list of which users are allowed to connect to which databases, the IP addresses they are allowed to connect from, and the authentication methods they can use to connect.

In the client authentication file, you'll find the following line (starting with a '#' sign), which tells you the order to add each piece of data. To grant permission for Moodle to connect to a PostgreSQL server on the same machine, just add the following line, changing the DATABASE and USER columns to your actual database name and the username you set up above. The METHOD field should say "password" - don't put your actual password here.

# TYPE DATABASE USER CIDR-ADDRESS METHOD
host moodle moodleuser 127.0.0.1/32 password

If your database lives on a separate server from your Moodle installation, you can change the IP address above to match. In this case, it is recommended to not use 'password' in the method field unless the connection between the two servers is secure, as 'password' sends the password in plain text. In these circumstances, you should consider changing METHOD to 'md5' instead.

Once the Client Authentication file has been changed, you will need to restart the PostgreSQL service.

== See also ==

* [http://www.postgresql.org PostgreSQL home page]
* [http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server Tuning Your PostgreSQL Server]
* [https://en.wikipedia.org/wiki/PostgreSQL PostgreSQL - Wikipedia]

[[Category:SQL databases]]

[[es:PostgreSQL]]
[[ja:PostgreSQL]]

Activity completion report

2021-05-21T09:38:37Z

Tsala: Category: Completion

{{Course reports}}
Activity completion info can be viewed by managers, teachers and non-editing teachers (and any other users with the capability [[Capabilities/report/progress:view|report/progress:view]]) by clicking the gear icon top right and selecting "More > Reports > Activity completion" (with the Boost theme) or from ''Course administration > Reports > Activity completion'' with non-Boost themes.

Teachers can mark activities complete on behalf of students by clicking into the relevant completion boxes. This requires the capability [[Capabilities/moodle/course:overridecompletion|Override activity completion status]] which is enabled for editing and non-editing teachers by default.

[[File:TAC.png]]

[[Category: Completion]]

[[es:Reporte de finalización de actividad]]

2021-05-21T09:38:03Z

Tsala: /* Tracking progress */ Activity completion report

<div class="navtrail">[[Main page]] ► [[{{PAGENAME}}]]</div>
==[[About Moodle]]==

*[[Features]]
*[[New features]]
*[[Philosophy]]
*[[Pedagogy]]
*[[Standards]]
*[[Accessibility]]
*[[History]]
*[[Usage]]
*[[Moodle site - basic structure]]
*[[Moodle key terms]]
*[[About Moodle FAQ]]

==[[Installation]]==

*[[Installing Moodle]]
*[[Installation Quickstart]]
*[[Cron]]
*[[Installing plugins]]
*[[Installation FAQ]]
*[[Upgrading]]
*[[Upgrade overview]]
*[[Automatic updates deployment]]
*[[Git for Administrators]]
*[[Administration via command line]]
*[[Upgrading FAQ]]
*[[Moodle migration]]

==[[Managing a Moodle site]]==

*[[Guide for new administrators]]
*[[Administration FAQ]]

====[[Authentication]]====
*[[Managing authentication]]
*[[Manual accounts]]
*[[No login]]
*[[Email-based self-registration]]
*[[CAS server (SSO)]]
*[[External database authentication]]
*[[LDAP authentication]]
*[[MNet]]
*[[No authentication]]
*[[Shibboleth]]
*[[Authentication FAQ]]

====[[Managing accounts]]====
* [[Browse list of users]]
* [[Bulk user actions]]
* [[Add a new user]]
* [[Upload users]]
* [[User pictures]]
* [[User profile fields]]
* [[Additional name fields]]
* [[Accounts FAQ]]

====[[Enrolments]]====
*[[Enrolment plugins|Managing enrolment plugins]]
*[[Manual enrolment]]
*[[Self enrolment]]
*[[Cohort sync]]
*[[Course meta link]]
*[[Guest access]]
*[[Category enrolments]]
*[[External database enrolment]]
*[[Enrolment on payment]]
*[[Flat file]]
*[[IMS Enterprise]]
*[[LDAP enrolment]]
*[[MNet remote enrolments]]
*[[Paypal enrolment]]
*[[Publish as LTI tool]]
*[[Enrolment FAQ]]

====[[Payment gateways]]====

====[[Roles and permissions]]====
*[[Managing roles]]
*[[Assign roles]]
*[[User policies]]
*[[Using roles]]
*[[Standard roles]]
**[[Site administrators|Site administrator]]
**[[Manager role]]
**[[Course creator role]]
**[[Teacher role]]
**[[Non-editing teacher role]]
**[[Student role]]
**[[Guest role]]
**[[Authenticated user role]]
*[[Creating custom roles]]
*[[Permissions]]
*[[Override permissions]]
*[[Roles FAQ]]

====[[Security]]====

*[[Security recommendations]]
*[[Security overview report]]
*[[Site policies]]
*[[Notifications]]
*[[Password salting]]
*[[Privacy]]
**[[Policies]]
**[[Data privacy]]
**[[Privacy officer role]]
*[[Reducing spam in Moodle|Reducing spam]]
*[[Security FAQ]]

====[[Performance]]====

*[[Performance recommendations]]
*[[Performance settings]]
*[[Performance overview]]
*[[Caching]]
*[[Performance FAQ]]
*[[MUC FAQ]]

====[[Backup]]====
*[[Site backup]]
*[[Course backup]]
*[[Course restore]]
*[[Automated course backup]]
*[[Year-end procedures]]
*[[IMS Common Cartridge import and export]]
*[[Backup and restore FAQ]]

====[[Site appearance]]====
*[[Front page]]
**[[Front page settings]]
**[[Front page FAQ]]
*[[Dashboard]]
*[[User profiles]]
*[[Navigation]]
*[[Course list]]
*[[Themes]]
**[[Theme settings]]
**[[Standard themes]]
**[[Installing a new theme]]
**[[Themes FAQ]]
*[[Header and footer]]

====[[Language]]====
*[[Language settings]]
*[[Language customisation]]
*[[Language packs]]
*[[Language FAQ]]

====[[Server settings]]====
*[[System paths]]
*[[Session handling]]
*[[HTTP]]
*[[Maintenance mode]]
*[[Cleanup]]
*[[Environment]]
*[[Site registration]]
*[[Mail configuration]]
*[[Scheduled tasks]]

====[[Site-wide reports]]====

*[[Config changes report]]
*[[Course overview report]]
*[[Events list report]]
*[[Question instances report]]
*[[Reports FAQ]]

====[[Admin tools]]====
*[[Migration from MyISAM to InnoDB|Convert to InnoDB]]
*[[Database transfer]]
*[[Search and replace tool|DB search and replace]]
*[[Reducing spam in Moodle|Spam cleaner]]
*[[Location|Timezones updater]]

====[[Developer tools]]====
*[[Experimental settings]]
*[[Debugging]]

====[[Web services]]====
*[[Using web services]]
*[[Mobile web services]]
*[[Web services FAQ]]

====[[More features]]====
*[[Blogs]]
**[[Blog settings]]
**[[Using Blogs]]
**[[Blogs FAQ]]
*[[Comments]]
**[[Comments FAQ]]
*[[Tags]]
**[[Tag settings]]
**[[Using tags]]
**[[Managing tags]]
**[[Tags FAQ]]
*[[Messaging]]
**[[Notifications]]
**[[Messaging settings]]
**[[Messaging FAQ]]
*[[Notes]]
**[[Notes FAQ]]
*[[RSS feeds]]
**[[RSS feeds settings]]
**[[Using RSS feeds]]
**[[RSS feeds FAQ]]
*[[Calendar]]
**[[Calendar settings]]
**[[Using Calendar]]
**[[Calendar import]]
**[[Calendar FAQ]]
*[[Global search]]
*[[Recycle bin]]

==[[Managing a Moodle course]]==

* [[Teacher quick guide]]

====[[Courses]]====
*[[Adding a new course]]
*[[Upload courses]]
*[[Course categories]]
*[[Course settings]]
*[[Course formats]]
*[[Course homepage]]
*[[Restrict access]]
**[[Restrict access settings]]
**[[Using restrict access]]
**[[Restrict access FAQ]]
*[[Stealth activities]]
*[[Course relative dates]]
*[[Course FAQ]]

====[[Editing text]]====
*[[Text editor]]
*[[Formatting text]]
*[[Text editor FAQ]]

====[[Activities]]====

*[[Managing activities]]
*[[Assignments]]
**[[Assignment settings]]
**[[Using Assignment]]
**[[Assignment FAQ]]
*[[Chat]]
**[[Chat settings]]
**[[Using Chat]]
**[[Chat FAQ]]
*[[Choice]]
**[[Choice settings]]
**[[Using Choice]]
**[[Choice FAQ]]
*[[Database]]
**[[Database settings]]
**[[Building Database]]
**[[Database templates]]
**[[Using Database]]
**[[Database FAQ]]
*[[External tool]]
**[[External tool settings]]
**[[Using External tool]]
**[[External tool FAQ]]
*[[Feedback]]
**[[Feedback settings]]
**[[Using Feedback]]
**[[Feedback FAQ]]
*[[Forum]]
**[[Forum settings]]
**[[Using Forum]]
**[[Forum FAQ]]
*[[Glossary]]
**[[Glossary settings]]
**[[Using Glossary]]
**[[Glossary FAQ]]
*[[Lesson]]
**[[Lesson settings]]
**[[Building Lesson]]
**[[Using Lesson]]
**[[Lesson FAQ]]
*[[SCORM]]
**[[SCORM settings]]
**[[Using SCORM]]
**[[SCORM FAQ]]
*[[Survey]]
**[[Survey settings]]
**[[Using Survey]]
**[[Survey FAQ]]
*[[Quiz]]
**[[Quiz settings]]
**[[Building Quiz]]
**[[Using Quiz]]
**[[Quiz reports]]
**[[Quiz FAQ]]
*[[Wiki]]
**[[Wiki settings]]
**[[Using Wiki]]
**[[Wiki FAQ]]
*[[Workshop]]
**[[Workshop settings]]
**[[Using Workshop]]
**[[Workshop FAQ]]

====[[Resources]]====

*[[Book module|Book]]
**[[Book settings]]
**[[Using Book]]
**[[Book FAQ]]
*[[File resource]]
**[[File resource settings]]
**[[File resource FAQ]]
*[[Folder]]
**[[Folder module settings]]
**[[Folder FAQ]]
*[[IMS content package]]
**[[IMS content package settings]]
**[[IMS content package FAQ]]
*[[Label]]
**[[Label module settings]]
**[[Using Label]]
**[[Label FAQ]]
*[[Page resource]]
**[[Page resource settings]]
**[[Using Page]]
**[[Page FAQ]]
*[[URL resource]]
**[[URL resource settings]]
**[[URL resource FAQ]]

====[[Blocks]]====

*[[Managing blocks]]
*[[Block settings]]
*[[Activities block]]
*[[Admin bookmarks block]]
*[[Administration block]]
*[[Blog menu block]]
*[[Blog tags block]]
*[[Calendar block]]
*[[Comments block]]
*[[Course completion status block]]
*[[Course overview block]]
*[[Course/site summary block]]
*[[Courses block]]
*[[Flickr block]]
*[[HTML block]]
*[[Latest news block]]
*[[Login block]]
*[[Logged in user block]]
*[[Main menu block]]
*[[Mentees block]]
*[[Messages block]]
*[[My latest badges block]]
*[[My private files block]]
*[[Navigation block]]
*[[Network servers block]]
*[[Online users block]]
*[[People block]]
*[[Quiz results block]]
*[[Random glossary entry block]]
*[[Recent activity block]]
*[[Recent blog entries block]]
*[[Remote RSS feeds block]]
*[[Search forums block]]
*[[Section links block]]
*[[Self completion block]]
*[[Social activities]]
*[[Tags block]]
*[[Upcoming events block]]
*[[Youtube block]]
*[[Blocks FAQ]]

====[[Questions]]====

*[[Managing questions]]
**[[Question bank]]
**[[Question categories]]
**[[Import questions]]
**[[Export questions]]
*[[Question behaviours]]
*[[Calculated question type|Calculated]]
*[[Simple calculated question type|Simple Calculated]]
*[[Calculated multichoice question type|Calculated Multichoice]]
*[[Description question type|Description]]
*[[Essay question type|Essay]]
*[[Matching question type|Matching]]
*[[Embedded Answers (Cloze) question type|Embedded Answers (Cloze)]]
*[[Multiple Choice question type|Multiple Choice]]
*[[Short-Answer question type|Short-Answer]]
*[[Numerical question type|Numerical]]
*[[True/False question type|True/False]]
*[[Questions FAQ]]

====[[Course enrolment]]====
*[[Participants]]
*[[Enrolment methods]]
*[[Enrolment key]]
*[[Unenrolment]]
*[[Other users]]

====[[Grouping users]]====
*[[Groups]]
*[[Import groups]]
*[[Groupings]]
*[[Cohorts]]
*[[Groups FAQ]]
*[[Groupings FAQ]]

====[[Tracking progress]]====
*[[Grades]]
**[[Grading quick guide]]
**[[Grader report]]
**[[Grade settings]]
**[[Managing grades]]
**[[Scales]]
**[[Outcomes]]
**[[Grade import]]
**[[Grade export]]
**[[Advanced grading methods]]
**[[Grades FAQ]]
*[[Competencies]]
** [[Competency frameworks]]
** [[Learning plans]]
** [[Competencies FAQ]]
*[[Activity completion]]
**[[Activity completion settings]]
**[[Using Activity completion]]
**[[Activity completion FAQ]]
*[[Course completion]]
**[[Course completion settings]]
**[[Using Course completion]]
**[[Course completion FAQ]]
*[[Badges]]
**[[Managing badges]]
**[[Badges settings]]
**[[Using badges]]
**[[Badges FAQ]]
*[[Course reports]]
** [[Activity completion report]]
** [[Competency breakdown report]]
** [[Logs]]
** [[Activity report]]
** [[Participation report]]
** [[Statistics]]
** [[Event monitoring]]

====[[Reusing activities]]====
*[[Activity backup]]
*[[Activity restore]]
*[[Import course data]]
*[[Reset course]]

==[[Managing content]]==

====[[Working with files]]====
*[[File picker]]
*[[File picker FAQ]]

====[[Repositories]]====
*[[Managing repositories]]
*[[Upload a file repository]]
*[[Server files repository]]
*[[Recent files repository]]
*[[Private files]]
*[[Google Drive repository]]
*[[Youtube videos repository]]
*[[Flickr public repository]]
*[[Flickr repository]]
*[[Picasa web album repository]]
*[[URL downloader repository]]
*[[Wikimedia repository]]
*[[Amazon S3 repository]]
*[[Box.net repository]]
*[[Dropbox repository]]
*[[File system repository]]
*[[Legacy course files]]
*[[Merlot.org repository]]
*[[Skydrive repository]]
*[[EQUELLA repository|EQUELLA]]
*[[WebDAV repository]]
*[[Repositories FAQ]]

====[[Portfolios]]====
*[[Managing portfolios]]
*[[Box.net portfolio]]
*[[File download]]
*[[Flickr]]
*[[Google Docs portfolio]]
*[[Picasa]]
*[[Mahara]]
*[[Portfolios FAQ]]

====[[Working with media]]====
*[[Video]]
*[[Audio]]
*[[Images]]
*[[Media embedding]]
*[[Media FAQ]]

====[[H5P]]====

====[[Data formats]]====

====[[Document converters]]====

* [[Universal Office Converter (unoconv)]]
* [[Google Drive converter]]

====[[Filters]]====
*[[Managing filters]]
*[[Filter settings]]
*[[Activity_names_auto-linking_filter|Activity names auto-linking]]
*[[Algebra filter|Algebra notation]]
*[[Convert URLs into links filter]]
*[[Database auto-linking filter]]
*[[Display emoticons as images filter]]
*[[Display H5P filter|Display H5P]]
*[[Email protection filter]]
*[[Glossary auto-linking filter]]
*[[HTML tidy filter]]
*[[MathJax filter]]
*[[Multimedia plugins filter]]
*[[Multi-language content filter]]
*[[TeX notation filter]]
*[[Word censorship filter]]
*[[Filters FAQ]]

====[[Licenses]]====

====[[Plagiarism prevention]]====
*[[Managing plagiarism prevention]]
*[[Plagiarism prevention FAQ]]

====[[Download course content]]====

==[[Moodle Mobile]]==
* [[Moodle Mobile features]]
* [[New for mobile]]
* [[Moodle Mobile guide for admins]]
* [[Mobile app notifications]]
* [[Creating Moodle Mobile friendly sites]]
* [[Moodle Mobile FAQ]]

[[es:Tabla_de_Contenidos]]
[[it:Tavola dei Contenuti]]

report/progress/index

2021-05-21T09:36:32Z

Tsala: redirect edit

#REDIRECT [[Activity completion report]]

[[es:report/progress/index]]

Template:Course reports

2021-05-21T09:35:48Z

Tsala: Activity completion report

<div class="navtrail">[[Main page]] ► [[Managing a Moodle course]] ► [[Tracking progress]] ► [[Course reports]] ► [[{{PAGENAME}}]]</div>
<div class="sideblock right" style="width: 12em;">
<div class="header">[[Course reports]]</div>
<div class="content">
* [[Activity completion report]]
* [[Competency breakdown report]]
* [[Logs]]
* [[Activity report]]
* [[Participation report]]
* [[Statistics]]
* [[Event monitoring]]
</div>
</div>

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

Activity completion report

2021-05-21T09:34:23Z

Tsala: content moved from Activity completion

Using Activity completion

2021-05-21T09:33:20Z

Tsala: Activity completion report info moved to Activity completion report

{{Activity completion}}
==Why use Activity completion?==
*If this feature is enabled, it is a helpful way for students to be able to track their progress in a course. The student has an easy to see checklist of what they have done so far.
*It can also be linked to [[Course_completion| Course completion]] in order to allow both students and teachers to watch progress through a course. As each activity is checked off as "complete", the student moves futher towards final completion of the course.
*It can also be linked to [[Conditional_activities| Restrict access]] in order to allow the teacher to set criteria upon which a student is allowed to progress through a course and access materials.
*It is possible to edit default activity completion settings within a course and to bulk update the settings for existing activities. See [[Activity completion]].

==Activity completion icons==

{|
| [[File:completion-manual-n.svg|16px|baseline]] manual - not yet marked as complete
|-
| [[File:completion-manual-enabled.svg|16px|baseline]] manual - enabled
|-
| [[File:completion-manual-y.svg|16px|baseline]] manually completed
|-
| [[File:completion-auto-y.svg|16px|baseline]] automatically completed
|-
| [[File:completion-auto-fail.svg|16px|baseline]] automatically failed
|-
| [[File:completion-auto-n.svg|16px|baseline]] automatic - not completed
|-
| [[File:completion-auto-pass.svg|16px|baseline]] automatically passed
|-
| [[File:completion-auto-enabled.svg|16px|baseline]] automatic - enabled
|}

The manual - enabled and automatic - enabled icons are used on the course page for teachers to see at a glance which activities have manual completion and which have automatic completion.

==See also==

* [[Activity completion report]]

[[de:Einsatzszenarien für den Aktivitätsabschluss]]
[[es:Usando finalización de actividad]]
[[fr:Rapport_achevement_activite]]

MoodleDocs:Overview

2021-05-19T06:06:32Z

Tsala: redirecting to latest version

#redirect [[:en:MoodleDocs:Overview]]

Awards

2021-05-19T06:05:46Z

Tsala: redirecting to latest version

#redirect [[:en:Awards]]

Creating SCORM Content

2021-05-19T05:27:36Z

Tsala: pointer to latest version

The up-to-date list of tools for creating SCORM content is available in the latest Moodle Docs wiki: [[:en:Creating SCORM Content|Creating SCORM Content]].

MediaWiki:Noarticletext

2021-05-19T05:26:10Z

Tsala: updated text pointing to the most recent version wiki

{{Main page}}
This page does not exist. You can [[:en:{{NAMESPACE}}:{{PAGENAME}}|check whether it exists in the documentation for the latest stable version of Moodle]] or [[Special:Search/{{PAGENAME}}|search for this page title]] in other pages.

You are also welcome to [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} create it] yourself :-)

==See also==

*[[MoodleDocs:Guidelines for contributors]]

MediaWiki:MoodleDocsVersionLinks

2021-05-14T14:47:14Z

Tsala: 3.11 link

3.10 docs: /310/en/{{FULLPAGENAMEE}}
3.11 docs: /311/en/{{FULLPAGENAMEE}}
3.9 docs: /39/en/{{FULLPAGENAMEE}}

Timeline block

2021-05-06T14:05:05Z

Tsala: rewording

{{Blocks}}
The Timeline block provides an overview of deadlines and is displayed by default on the [[Dashboard]]. Deadlines may be sorted by Overdue or Upcoming due dates (1) or by due dates per course (2).

[[File:docsTimelineblock.png|600px]]

==How to make activities and resources display in the Timeline block==

For activities
* Either set a deadline or
* Set an 'Expect completed on' date in the [[Activity completion settings|activity completion settings]]
* For teachers to see assignments which need grading, a 'Remind me to grade by' date must be entered in the assignment set up screen.
* Note 1: the dashboard will only display a maximum of 2 weeks in the past for 'Overdue' or 'Remind me to grade by' activities
* Note 2: students will not see activities on the dashboard unless they currently have access to view them in the course (ie. If an assignment is restricted to the view of a lesson, the assignment will not appear on the dashboard until the lesson has been viewed).

For resources
* Set an 'Expect completed on' date in the [[Activity completion settings|activity completion settings]]

[[es:Bloque Línea de tiempo]]
[[de:Zeitleiste]]

Upcoming events block

2021-05-06T13:56:53Z

Tsala: Calendar link

{{Blocks}}The '''Upcoming events''' block displays events from the [[Calendar]] in a summarised list.

[[File:34UB.png]]

*The number of days in advance and upcoming events to be displayed are determined in ''Site Administration > Appearance > Calendar''.
*Users can choose their own calendar display preferences from their Preferences page accessed from the user menu.
*There is also a link to go directly to the main calendar
*If you click on a date, you will go to the day-view calendar for that day. If the title of the event is a link, and you click on it, you will be taken to that event.

[[Category:Calendar]]

[[fr:Bloc Prochains événements]]
[[de:Aktuelle Termine]]
[[es:Bloque de eventos próximos]]

Scheduled tasks

2021-04-30T15:26:02Z

Tsala: /* Format for scheduling tasks */ Default: R meaning (thanks to David Mu)

{{Server settings}}
==Managing scheduled tasks==
An administrator can schedule routine tasks very precisely from ''Administration > Site administration > Server > Tasks > Scheduled tasks.''

Note that you still need to run the [[Cron|cron scripts]] (admin/cli/cron.php or https://yoursite/admin/cron.php) at regular intervals. It is recommended that the cron is run every minute.
{|
|-
|[[File:scheduledtasks1.png|thumb|Scheduled tasks]]
|[[File:scheduledtasks2.png|thumb|Editing a scheduled task]]
|}

Clicking the edit icon allows the administrator to specify the minute/hour/day/month or day of the week the task is to be run. It is also possible to reset the task to its default setting or disable it completely.

The column 'Next run' provides information on whether a plugin or a task is disabled (as well as the date that a task will next run).

==Format for scheduling tasks==

When typing into the fields, the format is the same as for Unix cron. Examples are as follows and are according to which field you are editing:

* is every minute, hour, day, month
*/2 is every two minutes, every two hours or every second day
2-10 is every minute between two and ten past the hour or every hour between 2 and 10 am
0 is every Sunday
1 is every Monday or every January
2,5 is the second and 5th of the month, or February and May, or Tuesday and Friday.

Default: R means that a random value is picked when saving changes. This helps to distribute tasks more equally instead of running too many of them on the hour, midnight etc.

==Fail delay==

If you're trying to debug a cron task, you may notice the Fail Delay becomes populated with a number. This is the time in seconds the cron will delay running the task. To sidestep this problem for development purposes, take a look at the Scheduled Tasks section here: [[Administration_via_command_line#Scheduled_tasks]].

==Running individual tasks==

To be able to run individual scheduled tasks via 'Run now' links on the scheduled tasks page, 'Allow 'Run now' for scheduled tasks' (tool_task | enablerunnow) in Site administration / Security / Site security settings should be enabled AND 'Path to PHP CLI' (pathtophp) in Site administration / Server / System paths should be set.

[[File:examplescheduledtasks.png]]

==Tasks running now==
{{New features}}
Currently running tasks may be viewed from Site administration > Server > Tasks >Tasks running now
[[File:TasksRunningNow.png|600px|center]]

==Launching a task from CLI==
You can also launch individual task from Command Line Interface (see [[Administration_via_command_line#Scheduled_tasks|Administration via command line]]).

[[es:Trabajos agendados]]
[[de:Geplante Vorgänge]]
[[fr:Tâches programmées]]

Moodle Workplace

2021-04-30T11:31:55Z

Tsala: pr_br and fr links

<div class="navtrail">[[Main page]] ► [[Moodle Workplace]]</div>
<div class="sideblock right" style="width: 16em;">
<div class="header">[[Moodle Workplace]]</div>
<div class="content">
* [[Programs]]
* [[Certifications]]
* [[Organisation structure]]
* [[Multi-tenancy]]
* [[Dynamic rules]]
* [[Report builder]]
* [[Certificates]]
* [[Appointments]]
* [[Migrations]]
* [[Upload users in Moodle Workplace]]
</div>
</div>
<p class="note">[[File:workplacelogo.png|24px]] '''Moodle Workplace''', available through [https://moodle.com/workplace/ Moodle Partners] only, helps you deliver effective corporate training and professional development, and share knowledge across your organisation.</p>

Moodle Workplace contains all the features of Moodle plus more:

== Major features ==

* [[Programs]], also known as Learning paths - Establish training paths for your employees grouping courses and content into programs.
* [[Certifications]], also known as Compliance Training - Create recurring certifications based on programs with a defined validity period that need to be retaken and keep your employee certifications up to date.
* [[Organisation structure]] - Adapt the software to your company structure defining roles and hierarchies that automatically create reporting lines. Assign management rights and security permissions to each role.
* [[Multi-tenancy]] - Multi-tenancy architecture allows you to give each of your divisions, departments or franchises their own full LMS platform with custom permissions so you can delegate the LMS management to the people actually doing the job.
* [[Dynamic rules]] - Save on your admin time by automating common processes such as enrolments, certification allocations, messaging and lots more with a set of ‘if this then that’ rules that you can define, template and save.
* [[Report builder]] - Save time by generating reports easily in a drag and drop interface with instant preview, filtering and aggregation of data from various sources, including the Workplace Datastore. Schedule reports to be sent automatically to different audiences.
* [[Certificates]] - Design, issue and verify digital certificates on completion of courses, programs and certifications.
* [[Appointments]] - Helps trainers to set up face-to-face appointments with students.
* [[Migrations|Migration]] - Offers the capacity to export different parts of a Moodle Workplace instance and import them into the same or a different site.

==Other features==

* [[Upload users in Moodle Workplace]] is enhanced to allow to upload to different tenants, allocate to programs and certifications and assign jobs.
* [[Workplace list course format]]

[[Category:Workplace]]

==Dashboard==
* [[Learner dashboard]]
* [[Manager dashboard]]

==See also==

* [[Moodle Workplace Installation]]
* [https://docs.moodle.org/dev/Moodle_Workplace_releases Moodle Workplace Releases]

[[fr:Moodle Workplace]]
[[pt-br:Moodle Workplace]]

[[Category:Workplace]]

MoodleDocs:Overview

2021-04-22T12:19:56Z

Tsala: 3.11 links

==English==
[https://docs.moodle.org/311/en/ 3.11 EN documentation]<br />
[https://docs.moodle.org/310/en/ 3.10 EN documentation]<br />
[https://docs.moodle.org/310/en/ 3.9 EN documentation]<br />
[https://docs.moodle.org/38/en/ 3.8 EN documentation]<br />
[https://docs.moodle.org/37/en/ 3.7 EN documentation]<br />
[https://docs.moodle.org/36/en/ 3.6 EN documentation]<br />
[https://docs.moodle.org/35/en/ 3.5 EN documentation]<br />
[https://docs.moodle.org/34/en/ 3.4 EN documentation]<br />
[https://docs.moodle.org/33/en/ 3.3 EN documentation]<br />
[https://docs.moodle.org/32/en/ 3.2 EN documentation]<br />
[https://docs.moodle.org/31/en/ 3.1 EN documentation]<br />

Also:<br />
[https://docs.moodle.org/dev/ Developer documentation]

==Català (Catalan)==

[https://docs.moodle.org/2x/ca/ 2.x CA documentation]<br />
[https://docs.moodle.org/19/ca/ 1.9 CA documentation]

==Deutsch (German)==
[https://docs.moodle.org/311/de/ 3.11 DE documentation]<br />
[https://docs.moodle.org/310/de/ 3.10 DE documentation]<br />
[https://docs.moodle.org/39/de/ 3.9 DE documentation]<br />
[https://docs.moodle.org/38/de/ 3.8 DE documentation]<br />
[https://docs.moodle.org/37/de/ 3.7 DE documentation]<br />
[https://docs.moodle.org/36/de/ 3.6 DE documentation]<br />
[https://docs.moodle.org/35/de/ 3.5 DE documentation]<br />
[https://docs.moodle.org/34/de/ 3.4 DE documentation]<br />
[https://docs.moodle.org/33/de/ 3.3 DE documentation]<br />
[https://docs.moodle.org/32/de/ 3.2 DE documentation]<br />
[https://docs.moodle.org/31/de/ 3.1 DE documentation]<br />

==Español (Spanish)==

[https://docs.moodle.org/all/es/ ES documentation]

==Euskara (Basque)==

[https://docs.moodle.org/all/eu/ EU documentation]

==Français (French)==

[https://docs.moodle.org/3x/fr/ 3.x FR documentation]<br />
[https://docs.moodle.org/2x/fr/ 2.x FR documentation]

==Hrvatski (Croatian)==

[https://docs.moodle.org/all/hr/ HR documentation]

==Íslenska (Icelandic)==

[https://docs.moodle.org/all/is/ IS documentation]

==Italiano (Italian)==

[https://docs.moodle.org/35/it/ 3.5 IT documentation]

==日本語 (Japanese)==

[https://docs.moodle.org/3x/ja/ 3.x JA documentation]<br />
[https://docs.moodle.org/2x/ja/ 2.x JA documentation]<br />

==Polski (Polish)==

[https://docs.moodle.org/2x/pl/ 2.x PL documentation]

==Português Brasileiro (Brazilan Portuguese)==

[https://docs.moodle.org/all/pt_br PT_BR documentation]

==Suomi (Finnish)==

[https://docs.moodle.org/3x/fi/ 3.x FI documentation]<br />
[https://docs.moodle.org/2x/fi/ 2.x FI documentation]

==中文 (Chinese)==

[https://docs.moodle.org/all/zh/ ZH documentation]

==See also==

* [[MoodleDocs:Read-only archives]]

Equation editor

2021-04-19T06:25:06Z

Tsala: redirect edit

#redirect [[Atto editor]]

[[es:Editor de ecuación]]

admin/setting/atto table settings

2021-04-19T06:24:50Z

Tsala: redirect edit

#Redirect [[Atto editor]]

[[es:admin/setting/atto table settings]]

admin/setting/atto collapse settings

2021-04-19T06:24:32Z

Tsala: redirect edit

#REDIRECT[[Atto editor]]

[[es:admin/setting/atto collapse settings]]

user/editor

2021-04-19T06:24:07Z

Tsala: redirect edit

#redirect [[Atto editor]]

[[es:user/editor]]

admin/setting/tinymcespellcheckersettings

2021-04-19T06:23:08Z

Tsala: redirect edit

#redirect [[TinyMCE editor]]

admin/setting/tinymcemoodleemoticonsettings

2021-04-19T06:22:46Z

Tsala: redirect edit

#Redirect[[TinyMCE editor]]

[[es:admin/setting/tinymcemoodleemoticonsettings]]

admin/setting/editorsettingsatto

2021-04-19T06:22:23Z

Tsala: redirect edit

#Redirect [[Atto editor]]

[[es:admin/setting/editorsettingsatto]]

admin/setting/atto equation settings

2021-04-19T06:20:45Z

Tsala: redirect edit

#Redirect [[Atto editor]]

[[es:admin/setting/atto equation settings]]

Spell engine

2021-04-19T06:20:11Z

Tsala: redirect edit

#redirect [[Atto editor]]

[[es:Motor de ortografía]]

HTML editor

2021-04-19T06:19:48Z

Tsala: redirect edit

#REDIRECT [[Atto editor]]

admin/setting/editorsettingstinymce

2021-04-19T06:19:20Z

Tsala: redirect edit

#redirect [[TinyMCE editor]]

admin/setting/manageeditors

2021-04-19T06:18:21Z

Tsala: redirect edit

#redirect [[Atto editor]]

Text editors

2021-04-19T06:16:23Z

Tsala: typo fix

#redirect [[Atto editor]]

Text editors

2021-04-19T06:16:09Z

Tsala: redirect edit

#redirect [[Attto editor]]

Questionnaire Personality test

2021-04-09T14:53:07Z

Tsala: current version replaced with 35 version

{{Questionnaire}}

==Overview==

===Definition===
A personality test is a tool that attempts to measure a person's social interaction skills and patterns of behavior. (US legal definition).

In the Moodle Questionnaire add-on, the "personality test" feature enables a questionnaire creator to attribute different "values" to the answers to certain types of questions. Those values can be added into scores - globally or in several "sections" - and relevant feedback messages based on those scores can be displayed to the respondent.

Given the particular nature of the "personality test" feature, great care should be exercised when using it in questionnaires.

===Organization===
The following question types can be used with the "personality test" feature: ''Radio buttons'', ''Dropdown Box'', ''Rate'' and ''Yes/No''. In order for the answers to those questions to be "scored", they ''must'' have a '''question name''', must be '''required''' and each of their choices must have a '''value'''. For the ''Yes/No'' question, the default values are 1 for a Yes answer and 0 for a No.

===Settings===
See the examples below.

==Global Feedback example==

Adapted from [https://jobmob.co.il/blog/dr-phil-human-resources-personality-test https://jobmob.co.il/blog/dr-phil-human-resources-personality-test]

===Questions===
*Create Q1 as a ''Radio Buttons'' (or Dropdown Box) question type
**'''Question Name''': ''feel your best''
**'''Response Required''': ''Yes''. We are giving question Q1 a '''name''' and setting it as '''Required''' because we plan to use it in the Personality test feedback.
**'''Question Text''': When do you feel your best?
**'''Possible answers''':
***2=In the morning
***4=During the afternoon and early evening
***6=Late at night
Each possible answer choice begins with a value ''immediately followed'' by the equal sign (=) ''immediately followed'' by the choice words(*). The values attributed to the various choices must be carefully considered in order to obtain a coherent "score" when they are added up in the feedback score calculation. Here we are using the values as given in the "personality fun test" of our example.

(*) '''No space''' before nor after the equal sign (=).

Continue to create all 10 questions in the sample questionnaire.

===Feedback===
Now go to the questionnaire's '''Feedback''' page (accessed from the tab or the settings menu).
In the Feedback options dropdown box, select the option you want - 'No feedback', 'Global feedback' or 'Feedback sections'.
You may use the ''Feedback notes'' field to enter text which will be displayed to your respondents at the end of their "Feedback report", e.g. external link to more information on the topic, etc.
Now click the '''Save settings and edit Feedback Sections''' button.
====Editing Questionnaire Feedback Sections====
On this page you can manage each feedback section you create. If you are using 'Global feedback' there will only be one section.
=====Sections=====
The top part of the page let's you select the section to manage and create new sections.
=====Section heading=====
* The ''Label'' text box should be kept as short as possible. It will be displayed in the Feedback report and - when the Chart feature is available in a later version of Questionnaire - will be used in the Charts.
* In the ''Heading'' field you may type a brief heading text. You may use 2 variables in this heading, $scorepercent and $oppositescorepercent. One example is: "You scored $scorepercent in this questionnaire."
=====Section questions=====
Here you can manage the questions assigned to this section. You can add and delete questions as well as assign the weight applied to this question in this section.
=====Section messages=====
This works exactly the same as the Moodle Quiz Score boundary system.
Here are a few examples, still taken from our sample Personality "Fun" test.
*Feedback Score boundary
**100%
**Feedback : Others see you as someone they should "handle with care" You're seen as vain, self-centered, and who is extremely dominant. Others may admire you, wishing they could be more like you, but don't always trust you, hesitating to become too deeply involved with you.

*Feedback Score boundary
**94%
**Feedback : Others see you as an exciting, highly volatile, rather impulsive personality; a natural leader, who's quick to make decisions, though not always the right ones. [etc.]

*Feedback Score boundary
**85%
etc.

This starts with 3 default boundaries and associated messages, but you may add more boundaries if needed.

When finished, click the '''Save changes''' button.

===Report===
This is how the Feedback report will look like to a respondent after taking our sample questionnaire.

[[File:03-12-2013 12-21-49.jpg]]

# This table shows the global score for respondent plus, if any, the average global score for all participants. If the questionnaire is set to "separate groups", this box may show the average global score for the group that the actual respondent belongs to.
# In the first box of the Feedback Report we see the Heading text, which may include the value of the $scorepercent variable.
# In the second box we see the "personalized" feedback message, relevant to the Feedback score boundaries that the actual respondent's score sits in.

On the View all Responses page, the Feedback report heading will be displayed, together with the average Global score for All participants. If the questionnaire is set to "visible" or "separate groups", the average global score for the current group will be displayed.

[[File:03-12-2013 13-42-07.jpg]]

==Several sections Feedback example==
A simplistic "health habits" questionnaire.
===Questions===
*Create Q1 as a ''Rate'' question type
**'''Question Name''': ''sports''
**'''Response Required''': ''Yes''.
**'''Question Text''': How often do you practise these sports?
**'''Possible answers''':
***0=never
***1=once a month
***2=every week
***3=every day
***cycling
***running
***swimming
***walking

*Create Q2 as a ''yes/no'' question type
**'''Question Name''': ''fruit and vegetables''
**'''Response Required''': ''Yes''.
**'''Question Text''': Do you regularly eat fresh fruit and vegetables?

*Create Q3 as a ''Radio buttons'' question type
**'''Question Name''': ''smoking''
**'''Response Required''': ''Yes''.
**'''Question Text''': How often do you smoke?
**'''Possible answers''':
***3=never
***2=less than one packet per month
***1=one packet per week
***0=one packet per day

*Create Q4 as a ''Radio buttons'' question type
**'''Question Name''': ''drinking''
**'''Response Required''': ''Yes''.
**'''Question Text''': How often do you drink alcohol?
**'''Possible answers''':
***3=never
***2=less than one glass per month
***1=one glass per week
***0=one glass per day

===Feedback===
Now go to the questionnaire's '''Feedback''' page.
====Feedback options====
Now that your questionnaire contains a number of questions which fill the requirements mentioned above for using the Personality test feature, the '''Feedback options''' section is available. In the Feedback options dropdown box, select 'Feedback sections'.
You may use the ''Feedback notes'' field to enter text which will be displayed to your respondents at the end of their "Feedback report", e.g. external link to more information on the topic, etc.

[[Image:feedbackoptions171211.png]]

Now click the '''Save settings and edit Feedback Sections''' button.

====Editing Questionnaire Feedback Sections====
On these pages you select and manage each feedback section. At the top of this page, you can select the section you wish to manage and create a new one.
[[Image:sectionselect.png]]

Below this, you can enter the label and heading to use for this section.

Below this is the section questions management. Here you can add, delete and assign weights to the questions for this section. You add a question by selecting it from the dropdown and clicking "Add question...". You delete a question by clicking the 'x' next to it. You assign a weight by choosing a value from the numeric selector next to the question.
By default, questions are not selected for any Feedback Section. You now have to select which question or questions you want assigned to this section for the feedback report.
You also have the ability to choose a smaller weight for a question's scores for the section. The fraction selected will be applied to the scores (individual and total) for that question in that section. That way a question can have a different impact on different sections. Note that selecting zero (0) is the same as selecting one (1).

Suppose you want Section 1 to be related to your respondents' practice of sport, you would put question 1 into section 1 (click check box 1 for that question). Now suppose you want your second section to be related to "healthy attitude" towards food, drinking and smoking. Navigate to that section and add the required questions.

[[Image:feedbacksections171211.png]]

Below the questions, you can manage the messages for the various boundaries in the section.
This works exactly the same as the Moodle Quiz Score boundary system.
Here are a few examples, taken from our sample "Healthy habits" questionnaire.
*Feedback Score boundary
**100%
**Feedback: You must be very fit. Congratulations!

*Feedback Score boundary
**66%
**Feedback: Your physical activity is only average. Come on!

*Feedback Score boundary
**33%
**Feedback: You seem to be a real couch potato. Make an effort!

When finished, click the '''Save changes''' button.

===Report===
This is how the Feedback report will look like to a respondent after taking our sample questionnaire.

[[File:03-12-2013 14-53-07.jpg]]

This report is similar to the Global Feedback report in our previous example, except that now the score is separated into 2 sections.

==Bipolar results==
Some "personality tests" aim at detecting a bipolar characteristic in respondents' character. For example, whether an individual's profile is rather visual or auditory, global or analytic, extrovert or introvert etc. See Julian Rotter's theory of [http://en.wikipedia.org/wiki/Julian_Rotter#Locus_of_control Locus of Control].

In such cases, you can enter the section labels as a set of 2 opposed (bipolar) concepts, separated by a pipe character.

[[File:03-12-2013 14-58-51.jpg]]

In a questionnaire based on the Locus of Control theory, this "bipolar" heading will give the following kind of report:

[[File:03-12-2013 15-13-09.jpg]]

==Chart display==

===Site settings===
Upon installing or updating the Questionnaire plugin, its "site settings" page is displayed. On that ''Site administration ► Plugins ► Activity modules ► Questionnaire'' page, an admin can choose to enable the Chart feature site-wide. The default is ''No'' (do not enable). The Questionnaire Chart feature currently uses the [http://www.rgraph.net/ RGraph] libraries, which are licensed under the MIT type of open source license.

===Chart types===
Navigate to the ''Feedback'' page.

You can choose to display or not the table of scores in the Feedback report.

The Chart type drop down list that is available is dependent on the number of feedback sections in your questionnaire.

* Global Feedback (i.e. one section only): Bipolar bars or Vertical Progress bar.
* 2 Sections: Bipolar bars or Horizontal bars or Rose.
* More than 2 sections: Bipolar bars or Horizontal bars or Radar or Rose.

Your choice of Chart type depends on the type of questions in your questionnaire. It's up to you to find out the most suitable Chart type. The Bipolar bars type is only suited when your feedback sections include Bipolar_results (see above).

The selected Chart will be displayed on the All Responses page. It will be constructed with all participants' results or, if the questionnaire is set to Visible Groups, with the results of the currently selected group.

On an Individual Responses page, the current user's current results Chart will be displayed, and also the All participants (or current group) results Chart.

Some samples illustrating the complete Chart types that can be used are displayed below.

Vertical Progress bar

[[File:02-01-2014 11-44-28.jpg]]

Bipolar bars

[[File:02-01-2014 11-40-05.jpg]]

Horizontal bars

[[File:02-01-2014 11-42-27.jpg]]

Radar

[[File:02-01-2014 11-37-47.jpg]]

Rose

[[File:02-01-2014 11-38-58.jpg]]

[[fr:Questionnaire_test_de_personnalité]]
[[es:Examen de personalidad de cuestionario]]

GIFT format

2021-03-29T07:09:27Z

Tsala: /* See also */ discussion link

{{Export questions}}
'''GIFT format''' allows someone to use a text editor to write multiple-choice, true-false, short answer, matching missing word and numerical questions in a simple format that can be imported. The GIFT format is also an export file format available in Question bank. The format has been developed within the Moodle Community but other software may support it to a greater or lesser degree.

*When creating a large numbers of questions, GIFT can provide a quick way of bulk loading questions either into a [[Question bank|question category]], or into a [[Adding_a_question_page#Importing_questions|Lesson]].
*Sometimes it is easier proofing questions in a question category by viewing them in a GIFT file.

== General instructions ==
At least one blank line must be left between each question.

In the simple form, the question comes first, then the answers are set in between brackets, with an equal sign (=) indicating the correct answer(s) and tilde (~) the wrong answers. A hash (#) will insert a response. Questions can be weighted by placing percentage signs (%..%) around the weight. Comments are preceded by double slashes (//) and are not imported.

Here are some useful [http://moodle.org/pluginfile.php/134/mod_forum/attachment/236161/GIFT-examples.zip GIFT examples] than can be imported or used as rough template. Many of the examples below used the questions in the file as a starting point.

=== UTF-8 encoding ===
Any GIFT file '''must''' be correctly encoded in [[UTF-8]]. You can use Microsoft's text editor Notepad which comes with Windows to save your file in UTF-8.

'''Note''': ANSI format will (only) work for languages without any special characters (like ä, ö, ü, æ, å, ø, œ or ß). And don't use "Unicode" as format as this is actually UTF-16 and won't work. See [[Converting files to UTF-8]] for further information.

===Format symbols===

Here are some common GIFT symbols and their use.

{|
! Symbols !! Use
|-
| // text || Comment until end of line (optional)
|-
| ::title:: || Question title (optional)
|-
| text || Question text (becomes title if no title specified)
|-
| [...format...] || The format of the following bit of text. Options are [html], [moodle], [plain] and [markdown]. The default is [moodle] for the question text, other parts of the question default to the format used for the question text.
|-
| { || Start answer(s) -- without any answers, text is a description of following questions
|-
| {T} or {F} || True or False answer; also {TRUE} and {FALSE}
|-
| { ... =right ... } || Correct answer for multiple choice, (multiple answer? -- see page comments) or fill-in-the-blank
|-
| { ... ~wrong ... } || Incorrect answer for multiple choice or multiple answer
|-
| { ... =item -> match ... } || Answer for matching questions
|-
| #feedback text || Answer feedback for preceding multiple, fill-in-the-blank, or numeric answers
|-
| ####general feedback || General feedback
|-
| {# || Start numeric answer(s)
|-
| answer:tolerance || Numeric answer accepted within ± tolerance range
|-
| low..high || Lower and upper range values of accepted numeric answer
|-
| =%n%answer:tolerance || n percent credit for one of multiple numeric ranges within tolerance from answer
|-
| } || End answer(s)
|-
| \character || Backslash escapes the special meaning of ~, =, #, {, }, and :
|-
| \n || Places a newline in question text -- blank lines delimit questions
|}

Here are some quick examples:

// true/false
::Q1:: 1+1=2 {T}

// multiple choice with specified feedback for right and wrong answers
::Q2:: What's between orange and green in the spectrum?
{ =yellow # right; good! ~red # wrong, it's yellow ~blue # wrong, it's yellow }

// fill-in-the-blank
::Q3:: Two plus {=two =2} equals four.

// matching
::Q4:: Which animal eats which food? { =cat -> cat food =dog -> dog food }

// math range question
::Q5:: What is a number from 1 to 5? {#3:2}

// math range specified with interval end points
::Q6:: What is a number from 1 to 5? {#1..5}
// translated on import to the same as Q5, but unavailable from Moodle question interface

// multiple numeric answers with partial credit and feedback
::Q7:: When was Ulysses S. Grant born? {#
=1822:0 # Correct! Full credit.
=%50%1822:2 # He was born in 1822. Half credit for being close.
}

// essay
::Q8:: How are you? {}

===Format symbols explained===
The multiple choice format below as a comment line // for the question, when Moodle exports it the question unique id number will appear here.

The first set of :: precedes the question title.

The second :: precedes the actual question. The first { indicates the start of the answers. The correct answer is preceded by an = sign and wrong answers by a ~. Teacher responses have a # in front of them. The question ends with a } and then a blank line. NOTE it is { } not ( ) parenthesis! Usually these are obtained with help of the [AltGr] key.

//Comment line
::Question title
:: Question {
=A correct answer
~Wrong answer1
#A response to wrong answer1
~Wrong answer2
#A response to wrong answer2
~Wrong answer3
#A response to wrong answer3
~Wrong answer4
#A response to wrong answer4
}

The shortest format for a multiple choice question is:
Question{= A Correct Answer ~Wrong answer1 ~Wrong answer2 ~Wrong answer3 ~Wrong answer4 }

:''Tip:'' If you don't specify a question title the WHOLE question will be used as the title at the time of import into Moodle. There are pros and cons to allowing this to happen.
** Cons: This can add a lot of unnecessary words. This can include characters which might confuse the export GIFT process.
** Pros: On the other hand. if the start of each question is different, it can make finding a single question easier in a category list of questions. It will save you typing. Having the same title for every question is a very bad idea.

==Question format examples==
There are several ways to use a text editor to write a GIFT format. We will try to show the simple version for example and in some formats we will introduce some more complex features that can be imported into many Moodle Question formats.

===Multiple choice===
For multiple choice questions, wrong answers are prefixed with a tilde (~) and the correct answer is prefixed with an equal sign (=).

Here is a simple acceptable GIFT multiple choice format:
Who's buried in Grant's tomb?{=Grant ~no one ~Napoleon ~Churchill ~Mother Teresa }

Here is a longer format that uses most of the GIFT elements:

// question: 1 name: Grants tomb
::Grants tomb::Who is buried in Grant's tomb in New York City? {
=Grant
~No one
#Was true for 12 years, but Grant's remains were buried in the tomb in 1897
~Napoleon
#He was buried in France
~Churchill
#He was buried in England
~Mother Teresa
#She was buried in India
}

===Multiple choice with multiple right answers===

That is, using checkboxes, not radio buttons:

What two people are entombed in Grant's tomb? {
~%-100%No one
~%50%Grant
~%50%Grant's wife
~%-100%Grant's father
}

===True-false===

In this question-type the answer indicates whether the statement is true or false. The answer should be written as {TRUE} or {FALSE}, or abbreviated to {T} or {F}.

// question: 0 name: TrueStatement using {T} style
::TrueStatement about Grant::Grant was buried in a tomb in New York City.{T}

// question: 0 name: FalseStatement using {FALSE} style
::FalseStatement about sun::The sun rises in the West.{FALSE}

===Short answer===

Answers in Short Answer question-type are all prefixed by an equal sign (=), indicating that they are all correct answers. The answers must not contain a tilde.

Here are two examples using the simple method showing possible right answers for credit.
Who's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}

Two plus two equals {=four =4}

If there is only one correct Short Answer, it may be written without the equal sign prefix, as long as it cannot be confused as True-False.

===Matching===
Matching pairs begin with an equal sign (=) and are separated by this symbol "->". There must be at least three matching pairs.

Match the following countries with their corresponding capitals. {
=Canada -> Ottawa
=Italy -> Rome
=Japan -> Tokyo
=India -> New Delhi
}

Matching questions do not support feedback or percentage answer weights.

===Missing word===
The Missing Word format automatically inserts a fill-in-the-blank line (like this _____) in the middle of the sentence. To use the Missing Word format, place the answers where you want the line to appear in the sentence.
Moodle costs {~lots of money =nothing ~a small amount} to download from moodle.org.

If the answers come before the closing punctuation mark, a fill-in-the-blank line will be inserted for the "missing word" format. All question types can be written in the Missing Word format.

There must be a blank line (double carriage return) separating questions. For clarity, the answers can be written on separate lines and even indented. Some examples:

Mahatma Gandhi's birthday is an Indian holiday on {
~15th
~3rd
=2nd
} of October.

Since {
~495 AD
=1066 AD
~1215 AD
~ 43 AD
}
the town of Hastings England has been "famous with visitors".

===Numerical questions===

The answer section for Numerical questions must start with a number sign (#). Numerical answers can include an error margin, which is written following the correct answer, separated by a colon. So for example, if the correct answer is anything between 1.5 and 2.5, then it would be written as follows {#2:0.5}. This indicates that 2 with an error margin of 0.5 is correct (i.e., the span from 1.5 to 2.5). If no error margin is specified, it will be assumed to be zero.

Here is a simple numerical format question. It will accept a range of 5 years.
When was Ulysses S. Grant born?{#1822:5}
It is a good idea to check the margins of the range, 3.141 is not counted as correct and 3.142 is considered in the range.
What is the value of pi (to 3 decimal places)? {#3.14159:0.0005}.

Optionally, numerical answers can be written as a span in the following format {#MinimumValue..MaximumValue}.

What is the value of pi (to 3 decimal places)? {#3.141..3.142}.

Moodle's browser interface does not support multiple numerical answers, but Moodle's code can and so does GIFT. This can be used to specify numerical multiple spans, and can be particularly usefully when combined with percentage weight grades. If multiple answers are used, they must be separated by an equal sign, like short answer questions.

When was Ulysses S. Grant born? {#
=1822:0
=%50%1822:2
}

Note that since Moodle's browser GUI didn't support multiple answers for Numerical questions, there's no way in older Moodle versions to see them or edit them through Moodle. The only way to change a numerical answer beyond the first, is to delete the question and re-import it (or use something like phpMyAdmin). But better would be to upgrade your Moodle to at least 1.9.

===Essay===
An essay question is simply a question with an empty answer field. Nothing is permitted between the curly braces at all.

Write a short biography of Dag Hammarskjöld. {}

===Description===
A description "question" has no answer part at all

You can use your pencil and paper for these next math questions.

==Options==

In addition to these basic question types, this filter offers the following options: line comments, question name, feedback and percentage answer weight.

===Line Comments===
Comments that will not be imported into Moodle can be included in the text file. This can be used to provide headers or more information about questions. All lines that start with a double backslash (not counting tabs or spaces) will be ignored by the filter.

// Subheading: Numerical questions below
What's 2 plus 2? {#4}

Comments will be exported from Moodle and will include the unique question id. The above question after it was imported and then exported from Moodle:
// question: 914 name: What's 2 plus 2?
::What's 2 plus 2?::What's 2 plus 2?{#
=4:0#
}

The question ID number and any question tags are exported and can be imported using the format:

// [id:123] [tag:basic] [tag:set 1]

===Question Name===
A question name can be specified by placing it first and enclosing it within double colons (::...::).

::Kanji Origins::Japanese characters originally
came from what country? {=China}

::Thanksgiving Date::The American holiday of Thanksgiving is
celebrated on the {~second ~third =fourth} Thursday of November.

If no question name is specified, the entire question will be used as the name by default.

===Feedback===
Feedback can be included for each answer by following the answer with a number sign (# also known as a hash mark) and the feedback.

What's the answer to this multiple-choice question? {
~wrong answer#feedback comment on the wrong answer
~another wrong answer#feedback comment on this wrong answer
=right answer#Very good!
}

//From The Hitchhiker's Guide to the Galaxy
Deep Thought said " {
=forty two#Correct according to The Hitchhiker's Guide to the Galaxy!
=42#Correct, as told to Loonquawl and Phouchg
=forty-two#Correct!
} is the Ultimate Answer to the Ultimate Question of Life, The Universe, and Everything."

42 is the Absolute Answer to everything.{
FALSE#42is the Ultimate Answer.#You gave the right answer.}

For Multiple Choice questions, feedback is displayed only for the answer the student selected. For short answer, feedback is shown only when students input the corresponding correct answer. For true-false questions, there can be one or two feedback strings. The first is shown if the student gives the wrong answer. The second if the student gives the right answer.

===Percentage Answer Weights===
Percentage answer weights are available for both Multiple Choice and Short Answer questions. Percentage answer weights can be included by following the tilde (for Multiple Choice) or equal sign (for Short Answer) with the desired percent enclosed within percent signs (e.g., %50%). This option can be combined with feedback comments.

Difficult question.{~wrong answer ~%50%half credit answer =full credit answer}

::Jesus' hometown::Jesus Christ was from {
~Jerusalem#This was an important city, but the wrong answer.
~%25%Bethlehem#He was born here, but not raised here.
~%50%Galilee#You need to be more specific.
=Nazareth#Yes! That's right!
}.

::Jesus' hometown:: Jesus Christ was from {
=Nazareth#Yes! That's right!
=%75%Nazereth#Right, but misspelled.
=%25%Bethlehem#He was born here, but not raised here.
}

Note that the last two examples are essentially the same question, first as multiple choice and then as short answer.

Note that it is possible to specify percentage answer weights that are NOT available through the browser interface. The Match Grades drop-down on the import page determines how these are handled. You can either request that an error be reported or that the answer weight be adjusted to the nearest valid answer weight.

Note specifically, that Moodle uses 5 decimal places to do its math, so if you wish to divide percentages in thirds, use %33.33333 instead of %33 or %33.33.

Specify text-formatting for the question
The question text (only) may have an optional text format specified. Currently the available formats are moodle (Moodle Auto-Format), html (HTML format), plain (Plain text format) and markdown (Markdown format). The format is specified in square brackets immediately before the question text. See [[Formatting text]] for further information.

[markdown]The *American holiday of Thanksgiving* is celebrated on the {
~second
~third
=fourth
} Thursday of November.

===Multiple Answers===
The Multiple Answers option is used for multiple choice questions when two or more answers must be selected in order to obtain full credit. The multiple answers option is enabled by assigning partial answer weight to multiple answers, while allowing no single answer to receive full credit.

What two people are entombed in Grant's tomb? {
~No one
~%50%Grant
~%50%Grant's wife
~Grant's father
}

Note that there is no equal sign (=) in any answer and the answers should total no more than 100%, otherwise Moodle will return an error. To avoid the problem of students automatically getting 100% by simply checking all of the answers, it is best to include negative answer weights for wrong answers.

What two people are entombed in Grant's tomb? {
~%-50%No one
~%50%Grant
~%50%Grant's wife
~%-50%Grant's father
}

===Special Characters ~ = # { }===
These symbols ~ = # { } : control the operation of this filter and cannot be used as normal text within questions. Since these symbols have a special role in determining the operation of this filter, they are called "control characters." But sometimes you may want to use one of these characters, for example to show a mathematical formula in a question. The way to get around this problem is "escaping" the control characters. This means simply putting a backslash (\) before a control character so the filter will know that you want to use it as a literal character instead of as a control character. For example:

Which answer equals 5? {
~ \= 2 + 2
= \= 2 + 3
~ \= 2 + 4
}

::GIFT Control Characters::
Which of the following is NOT a control character for the GIFT import format? {
~ \~ # \~ is a control character.
~ \= # \= is a control character.
~ \# # \# is a control character.
~ \{ # \{ is a control character.
~ \} # \} is a control character.
= \ # Correct! \ (backslash) is not a control character. BUT,
it is used to escape the control characters.
}

When the question is processed, the backslash is removed and is not saved in Moodle.

===HTML in answers===
The GIFT format will interpret HTML correctly if you add [html] in front of the question. See [https://moodle.org/mod/forum/discuss.php?d=334375 this forum thread].

===Specifying Categories===

It is possible to change the category into which the questions are added within the GIFT file. You can change the category as many times as you wish within the file. All questions after the modifier up to the next modifier or the end of the file will be added to the specified category. Up to the first category modifier the category specified on the import screen will be used. Note that for this to work the from file: box must be ticked on the import screen.

To include a category modifier include a line like this (with a blank line before and after):

$CATEGORY: tom/dick/harry

or simply

$CATEGORY: mycategory

...the first example specifies a path of nested categories. In this case the questions will go into harry. The categories are created if they do not exist.

To find out how your categories are organized, you might try exporting some questions including category data first and check the exported GIFT formatted file. The lowest level of system context might give you something like $CATEGORY: $system$/....

===Making questions case sensitive===
Short Answer questions can be made case sensitive by changing "0" to "1" in the following line '''of your moodle/question/format/gift/format.php file''':
$question->usecase = 0; // Ignore case

==Hints and Tips==
* Use the ::title:: at the beginning of every question to organize your questions when Moodle presents a list or exports them as another GIFT file. When the title is left blank, Moodle will put the beginning of the question as the title. Some teachers want to see something like "001 LIT101 Poe ref Purloin Letter" or "The Purloin Letter was written by (AmLit pg 254)" in the title.

* You can specify markup if you need to format the question by setting [html], [moodle], [plain] or [markdown] just before the question text. See more about this in the reference pdf below.
* In the Lesson module, in a question page, correct answers jump by default to Next page and incorrect answers jump to This page (i.e. student has to "try again"). When importing from a GIFT format file, this is exactly the mechanism which is used.
* If you want a student to be taken directly from one question to the next irrespective of their answer being correct or incorrect: in the Lesson Settings, set Maximum number of attempts: to 1.
**Please note, however, that a message "correct / incorrect" will still be displayed to the student upon answering each question. If you do not want this (default) feedback message to be displayed then enter your own feedback message (i.e. "continue", "---", etc.)
**In case you want no visible message displayed then enter a non-breaking space as feedback. Moodle will not put it's automatic response because it sees the blank space. To do this, put a # after the answer and write [[Image:Nbsp.png]] (without spaces between these characters).
* Need to use a special GIFT character in your question or answer? Put a \ in front of the GIFT character.
**For example if you want to use curly braces, { or }, or equal sign, =, or # or ~ in a GIFT file (in a math question including TeX expressions) you must "escape" them by preceding them with a \ directly in front of each { or } or =. It is possible to use a replace program/macro/editor filter to do this conversion before importing to Moodle.
* Want to change T/F type questions to multiple choice? Consider exporting the T/F questions as a GIFT file, then using a text editor to replace the (T) with (=True ~False). Perhaps change the title slightly so you will recognize the new questions.
* Alphabetic case-sensitive comparison is disabled by default. If you need case-sensitive comparison for short answer questions (an unusual need), precede them with:
$question->usecase = 1;
surrounded by blank lines.

==Tools that create or process GIFTs==
Several contributors have used macros to generate GIFT files from a more familiar popular programs.
*Here is a [http://hbwubecc.wixsite.com/jordan/tools Moodle Cloze and Gift generator] as presented at the 2017 Moodle Moot Japan.
* There are Word macros available for easily creating GIFT files.
** See [https://moodle.org/mod/forum/discuss.php?d=135112 this forum thread] for old links to downloadable files for different Word versions.
** See [https://github.com/juacas/MoodleQUIZ_template_UVa this GitHub page] for an improved new (2020) Word template for generating GIFT questions.
* There are several Excel spreadsheets for generating GIFT files. Several people have built upon other contributors work.
**The latest version was posted on 10 April 2007 and can be found in this thread with this file name: [http://moodle.org/mod/forum/discuss.php?d=66660 Excel2GIFTv1.1.zip by Timothy Takemoto]. There is also a set of instructions Excel2GIFTv1.1_Instructions.rtf by Jeff Shek on the same day in that thread.
** [http://video.google.com/videoplay?docid=-6612645502883459334# video tutorial] for using Excel2GIFTv2.xls
**An earlier version of this Excel spreadsheet for generating multiple choice GIFT files [http://moodle.org/mod/forum/discuss.php?d=45245 initially created by Olga Forlani and improved by A. T. Wyatt].
*There is a project, Libre Office templates, for generating GIFT files in Writer. It is located in
[https://code.google.com/p/libre-gift/downloads/list OOo template 2013 to write exams and convert to GIFT format]
*There are Open Office templates for generating GIFT files in Writer. These are located in the Quiz forum in the [http://moodle.org/mod/forum/discuss.php?d=20705&parent=168385 OOo template to write exams and convert to GIFT format thread].
**The most recent for OO 2.x is "OOo2GIFT_Template_05.zip" posted 17 December 2005 by Enrique Castro.
**An earlier version is "GIFT_template_OOo.zip" posted 22 March 2005 by Enrique Castro.
*There is an easy to use on line multiple question generator at [http://a4esl.org/c/qw.html a4esl.org]. Here you write your question(s) without formating marks, select Moodle and press the generate quiz button. This creates GIFT formatted text that can be pasted into a file for importing into Moodle.
**The initial format requires fewer keystrokes (it uses line position and returns) than the GIFT format, so you should save time and be less likely to create invalid data.
** Quiz authoring template for Microsoft Word [http://moodle.org/mod/data/view.php?d=13&rid=578 link]
** Moodle XML Converter [http://vletools.com]
** GIFT format parser library in Ruby [http://github.com/stuart/gift-parser]

* GIFT grammar using PEG.js (JavaScript) that parses GIFT into JavaScript objects [https://github.com/fuhrmanator/GIFT-grammar-PEG.js]
** Online GIFT question validator (editor) based on the PEG.js grammar above [https://fuhrmanator.github.io/GIFT-grammar-PEG.js/docs/editor/]

* [https://github.com/manuvazquez/gift-wrapper gift-wrapper] is a Python package to generate GIFT-formatted questions in a more user-friendly way
* [https://github.com/manuvazquez/py2gift py2gift] is a python library intended to write GIFT files (primarily) from [https://jupyter.org/ jupyter] notebooks

* If you are using Vim editor to prepare GIFT formatted questions, Vim syntax highlighting files and Vim SnipMate question snippets are available on this [http://selimtemizer.com/software/gift website].
*[http://selimtemizer.com/software/gift GIFT Escaper] is a free and practical tool for automatically and properly escaping GIFT control characters inside regular question/answer texts and/or LaTeX equations.

==GIFT format with medias (images, sound...)==
The [https://moodle.org/plugins/pluginversions.php?plugin=qformat_giftmedia GIFT with medias optional plugin] is an import format similar to Gift and uses the same syntax, but instead of a text file it imports a zip file containing the gift text file and media files (images, sounds, ...). A [[Gift_with_medias_format|documentation]] explain how to include medias in your questions.

==See also==

* Here is a 2-column PDF [http://buypct.com/gift_reference.pdf GIFT Reference Sheet]
*[[Import and export FAQ]]
*[[Aiken Format]]
* [https://moodle.org/mod/forum/discuss.php?d=420229 The latest GIFT tools I use] forum discussion

==External links==

*[http://text2gift.atwebpages.com/Text2GiftConverter.html On line Gift format generator from plain text]

[[de:GIFT]]
[[es:Formato GIFT]]
[[fr:Format GIFT]]
[[ja:GIFTフォーマット]]

Course overview

2021-03-26T12:12:07Z

Tsala: /* How to make the percentages display on the Course overview */ MDL-67890, MDL-60912

{{Blocks}}
==The course overview block==

{{MediaPlayer | url = https://youtu.be/oX18jf9prBM | desc = New in Moodle 3.8}}

The course overview block enables students to check their course progress. To get started, watch the [https://youtu.be/SKtUHEUMjWA Course overview improvements screencast].

Note for sites upgrading from earlier versions: The course overview block in previous versions of Moodle has been removed and replaced with a new course overview. The [[Course overview (legacy)|legacy course overview block]] may be downloaded from the Plugins directory: [https://moodle.org/plugins/block_course_overview Blocks: Course overview (legacy)].

==What enrolled users see==

*The course overview is displayed on a student's dashboard and displays three dropdowns:
*an option to sort by all, current, future, in progress, starred or hidden courses
*an option to display courses by last accessed or by title
*an option to display course by cards, summary or list view

'''Note:''' The timeline tab, available in pre-3.6 versions is now a separate [[Timeline block]].

===Past, In Progress and Future courses===
*For courses to appear in the 'Past' section, the course end date must be in the past or the course must be completed. If course completion is turned on in the course settings, the course will not appear in the 'Past' section until course completion conditions are met even if the course end date is in the past.
*For courses to appear in the 'In Progress' section, they must be not yet completed and the current date must be after the course start date. The current date must be before the end date, or there is no end date. Courses 'In progress 'displayed in the Course overview block match the courses displayed in the navigation drawer, although a site administration navigation setting can limit this number.
*For courses to appear in the 'Future' section, the student must be enrolled in them even though the course start date is in the future.
===Starred and hidden courses===

[[File:docsStarHide.png]]

*To 'star' ('bookmark') a course click the three dots by its name and then click the star icon.
*To hide a course, click the three dots by its name and then click the hide icon.
*Courses may be filtered by starred or hidden courses. Alternatively,for starred courses. the [[Starred courses block]] may be added to the dashboard

==How to make the percentages display on the Course overview==

For the percentages to display, the course must have [[Activity completion]] enabled.

[[File:completionpercentage.png]]

Note that the percentages relate only to the percentage of activities with activity completion set that have been completed. The percentages do NOT relate to course completion (MDL-67890).

The percentage calculation uses the total number of activities with activity completion set, regardless of whether they are hidden or have an access restriction (MDL-60912). The only way to make the percentage reflect work assigned to date would be to not set activity completion for activities which are hidden or have an access restriction.

==How to customise the Course overview layout==

Administrators can specify which layouts (card/list/summary) are available to users from ''Site administration / Plugins / Course overview block.''
==How to customise the course filter==

*Administrators can specify which courses may be filtered from ''Site administration / Plugins / Course overview block.''
*This now includes the option to filter by Course custom fields, as long as at least one course custom field is in use. Note that the course custom field must have its visibility field set to 'Everyone'.

==How to change the colours on the Course overview==
Administrators can specify colours of the course cards from Site administration / Appearance / Course pattern colours

==Displaying course categories==

Course categories may be displayed along with courses from an admin setting in Site admin / Plugins / Blocks / Course overview / Display course categories.

==Capabilities==

There is just one capability for this block:

* [[Capabilities/block/myoverview:myaddinstance|Add a new course overview block to Dashboard]]

==See also==

* For the documentation related to the previous version of the block, please refer to [[Course overview (legacy)]]
* MDL-60912 - Percentage complete in course overview on Dashboard should consider hidden or blocked activities

[[es:Vista general del curso]]
[[de:Kursübersicht-Block]]

MoodleDocs - User contributions [en]

Upgrading

Upgrading

MediaWiki:Helplogin-url

New features

MediaWiki:Helplogin-url

Main page

MediaWiki:Sidebar

File:linkedin scopes defined.png

File:linkedin auth page.png

File:linkedin added products.png

File:linkedin products prior selection.png

File:linkedin app creation.png

OAuth 2 LinkedIn service

Talk:Arguments in favour of PostgreSQL

Arguments in favour of PostgreSQL

Performance recommendations

PostgreSQL

Activity completion report

Table of Contents

report/progress/index

Template:Course reports

Activity completion report

Using Activity completion

MoodleDocs:Overview

Awards

Creating SCORM Content

MediaWiki:Noarticletext

MediaWiki:MoodleDocsVersionLinks

Timeline block

Upcoming events block

Scheduled tasks

Moodle Workplace

MoodleDocs:Overview

Equation editor

admin/setting/atto table settings

admin/setting/atto collapse settings

user/editor

admin/setting/tinymcespellcheckersettings

admin/setting/tinymcemoodleemoticonsettings

admin/setting/editorsettingsatto

admin/setting/atto equation settings

Spell engine

HTML editor

admin/setting/editorsettingstinymce

admin/setting/manageeditors

Text editors

Text editors

Questionnaire Personality test

GIFT format

Course overview