MoodleDocs - User contributions [en]

Upgrading

2021-09-17T10:08:57Z

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}}==

===Course overview improvements===

New course overview settings enable an admin to

* reduce the currently available layouts (Card, List and Summary)
* specify which filter options are available, including providing a custom filter which uses course custom field values

===Course request changes===

The capabilities moodle/course:request and moodle/site:approvecourse may now be applied in the category context.

===Removed functionality===

* The Community finder block and course-sharing functionality have been removed as part of the preparations for the new MoodleNet open social media platform.
* The People block has been removed because there is a Participants link in the navigation drawer (Boost theme) and in the navigation block (Classic theme).

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.9%22)%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%20in%20(%223.9%22)%20AND%20labels%20%3D%20ui_change%20 ui_change-labelled issues].

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

'''Forum'''

* forumreport/summary:view
* forumreport/summary:viewall
* mod/forum:exportforum
* mod/forum:grade

'''H5P'''

* atto/h5p:addembed
* moodle/h5p:deploy
* moodle/h5p:setdisplayoptions
* moodle/h5p:updatelibraries

=== Moodle 3.5, 3.6, 3.7 and 3.8 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]

==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]]

EQUELLA repository

2021-08-11T14:09:45Z

Tsala: /* See also */ removing broken links

{{Repositories}}
The EQUELLA repository enables users to make aliases (shortcuts) to EQUELLA files. Updating the files in EQUELLA will automatically cause them to update in Moodle. In addition to being able to search the EQUELLA repository, users also have the option to manage their repository and add new files.

{|
|[[File:equellarepository.png|thumb|600px]]
|}

==Requirements==

EQUELLA 5.2 QA2 or higher is required for this repository plug-in to work correctly.

==Setup==

Warning: This page may be outdated. See openEQUELLA's own documentation at https://openequella.github.io/guides/MoodleIntegrationGuide.html

===EQUELLA configuration===

A shared secret must be configured in EQUELLA that Moodle will use to authenticate access for users.
#Log in to your EQUELLA site as admin. Your URL might be for instance ''http:// equella.myequellainstitution.edu''
#Select 'Settings' and then 'Administration Console' (1 below) NOTE: You will need up to date Java for this to display.
#Select User Management. Highlight 'Shared Secret' and click 'Configure' at the bottom of the screen (2 below)
#A new name 'Default' will appear with configuration elements to the right (3 below)
#Add a name for the Unique identifier and a shared secret. Any secret will do, but a longer one with a mix of letters and numbers is best.
#Make a note of it to use when configuring Moodle. Add any extra details and save.

{|
|[[File:equellaadminconsole.png|thumb|1.Accessing the Admin console]]
|
|[[File:equallasharedsecretconfig.png|thumb|2.Configuring shared secret]]
|
[[File:equellasharedsecret2.png|thumb|3.Defining the shared secret]]
|}

For further information, please consult the [http://equella.github.io/guides/MoodleIntegrationGuide.html EQUELLA Moodle Configuration Guide].

===Moodle configuration===

The EQUELLA repository may be enabled by a site administrator in ''Administration > Site administration > Plugins > Repositories > Manage repositories.'' From there, an EQUELLA repository instance can be created.

{| class="wikitable"
|-
| EQUELLA URL
| The URL to your EQUELLA install with "/signon.do" appended. For example, "http:// equella.myinstitution.edu/logon.do" would become "http:// equella.myinstitution.edu/signon.do"
|-
| EQUELLA options
| This is an optional advanced setting that can be used to restrict users to a limited set of collections or advanced searches.
|-
| Restrict selection
| Choose if users should be restricted to only choosing attached resources, summary pages or no restriction.
|-
| Default role settings
| The shared secret ID and shared secret entered here should match those that have been setup in EQUELLA
|-
| {X} role settings
| Shared secrets configured under a specific role will take precedence over the default shared secret if a user has that role. The security ACLs in EQUELLA can then be configured to grant or revoke access to additional functionality based on the shared secret that the user was authenticated with.
|}

==Capabilities==

There is just one capability, [[Capabilities/repository/equella:view|View EQUELLA repository]], which is allowed for the default authenticated user role.

==See also==

*[http://www.equella.com/ EQUELLA]
*[http://www.prweb.com/releases/2012/6/prweb9642184.htm Pearson Announces Deeper Integration Between EQUELLA 5.2 Digital Repository and Moodle Learning Management System]

[[de:EQUELLA Repository]]
[[fr:EQUELLA]]

Upgrading

2021-08-05T09:37:30Z

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}}==

===Course overview improvements===

New course overview settings enable an admin to

* reduce the currently available layouts (Card, List and Summary)
* specify which filter options are available, including providing a custom filter which uses course custom field values

===Course request changes===

The capabilities moodle/course:request and moodle/site:approvecourse may now be applied in the category context.

===Removed functionality===

* The Community finder block and course-sharing functionality have been removed as part of the preparations for the new MoodleNet open social media platform.
* The People block has been removed because there is a Participants link in the navigation drawer (Boost theme) and in the navigation block (Classic theme).

See also the list of [https://tracker.moodle.org/issues/?jql=project%20%3D%20mdl%20AND%20resolution%20%3D%20fixed%20AND%20fixVersion%20in%20(%223.9%22)%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%20in%20(%223.9%22)%20AND%20labels%20%3D%20ui_change%20 ui_change-labelled issues].

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

'''Forum'''

* forumreport/summary:view
* forumreport/summary:viewall
* mod/forum:exportforum
* mod/forum:grade

'''H5P'''

* atto/h5p:addembed
* moodle/h5p:deploy
* moodle/h5p:setdisplayoptions
* moodle/h5p:updatelibraries

=== Moodle 3.5, 3.6, 3.7 and 3.8 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]

==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:23Z

Tsala: link edit

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

MediaWiki:Helplogin-url

2021-07-14T14:13:25Z

Tsala: changing URL

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

MediaWiki:Sidebar

2021-07-14T12:40:53Z

Tsala: Adding top menu

Main page

2021-07-14T12:39:56Z

Tsala: Replacing grid with BS4 Card decks

{{#addbodyclass:moodledocs-logo}}
<div class="navtrail">[https://docs.moodle.org/overview/ Docs overview] ► [[{{PAGENAME}}|Moodle Docs 3.9]]</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:首页]]

OAuth 2 LinkedIn service

2021-07-05T13:50:58Z

Tsala: requires 3.10 minimum (MDL-65637)

{{OAuth2}}
The OAuth 2 LinkedIn service no longer works in Moodle 3.9. Please upgrade to at least Moodle 3.10 to use it.

[[es:Servicio OAuth 2 Linkedln]]
[[de:OAuth2 LinkedIn Service]]

MediaWiki:MoodleDocsVersionLinks

2021-05-14T14:48:08Z

Tsala: 3.11 link

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

Multi-language content filter

2021-03-18T11:36:35Z

Tsala: /* Common problems */ removed statement about course short name, as it is possible to use the filter with the course short name

{{Filters}}
==Displaying text in multiple languages==
The multi-language content filter enables resources to be created in multiple languages. When turned on, it looks for <nowiki><span lang="xx" class="multilang"></nowiki> tags which indicate that a text contains multiple languages. Then it selects and outputs the text in the user's language (as set in their browser or in their preferences).

==Enabling the multi-language content filter==

An admin can enable the multi-language content filter as follows:

# Go to ''Site administration > Plugins > Filters > Manage filters'' and in the dropdown menu for multi-language content select 'On'.
# If headings are to be shown in multiple languages too, select 'Content and headings' in the 'Apply to' column. Note that this may affect site performance.

== How to use in a course ==

To use this feature first create your content in multiple languages (in the same resource). Then enclose each language block (aka multilang block) in the following tags:

<nowiki><span lang="XX" class="multilang">your_content_here</span>
<span lang="YY" class="multilang">your_content_in_other_language_here</span></nowiki>

It is essential to be in '''the code editing mode''' (press <nowiki>[<>]</nowiki> in the HTML editor), when you enter these tags for them to work. Only spaces, tabs and enters can be used between the individual languages in the multilang block.

Note: If your site uses a child language pack (see [[Language packs]] for the list), then the first span tag must be the parent language. Otherwise, when a user using the child language views the text, it will not be in the correct language for them (as reported in MDL-55197). For example, if your site uses en_us then the en span tag (as parent language) must be first i.e.

<nowiki><span lang="en" class="multilang">your_content_in English</span>
<span lang="de" class="multilang">your_content_in_German_here</span></nowiki>

==How to use for assignment submission agreements==

#With the filter enabled, go to ''Site administration > Plugins > Activity modules > Assignment > Assignment settings.
#In the submission statement, add (for example)

<nowiki><span lang="en" class="multilang">This assignment is my own work, except where I have acknowledged the use of the works of other people.</span>
<span lang="fr" class="multilang">Ce devoir est le fruit de mon travail personnel, sauf aux endroits où l'utilisation d'oeuvre d'autres auteurs est clairement indiquée.</span> </nowiki>

== How it works internally ==

# Filter first looks for ''multilang blocks'' in the text
# For each multilang block:
#* If there are texts in the currently active language, print them
#* Else, if there exists texts in the current parent language, print them
#* Else, print the first language found in the text
# Text outside of multilang blocks will be shown always

== Common problems ==

# The multi-lang filter is not enabled. It can be enabled in 'Manage filters' in the Site administration'.
# Headings aren't displaying correctly - the multi-lang filter should be set to apply to content and headings in 'Manage filters' in the Site administration'.
# Extra characters between language span tags - editor might add <nowiki><br /></nowiki> or other tags, please review the html in source view
# If the course setting is "force" some language, you won't be able to change the displayed language.
# Extra spaces in language span tag

==The 'Restriction by language' additional plugin==
[[File:Restriction by language.png|thumb|Restriction by language]]
Language filters are great, but sometimes they can make your resources and activities very complex.

The [https://moodle.org/plugins/view.php?plugin=availability_language Restriction by language availability condition] is an additional plugin that makes it easy to show an English resource only to English users and an activity in French only to French speaking students.

==The Multi-Language Content (v2) additional plugin and Multi-Language Content text editor plugins==
There is also an alternative multi-language content filter available called [https://moodle.org/plugins/filter_multilang2 Multi-language Content (v2)]. This filter uses very simple non-HTML tags to mark multi-language blocks (makes it easier to create multi-language content), and can be used together with the [https://moodle.org/plugins/atto_multilang2 Multi-Language Content Atto plugin] or the [https://github.com/iarenaza/moodle-tinymce_moodlelang2 Multi-Language Content TinyMCE plugin] to make it even easier to create multi-language content directly on the text editor without using the HTML view mode.

==The Multi-Lingual Content additional plugin==
[https://moodle.org/plugins/filter_multilangsecond This filter] is a more flexible version of multilang filter. One of three possible choices can be selected by the filter admin setting: HTML syntax, Non HTML syntax or Both. If the non html syntax is chosen language block looks like: {mlang en}English{mlang}{mlang bg}Bulgarian{mlang}. In case of Html syntax, language block is a sequence of identical html tags with lang="XX" attributes span or div or any other.

==Any questions?==

Please post in the [https://moodle.org/mod/forum/view.php?id=43 Languages forum] on moodle.org.

==See also==

*[[Language]]
*Custom menu items in [[Theme settings]]
*[https://moodle.org/mod/forum/discuss.php?d=320980 Translation of MOOC] forum discussion and solution
* [https://moodle.org/mod/forum/discuss.php?d=356318 language dropdown not displayed - Boots logon page] forum thread

[[Category:Language]]

[[de:Mehrsprachiger Inhalt]]
[[es:Filtro de contenido multi-idioma]]
[[fr:Contenu multilingue]]
[[ja:多言語シンタックス]]

Moodle Desktop

2021-02-04T14:42:20Z

Tsala: note about Moodle Desktop being discontinued

{{Mobile}}
<p class="note">Note: [https://moodle.org/mod/forum/discuss.php?d=413350 Moodle Desktop is to be discontinued]. It will no longer be actively developed from 1 May 2021.</p>
==What is Moodle Desktop?==
[[File:desktop course overview.png|thumb|Course overview in Moodle Desktop]]
Moodle Desktop is our solution to accessing your Moodle courses on desktop and/or Surface tablets.

With Moodle Desktop you can experience all these popular (and more) functionalities that are found in Moodle Mobile, on your desktop or surface tablets:
* View course activities and download materials offline
* Quickly find and contact other people in your courses or organisation
* Attempt quizzes, post in forums, play SCORM packages, edit wiki pages and more - on and offline
* Upload images, audio, videos and other files from your desktop or tablet
* View deadlines filtered by dates or course subjects
* Receive instant notifications for messages, forum posts, calendar events and deadlines
* Track your learning progress or grades
[[File:desktop assignment grading.png|thumb|Assignment grading in Moodle Desktop]]

==How do I get Moodle desktop?==

Go to [https://download.moodle.org/desktop/ Moodle downloads: Moodle Desktop].

==Using Moodle Desktop==

As for the Moodle Mobile app, Moodle Desktop will ONLY work with Moodle sites that have been set up to allow it. Site admins, please see the [[Moodle Mobile guide for admins]].

Teachers, for info on improving your courses for access via Moodle Desktop, please see [[Creating Moodle Mobile friendly courses]].

==How will Moodle Desktop get updated to the latest release?==

As with Moodle Mobile, the desktop version will be updated by Moodle HQ every two months.

==Why has Moodle released Moodle Desktop?==

Moodle Desktop is another step that Moodle is taking to make online learning more accessible - for students, educators and other users - who are utilising various operating systems and devices.

Feedback has shown that Moodle users in the K-12, higher education and workplace sectors would like the option of accessing their courses through desktops, laptops or tablets, which are the devices often provided by their institutions or organisations.”

Making Moodle Desktop available in Windows operating system is also important, as many of our users are also studying and learning in this environment.

==Where can I get support for Moodle Desktop?==

If you have any questions or feedback about Moodle Desktop, please join the discussions in the [https://moodle.org/mod/forum/view.php?id=7798 Moodle for mobile forum].

== See also ==

* [https://docs.moodle.org/dev/Moodle_Desktop_release_notes Moodle Desktop release notes]

[[es:Escritorio Moodle]]
[[de:Moodle Desktop]]

Atto

2021-02-04T13:55:18Z

Tsala: redirect edit

#Redirect [[Atto editor]]

Images

2021-02-04T13:51:44Z

Tsala: Copying and pasting an image (MDL-47750)

{{Working with media}}
Moodle allows teachers and students to upload and display images from a variety of sources via the image icon of the [[Atto editor]]. Course pages can be enhanced with images (or banners) in each section. Assignments can include images for extra clarification. Images attached to forum posts or quiz questions will appear embedded.

{{MediaPlayer | url = https://youtu.be/rehPpxl2Jh4 | desc = Adding images}}
Moodle accepts .jpg,.png,.svg and .gif formats.

==Uploading and displaying an image from your computer==

*''Note:'' It is a good idea to resize your image before uploading, rather than altering its dimensions online.
*With the editing turned on, go to where you want to display your image (e.g. in a course summary, label or page)
*Click the image icon as below

[[File:Imageicon.png]]

*Either enter the URL of an image which is already online or click 'Browse repositories' to access the File picker

[[File:uploadimageatto.png]]

*Click [[Upload a file]]. Browse for and upload your image. For more information, see [[File picker]]
*Either add a description of the image or tick/check the box 'Description not necessary'.
*Alter the size and alignment if needed and save the image

[[File:uploadedimageatto.png]]

===Editing an uploaded image===

*If you need to edit the image once it has been uploaded,you can double-click on the image from within the [[Text editor| Atto text editor]] and access the image properties window. ''Note it is much better to upload an image of the desired size rather than modifying it afterwards.''

==Dragging and dropping an image==

*Images may be dragged and dropped directly into a label onto the course page if you are using a supported browser (not IE 9, Safari 6 or below or earlier versions of Firefox) and 'media drag and drop" is enabled in ''Administration > Site administration > Plugins > Activity modules > Label'' and verify the box 'media drag and drop' setting is ticked.
*As you drag the image, a prompt box appears where you choose "add image to course page" rather than "create a file resource"
*See [[Using Label]] for full instructions how to do this.

==Copying and pasting an image==

In Moodle 3.9 onwards, images can be copied from anywhere and pasted into the [[Atto editor]]. For example, you can take a screenshot, copy it to your clipboard and then paste it into the Atto editor.

==Displaying an image already online==
*If you have images available elsewhere online, you can display them too without the need to upload to Moodle. ''Note:'' If the image is taken offline, it will be replaced by a red X on your course page. Also, so-called hot-linking [http://simple.wikipedia.org/wiki/Hot-linking] to images online if you don't own them yourself is not recommended.

===Method 1===
*Follow the instructions for Uploading and Displaying an image as above.
*Paste the URL of the image you have online into the ''Enter URL'' box.
*Add a description of the image or tick/check the box for no description

[[File:imageonlineatto.png]]
*Save the image.

===Method 2===
*It is possible to copy and paste an online image into the [[HTML|text editor]] in the same way that some students might copy and paste into a presentation. Care must be taken however that images pasted this way are not subject to copyright, and also that the image doesn't come with an unwanted hyperlink.

==Adding an image from image hosting sites like Flickr==
*It is possible to search and display an image from Flickr.
*For this, the [[Flickr public repository]] must be enabled by the administrator
*After clicking into Find or Upload an image, click on the Flickr repository to search for a suitable image.

[[File:Flickr.png]]

*The site administrator can also enable the [[Flickr repository|Flickr]] and [[Picasa web album repository|Picasa]] repositories for users to access images from their own accounts.

==Why is there no 'Browse repositories' option available?==

The filepicker and text editor in Moodle are affected if there are any Javascript errors in the page. So if you see any missing buttons etc. the first thing to check for is any errors in the Javascript console (F12 in Firefox or IE9+).

The second thing to mention is that some text areas in Moodle support uploading files and some do not. There are reasons why a particular area does or doesn't support files such as the ability to backup/restore or compatibility with other areas in Moodle such as the gradebook. If a text editor does not support file areas, you can still use images, but only by entering the URL to an image already hosted somewhere else on the internet.

[[de:Bilder]]
[[es:Imágenes]]
[[fr:Images]]

Talk:Text editor

2021-02-04T13:29:46Z

Tsala: Tsala moved page Talk:Text editor to Talk:Atto editor

#REDIRECT [[Talk:Atto editor]]

Talk:Atto editor

2021-02-04T13:29:46Z

Tsala: Tsala moved page Talk:Text editor to Talk:Atto editor

= Atto Editor discussion page =

==Atto colours==
The problem is that the colour schemes available are far too few. Page backgrounds, text colours and highlights should be the decisions of the authors, not the Developers. The text in the Doc:
"..."...user specified colours may conflict visually with the site colour... (T)he first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people."
is really tripe. I have no idea what colours someone else uses for their site, and I have no interest in it whatsoever, if I don't use the site, who cares? Only the people who do use it. So assertions that "visually unappealing combination of colours.." are just not warranted.
At the MoodlemootAU17, I actually spoke on this very issue, suggesting that people do need to be careful about the colours they use on their site. However, I did qualify that by stating at the outset there are three conditions for this to occur, 1, authors need '''be mindful of their audience''', 2, need be '''mindful of their environment''' and 3, don't impose what '''they think''' looks good on their site. In this Moodle Devs have ignored the first and last point concentrating on the second point.

I raise this issue as I have found there is a group of students in my classes, that are beset with Irlen Syndrome, a form of dyslexia. Their eyes are, as I understand it, overwhelmed by the luminosity of the documents they are reading. I found it difficult to replicate the background and foreground colours they really needed to use to be successful in Atto. I couldn't persist with it and switched to TinyMCE. Yes, I could add code to the page, but when on tight timelines, this becomes more problematic. Please do something about this. Or is this a Moodle Tracker issue? I understand there has already been a number of issues created in the tracker, but so far...

Text editor

2021-02-04T13:29:46Z

Tsala: Tsala moved page Text editor to Atto editor

#REDIRECT [[Atto editor]]

Atto editor

2021-02-04T13:29:45Z

Tsala: Tsala moved page Text editor to Atto editor

{{Editing text}}
==The Atto text editor==

The Atto text editor (sometimes referred to as the 'HTML editor') has many icons to assist the user in entering content. Many of these icons and functions should be familiar to anyone who uses a word processor.

Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.

The default text editor in Moodle is the Atto editor, built specifically for Moodle. There is also a [[TinyMCE editor]] and a plain text editor.

Text editors can be enabled, disabled or a different one set to default from ''Administration > Site administration > Plugins > Text editors > Manage editors''. The order of priority may also be specified here.

If more than one text editor is enabled, users can select their preferred editor via their preferences page in the user menu (top right).

{{MediaPlayer | url = https://youtu.be/GzOOWM8UdEc | desc = }}

==Atto features==

===Image copy and paste===
{{New features}}
Images can be copied from anywhere and pasted into the Atto editor. For example, you can take a screenshot, copy it to your clipboard and then paste it into the Atto editor.

===Image drag and drop===

If your browser allows it (and if it does, you will see a message at the top of your screen when the editing is on) you can add images into the Atto editor simply by dragging them from your computer:

[[File:Attodragdrop29.png|thumb|600px|center|Drag an image directly into the editor]]

===Autosave===

Text typed into the Atto editor is automatically saved if you leave the page. The default of 60 seconds may be changed by the administrator in ''Site administration>Plugins>Text editors>Atto HTML editor>Atto toolbar settings.'' If the user accidentally closes the tab or otherwise leaves the form without submitting, the text in the editor will be restored next time he opens the page. To discard a restored draft, the user needs to cancel the form or press the "Undo" button in the editor.
[[File:AtttoAutosave.png|thumb|600px|center]]

==Atto editor toolbar==

[[File:Attotopline1382.png]]

Atto Row 1 default buttons

{| class="nicetable"
|-
|-
| 1. Expand
| 2. Style
| 3. Bold
| 4. Italic
|-
| 5. Bulleted list
| 6. Numbered list
| 7. Add link
| 8. Unlink
|-
| 9. Add image
| 10. Add smiley (if enabled)
| 11. Add media
| 12. Record audio
|-
| 13. Record video
| 14. Manage embedded files
| 15. H5P

|}

[[File:Attobottomline.png]]

Atto Row 2 default buttons

{| class="nicetable"
|-
|-
| 1. Underline
| 2. Strikethrough
| 3. Subscript
| 4. Superscript
|-
| 5. Align left/centre/right
| 6. Decrease/increase indent
| 7. Equation editor
| 8. Special character
|-
| 9. Table
| 10. Clear formatting
| 11. Undo/redo
| 12. Accessibility checker
|-
| 13. Screenreader helper
| 14. HTML/code view
|
|}

===Manage embedded files===
This allows users to add, delete or override files embedded in the current text area, for example in a label or topic summary. (It complements the [[Embedded files repository]])

[[File:26embeddefiles2.png|thumb|400px|center]]

===Accessibility checker===

One of the tools available in the text editor is an automated [[Accessibility|accessibility]] checker which checks for some common errors in the text. These are usually things in the way the text is constructed that can prevent all users from having equal access to information and functionality. The list of problems that the accessibility checker looks for is:

* Images with missing or empty alt text (unless they have the presentation role)
* Contrast of font colour and background colour meets [https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines WCAG AA guidelines]
* Long blocks of text are sufficiently broken up into headings
* All tables require captions
* Tables should not contain merged cells as they are difficult to navigate with screen readers
* All tables should contain row or column headers

===Screenreader helper===

Screen readers basically treat a content editable region like a text box - which is wrong, because it can contain images, links and more.

The screen reader helper provides additional information about the currently selected text (e.g. is it bold), as well as a listing of any images or links in the text.

===Equation editor===

If either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX notation]] filters are enabled (in ''Administration > Site administration > Plugins > Filters > Manage filters'') then an equation editor button is provided in the toolbar for launching the equation editor.

===Table editor===

If the administrator has enabled the extra settings for the Atto table editor (see below) then border styling, sizing and colours are available when creating a table:

[[File:AttoTableRevised.png|center|thumb|center]]

===Displaying the HTML code===
{{MediaPlayer | url = https://youtu.be/EpceMkMpfCs | desc = }}

==Keyboard shortcuts==

The following keyboard shortcuts will work in the Atto text editor in most browsers. Note that for many of these commands to work you need to either click in the text editor or select content in the text editor.

{| class="wikitable"
|-
! Windows Command
! Mac Command
! Function
|-
| Ctrl + c
| ⌘ + c
| Copy
|-
| Ctrl + v
| ⌘ + v
| Paste
|-
| Ctrl + Shift + v
| ⌘ + Shift + v
| Paste without formatting (very useful)
|-
| Ctrl + x
| ⌘ + x
| Cut
|-
| Ctrl + z
| ⌘ + z
| Undo (careful - can undo a lot of text and doesn't always work)
|-
| Ctrl + y
| ⌘ + y
| Redo
|-
| Ctrl + a
| ⌘ + a
| Select all
|-
| Double-click
| Double-click
| Select word
|-
| Triple-click
| Triple-click
| Select line
|-
| Ctrl + f
| ⌘ + f
| Find on page
|-
| F3
| F3
| Find next
|-
| Shift + F3
| Shift + F3
| Find previous
|-
| Ctrl + b
| ⌘ + b
| Bold
|-
| Ctrl + i
| ⌘ + i
| Italics
|-
| Ctrl + u
| ⌘ + u
| Underline
|-
| Ctrl + k
| ⌘ + k
| Insert/edit link
|-
| Ctrl + Right arrow
| ⌘ + Right arrow
| Move to the end of the next word
|-
| Ctrl + Left arrow
| ⌘ + Left arrow
| Move to the end of the previous word
|-
| Ctrl + Shift + Right arrow
| ⌘ + Shift + Right arrow
| Select the next word or letter
|-
| Ctrl + Shift + Left arrow
| ⌘ + Shift + Left arrow
| Select the previous word or letter
|-
| Ctrl + Shift + Home
| ⌘ + Shift + Home
| Select from the cursor to the beginning of the page
|-
| Ctrl + Shift + End
| ⌘ + Shift + End
| Select from the cursor to the end of the page
|-
| Ctrl + Home
| ⌘ + Home
| Move to the beginning of the page
|-
| Ctrl + End
| ⌘ + End
| Move to the end of the page
|-
| Ctrl + Backspace
| ⌘ + Backspace
| Delete word or letter to the left
|-
| Ctrl + Delete
| ⌘ + Delete
| Delete word or letter to the right
|-
| Ctrl and +
| ⌘ and +
| Zoom in (not specific to the editor, but very useful)
|-
| Ctrl and -
| ⌘ and -
| Zoom out (not specific to the editor, but very useful)
|-
| Ctrl and 0
| ⌘ and 0
| Reset zoom (not specific to the editor, but very useful)
|}

<span style="font-size:80%">Source: [https://confluence.royalroads.ca:8443/pages/viewpage.action?pageId=47778173 Jason 1keddie, Royal Roads University (Creative Commons Attribution-ShareAlike)]</span>

==Site administration settings==

===Toolbar settings===

The administrator can specify which plugins to display and in which order from ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings''.
[[File:atto-plugins.png|thumb|center|450px|Atto Plugins]]

====Toolbar config table====
The toolbar is split into groups of related buttons. The format for the config setting is:

groupname1 = button1, button2, button3
groupname2 = button1, button2, button3

The group names on the left have no effect on how the toolbar works; they just need to be different for each button (and no spaces please). The list of buttons says which button goes in which group and in what order. The exact word to insert here for each button is listed in the "Toolbar config" column above.

The reason there are names for the groups is that it helps to make you think about how to group the buttons sensibly and not just stick new buttons in random locations. Ie. all the buttons in the "files" group interact with the file picker in some way

===Adding extra buttons===

Extra plugins from the list (for example 'Font color') may be added by typing the toolbarconfig term into the toolbar config table.

[[File:toolbarconfig.png]]

Here for example are the available colours when 'fontcolor' is added:

[[File:fontcolor.png]]

The icons are displayed in related groups and the administrator can decide how many groups to display in the default collapsed state of the toolbar (that is, how many groups to display on Row 1).

====Autosave frequency====
Text is automatically saved at regular intervals so it may be restored when the user returns to a form they had previously left. This setting allows the administrator to specify the time between autosaves. The default is one minute.
==== Non default Atto plugins ====
Not all plugins are enabled by default and the administrator of each site should give careful thought as to which plugins they choose to enable for their users. Here are some things to consider before enabling the non-default plugins:

===== Background colour / Font colour =====
While these are very popular plugins, there are downsides to enabling their use on a site. Firstly - user specified colours may conflict visually with the site colours chosen by the theme designer. Even if the colours of the content do not conflict with the colours of the current theme, if the theme is changed in future, or the content is reused on a different site conflicts may be introduced. There are 2 possible types of conflicts, the first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people. It is preferable if the theme designer uses some interesting colours that meet the accessibility standards required for the site in the theme for the site, and the person creating the content simply uses the proper heading levels (for example) to make use of those styles.

===== Emoji picker =====
An emoji picker button may be added by typing 'emojipicker' into the toolbar config table.
[[File:toolbar with emoji picker.png|thumb|Toolbar with emoji picker button]]
To add the emoji picker button to the top row:

# Enter the line <code>emoji = emojipicker</code> under the line <code>files = image, emoticon, media, managefiles, recordrtc, h5p</code>
# Go to 'Collapse toolbar settings' and change 'Show first (n) groups when collapsed' to 6 and save changes.

===== Emoticons =====
The emoticon plugin inserts text representations of the emoticons in the content. The emoticon filter is responsible for converting these text sequences into proper smiley images. The emoticon filter is not enabled by default, which is why the emoticon plugin for Atto is not enabled by default.

===== No-auto link =====
In general, the more plugins are added to the Atto toolbar, the harder it becomes to find specific plugins. Because the no-auto link plugin is not felt to be widely used it is not enabled by default.

===== Right to left =====
Because this plugin is only useful for courses where text needs to be written in a mixture of both "left to right" and "right to left" languages, it is not enabled by default.

==== Moodle plugins directory ====

There are more plugins available for Atto than just those included in a default install.
See the [https://moodle.org/plugins/browse.php?list=category&id=53 Moodle plugins directory] for additional plugins.
Some example plugins include the following:

===== Cloze editor for Atto=====
[[Cloze editor for Atto|This]] is a plugin for easily making [[Embedded Answers (Cloze) question type]] questions inside the standard Moodle Atto text editor.

===== Toggle preview =====
This plugin allows you view the content as it would be seen by a reader.

===== Chemistry plugins =====
There are a number of chemistry plugins that support chemistry equations and structures.

===== Text import plugins =====
There are a number of plugins that support importing text from other sources.
The [https://moodle.org/plugins/view/atto_pastespecial Paste special] plugin minimises the amount of superfluous HTML markup
included when pasting content from an external editor such as Microsoft Word.

The [https://moodle.org/plugins/view/atto_wordimport Word Import] plugin (beta) supports importing an entire Word document,
including embedded images.

===Equation editor settings===

Equation editor commands may be removed, added or reordered in ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Equation editor settings''.

[[File:equationeditor.png]]

===Table editor settings===
Styles, colours and sizes for tables and their borders may be enabled from ''Administration > Site administraton >Plugins > Test editors > Atto HTML editor > Table settings.''

==See also==

* [[Text editor FAQ]]
* [[Embedded files repository]]
* [[Word count quick guide]] - Word count is a plugin for the [[Text editor|Atto text editor]] which is used to create content within Moodle. This plugin enables the author of text, such as a student, to check how many words and letters are in a piece of text.

[[Category:Site administration]]
[[Category:Language teaching]]

[[de:Text-Editor]]
[[es:Editor de texto]]
[[fr:Éditeur de texte]]

Template:Editing text

2021-02-04T13:28:44Z

Tsala: link edit

<div class="navtrail">[[Main page]] ► [[Managing a Moodle course]] ► [[Editing text]] ► [[{{PAGENAME}}]]</div>
<div class="sideblock right" style="width: 12em;">
<div class="header">[[Editing text]]</div>
<div class="content">
* [[Atto editor]]
* [[TinyMCE editor]]
* [[Formatting text]]
* [[Text editor FAQ]]
</div>
</div>

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

Atto editor

2021-02-04T13:27:54Z

Tsala: /* Atto features */

Atto editor

2021-02-04T13:27:28Z

Tsala: /* Image copy and paste */

{{Editing text}}
==The Atto text editor==

The Atto text editor (sometimes referred to as the 'HTML editor') has many icons to assist the user in entering content. Many of these icons and functions should be familiar to anyone who uses a word processor.

Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.

The default text editor in Moodle is the Atto editor, built specifically for Moodle. There is also a [[TinyMCE editor]] and a plain text editor.

Text editors can be enabled, disabled or a different one set to default from ''Administration > Site administration > Plugins > Text editors > Manage editors''. The order of priority may also be specified here.

If more than one text editor is enabled, users can select their preferred editor via their preferences page in the user menu (top right).

{{MediaPlayer | url = https://youtu.be/GzOOWM8UdEc | desc = }}

==Atto features==

{{New features}}===Image copy and paste===

Images can be copied from anywhere and pasted into the Atto editor. For example, you can take a screenshot, copy it to your clipboard and then paste it into the Atto editor.

===Image drag and drop===

If your browser allows it (and if it does, you will see a message at the top of your screen when the editing is on) you can add images into the Atto editor simply by dragging them from your computer:

[[File:Attodragdrop29.png|thumb|600px|center|Drag an image directly into the editor]]

===Autosave===

Text typed into the Atto editor is automatically saved if you leave the page. The default of 60 seconds may be changed by the administrator in ''Site administration>Plugins>Text editors>Atto HTML editor>Atto toolbar settings.'' If the user accidentally closes the tab or otherwise leaves the form without submitting, the text in the editor will be restored next time he opens the page. To discard a restored draft, the user needs to cancel the form or press the "Undo" button in the editor.
[[File:AtttoAutosave.png|thumb|600px|center]]

==Atto editor toolbar==

[[File:Attotopline1382.png]]

Atto Row 1 default buttons

{| class="nicetable"
|-
|-
| 1. Expand
| 2. Style
| 3. Bold
| 4. Italic
|-
| 5. Bulleted list
| 6. Numbered list
| 7. Add link
| 8. Unlink
|-
| 9. Add image
| 10. Add smiley (if enabled)
| 11. Add media
| 12. Record audio
|-
| 13. Record video
| 14. Manage embedded files
| 15. H5P

|}

[[File:Attobottomline.png]]

Atto Row 2 default buttons

{| class="nicetable"
|-
|-
| 1. Underline
| 2. Strikethrough
| 3. Subscript
| 4. Superscript
|-
| 5. Align left/centre/right
| 6. Decrease/increase indent
| 7. Equation editor
| 8. Special character
|-
| 9. Table
| 10. Clear formatting
| 11. Undo/redo
| 12. Accessibility checker
|-
| 13. Screenreader helper
| 14. HTML/code view
|
|}

===Manage embedded files===
This allows users to add, delete or override files embedded in the current text area, for example in a label or topic summary. (It complements the [[Embedded files repository]])

[[File:26embeddefiles2.png|thumb|400px|center]]

===Accessibility checker===

One of the tools available in the text editor is an automated [[Accessibility|accessibility]] checker which checks for some common errors in the text. These are usually things in the way the text is constructed that can prevent all users from having equal access to information and functionality. The list of problems that the accessibility checker looks for is:

* Images with missing or empty alt text (unless they have the presentation role)
* Contrast of font colour and background colour meets [https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines WCAG AA guidelines]
* Long blocks of text are sufficiently broken up into headings
* All tables require captions
* Tables should not contain merged cells as they are difficult to navigate with screen readers
* All tables should contain row or column headers

===Screenreader helper===

Screen readers basically treat a content editable region like a text box - which is wrong, because it can contain images, links and more.

The screen reader helper provides additional information about the currently selected text (e.g. is it bold), as well as a listing of any images or links in the text.

===Equation editor===

If either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX notation]] filters are enabled (in ''Administration > Site administration > Plugins > Filters > Manage filters'') then an equation editor button is provided in the toolbar for launching the equation editor.

===Table editor===

If the administrator has enabled the extra settings for the Atto table editor (see below) then border styling, sizing and colours are available when creating a table:

[[File:AttoTableRevised.png|center|thumb|center]]

===Displaying the HTML code===
{{MediaPlayer | url = https://youtu.be/EpceMkMpfCs | desc = }}

==Keyboard shortcuts==

The following keyboard shortcuts will work in the Atto text editor in most browsers. Note that for many of these commands to work you need to either click in the text editor or select content in the text editor.

{| class="wikitable"
|-
! Windows Command
! Mac Command
! Function
|-
| Ctrl + c
| ⌘ + c
| Copy
|-
| Ctrl + v
| ⌘ + v
| Paste
|-
| Ctrl + Shift + v
| ⌘ + Shift + v
| Paste without formatting (very useful)
|-
| Ctrl + x
| ⌘ + x
| Cut
|-
| Ctrl + z
| ⌘ + z
| Undo (careful - can undo a lot of text and doesn't always work)
|-
| Ctrl + y
| ⌘ + y
| Redo
|-
| Ctrl + a
| ⌘ + a
| Select all
|-
| Double-click
| Double-click
| Select word
|-
| Triple-click
| Triple-click
| Select line
|-
| Ctrl + f
| ⌘ + f
| Find on page
|-
| F3
| F3
| Find next
|-
| Shift + F3
| Shift + F3
| Find previous
|-
| Ctrl + b
| ⌘ + b
| Bold
|-
| Ctrl + i
| ⌘ + i
| Italics
|-
| Ctrl + u
| ⌘ + u
| Underline
|-
| Ctrl + k
| ⌘ + k
| Insert/edit link
|-
| Ctrl + Right arrow
| ⌘ + Right arrow
| Move to the end of the next word
|-
| Ctrl + Left arrow
| ⌘ + Left arrow
| Move to the end of the previous word
|-
| Ctrl + Shift + Right arrow
| ⌘ + Shift + Right arrow
| Select the next word or letter
|-
| Ctrl + Shift + Left arrow
| ⌘ + Shift + Left arrow
| Select the previous word or letter
|-
| Ctrl + Shift + Home
| ⌘ + Shift + Home
| Select from the cursor to the beginning of the page
|-
| Ctrl + Shift + End
| ⌘ + Shift + End
| Select from the cursor to the end of the page
|-
| Ctrl + Home
| ⌘ + Home
| Move to the beginning of the page
|-
| Ctrl + End
| ⌘ + End
| Move to the end of the page
|-
| Ctrl + Backspace
| ⌘ + Backspace
| Delete word or letter to the left
|-
| Ctrl + Delete
| ⌘ + Delete
| Delete word or letter to the right
|-
| Ctrl and +
| ⌘ and +
| Zoom in (not specific to the editor, but very useful)
|-
| Ctrl and -
| ⌘ and -
| Zoom out (not specific to the editor, but very useful)
|-
| Ctrl and 0
| ⌘ and 0
| Reset zoom (not specific to the editor, but very useful)
|}

<span style="font-size:80%">Source: [https://confluence.royalroads.ca:8443/pages/viewpage.action?pageId=47778173 Jason 1keddie, Royal Roads University (Creative Commons Attribution-ShareAlike)]</span>

==Site administration settings==

===Toolbar settings===

The administrator can specify which plugins to display and in which order from ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings''.
[[File:atto-plugins.png|thumb|center|450px|Atto Plugins]]

====Toolbar config table====
The toolbar is split into groups of related buttons. The format for the config setting is:

groupname1 = button1, button2, button3
groupname2 = button1, button2, button3

The group names on the left have no effect on how the toolbar works; they just need to be different for each button (and no spaces please). The list of buttons says which button goes in which group and in what order. The exact word to insert here for each button is listed in the "Toolbar config" column above.

The reason there are names for the groups is that it helps to make you think about how to group the buttons sensibly and not just stick new buttons in random locations. Ie. all the buttons in the "files" group interact with the file picker in some way

===Adding extra buttons===

Extra plugins from the list (for example 'Font color') may be added by typing the toolbarconfig term into the toolbar config table.

[[File:toolbarconfig.png]]

Here for example are the available colours when 'fontcolor' is added:

[[File:fontcolor.png]]

The icons are displayed in related groups and the administrator can decide how many groups to display in the default collapsed state of the toolbar (that is, how many groups to display on Row 1).

====Autosave frequency====
Text is automatically saved at regular intervals so it may be restored when the user returns to a form they had previously left. This setting allows the administrator to specify the time between autosaves. The default is one minute.
==== Non default Atto plugins ====
Not all plugins are enabled by default and the administrator of each site should give careful thought as to which plugins they choose to enable for their users. Here are some things to consider before enabling the non-default plugins:

===== Background colour / Font colour =====
While these are very popular plugins, there are downsides to enabling their use on a site. Firstly - user specified colours may conflict visually with the site colours chosen by the theme designer. Even if the colours of the content do not conflict with the colours of the current theme, if the theme is changed in future, or the content is reused on a different site conflicts may be introduced. There are 2 possible types of conflicts, the first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people. It is preferable if the theme designer uses some interesting colours that meet the accessibility standards required for the site in the theme for the site, and the person creating the content simply uses the proper heading levels (for example) to make use of those styles.

===== Emoji picker =====
An emoji picker button may be added by typing 'emojipicker' into the toolbar config table.
[[File:toolbar with emoji picker.png|thumb|Toolbar with emoji picker button]]
To add the emoji picker button to the top row:

# Enter the line <code>emoji = emojipicker</code> under the line <code>files = image, emoticon, media, managefiles, recordrtc, h5p</code>
# Go to 'Collapse toolbar settings' and change 'Show first (n) groups when collapsed' to 6 and save changes.

===== Emoticons =====
The emoticon plugin inserts text representations of the emoticons in the content. The emoticon filter is responsible for converting these text sequences into proper smiley images. The emoticon filter is not enabled by default, which is why the emoticon plugin for Atto is not enabled by default.

===== No-auto link =====
In general, the more plugins are added to the Atto toolbar, the harder it becomes to find specific plugins. Because the no-auto link plugin is not felt to be widely used it is not enabled by default.

===== Right to left =====
Because this plugin is only useful for courses where text needs to be written in a mixture of both "left to right" and "right to left" languages, it is not enabled by default.

==== Moodle plugins directory ====

There are more plugins available for Atto than just those included in a default install.
See the [https://moodle.org/plugins/browse.php?list=category&id=53 Moodle plugins directory] for additional plugins.
Some example plugins include the following:

===== Cloze editor for Atto=====
[[Cloze editor for Atto|This]] is a plugin for easily making [[Embedded Answers (Cloze) question type]] questions inside the standard Moodle Atto text editor.

===== Toggle preview =====
This plugin allows you view the content as it would be seen by a reader.

===== Chemistry plugins =====
There are a number of chemistry plugins that support chemistry equations and structures.

===== Text import plugins =====
There are a number of plugins that support importing text from other sources.
The [https://moodle.org/plugins/view/atto_pastespecial Paste special] plugin minimises the amount of superfluous HTML markup
included when pasting content from an external editor such as Microsoft Word.

The [https://moodle.org/plugins/view/atto_wordimport Word Import] plugin (beta) supports importing an entire Word document,
including embedded images.

===Equation editor settings===

Equation editor commands may be removed, added or reordered in ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Equation editor settings''.

[[File:equationeditor.png]]

===Table editor settings===
Styles, colours and sizes for tables and their borders may be enabled from ''Administration > Site administraton >Plugins > Test editors > Atto HTML editor > Table settings.''

==See also==

* [[Text editor FAQ]]
* [[Embedded files repository]]
* [[Word count quick guide]] - Word count is a plugin for the [[Text editor|Atto text editor]] which is used to create content within Moodle. This plugin enables the author of text, such as a student, to check how many words and letters are in a piece of text.

[[Category:Site administration]]
[[Category:Language teaching]]

[[de:Text-Editor]]
[[es:Editor de texto]]
[[fr:Éditeur de texte]]

Atto editor

2021-02-04T13:26:44Z

Tsala: /* Atto features */ Image copy and paste (MDL-47750)

{{Editing text}}
==The Atto text editor==

The Atto text editor (sometimes referred to as the 'HTML editor') has many icons to assist the user in entering content. Many of these icons and functions should be familiar to anyone who uses a word processor.

Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.

The default text editor in Moodle is the Atto editor, built specifically for Moodle. There is also a [[TinyMCE editor]] and a plain text editor.

Text editors can be enabled, disabled or a different one set to default from ''Administration > Site administration > Plugins > Text editors > Manage editors''. The order of priority may also be specified here.

If more than one text editor is enabled, users can select their preferred editor via their preferences page in the user menu (top right).

{{MediaPlayer | url = https://youtu.be/GzOOWM8UdEc | desc = }}

==Atto features==

===Image copy and paste===

{{New features}}Images can be copied from anywhere and pasted into the Atto editor. For example, you can take a screenshot, copy it to your clipboard and then paste it into the Atto editor.

===Image drag and drop===

If your browser allows it (and if it does, you will see a message at the top of your screen when the editing is on) you can add images into the Atto editor simply by dragging them from your computer:

[[File:Attodragdrop29.png|thumb|600px|center|Drag an image directly into the editor]]

===Autosave===

Text typed into the Atto editor is automatically saved if you leave the page. The default of 60 seconds may be changed by the administrator in ''Site administration>Plugins>Text editors>Atto HTML editor>Atto toolbar settings.'' If the user accidentally closes the tab or otherwise leaves the form without submitting, the text in the editor will be restored next time he opens the page. To discard a restored draft, the user needs to cancel the form or press the "Undo" button in the editor.
[[File:AtttoAutosave.png|thumb|600px|center]]

==Atto editor toolbar==

[[File:Attotopline1382.png]]

Atto Row 1 default buttons

{| class="nicetable"
|-
|-
| 1. Expand
| 2. Style
| 3. Bold
| 4. Italic
|-
| 5. Bulleted list
| 6. Numbered list
| 7. Add link
| 8. Unlink
|-
| 9. Add image
| 10. Add smiley (if enabled)
| 11. Add media
| 12. Record audio
|-
| 13. Record video
| 14. Manage embedded files
| 15. H5P

|}

[[File:Attobottomline.png]]

Atto Row 2 default buttons

{| class="nicetable"
|-
|-
| 1. Underline
| 2. Strikethrough
| 3. Subscript
| 4. Superscript
|-
| 5. Align left/centre/right
| 6. Decrease/increase indent
| 7. Equation editor
| 8. Special character
|-
| 9. Table
| 10. Clear formatting
| 11. Undo/redo
| 12. Accessibility checker
|-
| 13. Screenreader helper
| 14. HTML/code view
|
|}

===Manage embedded files===
This allows users to add, delete or override files embedded in the current text area, for example in a label or topic summary. (It complements the [[Embedded files repository]])

[[File:26embeddefiles2.png|thumb|400px|center]]

===Accessibility checker===

One of the tools available in the text editor is an automated [[Accessibility|accessibility]] checker which checks for some common errors in the text. These are usually things in the way the text is constructed that can prevent all users from having equal access to information and functionality. The list of problems that the accessibility checker looks for is:

* Images with missing or empty alt text (unless they have the presentation role)
* Contrast of font colour and background colour meets [https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines WCAG AA guidelines]
* Long blocks of text are sufficiently broken up into headings
* All tables require captions
* Tables should not contain merged cells as they are difficult to navigate with screen readers
* All tables should contain row or column headers

===Screenreader helper===

Screen readers basically treat a content editable region like a text box - which is wrong, because it can contain images, links and more.

The screen reader helper provides additional information about the currently selected text (e.g. is it bold), as well as a listing of any images or links in the text.

===Equation editor===

If either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX notation]] filters are enabled (in ''Administration > Site administration > Plugins > Filters > Manage filters'') then an equation editor button is provided in the toolbar for launching the equation editor.

===Table editor===

If the administrator has enabled the extra settings for the Atto table editor (see below) then border styling, sizing and colours are available when creating a table:

[[File:AttoTableRevised.png|center|thumb|center]]

===Displaying the HTML code===
{{MediaPlayer | url = https://youtu.be/EpceMkMpfCs | desc = }}

==Keyboard shortcuts==

The following keyboard shortcuts will work in the Atto text editor in most browsers. Note that for many of these commands to work you need to either click in the text editor or select content in the text editor.

{| class="wikitable"
|-
! Windows Command
! Mac Command
! Function
|-
| Ctrl + c
| ⌘ + c
| Copy
|-
| Ctrl + v
| ⌘ + v
| Paste
|-
| Ctrl + Shift + v
| ⌘ + Shift + v
| Paste without formatting (very useful)
|-
| Ctrl + x
| ⌘ + x
| Cut
|-
| Ctrl + z
| ⌘ + z
| Undo (careful - can undo a lot of text and doesn't always work)
|-
| Ctrl + y
| ⌘ + y
| Redo
|-
| Ctrl + a
| ⌘ + a
| Select all
|-
| Double-click
| Double-click
| Select word
|-
| Triple-click
| Triple-click
| Select line
|-
| Ctrl + f
| ⌘ + f
| Find on page
|-
| F3
| F3
| Find next
|-
| Shift + F3
| Shift + F3
| Find previous
|-
| Ctrl + b
| ⌘ + b
| Bold
|-
| Ctrl + i
| ⌘ + i
| Italics
|-
| Ctrl + u
| ⌘ + u
| Underline
|-
| Ctrl + k
| ⌘ + k
| Insert/edit link
|-
| Ctrl + Right arrow
| ⌘ + Right arrow
| Move to the end of the next word
|-
| Ctrl + Left arrow
| ⌘ + Left arrow
| Move to the end of the previous word
|-
| Ctrl + Shift + Right arrow
| ⌘ + Shift + Right arrow
| Select the next word or letter
|-
| Ctrl + Shift + Left arrow
| ⌘ + Shift + Left arrow
| Select the previous word or letter
|-
| Ctrl + Shift + Home
| ⌘ + Shift + Home
| Select from the cursor to the beginning of the page
|-
| Ctrl + Shift + End
| ⌘ + Shift + End
| Select from the cursor to the end of the page
|-
| Ctrl + Home
| ⌘ + Home
| Move to the beginning of the page
|-
| Ctrl + End
| ⌘ + End
| Move to the end of the page
|-
| Ctrl + Backspace
| ⌘ + Backspace
| Delete word or letter to the left
|-
| Ctrl + Delete
| ⌘ + Delete
| Delete word or letter to the right
|-
| Ctrl and +
| ⌘ and +
| Zoom in (not specific to the editor, but very useful)
|-
| Ctrl and -
| ⌘ and -
| Zoom out (not specific to the editor, but very useful)
|-
| Ctrl and 0
| ⌘ and 0
| Reset zoom (not specific to the editor, but very useful)
|}

<span style="font-size:80%">Source: [https://confluence.royalroads.ca:8443/pages/viewpage.action?pageId=47778173 Jason 1keddie, Royal Roads University (Creative Commons Attribution-ShareAlike)]</span>

==Site administration settings==

===Toolbar settings===

The administrator can specify which plugins to display and in which order from ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings''.
[[File:atto-plugins.png|thumb|center|450px|Atto Plugins]]

====Toolbar config table====
The toolbar is split into groups of related buttons. The format for the config setting is:

groupname1 = button1, button2, button3
groupname2 = button1, button2, button3

The group names on the left have no effect on how the toolbar works; they just need to be different for each button (and no spaces please). The list of buttons says which button goes in which group and in what order. The exact word to insert here for each button is listed in the "Toolbar config" column above.

The reason there are names for the groups is that it helps to make you think about how to group the buttons sensibly and not just stick new buttons in random locations. Ie. all the buttons in the "files" group interact with the file picker in some way

===Adding extra buttons===

Extra plugins from the list (for example 'Font color') may be added by typing the toolbarconfig term into the toolbar config table.

[[File:toolbarconfig.png]]

Here for example are the available colours when 'fontcolor' is added:

[[File:fontcolor.png]]

The icons are displayed in related groups and the administrator can decide how many groups to display in the default collapsed state of the toolbar (that is, how many groups to display on Row 1).

====Autosave frequency====
Text is automatically saved at regular intervals so it may be restored when the user returns to a form they had previously left. This setting allows the administrator to specify the time between autosaves. The default is one minute.
==== Non default Atto plugins ====
Not all plugins are enabled by default and the administrator of each site should give careful thought as to which plugins they choose to enable for their users. Here are some things to consider before enabling the non-default plugins:

===== Background colour / Font colour =====
While these are very popular plugins, there are downsides to enabling their use on a site. Firstly - user specified colours may conflict visually with the site colours chosen by the theme designer. Even if the colours of the content do not conflict with the colours of the current theme, if the theme is changed in future, or the content is reused on a different site conflicts may be introduced. There are 2 possible types of conflicts, the first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people. It is preferable if the theme designer uses some interesting colours that meet the accessibility standards required for the site in the theme for the site, and the person creating the content simply uses the proper heading levels (for example) to make use of those styles.

===== Emoji picker =====
An emoji picker button may be added by typing 'emojipicker' into the toolbar config table.
[[File:toolbar with emoji picker.png|thumb|Toolbar with emoji picker button]]
To add the emoji picker button to the top row:

# Enter the line <code>emoji = emojipicker</code> under the line <code>files = image, emoticon, media, managefiles, recordrtc, h5p</code>
# Go to 'Collapse toolbar settings' and change 'Show first (n) groups when collapsed' to 6 and save changes.

===== Emoticons =====
The emoticon plugin inserts text representations of the emoticons in the content. The emoticon filter is responsible for converting these text sequences into proper smiley images. The emoticon filter is not enabled by default, which is why the emoticon plugin for Atto is not enabled by default.

===== No-auto link =====
In general, the more plugins are added to the Atto toolbar, the harder it becomes to find specific plugins. Because the no-auto link plugin is not felt to be widely used it is not enabled by default.

===== Right to left =====
Because this plugin is only useful for courses where text needs to be written in a mixture of both "left to right" and "right to left" languages, it is not enabled by default.

==== Moodle plugins directory ====

There are more plugins available for Atto than just those included in a default install.
See the [https://moodle.org/plugins/browse.php?list=category&id=53 Moodle plugins directory] for additional plugins.
Some example plugins include the following:

===== Cloze editor for Atto=====
[[Cloze editor for Atto|This]] is a plugin for easily making [[Embedded Answers (Cloze) question type]] questions inside the standard Moodle Atto text editor.

===== Toggle preview =====
This plugin allows you view the content as it would be seen by a reader.

===== Chemistry plugins =====
There are a number of chemistry plugins that support chemistry equations and structures.

===== Text import plugins =====
There are a number of plugins that support importing text from other sources.
The [https://moodle.org/plugins/view/atto_pastespecial Paste special] plugin minimises the amount of superfluous HTML markup
included when pasting content from an external editor such as Microsoft Word.

The [https://moodle.org/plugins/view/atto_wordimport Word Import] plugin (beta) supports importing an entire Word document,
including embedded images.

===Equation editor settings===

Equation editor commands may be removed, added or reordered in ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Equation editor settings''.

[[File:equationeditor.png]]

===Table editor settings===
Styles, colours and sizes for tables and their borders may be enabled from ''Administration > Site administraton >Plugins > Test editors > Atto HTML editor > Table settings.''

==See also==

* [[Text editor FAQ]]
* [[Embedded files repository]]
* [[Word count quick guide]] - Word count is a plugin for the [[Text editor|Atto text editor]] which is used to create content within Moodle. This plugin enables the author of text, such as a student, to check how many words and letters are in a piece of text.

[[Category:Site administration]]
[[Category:Language teaching]]

[[de:Text-Editor]]
[[es:Editor de texto]]
[[fr:Éditeur de texte]]

Atto editor

2021-02-04T13:18:05Z

Tsala: tidying up

{{Editing text}}
==The Atto text editor==

The Atto text editor (sometimes referred to as the 'HTML editor') has many icons to assist the user in entering content. Many of these icons and functions should be familiar to anyone who uses a word processor.

Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.

The default text editor in Moodle is the Atto editor, built specifically for Moodle. There is also a [[TinyMCE editor]] and a plain text editor.

Text editors can be enabled, disabled or a different one set to default from ''Administration > Site administration > Plugins > Text editors > Manage editors''. The order of priority may also be specified here.

If more than one text editor is enabled, users can select their preferred editor via their preferences page in the user menu (top right).

{{MediaPlayer | url = https://youtu.be/GzOOWM8UdEc | desc = }}

==Atto features==

===Image drag and drop===

If your browser allows it (and if it does, you will see a message at the top of your screen when the editing is on) you can add images into the Atto editor simply by dragging them from your computer:

[[File:Attodragdrop29.png|thumb|600px|center|Drag an image directly into the editor]]

===Autosave===

Text typed into the Atto editor is automatically saved if you leave the page. The default of 60 seconds may be changed by the administrator in ''Site administration>Plugins>Text editors>Atto HTML editor>Atto toolbar settings.'' If the user accidentally closes the tab or otherwise leaves the form without submitting, the text in the editor will be restored next time he opens the page. To discard a restored draft, the user needs to cancel the form or press the "Undo" button in the editor.
[[File:AtttoAutosave.png|thumb|600px|center]]

==Atto editor toolbar==

[[File:Attotopline1382.png]]

Atto Row 1 default buttons

{| class="nicetable"
|-
|-
| 1. Expand
| 2. Style
| 3. Bold
| 4. Italic
|-
| 5. Bulleted list
| 6. Numbered list
| 7. Add link
| 8. Unlink
|-
| 9. Add image
| 10. Add smiley (if enabled)
| 11. Add media
| 12. Record audio
|-
| 13. Record video
| 14. Manage embedded files
| 15. H5P

|}

[[File:Attobottomline.png]]

Atto Row 2 default buttons

{| class="nicetable"
|-
|-
| 1. Underline
| 2. Strikethrough
| 3. Subscript
| 4. Superscript
|-
| 5. Align left/centre/right
| 6. Decrease/increase indent
| 7. Equation editor
| 8. Special character
|-
| 9. Table
| 10. Clear formatting
| 11. Undo/redo
| 12. Accessibility checker
|-
| 13. Screenreader helper
| 14. HTML/code view
|
|}

===Manage embedded files===
This allows users to add, delete or override files embedded in the current text area, for example in a label or topic summary. (It complements the [[Embedded files repository]])

[[File:26embeddefiles2.png|thumb|400px|center]]

===Accessibility checker===

One of the tools available in the text editor is an automated [[Accessibility|accessibility]] checker which checks for some common errors in the text. These are usually things in the way the text is constructed that can prevent all users from having equal access to information and functionality. The list of problems that the accessibility checker looks for is:

* Images with missing or empty alt text (unless they have the presentation role)
* Contrast of font colour and background colour meets [https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines WCAG AA guidelines]
* Long blocks of text are sufficiently broken up into headings
* All tables require captions
* Tables should not contain merged cells as they are difficult to navigate with screen readers
* All tables should contain row or column headers

===Screenreader helper===

Screen readers basically treat a content editable region like a text box - which is wrong, because it can contain images, links and more.

The screen reader helper provides additional information about the currently selected text (e.g. is it bold), as well as a listing of any images or links in the text.

===Equation editor===

If either the [[MathJax filter|MathJax]] or the [[TeX notation filter|TeX notation]] filters are enabled (in ''Administration > Site administration > Plugins > Filters > Manage filters'') then an equation editor button is provided in the toolbar for launching the equation editor.

===Table editor===

If the administrator has enabled the extra settings for the Atto table editor (see below) then border styling, sizing and colours are available when creating a table:

[[File:AttoTableRevised.png|center|thumb|center]]

===Displaying the HTML code===
{{MediaPlayer | url = https://youtu.be/EpceMkMpfCs | desc = }}

==Keyboard shortcuts==

The following keyboard shortcuts will work in the Atto text editor in most browsers. Note that for many of these commands to work you need to either click in the text editor or select content in the text editor.

{| class="wikitable"
|-
! Windows Command
! Mac Command
! Function
|-
| Ctrl + c
| ⌘ + c
| Copy
|-
| Ctrl + v
| ⌘ + v
| Paste
|-
| Ctrl + Shift + v
| ⌘ + Shift + v
| Paste without formatting (very useful)
|-
| Ctrl + x
| ⌘ + x
| Cut
|-
| Ctrl + z
| ⌘ + z
| Undo (careful - can undo a lot of text and doesn't always work)
|-
| Ctrl + y
| ⌘ + y
| Redo
|-
| Ctrl + a
| ⌘ + a
| Select all
|-
| Double-click
| Double-click
| Select word
|-
| Triple-click
| Triple-click
| Select line
|-
| Ctrl + f
| ⌘ + f
| Find on page
|-
| F3
| F3
| Find next
|-
| Shift + F3
| Shift + F3
| Find previous
|-
| Ctrl + b
| ⌘ + b
| Bold
|-
| Ctrl + i
| ⌘ + i
| Italics
|-
| Ctrl + u
| ⌘ + u
| Underline
|-
| Ctrl + k
| ⌘ + k
| Insert/edit link
|-
| Ctrl + Right arrow
| ⌘ + Right arrow
| Move to the end of the next word
|-
| Ctrl + Left arrow
| ⌘ + Left arrow
| Move to the end of the previous word
|-
| Ctrl + Shift + Right arrow
| ⌘ + Shift + Right arrow
| Select the next word or letter
|-
| Ctrl + Shift + Left arrow
| ⌘ + Shift + Left arrow
| Select the previous word or letter
|-
| Ctrl + Shift + Home
| ⌘ + Shift + Home
| Select from the cursor to the beginning of the page
|-
| Ctrl + Shift + End
| ⌘ + Shift + End
| Select from the cursor to the end of the page
|-
| Ctrl + Home
| ⌘ + Home
| Move to the beginning of the page
|-
| Ctrl + End
| ⌘ + End
| Move to the end of the page
|-
| Ctrl + Backspace
| ⌘ + Backspace
| Delete word or letter to the left
|-
| Ctrl + Delete
| ⌘ + Delete
| Delete word or letter to the right
|-
| Ctrl and +
| ⌘ and +
| Zoom in (not specific to the editor, but very useful)
|-
| Ctrl and -
| ⌘ and -
| Zoom out (not specific to the editor, but very useful)
|-
| Ctrl and 0
| ⌘ and 0
| Reset zoom (not specific to the editor, but very useful)
|}

<span style="font-size:80%">Source: [https://confluence.royalroads.ca:8443/pages/viewpage.action?pageId=47778173 Jason 1keddie, Royal Roads University (Creative Commons Attribution-ShareAlike)]</span>

==Site administration settings==

===Toolbar settings===

The administrator can specify which plugins to display and in which order from ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings''.
[[File:atto-plugins.png|thumb|center|450px|Atto Plugins]]

====Toolbar config table====
The toolbar is split into groups of related buttons. The format for the config setting is:

groupname1 = button1, button2, button3
groupname2 = button1, button2, button3

The group names on the left have no effect on how the toolbar works; they just need to be different for each button (and no spaces please). The list of buttons says which button goes in which group and in what order. The exact word to insert here for each button is listed in the "Toolbar config" column above.

The reason there are names for the groups is that it helps to make you think about how to group the buttons sensibly and not just stick new buttons in random locations. Ie. all the buttons in the "files" group interact with the file picker in some way

===Adding extra buttons===

Extra plugins from the list (for example 'Font color') may be added by typing the toolbarconfig term into the toolbar config table.

[[File:toolbarconfig.png]]

Here for example are the available colours when 'fontcolor' is added:

[[File:fontcolor.png]]

The icons are displayed in related groups and the administrator can decide how many groups to display in the default collapsed state of the toolbar (that is, how many groups to display on Row 1).

====Autosave frequency====
Text is automatically saved at regular intervals so it may be restored when the user returns to a form they had previously left. This setting allows the administrator to specify the time between autosaves. The default is one minute.
==== Non default Atto plugins ====
Not all plugins are enabled by default and the administrator of each site should give careful thought as to which plugins they choose to enable for their users. Here are some things to consider before enabling the non-default plugins:

===== Background colour / Font colour =====
While these are very popular plugins, there are downsides to enabling their use on a site. Firstly - user specified colours may conflict visually with the site colours chosen by the theme designer. Even if the colours of the content do not conflict with the colours of the current theme, if the theme is changed in future, or the content is reused on a different site conflicts may be introduced. There are 2 possible types of conflicts, the first is just a visually unappealing combination of colours, the second is a combination of colours that may produce text that is hard to read for some people. It is preferable if the theme designer uses some interesting colours that meet the accessibility standards required for the site in the theme for the site, and the person creating the content simply uses the proper heading levels (for example) to make use of those styles.

===== Emoji picker =====
An emoji picker button may be added by typing 'emojipicker' into the toolbar config table.
[[File:toolbar with emoji picker.png|thumb|Toolbar with emoji picker button]]
To add the emoji picker button to the top row:

# Enter the line <code>emoji = emojipicker</code> under the line <code>files = image, emoticon, media, managefiles, recordrtc, h5p</code>
# Go to 'Collapse toolbar settings' and change 'Show first (n) groups when collapsed' to 6 and save changes.

===== Emoticons =====
The emoticon plugin inserts text representations of the emoticons in the content. The emoticon filter is responsible for converting these text sequences into proper smiley images. The emoticon filter is not enabled by default, which is why the emoticon plugin for Atto is not enabled by default.

===== No-auto link =====
In general, the more plugins are added to the Atto toolbar, the harder it becomes to find specific plugins. Because the no-auto link plugin is not felt to be widely used it is not enabled by default.

===== Right to left =====
Because this plugin is only useful for courses where text needs to be written in a mixture of both "left to right" and "right to left" languages, it is not enabled by default.

==== Moodle plugins directory ====

There are more plugins available for Atto than just those included in a default install.
See the [https://moodle.org/plugins/browse.php?list=category&id=53 Moodle plugins directory] for additional plugins.
Some example plugins include the following:

===== Cloze editor for Atto=====
[[Cloze editor for Atto|This]] is a plugin for easily making [[Embedded Answers (Cloze) question type]] questions inside the standard Moodle Atto text editor.

===== Toggle preview =====
This plugin allows you view the content as it would be seen by a reader.

===== Chemistry plugins =====
There are a number of chemistry plugins that support chemistry equations and structures.

===== Text import plugins =====
There are a number of plugins that support importing text from other sources.
The [https://moodle.org/plugins/view/atto_pastespecial Paste special] plugin minimises the amount of superfluous HTML markup
included when pasting content from an external editor such as Microsoft Word.

The [https://moodle.org/plugins/view/atto_wordimport Word Import] plugin (beta) supports importing an entire Word document,
including embedded images.

===Equation editor settings===

Equation editor commands may be removed, added or reordered in ''Administration > Site administration > Plugins > Text editors > Atto HTML editor > Equation editor settings''.

[[File:equationeditor.png]]

===Table editor settings===
Styles, colours and sizes for tables and their borders may be enabled from ''Administration > Site administraton >Plugins > Test editors > Atto HTML editor > Table settings.''

==See also==

* [[Text editor FAQ]]
* [[Embedded files repository]]
* [[Word count quick guide]] - Word count is a plugin for the [[Text editor|Atto text editor]] which is used to create content within Moodle. This plugin enables the author of text, such as a student, to check how many words and letters are in a piece of text.

[[Category:Site administration]]
[[Category:Language teaching]]

[[de:Text-Editor]]
[[es:Editor de texto]]
[[fr:Éditeur de texte]]

EQUELLA repository

2020-12-08T09:06:28Z

Tsala: /* Setup */ updated link

{{Repositories}}
The EQUELLA repository enables users to make aliases (shortcuts) to EQUELLA files. Updating the files in EQUELLA will automatically cause them to update in Moodle. In addition to being able to search the EQUELLA repository, users also have the option to manage their repository and add new files.

{|
|[[File:equellarepository.png|thumb|600px]]
|}

==Requirements==

EQUELLA 5.2 QA2 or higher is required for this repository plug-in to work correctly.

==Setup==

Warning: This page may be outdated. See openEQUELLA's own documentation at https://openequella.github.io/guides/MoodleIntegrationGuide.html

===EQUELLA configuration===

A shared secret must be configured in EQUELLA that Moodle will use to authenticate access for users.
#Log in to your EQUELLA site as admin. Your URL might be for instance ''http:// equella.myequellainstitution.edu''
#Select 'Settings' and then 'Administration Console' (1 below) NOTE: You will need up to date Java for this to display.
#Select User Management. Highlight 'Shared Secret' and click 'Configure' at the bottom of the screen (2 below)
#A new name 'Default' will appear with configuration elements to the right (3 below)
#Add a name for the Unique identifier and a shared secret. Any secret will do, but a longer one with a mix of letters and numbers is best.
#Make a note of it to use when configuring Moodle. Add any extra details and save.

{|
|[[File:equellaadminconsole.png|thumb|1.Accessing the Admin console]]
|
|[[File:equallasharedsecretconfig.png|thumb|2.Configuring shared secret]]
|
[[File:equellasharedsecret2.png|thumb|3.Defining the shared secret]]
|}

For further information, please consult the [http://equella.github.io/guides/MoodleIntegrationGuide.html EQUELLA Moodle Configuration Guide].

===Moodle configuration===

The EQUELLA repository may be enabled by a site administrator in ''Administration > Site administration > Plugins > Repositories > Manage repositories.'' From there, an EQUELLA repository instance can be created.

{| class="nicetable"
|-
| EQUELLA URL
| The URL to your EQUELLA install with "/signon.do" appended. For example, "http:// equella.myinstitution.edu/logon.do" would become "http:// equella.myinstitution.edu/signon.do"
|-
| EQUELLA options
| This is an optional advanced setting that can be used to restrict users to a limited set of collections or advanced searches.
|-
| Restrict selection
| Choose if users should be restricted to only choosing attached resources, summary pages or no restriction.
|-
| Default role settings
| The shared secret ID and shared secret entered here should match those that have been setup in EQUELLA
|-
| {X} role settings
| Shared secrets configured under a specific role will take precedence over the default shared secret if a user has that role. The security ACLs in EQUELLA can then be configured to grant or revoke access to additional functionality based on the shared secret that the user was authenticated with.
|}

==Capabilities==

There is just one capability, [[Capabilities/repository/equella:view|View EQUELLA repository]], which is allowed for the default authenticated user role.

==See also==

*[http://support.thelearningedge.com.au/downloads/5.2/Documentation/EQUELLA%205.2%20Moodle%20Configuration%20Guide.pdf Moodle configuration guide for EQUELLA 5.2]
*[http://support.thelearningedge.com.au/downloads/5.2/Documentation/EQUELLA%205.2%20Moodle%20User%20Guide.pdf Moodle user guide for EQUELLA 5.2]
*[https://github.com/equella Additional Moodle modules and blocks for integrating with EQUELLA]
*[http://www.equellacommunity.com/ EQUELLA community site]
*[http://www.equella.com/ EQUELLA]
*[http://www.prweb.com/releases/2012/6/prweb9642184.htm Pearson Announces Deeper Integration Between EQUELLA 5.2 Digital Repository and Moodle Learning Management System]

[[de:EQUELLA Repository]]
[[fr:EQUELLA]]

Building Quiz

2020-12-08T09:03:01Z

Tsala: /* After quiz has been attempted */ copying edit from 38 wiki

{{Quiz}}

==How a Moodle quiz works==
{{Note|If you're new to quiz creation, try the [[Quiz quick guide]] first.}}
Once a quiz has been added to the course and the [[Quiz settings]] established,the teacher can start to build the quiz. The teacher can access the quiz to edit the questions by clicking directly on the Quiz name on the course home page or by clicking "Edit quiz" in ''Administration>Quiz administration.'' (You can also make questions in the [[Question bank]] without first creating a quiz. These questions may then be used later.)

{|
| [[File:editquiz.png|thumb|400px|Accessing the quiz to add or edit questions]]

|}

==Adding questions==

Once you have accessed the quiz editing screen as above, you can add questions from a number of locations:

#Click the 'Add' link as in the screenshot below. (''Note that in the US, the term 'marks' is replaced by 'points'.'')
#When it opens up, choose either to add a new question, to select a question from the question bank or to add a random question.

{|
| [[File:newaddquestion.png|thumb|450px|Adding a question]]

|}

===Creating a new question===

1. To make a brand new question, click 'Add' and then '+ a new question'.

2. From the next screen, choose the question type you want to add and click "Next" ('When you click on a question type on the left, helpful information appears on the right''. )

{|
| [[File:questionpicker.png|thumb|440px|Selecting a question type]]

|}

3. Fill in the question form, making sure to give a grade to the correct answer.

4. Click "Save changes".

{|
| [[File:newlycreatedquestion.png|thumb|430px|A question when it has been created]]

|}

{{ Note| If you have a very complex question, and you want to check it as you go along, you can preview it and then click "Save changes and continue editing".}}

When a question has been created, an icon and words display its type (eg multiple choice). It can be modified by clicking the edit icon (eg [[File:editicon.png]]) and previewed by clicking the magnifiying glass icon.

As well as deleting individual questions with the delete (bin/trash can) icon, it is possible to delete more than one question by pressing the 'Select multiple items' button and choosing the questions to be removed:

[[File:multiplequestionselect.png]]

====Adding responses and feedback====
5. When you add responses and feedback, remember you can expand the toolbar to show more buttons.

6. You can continue adding questions this way, clicking 'Add' and '+ a new question' each time.

===Choosing a pre-made question===
*If other teachers in the course have made questions, or if a teacher made questions in an earlier quiz, these can be added to the current quiz by clicking 'Add' and '+ from question bank' .
* Click the + sign next to one question you want to add it (1 in screenshot below)
* If you have several questions, or you want to add all the questions, tick the box of each question or the top box (2 in screenshot below) and then click 'Add selected questions to the quiz' (3 in the screenshot below).
* To sort the questions, click the column headings. The default sort order (T) is short for question type. (2 in the screenshot below)
* To ensure all previously made questions are available, make sure to tick the boxes "also show questions from sub-categories/old questions".

{|
| [[File:addfromqbank1.png|thumb|350px|Using a previously made question]]

|}

'''Note:''' It is also possible to import pre-made questions into your quiz, from ''Quiz administration>Question bank>Import.'' See [[Import questions]] for more information. Sample questions are available from the [http://moodle.net/mod/data/view.php?d=1&mode=list&perpage=40&search=&sort=0&order=DESC&advanced=0&filter=1&advanced=1&f_2=Quiz+questions&f_11=&f_13=&f_12=&f_9=&f_8= Moodle.net content database.]

===Adding a random question===
As long as you have questions in the question bank, you can add random questions to your quiz by clicking 'Add' and then '+ a random question'. This might be useful if you have students in a class taking a quiz at the same time, because they are unlikely to get the same questions at the same time. The same question will never appear twice in a quiz. If you include several random questions then different questions will always be chosen for each of them. If you mix random questions with non-random questions then the random questions will be chosen so that they do not duplicate one of the non-random questions. This does imply that you need to provide enough questions in the category from which the random questions are chosen, otherwise the student will be shown a friendly error message. The more questions you provide the more likely it will be that students get different questions on each attempt. When a quiz with random questions is retaken, the random questions will be different from the ones in previous attempts. For a discussion on the behaviour of random questions, see MDL-6340

The grade for the randomly chosen question will be rescaled so that the maximum grade is what you have chosen as the grade for the random question.

You can add one or more random questions by choosing the number and category in the question bank. Note the die icon to highlight random question selection. Random questions may be filtered by tag and '''New in 3.5''' a list of random questions will be displayed when filtered.
{|
| [[File:RandomQuestionTag.png|thumb|400px|Adding a random question. Note tag and filtered list]]
| [[File:randomdie.png|thumb|400px|Random question selected for quiz]]

|}

{{Note|If you add random questions and your category of questions contains more than 10 different questions, when you look at the quiz statistics report related to position 1, it will not show them all on the front page of the report, just a summary, and then you have to click a link to drill down into the details (the report MDL-48092 is about the fact that working out which link to click is too difficult).}}

====Quiz question tags====

Questions may be tagged as they are created (as well as from the [[Question bank]]). Questions may be searched and filtered by tag in the Question bank and when adding random questions, as above.

===Question categories===
Questions can be stored and retrieved from categories in the Question bank. When you make a new question it defaults to the category with the course name. So if you make a quiz in the Senior Physics course, questions will automatically be added to "Default for Senior Physics". You can opt to have your quiz questions in a category of their own ("Quizname") or to add a subcategory.

To add a subcategory, go to ''Administration>Quiz administration>Question bank>Categories'' For more information on question contexts and categories, see [[Question bank]]

Users will have access to different categories according to their permissions. For example, a regular teacher might only have access to question categories in his own Physics course whereas his Faculty Head of Science with permissions in all science courses might have access to question categories in Biology and Chemistry as well.

==Quiz layout==

*You can choose in the Layout section of the quiz settings whether to have a new page for every question or after a certain number of questions.
* You can add a page break between questions by clicking the arrow icon (where the arrows are pointing away from each other) (1 in the screenshot below) A new page will be created. (2 in the screenshot below)
*You can remove pages by clicking the arrow icon (where the arrows are pointing towards each other). (3 in the screenshot below)

[[File:addpagebreak.png|thumb|500px|center]]
*You can also change the layout of the whole quiz by clicking the 'Repaginate' button:

[[File:repaginate.png|thumb|center|500px]]

*Questions may be moved by dragging and dropping using the crosshairs icon: [[File:crosshairsicon.png]]

===Section headings===

*Section headings may be added to each new page.
*For the first page, click the 'pencil' icon at the top (1) and add your heading (2):

[[File:sectionheading1.png]]

*For other pages, click the 'Add' link (1) and choose 'a new section heading' (2), and then add your heading as for Page 1:

[[File:sectionheading2.png]]

*The section headings are displayed in the Quiz navigation block:

[[File:quiznavsectionheadings.png]]

===Randomising the order questions appear===

*The order in which questions appear to the student may be randomised or 'shuffled' by ticking the 'Shuffle' box at the top of the screen:

[[File:shuffle1.png|289px]]

*Where questions are in different sections (see ''Section headings'' above), each section has its own 'Shuffle' box to tick. This means that you can mix up questions on one section, but in another section, where their order is important, you can keep them in the order you need them to display:

[[File:shuffle2.png|346px]]

==Making questions conditional upon other questions==

*If using the ''Interactive with multiple tries'' or ''Immediate Feedback'' behaviour and with the navigation method set to 'Free', it is possible to make the display of a question dependent on a previous question being answered first.
*The question editing page will display padlock icons to the right of each question:

[[File:locks1.png|thumb|center|400px|Padlocks - all unlocked]]

*If you want to make a question, for example Q2, conditional upon answering Q1, then click the padlock just above Q2:

[[File:lock2.png|thumb|center|400px|Padlocks - Q2 locked]]

*When a student accesses the quiz, they will see a message that Q2 is not available until they give a response to Q1:

[[File:lock3.png|thumb|center|550px|What students see]]

*In the Quiz navigation block, Q2 will be greyed out:
[[File:locksnav.png]]

*In the following example, note that, Q1 follows a description, and a description 'questions' cannot be finished. Therefore, Q1 cannot depend on the previous question. Similarly, Q4 follows an Essay question. The Essay cannot be finished during the attempt, so the following question cannot depend on it. Note the lack of padlocks in the following screenshot because of the description and Essay question:

[[File:conditionalquestionpadlocks.png|thumb|center|500px]]

==Assigning points to questions ==
''Administration > Quiz administration > Edit quiz > Editing quiz''

You can set how many points each question is worth by changing the number in the box to the right of each question and you can change the maximum grade by changing the number in the box top right at the top of the quiz. The default is one point per question and 100.00 maximum grade.

{|
| [[File:allquizgrades.png|thumb|450px|Points per question and max grade]]
| [[File:editmaxmark.png|thumb|450px|Edit individual marks]]

|}

The quiz module will do any maths, so for example, a 2 point question will be worth 2 times more when the Quiz module determines how many point out of 10 to award the student.

==Previewing the quiz==
*You can preview individual questions by clicking the magnifying glass icon.
*You can preview the whole quiz by clicking the "Preview" link in ''Administration>Quiz administration>Preview''
*The quiz works like a real quiz so you can see your grades and any feedback for correct/incorrect answers just as a student would see them.

'''NOTE''': ''To get a more accurate view of how a student would view your quiz, it is advised to log in with a "dummy" student account created by the admin for testing activities. This is more reliable than the 'switch role to student' feature.

*See also the question: 'How can a teacher '-dry run a quiz..?' in [[Quiz FAQ]]''
{|
| [[File:singleqp.png|thumb|300px|Previewing a single question]]
| [[File:previewquiz.png|thumb|200px|Click to preview the whole quiz]]
| [[File:quizpreviewed.png|thumb|200px|Quiz in preview mode]]

|}

==After quiz has been attempted==

If one or more students have taken the quiz, you will see a list of all the questions in the quiz and a notice saying that you cannot add or remove questions.

You can change the grade for a question (the scores for all students will recalculate immediately), preview an individual question and click on a question edit link that will allow you to directly edit the question stored in the question bank.

Be very careful about editing questions! It is OK to make small changes (e.g. fix a spelling mistake or change the grade for a partially correct response) but if you make a major change (for example deleting a choice from a multiple choice question) then you may break the existing quiz attempts. After editing questions in a way that affects the grading, you will need to re-grade the quiz.

Note: You can delete all quiz attempts by students and then edit the quiz as if no students had attempted it. To do this, click the quiz name and then the Results link in the Administration block. This will present a list of students and their scores. Click "Select all" and then "Delete selected attempts".

===Dealing with faulty questions===

There are several ways to deal with "bad" questions in a quiz.

::*Change the grade for the bad question to 0 in the quiz.
::*Edit the question, changing what you will accept as a correct answer, then regrading the exam. Remember when changing a question that the next time it is used it will be as it was in the last edit. Also, regrading will only affect one quiz at a time.
::*You can edit the question to explain the situation to the student and then you can set the grade for the question to zero. After you make such changes you should regrade the quiz by clicking on the '''Results''' tab and then the '''Regrade''' tab. This will change the grade for all students who have taken the quiz so far. Remember, if the question is used by another quiz, your "explanation" will appear as part of that quiz.
::*You can change the grade for the bad question and then move or delete the question from your question category. The question will still appear on the quiz. Some places do not like to delete any question, but will move them to a "dead" or "bad" question category.
::*When you discover a bad question in your quiz, it may affect the question bank. Remember that a final might be made up of a certain number of random questions drawn from different question categories, the same categories used in a smaller subject quiz. It can be very important do something about bad or invalid questions in a question category when the categories are use in other places.

==See also==
*[[Question types]]
*[[Effective quiz practices]]

[[Category:Questions]]

[[de:Test erstellen]]
[[es:Construyendo un examen]]
[[fr:Batir test]]

Using badges

2020-12-07T16:44:42Z

Tsala: removing issuer details as they are no longer displayed for OpenBadges 2.0 (MDL-68746)

{{Badges}}This page is about how to add badges to a course or the site and how users can access their badges. For managing badges which have already been added, see [[Managing badges]].

==Adding a course badge==

If course badges have been enabled in ''Administration > Site administration > Badges > Badges'' settings then a teacher can add badges from ''Administration > Course administration > Badges > Add a new badge''.

===Badge details===

Add a name and description and upload your badge here.

A badge version and language may be added, along with information about the author of the image used for the badge.

===Badge expiry===

Set a date here if the badge will cease to be valid after a certain date. Leave it to never if you want the badge to be permanently displayed.

*When the settings are saved, you are then taken to the Manage badges screen where you can decide the criteria for awarding the badge along with other optional information.
*This information can now include Endorsements, Related badges and (external) Competencies. See [[Managing badges]] for more details.

===Criteria===

*For course badges, the criteria are: Manual issue by role; course completion, activity completion, previously awarded badges, and competencies.
*When selecting Manual completion by role, you can choose the role you wish to award the badge, so for example a teacher could allow a non-editing teacher to award badges in the course.
*For badges to be awarded for course or activity completion, [[Completion tracking]] must be enabled in the site and the course.
* For awarded badges, a site badge can only have another site badge as criterion, whereas a course badge can have either another course badge or a site badge as criterion.

[[File:CourseBadgeCriteria.png|thumb|400px|center|Choosing criteria for the badge]]

It's possible to add a description of the criterion/criteria to provide more information or relevant links.

[[File:criteriondescription.png|thumb|center|400px|Criterion description field]]

Once criteria have been set, you are returned to the Manage badges screen where you must "enable access" for the badge to be available:

[[File:enableaccesscoursebadge.png|thumb|400px|center|Click to enable access to the badge]]

===Awarding the badge===
Badges may be awarded manually from the Badges link in the navigation drawer with the Boost theme or from ''Course administration > Badges > Manage badges > Recipients'' with other themes such as Classic.

For information on the Overview, Edit details, Message and Recipients tab, see [[Managing badges]].

Tip: If your site has a large number of users, it's easier to search for email addresses than names.

'''New in 3.8:''' If your course uses groups, it is possible to select a group and award the badge to members of just that group.

[[File:GroupBadgesAward.png|center|Awarding badges]]

===Revoking a badge===

If a badge is awarded my mistake, it may be revoked from the 'Badge recipients' page. Click the badge in question, click the Award button, select the person whose badge you wish to revoke and click 'Revoke'.

Only badges which were awarded manually may be revoked.

==Adding a site badge==

*An administrator can add a site badge from ''Site administration / Badges / Add a new badge''.
*While the settings are basically the same as for a teacher in a course, the criteria are slightly different because of the global nature of the badge. These are: manual issue by role; completing a set of courses or profile completion, cohort membership and previously awarded badges. As part of the profile completion criteria, a badge may be awarded for uploading a profile picture.
*In order to be able to award a site badge based on completing one or more courses, [[Completion tracking|completion tracking]] needs to be enabled in the site and relevant courses. In each course, [[Activity completion|activity completion]] must be set for the chosen activities, which must be then checked in the [[Course completion settings|course completion settings]].
{|
|[[File:SiteBadgeCriteria.png|thumb|Badge criteria for site badges]]
|}

==Earning badges==

*Once all criteria are set and badge creator is happy with badge details and settings, site users can start earning it. For users to be able to earn a badge, a badge creator/administrator needs to enable access to this badge on a badge overview page or "Manage badges" page (as shown on the picture).

*Normally badges are awarded to users automatically based on their actions in the system. The completion criteria of an active badge are re-calculated every time an event such as completion of a course or activity, or updating user profile happens. If a user has completed all necessary requirements they are issued a badge and sent an email notification.

'''Only badges with enabled access are available to users and can be earned!'''
{|
|[[File:Badge enable access.png|thumb|Enabling badge access]]
|[[File:Earning a badge.png|thumb|Earning a badge]]
|}

==See also==

*[https://moodle.org/mod/forum/discuss.php?d=235135 Custom Reports for Badges - Get some Here] - forum post
*[https://school.moodledemo.net/badges/index.php?type=1 School demo example: Managing site badges] (Log in with username: ''manager'', password: ''moodle'')
*[https://school.moodledemo.net/badges/index.php?type=2&id=62 School demo example: Managing course badges] (Log in with username: ''teacher'', password: ''moodle'')
*[https://school.moodledemo.net/badges/mybadges.php School demo example: Viewing your own badges] (Log in with username: ''student'', password: ''moodle'')
*[http://remediatingassessment.blogspot.co.nz/2013/07/research-design-principles-for-studying.html Research Design Principles for Studying Learning with Digital Badges] Re-mediating assessment blog post

[[es:Usando insignias]]
[[de:Auszeichnungen nutzen]]

Upload users

2020-12-07T16:21:26Z

Tsala: Reverted edits by Tsala (talk) to last revision by Krause

{{Accounts}}
==Uploading users via text file==

There are many options for uploading information (fields associated with a user) with this method: from enrolling users in multiple courses with course specific [[Roles|roles]] to updating user information in the [[User profile]] to deleting users from the site.

''Tip:'' It is usually not necessary to upload users in bulk with Upload users. To keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.

{{MediaPlayer | url = https://youtu.be/blUw-ZbhFqw| desc = How to bulk upload users and add to courses}}

==File formats for upload users file==
The upload users file has fields separated by a comma (or other delimiter) ONLY - no space. The first line contains the valid field names. The rest of the lines (records) contain information about each user.

''Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.

''Tip:'' You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors (eg, [https://notepad-plus-plus.org/ Notepad++]) for verification.

===Valid upload file for testing===

*From Site administration / Users / Upload users, an example text (.csv) file is available. It includes can be downloaded and adapted to your needs.

username,firstname,lastname,email

student1,Student,One,s1@example.com

student2,Student,Two,s2@example.com

student3,Student,Three,s3@example.com

*Additional fields can be added as below. The course and cohort must already have been manually created.

username,firstname,lastname,email,course1,group1,cohort1

student1,Student,One,s1@example.com,math102,groupA,cohortZ

student2,Student,Two,s2@example.com,math102,groupB,cohort Y

student3,Student,Three,s3@example.com,math102,groupA,cohortZ

== User Fields that can be included==

''Tip:'' We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time.

===Required fields===

These are the required user identification fields:
<code>username,firstname,lastname,email</code>
Validity checks are performed for:
* '''username''' can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
* '''email''' is in the form: ''name@example.com''

===Passwords===

The "password" field is optional if the 'New user password' setting on the upload screen is set to "Create password if needed and send via email" but is required if the setting is "Field required in file".

If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]].

To force password change for a particular user, set the password field to '''changeme'''. If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out. The text for the welcome e-mail is in the language settings in ''Site administration > Language > Language customisation'' with a String identifier of 'newusernewpasswordtext'.

===Optional user fields===

Note: Commas within a field must be encoded as &#44 - the script will decode these back to commas.
Tip: For Boolean fields with only two values, use '''0''' for false and '''1'''for true.

To provide values other than the default you can include one or more of these optional user fields:

<pre>institution,department,city,country,lang,auth,timezone,idnumber,icq,phone1,phone2,address,url,description,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,interests,theme</pre>

Most of the these are user profile fields or user preference fields that belong to the user profile and are the filled in the user or at manual creation. Some however require specific formats:

See [[Additional name fields]] for more details. Key things to note are:

'''country''' - use the country TWO LETTER CODE, in upper case, eg AU,ES,GB,US. These are all UPPER CASE. Using "au" or "es" or "USA" as a country code will result in a database error. If you are having trouble working out the two-letter code for a country, you can consult the list of [https://www.iso.org/obp/ui/#search country names and code elements] available on the ISO Website. A common error is to use UK for United Kingdom; it should be GB.

'''lang''' - use the two letter (or extended four lettter) code as defined in the Moodle language packs, e.g. en, es, en_us, de, in ''Site administration > Language > Language packs''.

'''auth''' - The auth field must be used if the site uses an alternative authentication method, such as LDAP, as otherwise the authentication method will default to manual and users using a different auth method won't be able to log in.
Use the shortname codes defined in Plugins > Authentication for the various types, e.g. manual, nlogin, ldap, cas, mnet, db, none. If you do not include an auth column, then newly created users will be created with the manual account type.

You can set "auth" to "nologin" in your csv file which will mean that then created users cannot login.

'''timezone''' - Should be in the format as found in the Location settings in terms of Zone/Region, eg. Australia/Sydney, Asia/Kathmandu, Europe/Madrid, etc. The entry is case sensitive so Europe/London will work but europe/london will not.

NOTE: Needed: settings for '''mailformat''','''maildisplay''','''htmleditor''','''autosubscribe'''

'''maildigest''' To prevent users from receiving a large number of emails from courses or forced subscription forums use the '''maildigest'''. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

'''maildisplay''' allows you to set the email display option for a user. The options for this field are 0 = Hide my email address from non-privileged users, 1 = Allow everyone to see my email address and 2 = Allow only other course members to see my email address.

'''theme''' User themes may be added by using 'classic', 'boost' or the name of any other installed theme. The value should be the short name of the theme, e.g 'boost' not 'Boost', 'fordson' not 'Fordson'.

===Custom profile field names===

These are optional and depend on whether you have created any custom profile fields in your site. The name of the header in file is of the form 'profile_field_xxxxx' where xxxx is the unique shortname of custom user profile field name as you created it.

The field name should match the case of the profile field shortname. So, for instance if the shortname of your custom profile field is all upper case, for example, ''DOB'', then use a header of ''profile_field_DOB'' to match the case, not ''profile_field_dob'', which will produce a "is not a valid field name" error. Likewise, a mixed case shortname such as ''Dob'' should have a header of ''profile_field_Dob''. (The exception to this is if the shortname is all lower case, then any case will work in the field header, which is a historical quirk: but best practice is to match the case and you will avoid errors.)

<pre>profile_field_xxxxx</pre>

'''Example''': To create a custom field "genre", you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.

For custom profile fields that are dates, use the ISO standard format YYYY-MM-DD, eg. 2014-06-19 which will then be properly localized in the interfaced. For example, a field called dohire for date of hire, the fields could be:
<pre>
username,firstname,lastname,email,profile_field_dohire
blumbergh,Bill,Lumbergh,blumbergh@example.com,1990-02-19
pgibbons,Peter,BGibbons,pgibbons@example.com,1996-06-05
tsmykowski,Tom,Smykowski,tsmykowski@example.com,1970-01-01
</pre>

For custom profile fields that are a menu, use the corresponding value in the menu list from field as you defined it. For example: a custom field 'corporatedivision' with one of three values 'Management', 'Development' or 'Training'. Just insert one of those three words (e.g. 'Training') as the value for that field. Eg.

<pre>
username,firstname,lastname,email,profile_field_corporatedivision
blumbergh,Bill,Lumbergh,blumbergh@example.com,Management
pgibbons,Peter,BGibbons,pgibbons@example.com,Development
tsmykowski,Tom,Smykowski,tsmykowski@example.com,Training
</pre>

=== Special user change fields===

Three special fields are used for managing user accounts, '''oldusername''', '''deleted''' and '''suspended'''. [[#Allow_renames|See below for details]].

===Enrolment fields===

You may optionally enrol users in already existing courses using manual enrolment. Only manual enrolment is done this way; if the manual enrolment method is disabled in a course, then no enrol is done.

You use fields in the upload file of this type:

<pre>course1,type1,role1,group1,enroltimestart1,enrolperiod1,enrolstatus1,course2,type2,role2,group2,enroltimestart2,enrolperiod2,enrolstatus2</pre> etc.

Header fields '''must''' have a numeric suffix such that type1,role1,group1,enrolperiod1 and enrolstatus1 all apply to course1 for course'''1''' to course'''n'''. Even if you are just doing one course enrolment, you must still use the number 1 on the heading name, i.e. course1,role1, etc. Do not use the bare headings without numbers, e.g. course,role, etc as those will generate an error.

'''course#''' is the shortname of the course, if present the user will be enrolled in that course. Do not use the fullname of the course or it will generate an error. This field is the ONLY required field for a succesful enrolment. All the others are optional.

'''type#''' sets the role to be used for the enrolment. A value of 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.

'''role#''' may be used to specify roles directly, using either role short name or the role id (numeric names of roles are not supported). Usually you will use the role name that is the shortname of the role as defined in Users > Permissions > Define roles, eg. student, editingteacher. If the role column is left out, the users will be enroled in the course with the default role, which is normally student.

'''group#''' may be used to assign users to groups in course, using name or id (numeric group names are not supported). NOTE: if the group does not already exist, it will be created.

'''enroltimestart#''' may be used to set the enrolment start time, for each course. If not explicitly set here, the enrolment start time is set to be today.

'''enrolperiod#''' may be used to set the enrolment duration, in days, for each course. If not explicitly set here, all the users will get the duration as set in the Manual enrolment method of the course (which defaults to 0 meaning unlimited.)

'''enrolstatus#''' is optional as by default all newly enrolled users are set to active. If used a value of 1, it will suspend users in the course and if a user is previously set as inactive / suspended then a value of 0 will unsuspend them and make them active again.

=== Cohort membership assignment===

You can assign users to any already existing Cohort by using only the "username" and the "Cohort ID" with just two fields in the file. Note that this is an exception to the usual case where the firstname, lastname and email address of the user are required.

'''cohort#''' is the form to use and like enrolment in courses, you have to add a number to each header, so cohort1,cohort2, etc.

Internal cohort id numbers or non-numeric Cohort IDs of existing cohorts must be used; do not use the full name are not allowed. (Note that cohort id is what is usually known elsewhere as the "shortname".)

Here is a sample CSV file:

<pre>
username,cohort1,cohort2
student1,nursing,2016class
student2,nursing,2014class
student3,nursing,2014class
</pre>

=== MNet ===

Existing [[MNet]]users can be added to courses, groups or cohorts as below by using the field header '''mnethostid'''

#enrolling to courses: username+mnethostid+course required
#adding to group: username+mnethostid+course+group required
#adding to cohort: username+mnethostid+cohort required
#suspending/reviving accounts: username+mnethostid+suspended required

All other operations are ignored. You can not add users, delete them or update them (such as change names or email, profile fields, etc.)

=== Set system roles ===
Users may also be assigned to already defined system roles, using the shortname of the system role as defined in ''Site administration > Users > Permissions > Define roles'' for roles with a system context defined.

<code>sysrole1,sysrole2,sysrole3</code> etc

Users may be uploaded to a system role (usually Manager or Course creator) by entering the shortname of that role. Other roles can only be uploaded if they have already been assigned in the 'system' context. See [[Creating custom roles]]. Multiple roles can be assigned using sysrole2, sysrole3, etc. fields. Note that the number suffix in no way relates to the number suffixes on the enrolment fields. The numbers must go up in sequence starting at 1.

Unassigning system roles
Users can also be removed from a given system role by entering the shortname of that role prefixed with a minus symbol: '-'. If the user is currently assigned to that role, they are removed from it. If the user is not currently assigned to that system role, the field value is ignored. However, the field value must refer to a system role that does exist on the system, otherwise an error will occur.
[[File:GlobalRoles1.png|thumb|500px|center|Example of a file for uploading users with global/system roles]]

==Upload user process==

# Create file for uploading
# Go to ''Site administration > Users > Accounts > Upload users''
# Add file to upload
# Upload users preview - check settings and default user profile settings
# Upload users preview - click "Upload users"
# Upload users results - shows list of users, exceptions made in upload and summary of number of users
# Upload users results - click "Continue"
# Returns to Upload users screen

==Updating users preview==
There are various settings to better control the desired upload behaviour. These settings are found on the "Upload users preview" page.

'''Warning''': errors updating existing accounts can affect your users badly. '''''Be careful''''' when using the options to update.

====Upload type====
The Upload type specifies how to handle existing accounts.

;Add new only, skip existing users : is the default Moodle upload type. It creates a new user account for each new record in the uploaded file. If an existing username is found in the uploaded file matches an existing username, that record is '''skipped'''. By skipping the existing user account, the data in the existing record is not touched (in contrast to the "Add new and update existing users" option) and a second new user account is '''not''' created (in contrast to the "Add all, append number to usernames if needed" option).

;Add all, append number to usernames if needed : creates a new user account for each record in the uploaded file. If an existing user account is found, a new account will be created with a number appended to the username. For example, if a user account for username 'jsmith' already exists and a new record in the uploaded file contains a record forusername 'jsmith' an additional user account is created with a 1 '''appended''' to the username to produce user 'jsmith1'.

;Add new and update existing users : creates a new user account for each new user in the upload file. If an existing user account with the same username is found, the account information is '''updated''' by the data in the uploaded file.

;Update existing users only : ignores any new users found in the upload file and updates the user account if a matching username record is found in the uploaded file.

====New user password====
When creating a new user account Moodle can create a new password (if one is not provided) or require a password in the uploaded file.

;Create password if needed and send via email: creates a random default password for each new user account if one is not provided in the uploaded file, and emails the user their user information and new password.

;Field required in file : requires that a password be provided in the uploaded file in order. If a password is not provided, an error is generated and the user account is not created. No notification of this user information or password is sent to the user.

====Existing user details====
The Existing user details options are only available when the Upload type allows existing user accounts to be updated. It specifies how Moodle should process user detail information for existing users.

;No changes : ignores user detail data in the uploaded and leaves the existing user account data unchanged.
;Override with file : overwrites data in the existing user account with the data provided in the uploaded file.
;Override with file and defaults : overwrites data in the existing user account with data provided in the uploaded file and fills in the default values for existing user details when no data is provided in the uploaded file.
;Fill in missing from file and defaults : adds data in the existing user account with data provided in the uploaded file if the field is empty (does not already contain data) and fills in the default values for existing user details when no data is provided in the uploaded file.

====Existing user password====
The Existing user password option appears when you you have set the "Existing user details" setting to "Overwrite with file". It specifies how to handle password data for existing user accounts, to change them or leave them as it. This is a bit of insurance to make sure that you really want to mass change user passwords.

;No changes : ignores password field in the uploaded user file and leaves the existing user account password untouched
;Update : overwrites the existing user account password with the password provided in the uploaded file

====Force password change====
The Force password change option specifies when to tag a user account so that the next login attempt will require the user to change the user's password.

;Users having a weak password : If the user account has a weak password as defined by the site's [[Password_policy#Password_policy|Password policy]] then the user will be forced to change the password during the next login attempt. This option is not shown if there the site does not have a [[Password_policy#Password_policy|Password policy]].
;None : None of the users in the uploaded file will be forced to change the password during the user's next login attempt.
;All : All of the users in the uploaded file will be forced to change the password during the user's next login attempt.

====Allow renames====
If the uploaded file contains the special '''oldusername''' field, it is possible to rename a user from the '''oldusername''' to a new '''username'''. The default setting is to '''not''' allow renames. Keep in mind that renaming a user will require the user to use the new username when logging in.
;No : ignores the '''oldusername''' field and leaves the existing user account's username field unchanged.
;Yes : allows the existing user account's username to be changed by the data provided in the uploaded file's username field. The '''oldusername''' will be searched for and then updated with the data provided in the username column.

====Allow deletes====
If the uploaded file contains the '''deleted''' special field, it is possible to use the upload file to delete existing user accounts. The default setting is to '''not''' allow deletes. Keep in mind that deleting a user account will prevent that user from logging in. As a protection, site administrator user accounts cannot be deleted with this method.
;No : ignores the '''deleted''' special field in the uploaded file and leaves the existing user account unchanged
;Yes : allows the existing user account to be deleted when the value of the of the '''deleted''' field is 1.

====Allow suspending and activating of accounts====
If the uploaded file contains the '''suspended''' special field, it is possible to use the upload file to either suspend or make active (unsuspend) existing user accounts. The default setting is to allow suspending/activating of existing user accounts. Keep in mind that suspending an existing user account will prevent that user from logging in.
;Yes : allows the existing user account to be suspended when the value of the of the '''suspended''' field is 1.
;No : ignores the '''suspended''' special field in the uploaded file and leaves the existing user account status unchanged.

====Prevent email address duplicates====
It is possible, but '''not''' recommended to upload users with duplicate email addresses. By default, uploading users with duplicate email addresses is prevented. To allow duplicate email addresses, go to Site administration ► Plugins ► Authentication ► Manage authentication. You can tick "Allow accounts with same email". Then on the upload users screen you will be allowed to change the "Prevent email address duplicates" setting.

However, doing this is not recommended for file uploads. Test thoroughly any user uploads before implementing.

For more info, see the [[Managing_authentication#Allow_accounts_with_same_email|Managing authentication]] docs page
;Yes : prevents user accounts from being created from the uploaded if an existing user account already has the same email address as found in the uploaded file's '''email''' column.
;No : allows user accounts to be created if an existing user account already has the same email address found in the uploaded file's '''email''' column.

====Standardise usernames====
Standardise usernames is used by default to convert the username to all lower case and to strip out illegal characters. It is possible to not standardise the usernames; however, doing so is '''not''' recommended.
;Yes : standardises usernames found in the uploaded file before updating existing or creating new user accounts so that the username contains only lowercase letters and numbers.
;No : skips standardising usernames found in the uploaded file so that the newly created or updated usernames will be exactly as they are in the uploaded file ('''not recommended''').

For those seeking a more technical explanation, the process for standardising the usernames consists of ensuring the characters are all UTF-8 (fix_utf8) encoded, converting the username to lower case, and then stripping out non-letters/non-number characters (unless ''Site administration > Security > Site policies > Allow extended characters in usernames'' is set on) with something similar to:

<code>$username = preg_replace('/[^-\.@_a-z0-9]/', '', $username);</code>

====Select for bulk user actions====
After the uploaded file has finished being processed (all new accounts have been created and existing accounts updated as specified by the previous settings), there is an option to select some of those user accounts to perform additional [[admin/user/user_bulk|bulk user actions]] such as
*Confirm user accounts created through Email-based self-registration which are not yet confirmed by the user
*Send a message (requires Messaging to be enabled)
*Delete user accounts
*Display a list of users on a page
*Download user data in text, ODS or Excel file format
*Force users to change their passwords
*Add users to a cohort

By default, no users are selected for [[admin/user/user_bulk|bulk user actions]].

;No : No users are selected for [[admin/user/user_bulk|bulk user actions]]
;New users : Only newly created users are selected for [[admin/user/user_bulk|bulk user actions]]
;Updated users : Only updated user accounts are selected for [[admin/user/user_bulk|bulk user actions]]
;All users : All users found (existing updated users and newly created user accounts) in the uploaded file are selected for [[admin/user/user_bulk|bulk user actions]]

===Default values===

You can provide default user values for some fields not included in the uploaded file. Some fields include:

*Email display
*Forum auto-subscribe
*City/town
*ID number
*Institution
*Department

By clicking the '''Show more....''' link, other default user profile fields will show up. You can set 17 different fields here, including the Authentication method, Country. Language, Timezone, as well as most other standard User profile fields.

'''Other fields'''

If you have created any custom profile fields for your users, they will show up here.

==Upload user results ==
After accepting the preview settings by clicking on "Upload users", you should see the the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The results screen; everything went well!]]
This screen will show you any exceptions or changes that were made to each user in the upload process. For example if you were updating user information, the updated information will be shown. Or if a user was not added that record will be highlighted.

The screen will summarize how many users were uploaded or updated, indicate the number of weak passwords and the number of errors.

==Advanced potentials of Upload user==
===Templates===

''Note: This section needs checking and updating if necessary for Moodle 2.0. Please do so and remove this note when finished.''

The default values are processed as templates in which the following codes are allowed:

* %l - will be replaced by the lastname
* %f - will be replaced by the firstname
* %u - will be replaced by the username
* %% - will be replaced by the %

Between the percent sign (%) and any code letter (l, f or u) the following modifiers are allowed:

* (-) minus sign - the information specified by the code letter will be converted to lowercase
* (+) plus sign - the information specified by the code letter will be converted to UPPERCASE
* (~) tilde sign - the information specified by the code letter will be converted to Title Case
* a decimal number - the information specified by the code letter will be truncated to that many characters

For example, if the firstname is John and the lastname is Doe, the following values will be obtained with the specified templates:

* %l%f = DoeJohn
* %l%1f = DoeJ
* %-l%+f = doeJOHN
* %-f_%-l = john_doe
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (if the username is jdoe or %-1f%-l)

Template processing is done only on default values, and not on the values retrieved from the CSV file.

In order to create correct Moodle usernames, the username is always converted to lowercase. Moreover, if the "Allow extended characters in usernames" option in the Site policies page is off, characters different to letters, digits, dash (-) and dot (.) are removed. For example if the firstname is John Jr. and the lastname is Doe, the username %-f_%-l will produce john jr._doe when Allow extended characters in usernames is on, and johnjr.doe when off.

When the "New username duplicate handling" setting is set to Append counter, an auto-increment counter will be append to duplicate usernames produced by the template. For example, if the CSV file contains the users named John Doe, Jane Doe and Jenny Doe without explicit usernames, the default username is %-1f%-l and New username duplicate handling is set to Append counter, then the usernames produced will be jdoe, jdoe2 and jdoe3.

===Deleting accounts===

If the '''deleted''' field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for '''username'''. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

''Tip:'' A similar field is available for '''suspended'''. This enables a user account to be temporarily disabled rather than completely removed.

Deleting and uploading accounts could be done with a single CSV file. For example, the following file will add the user Tom Jones and delete the user reznort:

username,firstname,lastname,deleted
jonest,Tom,Jones,0
reznort,,,1

==Encoding file format==
On the initial Upload user screen, you may select the file encoding format from a pull down list. These include UTF-8 (the default), ASCII, ISO-8859-1 to ISO-8859-11 or any one of over 36 formats.

==Hints==

===Spreadsheet===

If you use a spreadsheet program such as Excel to create your .csv file, check the resulting output in a text editor before you upload it. It is possible to get trailing commas on each line from an empty field if you have added and deleted columns of information prior to saving the final file. Also check the character encoding. A csv file is a simple text file (ASCII or Unicode) that can be used to upload user accounts.

Excel translates passwords that begin with - (minus) or + (plus) as zero. Even when saving as .csv and saying "Yes" to "Keep this format, and leave out any incompatible features." Check for this before uploading, as a zero halts the upload process.

If you use a formula in Excel to create fields (for example, the concatenate function to create a user name), then remember to copy the cells with the formula and use special paste with values checked to make them into an acceptable data for a csv file.

The upload will also fail if you have trailing spaces at the end of your data fields. Often, this can not be removed with a simple Find " " and Replace with "". If information has been copied from web sources than it is possible to include non-breaking spaces which will prevent your upload from being completed correctly. To find these invisible spaces, use the Find and Replace function in Excel. In the find field, hold alt and type 0160. Leave the replace field blank.

===Field size limits===
Some fields have maximum character lengths, as defined in the database fields. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. The error will be "User not added - error".

The sizes of some common fields, in number of characters, are currently (3.2):

*username - 100
*password - 255
*idnumber - 255
*firstname - 100
*lastname - 100
*lastnamephonetic - 255
*firstnamephonetic - 255
*middlename - 255
*alternatename - 255
*institution - 255
*department - 255
*address - 255
*city - 120
*icq -15
*skype - 50
*yahoo - 50
*aim - 50
*msn - 50
*phone1 - 20
*phone2 - 20

===All user fields listed here===
:All the user fields that are valid in an upload file are listed below, except for any custom fields you may have created (for which see below.)

<pre>firstname,lastname,username,email,password,auth,idnumber,institution,department,city,country,timezone,lang,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,skype,msn,aim,yahoo,icq,phone1,phone2,address,url,description,descriptionformat,interests,oldusername,deleted,suspended,alternatename,lastnamephonetic,firstnamephonetic,middlename</pre>

The enrolments into courses information are <pre>course1,type1,role1,group1,enrolperiod1,enrolstatus1</pre>
where each enrolment is grouped by number.

===Capabilities===

You may wish to create a limited role to allow some users access to this function. Create a role at the system/site level with the following capabilities allowed:
* moodle/site:uploadusers
* moodle/role:assign

And
* In 'Allow role assignments' tab of this new role, permit it to assign the required roles that it may be uploading, especially Student, but also Teacher, Non-editing Teacher, and any other custom roles you may have created, which will be used in the uploads to assign users to.

In particular, don't forget the moodle/role:assign capability (even if these users have it in the courses they will be enrolling users in - it won't work).

== See also ==
* [[Flat file]] enrolment
* [[User profile fields]] for details of how to include data about custom user profile fields in the upload users file
* [[Upload courses]]

Forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[de:Nutzerliste hochladen]]
[[es:Subir usuarios]]

Upload users

2020-12-07T16:18:58Z

Tsala: Upload users via CLI (MDL-65451)

{{Accounts}}
==Uploading users via text file==

There are many options for uploading information (fields associated with a user) with this method: from enrolling users in multiple courses with course specific [[Roles|roles]] to updating user information in the [[User profile]] to deleting users from the site.

''Tip:'' It is usually not necessary to upload users in bulk with Upload users. To keep maintenance work down you should first explore forms of authentication that do not require manual maintenance, such as [[External database authentication|connecting to existing external databases]] or letting the users create their own accounts ([[Self enrolment]]). See [[Authentication]] for more information.

{{MediaPlayer | url = https://youtu.be/blUw-ZbhFqw| desc = How to bulk upload users and add to courses}}

==File formats for upload users file==
The upload users file has fields separated by a comma (or other delimiter) ONLY - no space. The first line contains the valid field names. The rest of the lines (records) contain information about each user.

''Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.

''Tip:'' You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors (eg, [https://notepad-plus-plus.org/ Notepad++]) for verification.

===Valid upload file for testing===

*From Site administration / Users / Upload users, an example text (.csv) file is available. It includes can be downloaded and adapted to your needs.

username,firstname,lastname,email

student1,Student,One,s1@example.com

student2,Student,Two,s2@example.com

student3,Student,Three,s3@example.com

*Additional fields can be added as below. The course and cohort must already have been manually created.

username,firstname,lastname,email,course1,group1,cohort1

student1,Student,One,s1@example.com,math102,groupA,cohortZ

student2,Student,Two,s2@example.com,math102,groupB,cohort Y

student3,Student,Three,s3@example.com,math102,groupA,cohortZ

== User Fields that can be included==

''Tip:'' We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time.

===Required fields===

These are the required user identification fields:
<code>username,firstname,lastname,email</code>
Validity checks are performed for:
* '''username''' can only contain alphabetical '''lowercase''' letters , numbers, hypen '-', underscore '_', period '.', or at-sign '@'
* '''email''' is in the form: ''name@example.com''

===Passwords===

The "password" field is optional if the 'New user password' setting on the upload screen is set to "Create password if needed and send via email" but is required if the setting is "Field required in file".

If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]].

To force password change for a particular user, set the password field to '''changeme'''. If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out. The text for the welcome e-mail is in the language settings in ''Site administration > Language > Language customisation'' with a String identifier of 'newusernewpasswordtext'.

===Optional user fields===

Note: Commas within a field must be encoded as &#44 - the script will decode these back to commas.
Tip: For Boolean fields with only two values, use '''0''' for false and '''1'''for true.

To provide values other than the default you can include one or more of these optional user fields:

<pre>institution,department,city,country,lang,auth,timezone,idnumber,icq,phone1,phone2,address,url,description,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,interests,theme</pre>

Most of the these are user profile fields or user preference fields that belong to the user profile and are the filled in the user or at manual creation. Some however require specific formats:

See [[Additional name fields]] for more details. Key things to note are:

'''country''' - use the country TWO LETTER CODE, in upper case, eg AU,ES,GB,US. These are all UPPER CASE. Using "au" or "es" or "USA" as a country code will result in a database error. If you are having trouble working out the two-letter code for a country, you can consult the list of [https://www.iso.org/obp/ui/#search country names and code elements] available on the ISO Website. A common error is to use UK for United Kingdom; it should be GB.

'''lang''' - use the two letter (or extended four lettter) code as defined in the Moodle language packs, e.g. en, es, en_us, de, in ''Site administration > Language > Language packs''.

'''auth''' - The auth field must be used if the site uses an alternative authentication method, such as LDAP, as otherwise the authentication method will default to manual and users using a different auth method won't be able to log in.
Use the shortname codes defined in Plugins > Authentication for the various types, e.g. manual, nlogin, ldap, cas, mnet, db, none. If you do not include an auth column, then newly created users will be created with the manual account type.

You can set "auth" to "nologin" in your csv file which will mean that then created users cannot login.

'''timezone''' - Should be in the format as found in the Location settings in terms of Zone/Region, eg. Australia/Sydney, Asia/Kathmandu, Europe/Madrid, etc. The entry is case sensitive so Europe/London will work but europe/london will not.

NOTE: Needed: settings for '''mailformat''','''maildisplay''','''htmleditor''','''autosubscribe'''

'''maildigest''' To prevent users from receiving a large number of emails from courses or forced subscription forums use the '''maildigest'''. The options for this field are 0 = No digest, 1 = Complete digest and 2 = Digest with just subjects.

'''maildisplay''' allows you to set the email display option for a user. The options for this field are 0 = Hide my email address from non-privileged users, 1 = Allow everyone to see my email address and 2 = Allow only other course members to see my email address.

'''theme''' User themes may be added by using 'classic', 'boost' or the name of any other installed theme. The value should be the short name of the theme, e.g 'boost' not 'Boost', 'fordson' not 'Fordson'.

===Custom profile field names===

These are optional and depend on whether you have created any custom profile fields in your site. The name of the header in file is of the form 'profile_field_xxxxx' where xxxx is the unique shortname of custom user profile field name as you created it.

The field name should match the case of the profile field shortname. So, for instance if the shortname of your custom profile field is all upper case, for example, ''DOB'', then use a header of ''profile_field_DOB'' to match the case, not ''profile_field_dob'', which will produce a "is not a valid field name" error. Likewise, a mixed case shortname such as ''Dob'' should have a header of ''profile_field_Dob''. (The exception to this is if the shortname is all lower case, then any case will work in the field header, which is a historical quirk: but best practice is to match the case and you will avoid errors.)

<pre>profile_field_xxxxx</pre>

'''Example''': To create a custom field "genre", you must write a shortname "genre" in the new field, and write "profile_field_genre" in the header of the .csv file.

For custom profile fields that are dates, use the ISO standard format YYYY-MM-DD, eg. 2014-06-19 which will then be properly localized in the interfaced. For example, a field called dohire for date of hire, the fields could be:
<pre>
username,firstname,lastname,email,profile_field_dohire
blumbergh,Bill,Lumbergh,blumbergh@example.com,1990-02-19
pgibbons,Peter,BGibbons,pgibbons@example.com,1996-06-05
tsmykowski,Tom,Smykowski,tsmykowski@example.com,1970-01-01
</pre>

For custom profile fields that are a menu, use the corresponding value in the menu list from field as you defined it. For example: a custom field 'corporatedivision' with one of three values 'Management', 'Development' or 'Training'. Just insert one of those three words (e.g. 'Training') as the value for that field. Eg.

<pre>
username,firstname,lastname,email,profile_field_corporatedivision
blumbergh,Bill,Lumbergh,blumbergh@example.com,Management
pgibbons,Peter,BGibbons,pgibbons@example.com,Development
tsmykowski,Tom,Smykowski,tsmykowski@example.com,Training
</pre>

=== Special user change fields===

Three special fields are used for managing user accounts, '''oldusername''', '''deleted''' and '''suspended'''. [[#Allow_renames|See below for details]].

===Enrolment fields===

You may optionally enrol users in already existing courses using manual enrolment. Only manual enrolment is done this way; if the manual enrolment method is disabled in a course, then no enrol is done.

You use fields in the upload file of this type:

<pre>course1,type1,role1,group1,enroltimestart1,enrolperiod1,enrolstatus1,course2,type2,role2,group2,enroltimestart2,enrolperiod2,enrolstatus2</pre> etc.

Header fields '''must''' have a numeric suffix such that type1,role1,group1,enrolperiod1 and enrolstatus1 all apply to course1 for course'''1''' to course'''n'''. Even if you are just doing one course enrolment, you must still use the number 1 on the heading name, i.e. course1,role1, etc. Do not use the bare headings without numbers, e.g. course,role, etc as those will generate an error.

'''course#''' is the shortname of the course, if present the user will be enrolled in that course. Do not use the fullname of the course or it will generate an error. This field is the ONLY required field for a succesful enrolment. All the others are optional.

'''type#''' sets the role to be used for the enrolment. A value of 1 is default course role, 2 is legacy Teacher role and 3 is legacy Non-editing Teacher.

'''role#''' may be used to specify roles directly, using either role short name or the role id (numeric names of roles are not supported). Usually you will use the role name that is the shortname of the role as defined in Users > Permissions > Define roles, eg. student, editingteacher. If the role column is left out, the users will be enroled in the course with the default role, which is normally student.

'''group#''' may be used to assign users to groups in course, using name or id (numeric group names are not supported). NOTE: if the group does not already exist, it will be created.

'''enroltimestart#''' may be used to set the enrolment start time, for each course. If not explicitly set here, the enrolment start time is set to be today.

'''enrolperiod#''' may be used to set the enrolment duration, in days, for each course. If not explicitly set here, all the users will get the duration as set in the Manual enrolment method of the course (which defaults to 0 meaning unlimited.)

'''enrolstatus#''' is optional as by default all newly enrolled users are set to active. If used a value of 1, it will suspend users in the course and if a user is previously set as inactive / suspended then a value of 0 will unsuspend them and make them active again.

=== Cohort membership assignment===

You can assign users to any already existing Cohort by using only the "username" and the "Cohort ID" with just two fields in the file. Note that this is an exception to the usual case where the firstname, lastname and email address of the user are required.

'''cohort#''' is the form to use and like enrolment in courses, you have to add a number to each header, so cohort1,cohort2, etc.

Internal cohort id numbers or non-numeric Cohort IDs of existing cohorts must be used; do not use the full name are not allowed. (Note that cohort id is what is usually known elsewhere as the "shortname".)

Here is a sample CSV file:

<pre>
username,cohort1,cohort2
student1,nursing,2016class
student2,nursing,2014class
student3,nursing,2014class
</pre>

=== MNet ===

Existing [[MNet]]users can be added to courses, groups or cohorts as below by using the field header '''mnethostid'''

#enrolling to courses: username+mnethostid+course required
#adding to group: username+mnethostid+course+group required
#adding to cohort: username+mnethostid+cohort required
#suspending/reviving accounts: username+mnethostid+suspended required

All other operations are ignored. You can not add users, delete them or update them (such as change names or email, profile fields, etc.)

=== Set system roles ===
Users may also be assigned to already defined system roles, using the shortname of the system role as defined in ''Site administration > Users > Permissions > Define roles'' for roles with a system context defined.

<code>sysrole1,sysrole2,sysrole3</code> etc

Users may be uploaded to a system role (usually Manager or Course creator) by entering the shortname of that role. Other roles can only be uploaded if they have already been assigned in the 'system' context. See [[Creating custom roles]]. Multiple roles can be assigned using sysrole2, sysrole3, etc. fields. Note that the number suffix in no way relates to the number suffixes on the enrolment fields. The numbers must go up in sequence starting at 1.

Unassigning system roles
Users can also be removed from a given system role by entering the shortname of that role prefixed with a minus symbol: '-'. If the user is currently assigned to that role, they are removed from it. If the user is not currently assigned to that system role, the field value is ignored. However, the field value must refer to a system role that does exist on the system, otherwise an error will occur.
[[File:GlobalRoles1.png|thumb|500px|center|Example of a file for uploading users with global/system roles]]

==Upload user process==

# Create file for uploading
# Go to ''Site administration > Users > Accounts > Upload users''
# Add file to upload
# Upload users preview - check settings and default user profile settings
# Upload users preview - click "Upload users"
# Upload users results - shows list of users, exceptions made in upload and summary of number of users
# Upload users results - click "Continue"
# Returns to Upload users screen

==Updating users preview==
There are various settings to better control the desired upload behaviour. These settings are found on the "Upload users preview" page.

'''Warning''': errors updating existing accounts can affect your users badly. '''''Be careful''''' when using the options to update.

====Upload type====
The Upload type specifies how to handle existing accounts.

;Add new only, skip existing users : is the default Moodle upload type. It creates a new user account for each new record in the uploaded file. If an existing username is found in the uploaded file matches an existing username, that record is '''skipped'''. By skipping the existing user account, the data in the existing record is not touched (in contrast to the "Add new and update existing users" option) and a second new user account is '''not''' created (in contrast to the "Add all, append number to usernames if needed" option).

;Add all, append number to usernames if needed : creates a new user account for each record in the uploaded file. If an existing user account is found, a new account will be created with a number appended to the username. For example, if a user account for username 'jsmith' already exists and a new record in the uploaded file contains a record forusername 'jsmith' an additional user account is created with a 1 '''appended''' to the username to produce user 'jsmith1'.

;Add new and update existing users : creates a new user account for each new user in the upload file. If an existing user account with the same username is found, the account information is '''updated''' by the data in the uploaded file.

;Update existing users only : ignores any new users found in the upload file and updates the user account if a matching username record is found in the uploaded file.

====New user password====
When creating a new user account Moodle can create a new password (if one is not provided) or require a password in the uploaded file.

;Create password if needed and send via email: creates a random default password for each new user account if one is not provided in the uploaded file, and emails the user their user information and new password.

;Field required in file : requires that a password be provided in the uploaded file in order. If a password is not provided, an error is generated and the user account is not created. No notification of this user information or password is sent to the user.

====Existing user details====
The Existing user details options are only available when the Upload type allows existing user accounts to be updated. It specifies how Moodle should process user detail information for existing users.

;No changes : ignores user detail data in the uploaded and leaves the existing user account data unchanged.
;Override with file : overwrites data in the existing user account with the data provided in the uploaded file.
;Override with file and defaults : overwrites data in the existing user account with data provided in the uploaded file and fills in the default values for existing user details when no data is provided in the uploaded file.
;Fill in missing from file and defaults : adds data in the existing user account with data provided in the uploaded file if the field is empty (does not already contain data) and fills in the default values for existing user details when no data is provided in the uploaded file.

====Existing user password====
The Existing user password option appears when you you have set the "Existing user details" setting to "Overwrite with file". It specifies how to handle password data for existing user accounts, to change them or leave them as it. This is a bit of insurance to make sure that you really want to mass change user passwords.

;No changes : ignores password field in the uploaded user file and leaves the existing user account password untouched
;Update : overwrites the existing user account password with the password provided in the uploaded file

====Force password change====
The Force password change option specifies when to tag a user account so that the next login attempt will require the user to change the user's password.

;Users having a weak password : If the user account has a weak password as defined by the site's [[Password_policy#Password_policy|Password policy]] then the user will be forced to change the password during the next login attempt. This option is not shown if there the site does not have a [[Password_policy#Password_policy|Password policy]].
;None : None of the users in the uploaded file will be forced to change the password during the user's next login attempt.
;All : All of the users in the uploaded file will be forced to change the password during the user's next login attempt.

====Allow renames====
If the uploaded file contains the special '''oldusername''' field, it is possible to rename a user from the '''oldusername''' to a new '''username'''. The default setting is to '''not''' allow renames. Keep in mind that renaming a user will require the user to use the new username when logging in.
;No : ignores the '''oldusername''' field and leaves the existing user account's username field unchanged.
;Yes : allows the existing user account's username to be changed by the data provided in the uploaded file's username field. The '''oldusername''' will be searched for and then updated with the data provided in the username column.

====Allow deletes====
If the uploaded file contains the '''deleted''' special field, it is possible to use the upload file to delete existing user accounts. The default setting is to '''not''' allow deletes. Keep in mind that deleting a user account will prevent that user from logging in. As a protection, site administrator user accounts cannot be deleted with this method.
;No : ignores the '''deleted''' special field in the uploaded file and leaves the existing user account unchanged
;Yes : allows the existing user account to be deleted when the value of the of the '''deleted''' field is 1.

====Allow suspending and activating of accounts====
If the uploaded file contains the '''suspended''' special field, it is possible to use the upload file to either suspend or make active (unsuspend) existing user accounts. The default setting is to allow suspending/activating of existing user accounts. Keep in mind that suspending an existing user account will prevent that user from logging in.
;Yes : allows the existing user account to be suspended when the value of the of the '''suspended''' field is 1.
;No : ignores the '''suspended''' special field in the uploaded file and leaves the existing user account status unchanged.

====Prevent email address duplicates====
It is possible, but '''not''' recommended to upload users with duplicate email addresses. By default, uploading users with duplicate email addresses is prevented. To allow duplicate email addresses, go to Site administration ► Plugins ► Authentication ► Manage authentication. You can tick "Allow accounts with same email". Then on the upload users screen you will be allowed to change the "Prevent email address duplicates" setting.

However, doing this is not recommended for file uploads. Test thoroughly any user uploads before implementing.

For more info, see the [[Managing_authentication#Allow_accounts_with_same_email|Managing authentication]] docs page
;Yes : prevents user accounts from being created from the uploaded if an existing user account already has the same email address as found in the uploaded file's '''email''' column.
;No : allows user accounts to be created if an existing user account already has the same email address found in the uploaded file's '''email''' column.

====Standardise usernames====
Standardise usernames is used by default to convert the username to all lower case and to strip out illegal characters. It is possible to not standardise the usernames; however, doing so is '''not''' recommended.
;Yes : standardises usernames found in the uploaded file before updating existing or creating new user accounts so that the username contains only lowercase letters and numbers.
;No : skips standardising usernames found in the uploaded file so that the newly created or updated usernames will be exactly as they are in the uploaded file ('''not recommended''').

For those seeking a more technical explanation, the process for standardising the usernames consists of ensuring the characters are all UTF-8 (fix_utf8) encoded, converting the username to lower case, and then stripping out non-letters/non-number characters (unless ''Site administration > Security > Site policies > Allow extended characters in usernames'' is set on) with something similar to:

<code>$username = preg_replace('/[^-\.@_a-z0-9]/', '', $username);</code>

====Select for bulk user actions====
After the uploaded file has finished being processed (all new accounts have been created and existing accounts updated as specified by the previous settings), there is an option to select some of those user accounts to perform additional [[admin/user/user_bulk|bulk user actions]] such as
*Confirm user accounts created through Email-based self-registration which are not yet confirmed by the user
*Send a message (requires Messaging to be enabled)
*Delete user accounts
*Display a list of users on a page
*Download user data in text, ODS or Excel file format
*Force users to change their passwords
*Add users to a cohort

By default, no users are selected for [[admin/user/user_bulk|bulk user actions]].

;No : No users are selected for [[admin/user/user_bulk|bulk user actions]]
;New users : Only newly created users are selected for [[admin/user/user_bulk|bulk user actions]]
;Updated users : Only updated user accounts are selected for [[admin/user/user_bulk|bulk user actions]]
;All users : All users found (existing updated users and newly created user accounts) in the uploaded file are selected for [[admin/user/user_bulk|bulk user actions]]

===Default values===

You can provide default user values for some fields not included in the uploaded file. Some fields include:

*Email display
*Forum auto-subscribe
*City/town
*ID number
*Institution
*Department

By clicking the '''Show more....''' link, other default user profile fields will show up. You can set 17 different fields here, including the Authentication method, Country. Language, Timezone, as well as most other standard User profile fields.

'''Other fields'''

If you have created any custom profile fields for your users, they will show up here.

==Upload user results ==
After accepting the preview settings by clicking on "Upload users", you should see the the Upload users results screen.
[[File:Upload users results 2.0.JPG|thumb|center|The results screen; everything went well!]]
This screen will show you any exceptions or changes that were made to each user in the upload process. For example if you were updating user information, the updated information will be shown. Or if a user was not added that record will be highlighted.

The screen will summarize how many users were uploaded or updated, indicate the number of weak passwords and the number of errors.

==Advanced potentials of Upload user==
===Templates===

''Note: This section needs checking and updating if necessary for Moodle 2.0. Please do so and remove this note when finished.''

The default values are processed as templates in which the following codes are allowed:

* %l - will be replaced by the lastname
* %f - will be replaced by the firstname
* %u - will be replaced by the username
* %% - will be replaced by the %

Between the percent sign (%) and any code letter (l, f or u) the following modifiers are allowed:

* (-) minus sign - the information specified by the code letter will be converted to lowercase
* (+) plus sign - the information specified by the code letter will be converted to UPPERCASE
* (~) tilde sign - the information specified by the code letter will be converted to Title Case
* a decimal number - the information specified by the code letter will be truncated to that many characters

For example, if the firstname is John and the lastname is Doe, the following values will be obtained with the specified templates:

* %l%f = DoeJohn
* %l%1f = DoeJ
* %-l%+f = doeJOHN
* %-f_%-l = john_doe
*<nowiki> http://www.example.com/~%u/</nowiki> results in <nowiki>http://www.example.com/~jdoe/</nowiki> (if the username is jdoe or %-1f%-l)

Template processing is done only on default values, and not on the values retrieved from the CSV file.

In order to create correct Moodle usernames, the username is always converted to lowercase. Moreover, if the "Allow extended characters in usernames" option in the Site policies page is off, characters different to letters, digits, dash (-) and dot (.) are removed. For example if the firstname is John Jr. and the lastname is Doe, the username %-f_%-l will produce john jr._doe when Allow extended characters in usernames is on, and johnjr.doe when off.

When the "New username duplicate handling" setting is set to Append counter, an auto-increment counter will be append to duplicate usernames produced by the template. For example, if the CSV file contains the users named John Doe, Jane Doe and Jenny Doe without explicit usernames, the default username is %-1f%-l and New username duplicate handling is set to Append counter, then the usernames produced will be jdoe, jdoe2 and jdoe3.

===Deleting accounts===

If the '''deleted''' field is present, users with value 1 for it will be deleted. In this case, all the fields may be omitted, except for '''username'''. After uploading the file, be sure to change the "Upload type" to "Update existing users only" and the "Allow deletes" option to "Yes".

''Tip:'' A similar field is available for '''suspended'''. This enables a user account to be temporarily disabled rather than completely removed.

Deleting and uploading accounts could be done with a single CSV file. For example, the following file will add the user Tom Jones and delete the user reznort:

username,firstname,lastname,deleted
jonest,Tom,Jones,0
reznort,,,1

==Encoding file format==
On the initial Upload user screen, you may select the file encoding format from a pull down list. These include UTF-8 (the default), ASCII, ISO-8859-1 to ISO-8859-11 or any one of over 36 formats.

==Hints==

===Spreadsheet===

If you use a spreadsheet program such as Excel to create your .csv file, check the resulting output in a text editor before you upload it. It is possible to get trailing commas on each line from an empty field if you have added and deleted columns of information prior to saving the final file. Also check the character encoding. A csv file is a simple text file (ASCII or Unicode) that can be used to upload user accounts.

Excel translates passwords that begin with - (minus) or + (plus) as zero. Even when saving as .csv and saying "Yes" to "Keep this format, and leave out any incompatible features." Check for this before uploading, as a zero halts the upload process.

If you use a formula in Excel to create fields (for example, the concatenate function to create a user name), then remember to copy the cells with the formula and use special paste with values checked to make them into an acceptable data for a csv file.

The upload will also fail if you have trailing spaces at the end of your data fields. Often, this can not be removed with a simple Find " " and Replace with "". If information has been copied from web sources than it is possible to include non-breaking spaces which will prevent your upload from being completed correctly. To find these invisible spaces, use the Find and Replace function in Excel. In the find field, hold alt and type 0160. Leave the replace field blank.

===Field size limits===
Some fields have maximum character lengths, as defined in the database fields. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. The error will be "User not added - error".

The sizes of some common fields, in number of characters, are currently (3.2):

*username - 100
*password - 255
*idnumber - 255
*firstname - 100
*lastname - 100
*lastnamephonetic - 255
*firstnamephonetic - 255
*middlename - 255
*alternatename - 255
*institution - 255
*department - 255
*address - 255
*city - 120
*icq -15
*skype - 50
*yahoo - 50
*aim - 50
*msn - 50
*phone1 - 20
*phone2 - 20

===All user fields listed here===
:All the user fields that are valid in an upload file are listed below, except for any custom fields you may have created (for which see below.)

<pre>firstname,lastname,username,email,password,auth,idnumber,institution,department,city,country,timezone,lang,mailformat,maildisplay,maildigest,htmleditor,autosubscribe,skype,msn,aim,yahoo,icq,phone1,phone2,address,url,description,descriptionformat,interests,oldusername,deleted,suspended,alternatename,lastnamephonetic,firstnamephonetic,middlename</pre>

The enrolments into courses information are <pre>course1,type1,role1,group1,enrolperiod1,enrolstatus1</pre>
where each enrolment is grouped by number.

===Capabilities===

You may wish to create a limited role to allow some users access to this function. Create a role at the system/site level with the following capabilities allowed:
* moodle/site:uploadusers
* moodle/role:assign

And
* In 'Allow role assignments' tab of this new role, permit it to assign the required roles that it may be uploading, especially Student, but also Teacher, Non-editing Teacher, and any other custom roles you may have created, which will be used in the uploads to assign users to.

In particular, don't forget the moodle/role:assign capability (even if these users have it in the courses they will be enrolling users in - it won't work).

==Upload users via CLI==

{{New features}}In Moodle 3.10 onwards, an administrator can upload users via a CLI script.

To obtain instructions on how to use the script, in the command line from the moodle directory run
php admin/tool/uploaduser/cli/uploaduser.php --help

== See also ==
* [[Flat file]] enrolment
* [[User profile fields]] for details of how to include data about custom user profile fields in the upload users file
* [[Upload courses]]

Forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

[[fr:Importer des utilisateurs]]
[[ja:ユーザのアップロード]]
[[de:Nutzerliste hochladen]]
[[es:Subir usuarios]]

Chemistry/Biochemistry

2020-11-10T17:30:04Z

Tsala: /* Moode Add-ins */ removing Jmol filter

==Notation==
Regarding basic notation, see http://moodle.org/mod/forum/discuss.php?d=111785&mode=1
See also:
*[[TeX filter]] - displays TeX notation as GIF images and will show full LaTeX implemention in Moodle 1.6 or later
*[[DragMath equation editor]] - a drag-and-drop equation editor that installs as a button in the regular editor, so that it is visible everywhere a user would enter text. Clicking the button launches an applet in a pop-up window so that the user can choose the parts of the equation.
*[http://www.dessci.com/en/support/mathtype/workswith/moodle.htm MathType] - a commercial product compatible with many text-editing and presentation software programs, that works with Moodle.

==Moode Add-ins==
The following Moodle add-ins are useful for making use of molecular data files in courses, and providing 3D visualisations:

*[[2D/3D structure display short answer]] - The 2D/3D Structure Display short answer question type is a short answer question with MarvinSketch for building question content and MarvinView for displaying question content. Anything that you can construct in MarvinSketch can be easily used in short answer questions.
*[[Drag and drop organic chemistry nomenclature question type]] - Drag and drop organic chemestry nomenclature question type.
*[[Fischer projections question type]] - Drag and drop question type that assesses students knowledge of constructing and interpreting Fischer Projections.
*[[Lewis structures]] - With this question type the instructor draws valid Lewis structures with all lone pairs and charges for a molecule. The student is presented with the structure stripped of lone pairs or formal charge, and they must add correct number of lone pairs/radicals or charges to any atoms.
*[[Newman projections question type]] - Drag and drop question that tests students knowledge of drawing and interpreting Newman Projections
*[[Select atoms or molecules question type]] - This question type allows you to design questions in which students select various atoms, molecules, bonds or other objects
*[https://docs.moodle.org/20/en/Jmol_resource_type Jmol resource module] for Moodle 1.9 - display a 3D interactive molecule as a specific configurable resource
*[http://moodle.org/mod/data/view.php?d=13&rid=296 Java Molecular Editor question type] - ask students to design and submit a molecular structure.
*[[Chemistry notation using mhchem]] The mhchem package provides commands for typesetting chemical molecular formulae and equations.
*[https://moodle.org/plugins/atto_chemrender ChemRender] - Chemical structure editor and molecular data file import plugin for the Atto HTML Editor.
*[https://moodle.org/plugins/filter_chemrender ChemRender filter] - Render 2-D and 3-D molecular structures and spectra from open chemical data files.

==See also==
Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=66147 How do Science Teachers Use Moodle?]
* [http://moodle.org/mod/forum/discuss.php?d=60440 Equation editors in Moodle]
* [http://moodle.org/mod/forum/discuss.php?d=131325 Scientific notation in quiz answers]
* [https://moodle.org/mod/forum/discuss.php?d=230558 Capital vs lower case letters with units]

[[Category:Teacher]]
[[Category:Discipline-specific Moodling]]
[[Category:Chemistry]]

[[es:Química/Bioquímica]]

MoodleDocs:Overview

2020-11-09T15:12:57Z

Tsala: redirect to latest version of page

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

Awards

2020-11-09T15:10:07Z

Tsala: redirect to latest version

#redirect [[:en:Awards]]

Creating SCORM Content

2020-11-09T12:56:39Z

Tsala: pointer to latest version wiki

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

2020-11-09T12:55:42Z

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

2020-11-06T14:59:14Z

Tsala: 3.10 link

3.9 docs: /39/en/{{FULLPAGENAMEE}}
3.10 docs: /310/en/{{FULLPAGENAMEE}}
3.8 docs: /38/en/{{FULLPAGENAMEE}}
3.5 docs: /35/en/{{FULLPAGENAMEE}}

MoodleDocs:Overview

2020-11-06T13:45:43Z

Tsala: 3.10 links

==English==

[https://docs.moodle.org/310/en/ 3.10 EN documentation]<br />
[https://docs.moodle.org/39/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/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]]

Matching question type

2020-10-25T19:47:40Z

Tsala: /* Question set-up in Question bank */ questions not answers shuffled

{{Questions}}
Matching questions have a content area and a list of names or statements which must be correctly matched against another list of names or statements. For example "Match the Capital with the Country" with the two lists "Canada, Italy, Japan" and "Ottawa, Rome, Tokyo". In the Quiz Module, each match is equally weighted to contribute towards the grade for the total question.

==Question set-up in Question bank==

#Select the question category
#Give the question a descriptive name - this allows you to identify it in the question bank.
#Enter some instructions in the 'Question text' field to tell the students what they are matching.
#Set the 'Default mark' (i.e. the maximum number of points for this question).
#If you wish, add general feedback. This is text that appears to the student after he/she has answered the question.
#Check the 'shuffle' box if you want the questions to be shuffled. Note: The Quiz display setting must also be set to shuffle within a questions for this to work.
#For the first matching item, enter the question and a matching answer.
#Fill in ''at least'' two questions and three answers. Click 'Blanks for 3 more questions' to add more. You can enter as many as 10 items (or more - [[Matching_question_type#See_also|see 'See also' below]]). You can provide extra wrong answers by giving an answer with a blank question.
#Set the 'Penalty for each incorrect try' (see [[Matching_question_type#Grading|grading]] below).
#Click Save changes to add the question to the category.

== Grading ==

* Each sub-question is equally weighted to contribute towards the grade for the total question. For example a student who correctly matches 3 of the 4 possible matches will receive 3/4 or 75% of the total possible score for that question.
* The 'penalty factor' only applies when the question is used in a quiz using adaptive mode - i.e. where the student is allowed multiple attempts at a question even within the same attempt at the quiz. If the penalty factor is more than 0, then the student will lose that proportion of the '''maximum''' grade upon each successive attempt. For example, if the default question grade is 10, and the penalty factor is 0.2, then each successive attempt after the first one will incur a penalty of 0.2 x 10 = 2 points.

==Repeated entries==

It is possible to have repeated entries in one of the lists but care should be taken to make the repeats identical. For example "Identify the type of these creatures" with the lists "Ant, Cow, Dog, Sparrow" and "Insect, Mammal, Mammal, Bird".

==Having more answers than questions==
It is possible to have more answers than the number of questions; just put in more answers, without any corresponding question. It also works if several subquestions have the same answers; for example if you have five parts to the question all with answer either "yes" or "no".

==Ordered questions==
In the Quiz module, it is possible for both the question list and the answer list to be shuffled. The answer list is always shuffled. The "shuffle within questions" must be "Yes" as a quiz setting under Display AND the shuffle question box must be check on the individual question.

Consider the question "Match the letter with its position in the alphabet" with the question list "1, 2, 3, 4" and answer list "A, B, C, D". The answer list is always shuffled for each student in the pull down list of the possible matches. However, only when both the quiz and individual question shuffles are turned on, will the question list be shuffled to something like "2,4,1,3".

==Lesson Module matching questions==
Matching questions are also used in the Lesson Module. However, while they look similar to the student, they are different for the teacher. Quizzes don't have jumps.

*In the Lesson Module, all matches must be right for the question to be scored as correct.
*What is called the question list in a Quiz, does not shuffle in the Lesson Module. In the earlier example, A, B, C , D will always be in that order and 1,2,3,4 will always be shuffled in the Lesson Module.
*Lesson Module has an "answer" and a "matching answer" instead of a "question" and "answer".
*In Lesson Module there has to be matching pairs. It is not possible to have 4 items in one list to match with 1 of 5 items in another list. Both lists will be equal in their number.

===Ordered questions in Lesson Module===
In the Lesson Module, unlike [[Multiple Choice question type|Multiple choice questions]] or the Quiz Module, the question list is always the same order and the choices are shown in a random order.

== Tips and tricks==
*Matching questions look better on screen if you put the longer piece of text in the question and not the match. For example, when vocabulary matching put the single word in the match and the definition sentence in the question. Otherwise the drop down for long questions will be awkward to use and difficult to read.
*Matching questions in a Lesson module are slightly different than in a Quiz module when the teacher is in edit mode. For example, there are scoring differences and a quiz does not use [[Jumps|jumps]].

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=67314 Matching question type: more than 10 items] forum discussion

[[ca:Tipus_de_pregunta_de_aparellament]]
[[de:Fragetyp Zuordnung]]
[[es:Tipo de pregunta de relacionar columnas]]
[[fr:Question d'appariement]]
[[ja:組み合わせ問題タイプ]]
[[zh:配合題]]

OAuth 2 services

2020-10-20T13:43:51Z

Tsala: /* Login domains */ small rewordings

{{Server settings}}
==OAuth2 services==

* Moodle 3.3 adds support for OAuth 2 services (or "Issuers"), which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
* OAuth 2 services are used for example, to provide a "Log in using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like [[Google Drive repository|Google Drive]] and [[OneDrive repository|OneDrive]] without having to re-authenticate.
* OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.

== Login ==

See [[OAuth 2 authentication]] for details of how to enable the feature.

== Open ID Connect ==

Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.

== Issuer Configuration ==

First some terminology: In these scenarios, Moodle is the "client" and the remote service (Google, Facebook, ...) is the "issuer" or "provider".

=== How do I get a client ID and secret? ===

The client ID and secret are provided by the issuer, so you need to set it up outside of Moodle, at the issuer. Instructions for prominent OAuth 2 providers are linked here.

* [[OAuth 2 Google service]]
* [[OAuth 2 Microsoft service]]
* [[OAuth 2 Facebook service]]
* [[OAuth 2 LinkedIn service]]
* [[OAuth 2 Nextcloud service]]
* [[OAuth 2 Twitter service]]

For custom services you will need to find out how to obtain the client ID and secret. The issuer will need configuring with the corresponding redirect URL for Moodle which is '''<wwwroot>/admin/oauth2callback.php''', e.g. if your Moodle site is https://moodle.example.com, then the redirect URL is https://moodle.example.com/admin/oauth2callback.php.

=== Adding an issuer ===

If possible, use one of the preconfigured services if yours is among it. You can still configure individual details later on. You can choose from this list:

[[Image:OAuth2-predefined-issuers.png|frame|center|Preconfigured issuers]]

Then, the following settings appear:

[[Image:OAuth2-issuer-settings.png|frame|center|Issuer settings]]

As a general rule, don't change any settings, except for '''Name''', '''Client ID''', '''Client Secret''', and '''Service Base URL''', unless installation instructions advise you to. Apart from that the defaults are usually fine, especially if you use one of the preconfigured services.
See [[#Advanced_issuer_settings|Advanced issuer settings (below)]] for explanations of some of the settings.

====Login domains====

This setting only applies if "Show on login page" is checked. If specified, only users with matching emails will be able to sign-up and log in using this service.

This restriction will apply on top of the allowed and denied email domains settings in [[Managing_authentication|Manage authentication]], however the latter are only checked when a user is created and are not checked again when the user logs in.

====Further configuration options====

After an issuer has been created, further configuration options are shown to the right of the service. Usually no change is required for preconfigured services.

[[Image:OAuth2-issuer-other-settings.png|frame|center|Further configuration options for OAuth 2 issuers]]

; Edit : Go to the settings screen again.
; Configure endpoints : Define the issuer's endpoints, i.e. the URLs that Moodle will connect to. The following endpoints are mandatory for user authentication: '''authorization_endpoint''', '''token_endpoint''' and '''userinfo_endpoint'''. (Example image below).
; Configure user field mappings : If you use the issuer as an identity provider, you can configure how the provider's response (from the '''userinfo_endpoint''') should be mapped to Moodle user fields. You should set up mappings for internal field names '''firstname''', '''lastname''' and '''email''' so that the user is fully set up when they log in as these fields are mandatory in Moodle. If any of these are not mapped the user will be redirected to their [[Edit profile]] page and prompted for the missing information. (Example image below).
; Delete : Delete the issuer configuration.
; Disable : Mark the issuer as disabled; plugins may not use them.
; Move up / down : Change the order of appearance in the issuer table.

[[File:endpoints.png|frame|center|Example endpoints for a custom service]][[File:user_field_mappings.png|frame|center|Example user field mappings]]

=== Connecting a system account ===

* A system account may be connected. It may be needed by plugins in order to provide advanced functionality, such as access controlled links from the [[Google Drive repository]] or [[OneDrive repository]].
* The system account should be a dedicated account for this purpose only. The system account doesn't require an email address to be associated with it (Moodle 3.3.2 onwards).
* A system account is not needed for login functionality.

[[File:errorsNotification.png|thumb|right|Notification preferences page]]
==== Refreshing Access Token ====

There is a scheduled task to regularly update the OAuth token for service accounts, ''Refresh OAuth tokens for service accounts'' (''\core\oauth2\refresh_system_tokens_task''). If for any reason the token cannot be refreshed, e.g. if the authorization expires, all Moodle administrators will be notified.

If an admin user does not wish to receive these notifications, it can be set up on the [[Notifications|Notification preferences]] page. The notification option to deactivate is ''Important errors with the site''.

'''Caution''': A user who turns off the ''Important errors with the site'' notification may not receive other important information related to site errors. For example, the user will not receive e-mails about the results of the antivirus scan or any notification sent from a third-party plugin that uses the core message provider ''errors''.
Currently there are not many notifications sent using this message provider; unfortunately, there is no way to list them, so it is recommended to check the notifications that were received before and those that are received after deactivating the notification.

=== Advanced issuer settings ===

; Authenticate token requests via HTTP headers : This should be the norm according to the OAuth 2 standard. However, most providers don't support this and require authentication details in the body instead. For most configurations, leave this checkbox disabled, unless instructions advise you to check it.

==See also==

* [[:Category:OAuth 2]]
* [https://moodle.org/mod/forum/discuss.php?d=351727 Oauth2 problems in Moodle 3.3] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=362593 Problem to configure Oauth2 with Microsoft Office365] forum discussion

[[Category:OAuth 2]]

[[es:Servicios OAuth 2]]
[[de:OAuth2 Services]]

OAuth 2 login domains

2020-10-20T13:29:55Z

Tsala: redirect

#redirect [[OAuth 2 services]]

OAuth 2 services

2020-10-20T13:28:35Z

Tsala: Login domains heading

{{Server settings}}
==OAuth2 services==

* Moodle 3.3 adds support for OAuth 2 services (or "Issuers"), which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
* OAuth 2 services are used for example, to provide a "Log in using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like [[Google Drive repository|Google Drive]] and [[OneDrive repository|OneDrive]] without having to re-authenticate.
* OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.

== Login ==

See [[OAuth 2 authentication]] for details of how to enable the feature.

== Open ID Connect ==

Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.

== Issuer Configuration ==

First some terminology: In these scenarios, Moodle is the "client" and the remote service (Google, Facebook, ...) is the "issuer" or "provider".

=== How do I get a client ID and secret? ===

The client ID and secret are provided by the issuer, so you need to set it up outside of Moodle, at the issuer. Instructions for prominent OAuth 2 providers are linked here.

* [[OAuth 2 Google service]]
* [[OAuth 2 Microsoft service]]
* [[OAuth 2 Facebook service]]
* [[OAuth 2 LinkedIn service]]
* [[OAuth 2 Nextcloud service]]
* [[OAuth 2 Twitter service]]

For custom services you will need to find out how to obtain the client ID and secret. The issuer will need configuring with the corresponding redirect URL for Moodle which is '''<wwwroot>/admin/oauth2callback.php''', e.g. if your Moodle site is https://moodle.example.com, then the redirect URL is https://moodle.example.com/admin/oauth2callback.php.

=== Adding an issuer ===

If possible, use one of the preconfigured services if yours is among it. You can still configure individual details later on. You can choose from this list:

[[Image:OAuth2-predefined-issuers.png|frame|center|Preconfigured issuers]]

Then, the following settings appear:

[[Image:OAuth2-issuer-settings.png|frame|center|Issuer settings]]

As a general rule, don't change any settings, except for '''Name''', '''Client ID''', '''Client Secret''', and '''Service Base URL''', unless installation instructions advise you to. Apart from that the defaults are usually fine, especially if you use one of the preconfigured services.
See [[#Advanced_issuer_settings|Advanced issuer settings (below)]] for explanations of some of the settings.

====Login domains====

''Please add information here...''

====Further configuration options====

After an issuer has been created, further configuration options are shown to the right of the service. Usually no change is required for preconfigured services.

[[Image:OAuth2-issuer-other-settings.png|frame|center|Further configuration options for OAuth 2 issuers]]

; Edit : Go to the settings screen again.
; Configure endpoints : Define the issuer's endpoints, i.e. the URLs that Moodle will connect to. The following endpoints are mandatory for user authentication: '''authorization_endpoint''', '''token_endpoint''' and '''userinfo_endpoint'''. (Example image below).
; Configure user field mappings : If you use the issuer as an identity provider, you can configure how the provider's response (from the '''userinfo_endpoint''') should be mapped to Moodle user fields. You should set up mappings for internal field names '''firstname''', '''lastname''' and '''email''' so that the user is fully set up when they log in as these fields are mandatory in Moodle. If any of these are not mapped the user will be redirected to their [[Edit profile]] page and prompted for the missing information. (Example image below).
; Delete : Delete the issuer configuration.
; Disable : Mark the issuer as disabled; plugins may not use them.
; Move up / down : Change the order of appearance in the issuer table.

[[File:endpoints.png|frame|center|Example endpoints for a custom service]][[File:user_field_mappings.png|frame|center|Example user field mappings]]

=== Connecting a system account ===

* A system account may be connected. It may be needed by plugins in order to provide advanced functionality, such as access controlled links from the [[Google Drive repository]] or [[OneDrive repository]].
* The system account should be a dedicated account for this purpose only. The system account doesn't require an email address to be associated with it (Moodle 3.3.2 onwards).
* A system account is not needed for login functionality.

[[File:errorsNotification.png|thumb|right|Notification preferences page]]
==== Refreshing Access Token ====

There is a scheduled task to regularly update the OAuth token for service accounts, ''Refresh OAuth tokens for service accounts'' (''\core\oauth2\refresh_system_tokens_task''). If for any reason the token cannot be refreshed, e.g. if the authorization expires, all Moodle administrators will be notified.

If an admin user does not wish to receive these notifications, it can be set up on the [[Notifications|Notification preferences]] page. The notification option to deactivate is ''Important errors with the site''.

'''Caution''': A user who turns off the ''Important errors with the site'' notification may not receive other important information related to site errors. For example, the user will not receive e-mails about the results of the antivirus scan or any notification sent from a third-party plugin that uses the core message provider ''errors''.
Currently there are not many notifications sent using this message provider; unfortunately, there is no way to list them, so it is recommended to check the notifications that were received before and those that are received after deactivating the notification.

=== Advanced issuer settings ===

; Authenticate token requests via HTTP headers : This should be the norm according to the OAuth 2 standard. However, most providers don't support this and require authentication details in the body instead. For most configurations, leave this checkbox disabled, unless instructions advise you to check it.

==See also==

* [[:Category:OAuth 2]]
* [https://moodle.org/mod/forum/discuss.php?d=351727 Oauth2 problems in Moodle 3.3] forum discussion
* [https://moodle.org/mod/forum/discuss.php?d=362593 Problem to configure Oauth2 with Microsoft Office365] forum discussion

[[Category:OAuth 2]]

[[es:Servicios OAuth 2]]
[[de:OAuth2 Services]]

Using Forum

2020-10-06T10:10:39Z

Tsala: /* Forum grading */ Grade users button

{{Forum}}
This page explains how students and teachers can use the [[Forum activity]] and explores ways to make the most of it in your Moodle course.

==Which forum do I need?==
In the (default) '''Standard forum for general use''', students will see an introduction text in a separate space above the list of discussions. Students see a button to start a new discussion (thread).

[[File:standardforum.png|thumb|center|467px|Student view of "Standard forum" type]]

In a '''Single, simple discussion''' the teachers posts a question and students are able only to reply. They cannot start a new topic of discussion. This is useful if you wish to keep a discussion focused. '''Note''': This forum type does not work with separate groups.

[[File:Single simple discussion.png|thumb|center|450px|Student view of "A single simple discussion" forum type]]

The '''Question and Answer forum''' is best used when you have a particular question that you wish to have answered. The teacher posts a question and students respond with possible answers. By default a Q and A forum requires students to post once before viewing other students' postings.

{|
| [[File:QA1.png|thumb|Inital view of Q&A forum]]
| [[File:QA2.png|thumb|Students cannot see posts until they post]]
| [[FIle:QA3.png|thumb|Other posts visible when editing time is over]]
|}

The '''Standard forum displayed in a blog-like format''' works like the standard forum for general use, but the first post of each discussion is displayed (as in a blog) so that users can read it and then choose to respond by clicking the "Discuss this topic" button bottom right of the post.

[[File:Bloglikeforum.png|thumb|450px|center|Blog like forum]]

==Using Forum: All users==

===Replying to discussions===
Similar to when starting a new discussion, the reply box appears inline, allowing the user to respond quickly. If a more detailed reply is needed, for example, needing the editing toolbar or attachment box, clicking Advanced will display the full version.

===Star discussions===
Discussions may be favourited or 'starred' either by clicking the three dots to the right of the discussion or by clicking directly on the star. This setting is individual and will move the discussion to the top of the discussion list, under any pinned discussions.
[[File:SmallStar.png]]

===Sort discussions===
Discussions may be sorted by replies, last post or created, by clicking the linked words at the top of the discussion list.

===Permalinks===

A permalink allows you to link directly to a specific forum post so you can share it easily with others. You will see the permalink option when clicking to reply to a post. If you click the permalink ''(1)'', it is highlighted to the side ''(2)'', and you will have a particular web address ''(3)'' which you can then copy and paste to use elsewhere:

[[File:permalinkexample.png|thumb|center|600px|Linking directly to a single post]]

===Forum preferences===
Users can set their forum preferences via Preferences in the user menu top right. (Defaults for each of these settings can be set by an administrator in ''Administration > Site administration > Accounts > User default preferences''.)
====Experimental nested view====

Enabling this will then make available a new discussion view, trialled in Moodle 3.8:
[[File:ExpNest.png|center|Experimental nested view]]

===Subscribing to forum discussions===
Users can subscribe to forum discussions in several ways, to receive notification about new posts.
# From the Preferences link in the user menu they can choose to be automatically subscribed to forum discussions when they post
# They can click on the open envelope icon next to a forum discussion. (It will then change to a closed envelope.)
#They can click into the forum and click the cog icon top right and subscribe to the whole forum.

===Track read and unread forum posts===
*Access the Preferences page from the user menu and select 'Forum preferences'.
* For 'Forum tracking', choose ''Yes: highlight new posts for me'' and if the forum administrator has set the 'Read tracking for this forum?' to On or Optional then unread posts will be highlighted for you:
{|
|[[File:forumtracking1.png|thumb|296px|left|Unread posts alert]]
|}

The posts will be highlighted in the following places:

* Course page
* Within the forum itself
* In forum discussion threads
{|
|[[File:forumtracking2.png|thumb|500px|left|Click to mark as read]]
|}

Only posts made in the last two weeks are tracked as read or unread. Older posts are all reported as read.

Note: You can also choose to have any forum post notifications automatically marked as read (so they don't appear in the Unread list.) Some people find this confusing and prefer to keep them as unread:

{|
|[[File:forumnotificationsread.png|thumb|left|600px|Forum post notification options]]
|}
===Display options===
[[Image:forumviewoptions.jpg|thumb|Reply display options]]A discussion thread may be displayed in four ways. Use the pull-down menu at the top of each forum discussion to select a display type.

* Display replies flat, with oldest first
* Display replies flat, with newest first - The discussion will be displayed in one line and the chronological order from the newest to the oldest. This view is the same as the above, just a different sort order.
* Display replies in threaded form - Only the post starting the discussion will be displayed in its full form; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.
* Display replies in nested form - All posts are displayed in their full forms; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.

{|
| [[Image:Forum Flat form mu.png|thumb|Flat Forum discussion, example from middle]]
| [[Image:Forum threaded form mu.png|thumb|Posts in threaded form]]
| [[Image:Forum nested form mu.png|thumb|"Nested reply example"]]
|}

===Forum posting===

The default content of '''Subject''' is usually 'Re: <the name of the 'parent' post>'. You can change it, though.

==== Adding images, sound and video ====

*When an image is "attached" as a file to a forum message, it is immediately displayed full size after the message (i.e. no need to click on an attachment). This is an excellent way of sharing images without having to go through the process of uploading them as files and linking them from within web pages.
*Images may be dragged and dropped into the box as well as uploading via the "add" link and the [[File picker]].
*If multimedia filters are enabled, a sound file (mp3) or accepted video file can be attached, and it will be embedded into the forum post in an appropriate player.

====Tags====

Forum posts may be tagged.

Tags can be managed by a site administrator in [[Managing tags|Manage tags]] in the Site administration. Forum post tags may be added to a specified tag collection, and standard tags may be suggested or forced. If desired, forum post tagging may be disabled completely.

====Post editing time limit====
Once a post has been made, students can go back and edit it within a set time limit. This limit is 30 minutes by default and is set by an administrator in [[Site security settings]] in the Site administration. Note that teachers can always edit their posts.

====Moving between forum threads====

Links top and bottom, left and right (where applicable) take you to the previous and next forum discussion in a list:

[[File:navigateforums1.png|thumbnail|center|500px]]

===Reply to posts via email===

If enabled by an administrator (in [[Mail configuration]]), you can reply to forum posts via email.

# Click the Reply by email link in the email. You will see a special unique email address to send your reply to.
# Reply using the email address provided. '''IMPORTANT: Make sure you remove the original email content so that your forum post does not contain the quoted text.'''
# You should receive an email saying your reply has been successfully posted.
# Your post now appears in the forum.

{|
| [[File:forumemailreplylatest.png|thumb|400px|(1) Click to reply by email]]
| [[File:specialemailaddress.png|thumb| 300px|(1a) Note the special email address to reply to]]
| [[File:forumemailreply2.png|thumb|400px|(2) Type and send your reply]]
|}

{|
| [[File:forumemailreply3.png|thumb|400px|(3) The success message]]
| [[File:forumemailreply4.png|thumb|400px| (4) Your reply is posted to the forum]]
|}

[[File:navigateforums1.png|thumbnail|center|500px]]

===Exporting forum posts===
Users with the ''mod/forum:exportdiscussion'' or ''mod/forum:exportownpost'' or ''mod/forum:exportpost'' permission can export forum posts to any portfolio the administrator has enabled:

[[File:Exportforum.png]]

See the discussion [https://moodle.org/mod/forum/discuss.php?d=320382 Printing/exporting forum discussions] for further details.

==Using Forum: Teachers==

=== Private replies===

Teachers (or anyone with the capability [[Capabilities/mod/forum:postprivatereply|mod/forum:postprivatereply]] can reply privately to a forum message. By default, the reply is only seen by the recipient and the teachers of the course, and cannot be replied. (Details in [[https://tracker.moodle.org/browse/MDL-22077]])
[[File:SmallPrivateReply.png]]

===Pinned posts===

When adding a new discussion as a teacher, you can 'pin' it from the three dots to the right of the discussion. (See screenshot below.) Any forum discussions which come after that will appear underneath this pinned post. If you later click to 'unpin' it, it will display as a regular forum discussion, moving down the list when others are posted.

===Manually locking discussion threads===

By clicking 'Lock' from three dots to the right of a discussion, you can manually lock a thread so that nobody can post to it anymore. A padlock icon will appear next to the locked discussion. Clicking again will unlock it if necessary:

[[File:SmallForumStarPinLock.png]]

==='Send forum post notifications with no editing time delay'===

Teachers (and others with the [[Capabilities/moodle/course:manageactivities|capability to manage course activities]]) will see this option when posting to a forum. Ticking this box will send a notification to everyone subscribed to that forum with no editing time delay. (Users have 30 minutes by default to edit their posts.)

Note: For users who have enabled email digests in their forum preferences, the notification is NOT sent separately from other forum post notifications.

=== Display period ===

Teachers (and others with the capability [[Capabilities/mod/forum:viewhiddentimedposts|mod/forum:viewhiddentimedposts]]) can set a display period of a date and time for the forum post to appear.

[[File:timedposts.png|500px]]

Note: Timed forum posts were included in previous versions of Moodle as an experimental feature. In Moodle 3.1 onwards, it is enabled by default for new installations. For sites upgrading from a previous version, it may be enabled via ''Site administration > Plugins > Activity modules > Forum''.

===Locking a discussion===

Forum threads may be automatically locked after a certain period of inactivity. This is done from the setting 'Discussion locking' when creating or editing a new forum.

[[File:discussionlocking.png|center|thumb|600px|Locked discussion alert when viewing a forum.]]

*A period from a day to a year may be selected. The default is for discussions not to be locked.
*Watch the screencast [https://youtu.be/M9ZxCq50hiQ Discussion locking] to see a demonstration.
*Teachers and other users with the [[Capabilities/mod/forum:canoverridediscussionlock|capability to override locked discussions]] can unlock discussions simply by posting a reply.

===Moving a discussion===

Teachers and other users with the [[Capabilities/mod/forum:movediscussions|capability to move discussions]] can move a discussion to any other forum in the course for which they have appropriate rights.
# Click on the arrow in the 'Move this discussion to...' dropdown menu in the top right corner of the page and select a destination forum.
# Click the Move button.

Note: Moving a forum post will display incorrect results in the [[Participation_report|course participation report]] for the affected forums. For example, take a student who posted in forum A and had their post moved to forum B. In the course participation report, the student will still be listed as having made a post in forum A, but will not be listed as having made a post yet in forum B.

Note: Discussion subscriptions are retained when a post is moved.

===Splitting a discussion===

Teachers and other users with the [[Capabilities/mod/forum:splitdiscussions|capability to split discussions]] can split a discussion thread. Splitting a discussion means that beginning with the post selected and going to the end of that sub-thread, the posts are cut from the current discussion topic and put into a newly created discussion topic. If a discussion has strayed away from the original topic, splitting the discussion can provide new attention and space for the tangent discussion while keeping the original discussion on topic.

# Click the link 'Split' in the forum post
# Enter a new discussion name (optional)
# Click the Split button

Note: Discussion subscriptions are NOT retained when a post is split.

===Using groups with forums===
'Group mode' available from the Common module settings has three options. (Note that you must have groups in your course to use this feature.)
[[File:forumdiscussiongroup3.png|thumb|Forum with discussion to all participants with 'Post a copy to all groups' ticked]]
If the group mode is set to separate groups:

* Teachers (and other users with the [[Capabilities/mod/forum:canposttomygroups|capability to post in all groups they have access to]]) are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for a selected group, then only group members can reply to it. If the teacher adds a new discussion topic for all participants, they need to also tick the box 'Post a copy to all groups', otherwise students will only be able to view their post and not reply to it.
* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or discussions for their group started by a teacher.

If the group mode is set to visible groups:

* Teachers are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for a selected group, then only group members can reply to it.
* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or teachers.

Teachers, and other users with the capability [[Capabilities/moodle/site:accessallgroups|moodle/site:accessallgroups]] set to allow, can view and post in all forum discussions, regardless of the group mode setting.

Where visible groups are used, the user's groups will be shown first in the list, followed by other groups:

[[File:mygroupsfirst.png]]

Note: Single simple discussions cannot be set to separate groups (as this feature is not implemented). Instead, a standard forum should be used. If required, a permissions override may be set to prevent students from starting new discussions.
For teachers who have access to all or several groups in a forum, this setting allows them to post the same message once only to all groups.

===Forum grading===

To be able to grade forum posts, in the forum settings in the section 'Whole forum grading', you need to set the grade type to Point or Scale. You can then choose a grading method, such as a marking guide or rubric. After saving the forum settings, you'll find a 'Grade users' button on the forum page.

==Ideas for using forums==

Ask yourself

# you wish to have involvement in the forum or if you want the students to lead and own the space
# you want the forum to add value to the face to face environment or have a life of its own in its own right outside the lecture theatre/classroom or seminar room
# you are prepared to make appropriate contributions to the discussion to:
## encourage discussion if students are quiet
## help shape ideas if students begin to wander off-task
## your role will be defined as discussions/a course progresses
## you will explicitly but gradually relinquish control of the discussions
## you will encourage and support learners to share control of discussions (for example you might ask a learner/group of learners to summarise contributions to a discussion thread/topic, or you might ask learners to initiate discussion topics)

[[de: Forum nutzen]]
[[fr:Afficher un forum]]
[[ja:フォーラムの閲覧]]
[[es:Usando Foro]]

Forum FAQ

2020-10-06T10:05:41Z

Tsala: How can I enable forum grading?

{{Forum}}
==How can I use permalinks?==
A permalink allows you to link directly to a specific forum post so you can share it easily with others. You will see the permalink option when clicking to reply to a post. If you click the permalink ''(1)'', it is highlighted to the side ''(2)'' and you will have a particular web address ''(3)'' which you can then copy and paste to use elsewhere:

[[File:permalinkexample.png|thumb|center|600px|Linking directly to a single post]]

==How can I easily see which posts I have read and not read?==
#Go to the user menu top right and select 'Preferences'.
#Click 'Forum preferences' and for 'Forum tracking' select: ''Yes; highlight new posts for me''
#When in the forum itself' you will see which posts are read and unread.

[[File:forumtracking2.png]]

==How can I get my forum to display in the [[Course overview block]]?==

Set an 'Expect completed by' date in the [[Activity completion]] section of your forum.
==Why are students unable to post in the forum?==

The most likely reason is that the forum is an [[Announcements forum]] i.e. a special forum for news and general announcements which is automatically created for each course, and which by default only teachers and administrators can post in.

To create a standard forum in which students can post, turn editing on for the course, click the 'Add an activity or resource' link and then choose Forum.

Students may also be unable to post to a forum where a [[Forum_settings#Common_module_settings|Group Mode]] other than 'No Groups' has been used but the student is not a member of any group in the course. They will see the message "Adding discussions to this forum requires group membership". In this case, either add the student to a [[Groups|group]] or change the [[Forum_settings#Common_module_settings|Group Mode]] to 'No Groups'.

==How do I enable ratings in my forum?==
For the standard [[Boost theme]] click into your forum and then click the gear menu top right inside the forum. For other themes, find the administration block for the forum to one side of your course page. Then click Edit settings or Settings and scroll down to 'Ratings'. Expand this and from the Aggregate type dropdown, choose the type of rating you want. The help icon gives more information. Note: If you want to use a specific scale (such as 'Like', as mentioned below) then from the Scale section change the Type to 'Scale' and then select your chosen Scale.

==How do I enable students to rate forum posts?==

For the standard [[Boost theme]] click the relevant forum and then from the gear menu top right inside the forum, click 'Permissions' and then click the + symbol opposite the capability to rate posts and allow the role of Student. For other themes, click the forum and then, on the side of your screen, find the administration block for the forum. Click the + symbol opposite the capability to rate posts and allow the role of student.

==How can I have a 'Like' button for my forum discussions?==

# For the standard [[Boost theme]], click Grades and then Scales. For other themes, find the side block ''Course administration and click Grades > Scales''. Add a new scale with just one item. This could be 'Like' or it could be 'Useful' for example.
# Enable ratings in your forum and if you want students to 'like' the posts, follow the instructions above.

[[File:forumlike.png|thumb|center|500px]]

==How can I create a teacher-only forum?==

A teacher/tutor-only forum may be added to a course by creating a hidden forum. Teachers are able to view hidden course activities whereas students cannot.

==My users can't add attachments to my forum, either with drag and drop or with the file picker.==

Check that in the forum settings that you have changed the maximum number of attachments allowed to a number greater than 0.

==How can I remove the Announcements from a course?==

#Delete the Announcements from the course homepage.
#In ''Administration > Course administration > Edit settings'' set "News items to show" to 0.
#Delete the Latest announcements block.

==How can I remove test messages from a new forum?==
There are several options ([https://moodle.org/mod/forum/discuss.php?d=95470#p421687 Here is a nice graphic]). Remember you can
*Move the discussion/thread to another forum
*Edit the post with your moderator powers
*Delete the post with your moderator powers
*Split the thread at a particular post and move it to another thread
*Split>move>delete your test messages.

==How can I set a display period for announcements?==

See the section 'Display period' in [[Using Forum]].

==Why are forum post notification emails not being sent?==

The most likely reason is that the cron is not set up. Please refer to the [[Cron|cron instructions]].

Tip: Try the default settings in the 'Outgoing mail configuration' in the Site administration. This generally works.

==How do I enable guests to post in a forum?==

It's not possible to enable guests to post in a forum, though there is a workaround. Please see [[Forum poster role]] for details.

==How can I close/archive a forum?==
*You might want to do this if, for example, you want to put an end to a student discussion topic but still want them to be able to see posts which had been made without being able to reply any more.

*In ''Administration > Forum administration > Permissions'' click the Prevent icon (X) for the student role for the capabilities 'Start new discussions' and 'Reply to posts'.

{|
|[[File:forum-permissions-page1.gif|thumb|The screen and relevant capabilities. (Click to enlarge]]
|}

Note: If you are a teacher in a course, you should be able to do this by default, but if you don't see these options, ask your admin to do the following:
#Go to ''Administration > Site Administration > Users > Permissions > Define roles''
#Edit the teacher role and change the capability moodle/role:safeoverride to allow
#Click the button "Save changes"
#Click the tab "Allow role overrides" (in ''Site administration > Users > Permissions > Define roles'')
#Check the appropriate box(s) in the teacher row to set which role(s) they can override. Most likely it will just be the student role, so check the box where the teacher row intersects with the student column
#Click the button "Save changes"

To make a single thread read only, you need a forum which has already been closed/archived. Move the the thread to this read-only forum.

==How can I quarantine a forum post?==
If a student makes an inappropriate post, rather than deleting it, you can "quarantine" it by sending it to a hidden forum and then alerting your superior and the child's guardians. To do this you first need to create a forum "Hidden forum for Offensive Posts" (for example) and hide it with its eye.
**Find the offensive post and click 'split' (between 'edit' and 'delete')
**This will take you to a second page where you will be asked to verify the split. Confirm it by pressing the 'split' button near the top of the page.
**The post(s) will now be split. You should see the post/discussion individually on a separate page. In the right-hand corner will be a dropdown bar and a button that says 'move.'
**Choose 'Hidden Forum for Offensive Posts' in the dropdown and click 'move.'

Make sure you inform the child why their post has been quarantined, as well as your superior and the child's guardians.

==Can I set up forum moderation or an approval process before a post appears?==
Not in core Moodle.
*Check out MDL-35378
*And https://tracker.moodle.org/browse/CONTRIB-2260

==Can I subscribe to just one discussion in a forum?==

Yes. Please see [[Forum settings]].

==How can I receive forum emails in digest form?==

You can select a daily digest of either complete forum posts or with subjects only via your user menu (top right) ''Preferences > Forum preferences''.

==How can I allow students to add new questions in a Q & A forum type?==

Only teachers and managers by default see the "add a new question" button. If you wish students to be able to add new questions, they need to be given the capability [[Capabilities/mod/forum:addquestion|mod/forum:addquestion]].

==How can I make sure my students are notified of forum posts?==

For students to be notified of forum posts, they need to be ''subscribed'' to the forum. A teacher can choose to force subscription on a particular forum either initially (auto subscription) or permanently (forced subscription) using the subscription mode setting. See the section on subscription mode in [[Forum settings]] for further details.

A teacher can also subscribe selected students to the forum via ''Forum administration > Show/edit current subscribers''.

==How can I set the 'From' address for forum notifications sent via email?==

A no-reply address and any allowed email domains may be set in 'Outgoing mail configuration' in the Site administration. See [[Mail configuration]] for further details.

==How can I remove the words "Site news"?==
You can change the words to something else from ''Administration>Forum administration>Edit settings'' but to have no words at all - and without touching the code - do the following:
*As admin go to ''Administration>Site administration>Appearance>HTML settings'' and uncheck/untick ''Remove HTML tags from all activity names''
*Go to ''Administration>Forum administration<Edit settings'' (for the site news) and type:
[[File:sitenewsname.png]]

*Save. What this does is code a space into the name field so Moodle thinks there is something in the required field - but that something is a space, not words.

==Can I have different email digests for different forums?==

Yes, you can specify how you want to receive notifications on the forum index page ''http://YOURMOODLESITE/mod/forum/index.php?id=2'' (where ''YOURMOODLESITE'' is your Moodle and the ''=number'' is the course ID) e.g. https://moodle.org/mod/forum/index.php?id=5.
{|
|[[File:26forumdigest.png|thumb|Per forum digest settings]]
|}

==How can a teacher see all of a student's forum posts in a course?==
If a teacher clicks the Participants link and then clicks on the profile of a particular student, they can then access a link 'Forum posts' from the 'Miscellaneous' section of the student's profile.

==How can a user see all their forum posts on Moodle?==
A user can view all their forum posts via the forum posts link in their profile.

==How can I remove a rating from a forum post?==

A user can remove a rating that they made previously by selecting 'Rate...' in the dropdown menu.

It is not possible to remove a rating made by another user. However, if a certain poster gives inappropriate ratings on a regular basis, it is possible to create a custom system role preventing them from rating posts and assign the role for a limited time.

==How can I enable forum grading?==

See the section 'Forum grading' in [[Using Forum]].

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?f=116 Forum forum] on moodle.org.

==See also==

Moodle in English forum discussions:

* [http://moodle.org/mod/forum/discuss.php?d=178331 How to resend forum posts]
* [http://moodle.org/mod/forum/discuss.php?d=196698 Discussion Count]
* [https://moodle.org/mod/forum/discuss.php?d=364991 Delayed mailings]
* [https://moodle.org/mod/forum/discuss.php?d=397754 Attaching more than one file in the announcement section]

[[Category:FAQ]]
[[de:Forum FAQ]]
[[fr:FAQ sur le forum]]
[[es:Foro FAQ]]

Using Forum

2020-10-06T10:02:57Z

Tsala: /* Forum grading */ grading method

{{Forum}}
This page explains how students and teachers can use the [[Forum activity]] and explores ways to make the most of it in your Moodle course.

==Which forum do I need?==
In the (default) '''Standard forum for general use''', students will see an introduction text in a separate space above the list of discussions. Students see a button to start a new discussion (thread).

[[File:standardforum.png|thumb|center|467px|Student view of "Standard forum" type]]

In a '''Single, simple discussion''' the teachers posts a question and students are able only to reply. They cannot start a new topic of discussion. This is useful if you wish to keep a discussion focused. '''Note''': This forum type does not work with separate groups.

[[File:Single simple discussion.png|thumb|center|450px|Student view of "A single simple discussion" forum type]]

The '''Question and Answer forum''' is best used when you have a particular question that you wish to have answered. The teacher posts a question and students respond with possible answers. By default a Q and A forum requires students to post once before viewing other students' postings.

{|
| [[File:QA1.png|thumb|Inital view of Q&A forum]]
| [[File:QA2.png|thumb|Students cannot see posts until they post]]
| [[FIle:QA3.png|thumb|Other posts visible when editing time is over]]
|}

The '''Standard forum displayed in a blog-like format''' works like the standard forum for general use, but the first post of each discussion is displayed (as in a blog) so that users can read it and then choose to respond by clicking the "Discuss this topic" button bottom right of the post.

[[File:Bloglikeforum.png|thumb|450px|center|Blog like forum]]

==Using Forum: All users==

===Replying to discussions===
Similar to when starting a new discussion, the reply box appears inline, allowing the user to respond quickly. If a more detailed reply is needed, for example, needing the editing toolbar or attachment box, clicking Advanced will display the full version.

===Star discussions===
Discussions may be favourited or 'starred' either by clicking the three dots to the right of the discussion or by clicking directly on the star. This setting is individual and will move the discussion to the top of the discussion list, under any pinned discussions.
[[File:SmallStar.png]]

===Sort discussions===
Discussions may be sorted by replies, last post or created, by clicking the linked words at the top of the discussion list.

===Permalinks===

A permalink allows you to link directly to a specific forum post so you can share it easily with others. You will see the permalink option when clicking to reply to a post. If you click the permalink ''(1)'', it is highlighted to the side ''(2)'', and you will have a particular web address ''(3)'' which you can then copy and paste to use elsewhere:

[[File:permalinkexample.png|thumb|center|600px|Linking directly to a single post]]

===Forum preferences===
Users can set their forum preferences via Preferences in the user menu top right. (Defaults for each of these settings can be set by an administrator in ''Administration > Site administration > Accounts > User default preferences''.)
====Experimental nested view====

Enabling this will then make available a new discussion view, trialled in Moodle 3.8:
[[File:ExpNest.png|center|Experimental nested view]]

===Subscribing to forum discussions===
Users can subscribe to forum discussions in several ways, to receive notification about new posts.
# From the Preferences link in the user menu they can choose to be automatically subscribed to forum discussions when they post
# They can click on the open envelope icon next to a forum discussion. (It will then change to a closed envelope.)
#They can click into the forum and click the cog icon top right and subscribe to the whole forum.

===Track read and unread forum posts===
*Access the Preferences page from the user menu and select 'Forum preferences'.
* For 'Forum tracking', choose ''Yes: highlight new posts for me'' and if the forum administrator has set the 'Read tracking for this forum?' to On or Optional then unread posts will be highlighted for you:
{|
|[[File:forumtracking1.png|thumb|296px|left|Unread posts alert]]
|}

The posts will be highlighted in the following places:

* Course page
* Within the forum itself
* In forum discussion threads
{|
|[[File:forumtracking2.png|thumb|500px|left|Click to mark as read]]
|}

Only posts made in the last two weeks are tracked as read or unread. Older posts are all reported as read.

Note: You can also choose to have any forum post notifications automatically marked as read (so they don't appear in the Unread list.) Some people find this confusing and prefer to keep them as unread:

{|
|[[File:forumnotificationsread.png|thumb|left|600px|Forum post notification options]]
|}
===Display options===
[[Image:forumviewoptions.jpg|thumb|Reply display options]]A discussion thread may be displayed in four ways. Use the pull-down menu at the top of each forum discussion to select a display type.

* Display replies flat, with oldest first
* Display replies flat, with newest first - The discussion will be displayed in one line and the chronological order from the newest to the oldest. This view is the same as the above, just a different sort order.
* Display replies in threaded form - Only the post starting the discussion will be displayed in its full form; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.
* Display replies in nested form - All posts are displayed in their full forms; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.

{|
| [[Image:Forum Flat form mu.png|thumb|Flat Forum discussion, example from middle]]
| [[Image:Forum threaded form mu.png|thumb|Posts in threaded form]]
| [[Image:Forum nested form mu.png|thumb|"Nested reply example"]]
|}

===Forum posting===

The default content of '''Subject''' is usually 'Re: <the name of the 'parent' post>'. You can change it, though.

==== Adding images, sound and video ====

*When an image is "attached" as a file to a forum message, it is immediately displayed full size after the message (i.e. no need to click on an attachment). This is an excellent way of sharing images without having to go through the process of uploading them as files and linking them from within web pages.
*Images may be dragged and dropped into the box as well as uploading via the "add" link and the [[File picker]].
*If multimedia filters are enabled, a sound file (mp3) or accepted video file can be attached, and it will be embedded into the forum post in an appropriate player.

====Tags====

Forum posts may be tagged.

Tags can be managed by a site administrator in [[Managing tags|Manage tags]] in the Site administration. Forum post tags may be added to a specified tag collection, and standard tags may be suggested or forced. If desired, forum post tagging may be disabled completely.

====Post editing time limit====
Once a post has been made, students can go back and edit it within a set time limit. This limit is 30 minutes by default and is set by an administrator in [[Site security settings]] in the Site administration. Note that teachers can always edit their posts.

====Moving between forum threads====

Links top and bottom, left and right (where applicable) take you to the previous and next forum discussion in a list:

[[File:navigateforums1.png|thumbnail|center|500px]]

===Reply to posts via email===

If enabled by an administrator (in [[Mail configuration]]), you can reply to forum posts via email.

# Click the Reply by email link in the email. You will see a special unique email address to send your reply to.
# Reply using the email address provided. '''IMPORTANT: Make sure you remove the original email content so that your forum post does not contain the quoted text.'''
# You should receive an email saying your reply has been successfully posted.
# Your post now appears in the forum.

{|
| [[File:forumemailreplylatest.png|thumb|400px|(1) Click to reply by email]]
| [[File:specialemailaddress.png|thumb| 300px|(1a) Note the special email address to reply to]]
| [[File:forumemailreply2.png|thumb|400px|(2) Type and send your reply]]
|}

{|
| [[File:forumemailreply3.png|thumb|400px|(3) The success message]]
| [[File:forumemailreply4.png|thumb|400px| (4) Your reply is posted to the forum]]
|}

[[File:navigateforums1.png|thumbnail|center|500px]]

===Exporting forum posts===
Users with the ''mod/forum:exportdiscussion'' or ''mod/forum:exportownpost'' or ''mod/forum:exportpost'' permission can export forum posts to any portfolio the administrator has enabled:

[[File:Exportforum.png]]

See the discussion [https://moodle.org/mod/forum/discuss.php?d=320382 Printing/exporting forum discussions] for further details.

==Using Forum: Teachers==

=== Private replies===

Teachers (or anyone with the capability [[Capabilities/mod/forum:postprivatereply|mod/forum:postprivatereply]] can reply privately to a forum message. By default, the reply is only seen by the recipient and the teachers of the course, and cannot be replied. (Details in [[https://tracker.moodle.org/browse/MDL-22077]])
[[File:SmallPrivateReply.png]]

===Pinned posts===

When adding a new discussion as a teacher, you can 'pin' it from the three dots to the right of the discussion. (See screenshot below.) Any forum discussions which come after that will appear underneath this pinned post. If you later click to 'unpin' it, it will display as a regular forum discussion, moving down the list when others are posted.

===Manually locking discussion threads===

By clicking 'Lock' from three dots to the right of a discussion, you can manually lock a thread so that nobody can post to it anymore. A padlock icon will appear next to the locked discussion. Clicking again will unlock it if necessary:

[[File:SmallForumStarPinLock.png]]

==='Send forum post notifications with no editing time delay'===

Teachers (and others with the [[Capabilities/moodle/course:manageactivities|capability to manage course activities]]) will see this option when posting to a forum. Ticking this box will send a notification to everyone subscribed to that forum with no editing time delay. (Users have 30 minutes by default to edit their posts.)

Note: For users who have enabled email digests in their forum preferences, the notification is NOT sent separately from other forum post notifications.

=== Display period ===

Teachers (and others with the capability [[Capabilities/mod/forum:viewhiddentimedposts|mod/forum:viewhiddentimedposts]]) can set a display period of a date and time for the forum post to appear.

[[File:timedposts.png|500px]]

Note: Timed forum posts were included in previous versions of Moodle as an experimental feature. In Moodle 3.1 onwards, it is enabled by default for new installations. For sites upgrading from a previous version, it may be enabled via ''Site administration > Plugins > Activity modules > Forum''.

===Locking a discussion===

Forum threads may be automatically locked after a certain period of inactivity. This is done from the setting 'Discussion locking' when creating or editing a new forum.

[[File:discussionlocking.png|center|thumb|600px|Locked discussion alert when viewing a forum.]]

*A period from a day to a year may be selected. The default is for discussions not to be locked.
*Watch the screencast [https://youtu.be/M9ZxCq50hiQ Discussion locking] to see a demonstration.
*Teachers and other users with the [[Capabilities/mod/forum:canoverridediscussionlock|capability to override locked discussions]] can unlock discussions simply by posting a reply.

===Moving a discussion===

Teachers and other users with the [[Capabilities/mod/forum:movediscussions|capability to move discussions]] can move a discussion to any other forum in the course for which they have appropriate rights.
# Click on the arrow in the 'Move this discussion to...' dropdown menu in the top right corner of the page and select a destination forum.
# Click the Move button.

Note: Moving a forum post will display incorrect results in the [[Participation_report|course participation report]] for the affected forums. For example, take a student who posted in forum A and had their post moved to forum B. In the course participation report, the student will still be listed as having made a post in forum A, but will not be listed as having made a post yet in forum B.

Note: Discussion subscriptions are retained when a post is moved.

===Splitting a discussion===

Teachers and other users with the [[Capabilities/mod/forum:splitdiscussions|capability to split discussions]] can split a discussion thread. Splitting a discussion means that beginning with the post selected and going to the end of that sub-thread, the posts are cut from the current discussion topic and put into a newly created discussion topic. If a discussion has strayed away from the original topic, splitting the discussion can provide new attention and space for the tangent discussion while keeping the original discussion on topic.

# Click the link 'Split' in the forum post
# Enter a new discussion name (optional)
# Click the Split button

Note: Discussion subscriptions are NOT retained when a post is split.

===Using groups with forums===
'Group mode' available from the Common module settings has three options. (Note that you must have groups in your course to use this feature.)
[[File:forumdiscussiongroup3.png|thumb|Forum with discussion to all participants with 'Post a copy to all groups' ticked]]
If the group mode is set to separate groups:

* Teachers (and other users with the [[Capabilities/mod/forum:canposttomygroups|capability to post in all groups they have access to]]) are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for a selected group, then only group members can reply to it. If the teacher adds a new discussion topic for all participants, they need to also tick the box 'Post a copy to all groups', otherwise students will only be able to view their post and not reply to it.
* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or discussions for their group started by a teacher.

If the group mode is set to visible groups:

* Teachers are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for a selected group, then only group members can reply to it.
* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or teachers.

Teachers, and other users with the capability [[Capabilities/moodle/site:accessallgroups|moodle/site:accessallgroups]] set to allow, can view and post in all forum discussions, regardless of the group mode setting.

Where visible groups are used, the user's groups will be shown first in the list, followed by other groups:

[[File:mygroupsfirst.png]]

Note: Single simple discussions cannot be set to separate groups (as this feature is not implemented). Instead, a standard forum should be used. If required, a permissions override may be set to prevent students from starting new discussions.
For teachers who have access to all or several groups in a forum, this setting allows them to post the same message once only to all groups.

===Forum grading===

To be able to grade forum posts, in the forum settings in the section 'Whole forum grading', you need to set the grade type to Point or Scale. You can then choose a grading method, such as a marking guide or rubric.

==Ideas for using forums==

Ask yourself

# you wish to have involvement in the forum or if you want the students to lead and own the space
# you want the forum to add value to the face to face environment or have a life of its own in its own right outside the lecture theatre/classroom or seminar room
# you are prepared to make appropriate contributions to the discussion to:
## encourage discussion if students are quiet
## help shape ideas if students begin to wander off-task
## your role will be defined as discussions/a course progresses
## you will explicitly but gradually relinquish control of the discussions
## you will encourage and support learners to share control of discussions (for example you might ask a learner/group of learners to summarise contributions to a discussion thread/topic, or you might ask learners to initiate discussion topics)

[[de: Forum nutzen]]
[[fr:Afficher un forum]]
[[ja:フォーラムの閲覧]]
[[es:Usando Foro]]

Using Forum

2020-10-06T09:59:11Z

Tsala: /* Using Forum: Teachers */ Forum grading

{{Forum}}
This page explains how students and teachers can use the [[Forum activity]] and explores ways to make the most of it in your Moodle course.

==Which forum do I need?==
In the (default) '''Standard forum for general use''', students will see an introduction text in a separate space above the list of discussions. Students see a button to start a new discussion (thread).

[[File:standardforum.png|thumb|center|467px|Student view of "Standard forum" type]]

In a '''Single, simple discussion''' the teachers posts a question and students are able only to reply. They cannot start a new topic of discussion. This is useful if you wish to keep a discussion focused. '''Note''': This forum type does not work with separate groups.

[[File:Single simple discussion.png|thumb|center|450px|Student view of "A single simple discussion" forum type]]

The '''Question and Answer forum''' is best used when you have a particular question that you wish to have answered. The teacher posts a question and students respond with possible answers. By default a Q and A forum requires students to post once before viewing other students' postings.

{|
| [[File:QA1.png|thumb|Inital view of Q&A forum]]
| [[File:QA2.png|thumb|Students cannot see posts until they post]]
| [[FIle:QA3.png|thumb|Other posts visible when editing time is over]]
|}

The '''Standard forum displayed in a blog-like format''' works like the standard forum for general use, but the first post of each discussion is displayed (as in a blog) so that users can read it and then choose to respond by clicking the "Discuss this topic" button bottom right of the post.

[[File:Bloglikeforum.png|thumb|450px|center|Blog like forum]]

==Using Forum: All users==

===Replying to discussions===
Similar to when starting a new discussion, the reply box appears inline, allowing the user to respond quickly. If a more detailed reply is needed, for example, needing the editing toolbar or attachment box, clicking Advanced will display the full version.

===Star discussions===
Discussions may be favourited or 'starred' either by clicking the three dots to the right of the discussion or by clicking directly on the star. This setting is individual and will move the discussion to the top of the discussion list, under any pinned discussions.
[[File:SmallStar.png]]

===Sort discussions===
Discussions may be sorted by replies, last post or created, by clicking the linked words at the top of the discussion list.

===Permalinks===

A permalink allows you to link directly to a specific forum post so you can share it easily with others. You will see the permalink option when clicking to reply to a post. If you click the permalink ''(1)'', it is highlighted to the side ''(2)'', and you will have a particular web address ''(3)'' which you can then copy and paste to use elsewhere:

[[File:permalinkexample.png|thumb|center|600px|Linking directly to a single post]]

===Forum preferences===
Users can set their forum preferences via Preferences in the user menu top right. (Defaults for each of these settings can be set by an administrator in ''Administration > Site administration > Accounts > User default preferences''.)
====Experimental nested view====

Enabling this will then make available a new discussion view, trialled in Moodle 3.8:
[[File:ExpNest.png|center|Experimental nested view]]

===Subscribing to forum discussions===
Users can subscribe to forum discussions in several ways, to receive notification about new posts.
# From the Preferences link in the user menu they can choose to be automatically subscribed to forum discussions when they post
# They can click on the open envelope icon next to a forum discussion. (It will then change to a closed envelope.)
#They can click into the forum and click the cog icon top right and subscribe to the whole forum.

===Track read and unread forum posts===
*Access the Preferences page from the user menu and select 'Forum preferences'.
* For 'Forum tracking', choose ''Yes: highlight new posts for me'' and if the forum administrator has set the 'Read tracking for this forum?' to On or Optional then unread posts will be highlighted for you:
{|
|[[File:forumtracking1.png|thumb|296px|left|Unread posts alert]]
|}

The posts will be highlighted in the following places:

* Course page
* Within the forum itself
* In forum discussion threads
{|
|[[File:forumtracking2.png|thumb|500px|left|Click to mark as read]]
|}

Only posts made in the last two weeks are tracked as read or unread. Older posts are all reported as read.

Note: You can also choose to have any forum post notifications automatically marked as read (so they don't appear in the Unread list.) Some people find this confusing and prefer to keep them as unread:

{|
|[[File:forumnotificationsread.png|thumb|left|600px|Forum post notification options]]
|}
===Display options===
[[Image:forumviewoptions.jpg|thumb|Reply display options]]A discussion thread may be displayed in four ways. Use the pull-down menu at the top of each forum discussion to select a display type.

* Display replies flat, with oldest first
* Display replies flat, with newest first - The discussion will be displayed in one line and the chronological order from the newest to the oldest. This view is the same as the above, just a different sort order.
* Display replies in threaded form - Only the post starting the discussion will be displayed in its full form; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.
* Display replies in nested form - All posts are displayed in their full forms; replies will be reduced to the headlines (including information about its author and date of release) and organised chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.

{|
| [[Image:Forum Flat form mu.png|thumb|Flat Forum discussion, example from middle]]
| [[Image:Forum threaded form mu.png|thumb|Posts in threaded form]]
| [[Image:Forum nested form mu.png|thumb|"Nested reply example"]]
|}

===Forum posting===

The default content of '''Subject''' is usually 'Re: <the name of the 'parent' post>'. You can change it, though.

==== Adding images, sound and video ====

*When an image is "attached" as a file to a forum message, it is immediately displayed full size after the message (i.e. no need to click on an attachment). This is an excellent way of sharing images without having to go through the process of uploading them as files and linking them from within web pages.
*Images may be dragged and dropped into the box as well as uploading via the "add" link and the [[File picker]].
*If multimedia filters are enabled, a sound file (mp3) or accepted video file can be attached, and it will be embedded into the forum post in an appropriate player.

====Tags====

Forum posts may be tagged.

Tags can be managed by a site administrator in [[Managing tags|Manage tags]] in the Site administration. Forum post tags may be added to a specified tag collection, and standard tags may be suggested or forced. If desired, forum post tagging may be disabled completely.

====Post editing time limit====
Once a post has been made, students can go back and edit it within a set time limit. This limit is 30 minutes by default and is set by an administrator in [[Site security settings]] in the Site administration. Note that teachers can always edit their posts.

====Moving between forum threads====

Links top and bottom, left and right (where applicable) take you to the previous and next forum discussion in a list:

[[File:navigateforums1.png|thumbnail|center|500px]]

===Reply to posts via email===

If enabled by an administrator (in [[Mail configuration]]), you can reply to forum posts via email.

# Click the Reply by email link in the email. You will see a special unique email address to send your reply to.
# Reply using the email address provided. '''IMPORTANT: Make sure you remove the original email content so that your forum post does not contain the quoted text.'''
# You should receive an email saying your reply has been successfully posted.
# Your post now appears in the forum.

{|
| [[File:forumemailreplylatest.png|thumb|400px|(1) Click to reply by email]]
| [[File:specialemailaddress.png|thumb| 300px|(1a) Note the special email address to reply to]]
| [[File:forumemailreply2.png|thumb|400px|(2) Type and send your reply]]
|}

{|
| [[File:forumemailreply3.png|thumb|400px|(3) The success message]]
| [[File:forumemailreply4.png|thumb|400px| (4) Your reply is posted to the forum]]
|}

[[File:navigateforums1.png|thumbnail|center|500px]]

===Exporting forum posts===
Users with the ''mod/forum:exportdiscussion'' or ''mod/forum:exportownpost'' or ''mod/forum:exportpost'' permission can export forum posts to any portfolio the administrator has enabled:

[[File:Exportforum.png]]

See the discussion [https://moodle.org/mod/forum/discuss.php?d=320382 Printing/exporting forum discussions] for further details.

==Using Forum: Teachers==

=== Private replies===

Teachers (or anyone with the capability [[Capabilities/mod/forum:postprivatereply|mod/forum:postprivatereply]] can reply privately to a forum message. By default, the reply is only seen by the recipient and the teachers of the course, and cannot be replied. (Details in [[https://tracker.moodle.org/browse/MDL-22077]])
[[File:SmallPrivateReply.png]]

===Pinned posts===

When adding a new discussion as a teacher, you can 'pin' it from the three dots to the right of the discussion. (See screenshot below.) Any forum discussions which come after that will appear underneath this pinned post. If you later click to 'unpin' it, it will display as a regular forum discussion, moving down the list when others are posted.

===Manually locking discussion threads===

By clicking 'Lock' from three dots to the right of a discussion, you can manually lock a thread so that nobody can post to it anymore. A padlock icon will appear next to the locked discussion. Clicking again will unlock it if necessary:

[[File:SmallForumStarPinLock.png]]

==='Send forum post notifications with no editing time delay'===

Teachers (and others with the [[Capabilities/moodle/course:manageactivities|capability to manage course activities]]) will see this option when posting to a forum. Ticking this box will send a notification to everyone subscribed to that forum with no editing time delay. (Users have 30 minutes by default to edit their posts.)

Note: For users who have enabled email digests in their forum preferences, the notification is NOT sent separately from other forum post notifications.

=== Display period ===

Teachers (and others with the capability [[Capabilities/mod/forum:viewhiddentimedposts|mod/forum:viewhiddentimedposts]]) can set a display period of a date and time for the forum post to appear.

[[File:timedposts.png|500px]]

Note: Timed forum posts were included in previous versions of Moodle as an experimental feature. In Moodle 3.1 onwards, it is enabled by default for new installations. For sites upgrading from a previous version, it may be enabled via ''Site administration > Plugins > Activity modules > Forum''.

===Locking a discussion===

Forum threads may be automatically locked after a certain period of inactivity. This is done from the setting 'Discussion locking' when creating or editing a new forum.

[[File:discussionlocking.png|center|thumb|600px|Locked discussion alert when viewing a forum.]]

*A period from a day to a year may be selected. The default is for discussions not to be locked.
*Watch the screencast [https://youtu.be/M9ZxCq50hiQ Discussion locking] to see a demonstration.
*Teachers and other users with the [[Capabilities/mod/forum:canoverridediscussionlock|capability to override locked discussions]] can unlock discussions simply by posting a reply.

===Moving a discussion===

Teachers and other users with the [[Capabilities/mod/forum:movediscussions|capability to move discussions]] can move a discussion to any other forum in the course for which they have appropriate rights.
# Click on the arrow in the 'Move this discussion to...' dropdown menu in the top right corner of the page and select a destination forum.
# Click the Move button.

Note: Moving a forum post will display incorrect results in the [[Participation_report|course participation report]] for the affected forums. For example, take a student who posted in forum A and had their post moved to forum B. In the course participation report, the student will still be listed as having made a post in forum A, but will not be listed as having made a post yet in forum B.

Note: Discussion subscriptions are retained when a post is moved.

===Splitting a discussion===

Teachers and other users with the [[Capabilities/mod/forum:splitdiscussions|capability to split discussions]] can split a discussion thread. Splitting a discussion means that beginning with the post selected and going to the end of that sub-thread, the posts are cut from the current discussion topic and put into a newly created discussion topic. If a discussion has strayed away from the original topic, splitting the discussion can provide new attention and space for the tangent discussion while keeping the original discussion on topic.

# Click the link 'Split' in the forum post
# Enter a new discussion name (optional)
# Click the Split button

Note: Discussion subscriptions are NOT retained when a post is split.

===Using groups with forums===
'Group mode' available from the Common module settings has three options. (Note that you must have groups in your course to use this feature.)
[[File:forumdiscussiongroup3.png|thumb|Forum with discussion to all participants with 'Post a copy to all groups' ticked]]
If the group mode is set to separate groups:

* Teachers (and other users with the [[Capabilities/mod/forum:canposttomygroups|capability to post in all groups they have access to]]) are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for a selected group, then only group members can reply to it. If the teacher adds a new discussion topic for all participants, they need to also tick the box 'Post a copy to all groups', otherwise students will only be able to view their post and not reply to it.
* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or discussions for their group started by a teacher.

If the group mode is set to visible groups:

* Teachers are given the option of adding a new discussion topic for all participants or a selected group. If a teacher adds a new discussion topic for a selected group, then only group members can reply to it.
* Students can only start discussions for their group.
* Students can only reply to discussions started by other group members or teachers.

Teachers, and other users with the capability [[Capabilities/moodle/site:accessallgroups|moodle/site:accessallgroups]] set to allow, can view and post in all forum discussions, regardless of the group mode setting.

Where visible groups are used, the user's groups will be shown first in the list, followed by other groups:

[[File:mygroupsfirst.png]]

Note: Single simple discussions cannot be set to separate groups (as this feature is not implemented). Instead, a standard forum should be used. If required, a permissions override may be set to prevent students from starting new discussions.
For teachers who have access to all or several groups in a forum, this setting allows them to post the same message once only to all groups.

===Forum grading===

To be able to grade forum posts, in the forum settings in the section 'Whole forum grading', you need to set the grade type to Point or Scale, then save.

==Ideas for using forums==

Ask yourself

# you wish to have involvement in the forum or if you want the students to lead and own the space
# you want the forum to add value to the face to face environment or have a life of its own in its own right outside the lecture theatre/classroom or seminar room
# you are prepared to make appropriate contributions to the discussion to:
## encourage discussion if students are quiet
## help shape ideas if students begin to wander off-task
## your role will be defined as discussions/a course progresses
## you will explicitly but gradually relinquish control of the discussions
## you will encourage and support learners to share control of discussions (for example you might ask a learner/group of learners to summarise contributions to a discussion thread/topic, or you might ask learners to initiate discussion topics)

[[de: Forum nutzen]]
[[fr:Afficher un forum]]
[[ja:フォーラムの閲覧]]
[[es:Usando Foro]]

Activity completion settings

2020-10-01T14:24:56Z

Tsala: /* Expect completed on */ Timeline block

{{Activity completion}}
==Activity settings==

Depending on the type of activity, there are different completion requirements. For example, a [[Page|Page]] might have the requirement to ''require view''; a [[Quiz|Quiz]] might have the requirement to ''require grade'' while a [[Forum|Forum]] might have the requirement to ''require posts/discussions/replies''.

<gallery widths="300px">
File:Activity_completion_settings_common.png|Activity completion settings for most graded activities
File:Forumactivitycompletion.png|Forum activity completion settings
File:24assignmentsubmit.png|Assignment activity completion settings
File:quizpassinggrade.png|Quiz activity completion settings
</gallery>

===Completion tracking===
There are three options:

*''Do not indicate activity completion'' - this will not show checks (ticks) next to the activity
*''Students can manually mark the activity as completed'' - students press the check (tick) to change it. (Note: they can do this even without doing the activity!)
*''Show activity as complete when conditions are met'' - the selected completion criteria must be met before the check (tick) will change style

===Require view===

When this option is ticked, students have to view the activity i.e. click the link in order to complete it. You should not turn on the 'view' condition if you have other requirements - this makes extra work for the server and it's unlikely that a student could meet any other conditions without viewing the activity.

===Require grade===

When this option is ticked, students have to get a grade on the activity in order to complete it. For example, a quiz would be marked completed as soon as the user submits it (so long as it doesn't contain any "essay" questions).

It does not matter how well the student did. Getting any grade will mark the activity completed.

====Setting a grade to pass for a quiz====

It is possible to distinguish between 'pass' and 'fail' grades so that a quiz becomes 'completed, passed' or 'completed, not passed' instead of just 'completed'. These results show a different icon and alternative text in the [[Using Activity completion|Activity completion report]].
[[File:quizpassfail.png|thumb|400px|center]]

To set this up, you need to specify the pass value for the quiz activity's individual grade:

# Go to the Quiz settings and in the Grade section, locate the 'Grade to pass' field.
# Enter a grade value (e.g. 5.0)
# Click the 'Save changes' button

'Completed, passed' shows a green tick and 'Completed, not passed' shows a red cross.

Once you have done this, anybody submitting the quiz will receive either the pass or fail completion icon. If the quiz can be taken multiple times, the completion icon will automatically update whenever the grade does.

There is one limitation: this only works if grades are immediately visible to students. The grade must be neither permanently hidden, nor hidden until a certain date. If a grade is hidden then only the standard 'completed' state will be displayed - even once the hidden date has passed.

====Require passing grade====

If a grade to pass is set for the quiz then it will be marked complete once the student obtains this grade.

If a certain number of attempts are allowed, the quiz may be marked complete once the student has done them all (even if, for example, they did not achieve the passing grade.)

Note that ''Require grade'' must be ticked as well as "Require passing grade".

===Lesson completion settings===
The following settings are specific to the Lesson activity (in addition to the standard ones)

[[File:newlessonconditions.png]]

====Require end reached====
In order for the lesson to be marked complete, the student must go to the very last page of the lesson.

====Require time spent====
In order for the lesson to be marked complete, the student must stay within the lesson pages for the time specified by the teacher here. The time can range from seconds to weeks. If they finish the lesson sooner, they will see an alert saying they did not reach the minimum time acceptable and may have to repeat the lesson.

[[File:lessonstudentviewrequiretimespent.png|thumb|400px|center|Student message if the condition is not met.]]

===Assignment completion settings===

=====Student must submit to this activity to complete it=====
This setting means that an assignment may be considered as completed once the student has submitted it but before the teacher has had time to grade it.

===Forum completion settings===

====Require posts====
For the forum to be classed as "complete" the student must either start a discussion or reply to a discussion. The total number of posts they must make can be specified in the box.

====Require discussions====
For the forum to be classed as "complete", the student must start a discussion topic. The number of posts they must make can be specified in the box. ''Note: this requirement cannot be satisfied using the "Single simple discussion" and the "Q and A" forum types, since students cannot create discussions in those two types.''

====Require replies====
For the forum to be classed as "complete" the student must reply to a discussion. The number of posts they must make can be specified in the box.

===Expect completed on===

When a date is entered here for a Forum activity, or for a resource, such as a Page or Folder, the expected completion date will be displayed in the [[Timeline block]].
[[File:expectedcompletion.png|center|thumb|600px|Add a date to display to students.]]

==Locked completion options==

If at least one person has completed an activity, completion options are 'locked'. This is because changing these options may result in unexpected behaviour. For example, if somebody has ticked an activity as manually completed, and you then set it to automatic completion, the activity will become unticked - very confusing for the student who had already ticked it!

:''Tip:'' It is best not to unlock options unless you are sure it won't cause problems - for example, if you know that students don't have access to the course yet, so it will only be staff who have marked the activity completed when testing.

==What happens when you unlock==

Once you unlock options and then click 'Save changes', all completion information for the activity will be deleted and, if possible, regenerated according to the new settings.

* If the new completion option is manual, everyone will be set to 'not completed' regardless of any previous setting.
* If it is automatic then, depending on the options chosen, the system may or may not be able to construct a correct current value for everyone.
** The 'viewed' requirement will not work - even if a student has viewed the activity before, it will not be marked completed until they view it again.
** Most other options will be recalculated successfully.

If you change completion options while a student is logged in, they may not see the changes for some minutes.

==Required site settings==
To use activity completion, the feature needs to be enabled for the site by an administrator as follows:
*In ''Administration > Site administration > [[Advanced_features| Advanced features]]'' check the "Enable completion tracking" box.
*The admin may also set the default completion tracking setting when adding new activities, choosing from 'Do not indicate completion' or ' Use activity default'
{|
|[[File:26defaultactivtycompletion.png|thumb|Selecting the default completion tracking setting]]
|}

* Click the 'Save changes' button

==Required course settings==

''Administration > Course administration > Edit settings'' and look for the ''Completion tracking'' section.

You must enable this setting.

==Changing activity completion settings in bulk==

Within a course, the default settings for activity completion may be changed and several activities may have their completion settings updated at once, from the tabs in the Course completion screen.

[[File:activitycompletiondefaultbulk.png]]

'''Default activity completion''' allows you to select one or more course activities or resources and change their default settings (usually 'manual') to a setting of your choice. For example, if you always want your quizzes to be completed with a specific passing grade, you can specify this here. If you always want assignments to be completed when submitted, you can specify this here. Note that the altered settings only apply to items added after the change, not to existing items on the course page.

'''Bulk edit activity completion''' allows you to change the completion requirements of one or several existing activities in one step. For example, if you have four quizzes with manual activity completion, you can bulk edit them so that all four require a grade to be marked complete.

{{MediaPlayer | url = https://youtu.be/q987DAm6sYM | desc = Activity completion enhancements in Moodle 3.3}}

[[Category: Completion]]

[[de:Einstellungen zum Aktivitätsabschluss]]
[[es:Configuraciones de finalización de actividad]]
[[fr:Paramètres Achèvement des activités]]

Badges FAQ

2020-09-28T12:58:02Z

Tsala: /* How can I add badges I have earned to my backpack? */ selecting US as region

{{Badges}}
==How can teachers award site badges?==

By default, teachers can only award course badges. Only users with capabilities to manage badges in the system are able to do this, so if you wish teachers to award site badges you need to create a new role as follows:

# Go to ''Administration > Site administration > Users > Permissions > Define roles'' and click 'Add a new role'
# Leave 'Use role or archetype' as No role' and click the continue button
# Give the role a name e.g. "Site badge awarder"
# Tick the '''System''' box to allow the role to be assigned in the System context
# Set the following capabilities to "allow": moodle/badges:awardbadge, moodle/badges:viewbadges, moodle/badges:configurecriteria
# Click the button 'Create this role".
# Assign the "Site badge awarder" role as a system role to the teachers you wish to award site badges.

Teachers with the role of "Site badge awarder" will see a link in the Administration block ''Site administration > Badges > Manage badges''.

==Can more than one teacher in a course award the same badge?==

It's not the user who issues the badge, but a role. Users with multiple roles will have an option to use both of them to issue badges. If the badge is awarded twice by different roles, both roles are displayed and criteria (ALL/ANY) is given. In some cases it will be required for a badge to be awarded by several different roles. When there are, let's say, three teachers in the course and they go to award a badge as a teacher, each of them will see the list of users who already got the badge from a teacher, so they won't need to award the badge again.

==What's the difference between a backpack and a collection?==

When you upload a badge to Badgr, you are adding it to your backpack, which is the general area you put your badges in (like a backpack). You then organise them into collections (like separate little bags in your backpack) and you choose which to display on your Moodle profile. So a badge may be in your backpack and not in a collection, but it must be in your backpack before it can be in a collection (note the 'public' box must be ticked too). Collections allow you to control which badges you share with people.
{|
|[[File:mozillabackpack.png|thumb|A user's online backpack]]
|[[File:collections.png|thumb|Drag badges into a new collection to display on Moodle]]
|}

==What size is a badge?==

A badge is displayed with dimensions 100 X 100 pixels. However, a larger image may be uploaded, which will then be cropped to be a square, and then resized.

See also [https://moodle.org/mod/forum/discuss.php?d=230591 Badge image size] discussion.

==Can I award a badge based on a specific grade?==

There are two ways of awarding a badge based on a specific grade.

Method 1:

Set a passing grade for the quiz in the gradebook, as explained in section 1.3 of [[Activity completion settings]].

Method 2:

# Create a page resource and set the restrict access conditions so that it only appears if the user obtains a certain activity grade or course total
# Set the activity completion for the page as "view"
# Set the badge criteria such that the page has to be completed (i.e. viewed)

==How can I add badges I have earned to my backpack?==

# If you've not done so already, create an account on https://badgr.com. When prompted to select a Badgr region, select 'United States' (regardless of where you are in the world, as you can only connect to a backpack on badgr.com).
# Go to your backpack settings (via Preferences / Badges) and connect to your Badgr backpack by entering your email address and password for your Badgr account.
# Go to Manage badges (via Preferences / Badges) and click the icon to add your badge to your backpack.

==I previously used the Mozilla Open Badges backpack as the active external backpack on my site. How do I change to Badgr?==

See the section 'Enabling Badgr as the active external backpack' in [[Badges settings]].

==I previously added badges to my Mozilla Open Badges backpack. What do I do now?==

# Create an account on https://badgr.io.
# You will receive an email from Mozilla with a zipped file of your badges, which you can upload to your Badgr backpack.

==I have an account on eu.badgr.com but I can't connect to my backpack==

If your site has badgr.com set as the active external backpack, then you can't use your eu.badgr.com (or other regional site) account to connect. You need to create a (separate) account on https://badgr.com and select 'US' if asked to choose a location. This issue is reported as MDL-66585.

==Do I have to use my Moodle email for my backpack?==

No, you can specify the email address associated with your backpack.

==Which roles can see which badges?==

See this forum post on [https://moodle.org/mod/forum/discuss.php?d=234155&parent=1017187#p1017363 viewing badges].

==Can I change a badge image once awarded?==
The short answer is 'no', but see this forum post on [https://moodle.org/mod/forum/discuss.php?d=228553 changing badge images] for more information.

==Can I revoke a badge once it has been awarded?==

Yes - see the section on revoking a badge in [[Using badges]].

==How can I get badges with participants' profiles like on Moodle.org?==
[[File:profilebadges.png|thumb|500px|center]]

These are not badges. These are group avatars/pictures. When you create a group in your course - see the documentation on [[Groups]] - you can add a picture to represent that group. In places such as forums this picture is then displayed for each participant. If they are a member of several groups then several pictures will be displayed.
==Any further questions?==

Please post in the [https://moodle.org/mod/forum/view.php?id=8085 Badges forum] on moodle.org

==See also==

* [https://www.openbadges.me/ OpenBadges.me] - An open-access image creator from MyKnowledgeMap to support all of your Open Badge building needs.
* [http://moodlebadges.com/ Badges For Your Moodle] - CC-licensed badges available for free download

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=353554 Site closure and open badges]

[[Category:FAQ]]

[[fr:FAQ sur les badges]]
[[es:Insignias FAQ]]
[[ja:バッジFAQ]]

Permissions

2020-09-28T06:54:51Z

Tsala: course and activity permissions changes for Boost-based themes

{{Roles}}
Moodle allows specific roles to be able to change other specific role capabilities based on the context. For example, a teacher in a course may want all students (users with a student role) to be able to edit all forums in that course. Or a teacher may want all students in a specific forum to be able to edit that forum.

If you want to give a specific student the ability to edit a specific activity, see [[Override permissions]].

==Course and activity permissions==

[[File:Permissions.png|thumb|Course permissions]]Permissions for a course can be changed on the course page via the ''Actions menu > More > Users tab > Permissions'' (Boost-based themes) or ''Course administration > Users > Permissions'' (Classic-based themes).

Permissions for a particular activity can be changed on the activity page via the ''Actions menu > Permissions'' (Boost-based themes) or ''Activity administration > Permissions'' (Classic-based themes).

Click the Allow icon (+) opposite a capability to give permission to additional roles or the Prevent icon (X) to take away permission.

==Front page permissions==

Front page permissions can be changed in ''Front page settings > Users > Permissions'' and for a particular activity in ''Activity administration > Permissions''.

==Block permissions==

To change role permissions for a block

# Turn editing on in the course
# In the actions menu in the header of the block, click Permissions'.

==Checking permissions==

[[Image:Check permissions.png|thumb|Check permissions]]The check permissions feature provides a method to view all roles both in the current context and higher contexts and capabilities for a selected user based on their role assignments. These capabilities determine whether or not the selected user is allowed to perform associated tasks within the system or course.

A teacher can check permissions for their course in ''Course administration > Users > Permissions > Check permissions'' and for a particular activity in ''Activity administration > Check permissions''.

An administrator can check system permissions in ''Site administration > Users > Permissions > Check system permissions''.

The [[Capabilities/moodle/role:review|review permissions for others capability]] (allowed for the default roles of manager, teacher and non-editing teacher) controls whether a user can check permissions.

==Capability overview report==
[[Image:26capabilityoverview.png|thumb|Capability overview multi-select]]
An administrator can generate a capability overview report in ''Site administration > Users > Permissions > Capability overview''.

The report allows the administrator to select a capability and one or more roles. The report will show the role and its permission level for that capability. And if that capability was overridden for the role where in the site. For example, it might show that the gradereport:user view capability for a student role is set at the system level as "Allow" and for Course 1 it is set to "Prohibit".

It is possible to select more than one capability with more than one role and have an overview of all.

{{New features}}In Moodle 3.9 onwards, permissions for two or more roles may be more easily compared by ticking the 'Show differences only' checkbox.

==See also==

* [[Risks]]
* [[:Category:Capabilities|List of all capabilities]]

[[eu:Sistemako_baimenak_aztertu]]
[[fr:Permissions]]
[[de:Rechte]]
[[es:Permisos]]

Capabilities/moodle/course:isincompletionreports

2020-09-25T09:54:46Z

Tsala: links, completion cat

{{Capabilities}}
* This allows a user to be shown on [[Activity completion]] or [[Course completion]] reports.
* This capability is allowed for the default role of student only.

[[Category:Capabilities]]
[[Category:Report]]
[[Category:Completion]]

[[es:Capabilities/moodle/course:isincompletionreports]]

Content bank

2020-09-18T15:01:01Z

Tsala: rewording

{{Managing content}}
{{New features}}
==What is the content bank?==

The content bank is an area in Moodle where content (currently [[H5P]] content) may be stored, edited and created.

The content bank repository gives access to these files from the file picker.

[[File:H5Pcontentbank.png|center|Content bank]]

==Where is the content bank?==

As a teacher, when you are in a course you'll find a link to the content bank in the Navigation drawer (Boost-based themes) or the Navigation block, under Site pages (Classic-based themes).

Files may be viewed in list view by clicking the icon top right of the content bank.

The content bank repository is available from the file picker to locate and add H5P files into courses.

==How does the content bank work?==

New H5P content may be created via the Add button. It can be edited by clicking into the content then clicking Edit:

[[File:EditH5P.png|center|Editing existing H5P]]

H5P activities can also be uploaded into the content bank then edited if required.

H5P activity types available in the content back are automatically downloaded via CRON or can manually be added by uploading h5p activity files (*.h5p).

==Renaming and deleting H5P==
Click into an H5P activity and from the cog icon top right, access the Rename and Delete options.
[[File:H5pRenameDelete.png|center|Renaming and deleting]]

==Searching the content bank==
*The search field above the content bank allows you to search for H5P content in the course you are in.
*When adding an H5P activity from ''Add an activity or resource > H5P'', you can search the content bank for H5P in other courses and categories, depending on permissions.

[[File:ContentBankSearch.png|center|Searching the content bank]]

==Admin settings==
*From ''Site administration > Plugins > Content bank > Manage content types'', you can enable and disable H5P content.
*From ''Site administration > Repositories > Content bank'' you can rename the content bank repository if desired.

==Capabilities==

===Repository: Content bank===
* [[Capabilities/repository/contentbank:accesscoursecategorycontent|Access course category content bank files]] - allowed for the default roles of manager and course creator
* [[Capabilities/repository/contentbank:accessgeneralcontent|Access system content bank files]] - allowed for the default role of authenticated user
* [[Capabilities/repository/contentbank:accesscoursecontent|Access course content bank files]] - allowed for the default roles of manager, course creator and teacher
* [[Capabilities/repository/contentbank:view|View content bank repository]] - allowed for the default roles of manager, course creator and teacher

===Course===

* [[Capabilities/moodle/contentbank:access|Access the content bank]] - allowed for the default roles of manager, course creator and teacher
* [[Capabilities/moodle/contentbank:deleteanycontent|Delete any content from the content bank]] - allowed for the default roles of manager and course creator
* [[Capabilities/moodle/contentbank:deleteowncontent|Delete content from own content bank]] - allowed for the default role of authenticated user
* [[Capabilities/moodle/contentbank:manageanycontent|Manage any content from the content bank]] - allowed for the default roles of manager and course creator
* [[Capabilities/moodle/contentbank:manageowncontent|Manage content from own content bank]] - allowed for the default roles of manager, course creator and teacher
* [[Capabilities/moodle/contentbank:upload|Upload new content to the content bank]] - allowed for the default roles of manager, course creator and teacher
* [[Capabilities/moodle/contentbank:useeditor|Create or edit content using a content type editor]] - allowed for the default roles of manager and course creator

===H5P===
* [[Capabilities/contenttype/h5p:access|Access H5P content in the content bank]] - allowed for the default roles of manager, course creator and teacher
* [[Capabilities/contenttype/h5p:upload|Upload new H5P content]] - allowed for the default roles of manager, course creator and teacher
* [[Capabilities/contenttype/h5p:useeditor|Create or edit content using the H5P editor]] - allowed for the default roles of manager, course creator and teacher

[[Category:H5P]]
[[Category:Content bank]]

[[es:Banco de contenido]]
[[de:Inhaltsspeicher]]

H5P

2020-09-18T12:10:31Z

Tsala: creating a shortcut image

{{Managing content}}
==About H5P==

H5P is an abbreviation for HTML5 Package. It enables educators to create content such as interactive videos, quizzes and presentations. H5P content can be created in the [[Content bank]] (new in 3.9), or on h5p.com, and added to your course as an [[H5P activity]] (new in 3.9) or embedded into any other activity or resource.

{{MediaPlayer | url =https://youtu.be/p7ihJZgZQ4M | desc = Content bank and H5P}}

==Creating and editing H5P content==

To create and edit H5P content,
# Go to the [[Content bank]], accessible when in a course from the Navigation drawer (Boost theme) or from Site pages in the Navigation block (Classic theme).
# Click the Add button and select a content type.

For more information, see [[Content bank]].

==Adding an H5P activity to a course==

See [[H5P activity]] for how to create an H5P activity in a course.

==Embedding H5P into other activities==
[[File:H5PiconAtto.png|thumb|H5P button in the Atto editor]]
You can embed H5P content into other activities and resources such as a [[Lesson]] or a [[Book]], by clicking the H5P button in the [[Atto editor]].

To embed H5P from the Content bank:

# Click the H5P button in Atto then click 'Browse repositories'.
# Browse the Content bank repository and select an H5P file.
# Choose to either make a copy of the file or create a shortcut.
# Click the button 'Select this file'.
# Click 'Insert H5P'.
[[File:creating a shortcut.png|thumb|Creating a shortcut to the file]]
Note: If you create a shortcut to the file, you can edit it in the Content bank and any activities with a link to the file will be updated.

==Admin settings==

For H5P content to display in other activities, the [[Display H5P filter]] must be enabled and the URL e.g. h5p.com should be listed as an allowed source in ''Site admin / Plugins / Filters / Display H5P''.

===Manage H5P content types===

For teachers to upload and display H5P files in their courses, [https://h5p.org/content-types-and-applications H5P content types] and libraries must be available on the site. A scheduled task ''Download available H5P content types from h5p.org'' does this automatically (but check if it is enabled and has already run after first upgrading your site).

If it is not possible to use this scheduled task, then the Site administration page 'Manage H5P content types' allows you to upload necessary files.

(If the scheduled task is not run and files are not uploaded, teachers will receive an error message when attempting to upload H5P content.)

==Capabilities==

In addition to capabilities relating to the [[H5P activity]] and the [[Content bank]] there are further H5P capabilities as follows:

* [[Capabilities/atto/h5p:addembed|Add embedded H5P]] - allowed for the default role of teacher
* [[Capabilities/moodle/h5p:setdisplayoptions|Set H5P display options]] - allowed for the default role of teacher
* [[Capabilities/moodle/h5p:updatelibraries|Manage H5P content types]] - allowed for the default role of manager only
* [[Capabilities/moodle/h5p:deploy|Deploy H5P content]] - allowed for the default roles of manager and teacher

==See also==

* [[H5P activity]]
* [[H5P FAQ]]
* [https://elearningworld.h5p.com/content/1290985419330027149 Comparison chart of H5P questions and standard quiz questions]
* [https://www.youtube.com/watch?v=hxYgod9CIYg Moodle & H5P, Magic Together | Michelle Lomman | MoodleMoot Global 2020]

[[Category:H5P]]
[[Category:Language teaching]]

[[es:H5P]]

File:creating a shortcut.png

2020-09-18T12:08:40Z

Tsala:

H5P

2020-09-18T10:09:33Z

Tsala: /* Embedding H5P into other activities */ rewording

{{Managing content}}
==About H5P==

H5P is an abbreviation for HTML5 Package. It enables educators to create content such as interactive videos, quizzes and presentations. H5P content can be created in the [[Content bank]] (new in 3.9), or on h5p.com, and added to your course as an [[H5P activity]] (new in 3.9) or embedded into any other activity or resource.

{{MediaPlayer | url =https://youtu.be/p7ihJZgZQ4M | desc = Content bank and H5P}}

==Creating and editing H5P content==

To create and edit H5P content,
# Go to the [[Content bank]], accessible when in a course from the Navigation drawer (Boost theme) or from Site pages in the Navigation block (Classic theme).
# Click the Add button and select a content type.

For more information, see [[Content bank]].

==Adding an H5P activity to a course==

See [[H5P activity]] for how to create an H5P activity in a course.

==Embedding H5P into other activities==
[[File:H5PiconAtto.png|thumb|H5P button in the Atto editor]]
You can embed H5P content into other activities and resources such as a [[Lesson]] or a [[Book]], by clicking the H5P button in the [[Atto editor]].

To embed H5P from the Content bank:

# Click the H5P button in Atto then click 'Browse repositories'.
# Browse the Content bank repository and select an H5P file.
# Choose to either make a copy of the file or create a shortcut.
# Click the button 'Select this file'.
# Click 'Insert H5P'.

Note: If you create a shortcut to the file, you can edit it in the Content bank and any activities with a link to the file will be updated.

==Admin settings==

For H5P content to display in other activities, the [[Display H5P filter]] must be enabled and the URL e.g. h5p.com should be listed as an allowed source in ''Site admin / Plugins / Filters / Display H5P''.

===Manage H5P content types===

For teachers to upload and display H5P files in their courses, [https://h5p.org/content-types-and-applications H5P content types] and libraries must be available on the site. A scheduled task ''Download available H5P content types from h5p.org'' does this automatically (but check if it is enabled and has already run after first upgrading your site).

If it is not possible to use this scheduled task, then the Site administration page 'Manage H5P content types' allows you to upload necessary files.

(If the scheduled task is not run and files are not uploaded, teachers will receive an error message when attempting to upload H5P content.)

==Capabilities==

In addition to capabilities relating to the [[H5P activity]] and the [[Content bank]] there are further H5P capabilities as follows:

* [[Capabilities/atto/h5p:addembed|Add embedded H5P]] - allowed for the default role of teacher
* [[Capabilities/moodle/h5p:setdisplayoptions|Set H5P display options]] - allowed for the default role of teacher
* [[Capabilities/moodle/h5p:updatelibraries|Manage H5P content types]] - allowed for the default role of manager only
* [[Capabilities/moodle/h5p:deploy|Deploy H5P content]] - allowed for the default roles of manager and teacher

==See also==

* [[H5P activity]]
* [[H5P FAQ]]
* [https://elearningworld.h5p.com/content/1290985419330027149 Comparison chart of H5P questions and standard quiz questions]
* [https://www.youtube.com/watch?v=hxYgod9CIYg Moodle & H5P, Magic Together | Michelle Lomman | MoodleMoot Global 2020]

[[Category:H5P]]
[[Category:Language teaching]]

[[es:H5P]]