MoodleDocs - User contributions [en]

mod/assign/feedback/editpdf/testunoconv/systemd

2017-06-14T11:27:41Z

Ghillenb:

= SystemD script example for unoconv on CentOS/RedHat 7.x =
[[ mod/assign/feedback/editpdf/testunoconv | Back to unoconv installation ]]

<pre>vim /etc/systemd/system/unoconv.service</pre>

If you installed [http://www.tecmint.com/install-libreoffice-on-rhel-centos-fedora-debian-ubuntu-linux-mint/ LibreOffice 5.2] packages that are not part of the CentOS/RedHat distribution,
You better add the ''Environment="UNO_PATH=/opt/libreoffice5.2/program" '' to the file (as seen in the example below) as ''unoconv'' might need the python libraries that came with the LibreOffice 5.2 packages.
Otherwise, discard the 'Environment' line from the file.

Also, if you installed 'unoconv' from [https://github.com/dagwieers/unoconv sources] (like in the example below), make sure you use the proper path (i.e "/usr/local/bin/unoconv").

<pre>
[Unit]
Description=Unoconv listener for document conversions
Documentation=https://github.com/dagwieers/unoconv
After=network.target remote-fs.target nss-lookup.target

[Service]
Type=simple
Environment="UNO_PATH=/opt/libreoffice5.2/program"
ExecStart=/usr/local/bin/unoconv --listener

[Install]
WantedBy=multi-user.target
</pre>

[[de:SystemD Service Skript für CentOS/RedHat 7.x]]
After you saved the above file, make it stick between system boots:

<pre>
#systemctl enable unoconv.service
#systemctl start unoconv.service
</pre>

[[ mod/assign/feedback/editpdf/testunoconv | Back to unoconv installation ]]

mod/assign/feedback/editpdf/testunoconv/initdcentos6

2017-06-14T11:12:05Z

Ghillenb:

Create a new init file: "vim /etc/init.d/unoconvd"
<code ini>
#!/bin/sh
### BEGIN INIT INFO
# Provides:
# Required-Start: $remote_fs $syslog
# Required-Stop: $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start daemon at boot time
# Description: Enable service provided by daemon.
### END INIT INFO

#UNO_PATH=/opt/libreoffice5.2/program unoconv --listener

dir="/opt/libreoffice5.2/program"
#cmd="/usr/bin/unoconv -vvv --listener &"
cmd="/usr/bin/unoconv --listener"
user="root"

name=`basename $0`
pid_file="/var/run/$name.pid"
stdout_log="/var/log/$name.log"
stderr_log="/var/log/$name.err"

get_pid() {
cat "$pid_file"
}

is_running() {
[ -f "$pid_file" ] && ps `get_pid` > /dev/null 2>&1
}

case "$1" in
start)
if is_running; then
echo "Already started"
else
echo "Starting $name"
cd "$dir"
if [ -z "$user" ]; then
sudo $cmd >> "$stdout_log" 2>> "$stderr_log" &
else
sudo -u "$user" $cmd >> "$stdout_log" 2>> "$stderr_log" &
fi
echo $! > "$pid_file"
if ! is_running; then
echo "Unable to start, see $stdout_log and $stderr_log"
exit 1
fi
fi
;;
stop)
if is_running; then
echo -n "Stopping $name.."
kill `get_pid`
killall soffice.bin
for i in {1..10}
do
if ! is_running; then
break
fi

echo -n "."
sleep 1
done
echo

if is_running; then
echo "Not stopped; may still be shutting down or shutdown may have failed"
exit 1
else
echo "Stopped"
if [ -f "$pid_file" ]; then
rm "$pid_file"
fi
fi
else
echo "Not running"
fi
;;
restart)
$0 stop
if is_running; then
echo "Unable to stop, will not attempt to start"
exit 1
fi
$0 start
;;
status)
if is_running; then
echo "Running"
else
echo "Stopped"
exit 1
fi
;;
*)
echo "Usage: $0 {start|stop|restart|status}"
exit 1
;;
esac

exit 0

</code>

Install:
<code ini>
chmod 755 /etc/init.d/unoconvd
chkconfig --add unoconvd
chkconfig --level 5 unoconvd on
chkconfig --level 4 unoconvd on
chkconfig --level 3 unoconvd on

/etc/init.d/unoconvd start
</code>

[[de:Init_Skript_für_CentOS/RedHat_6.x]]

mod/assign/feedback/editpdf/testunoconv/initd

2017-06-14T11:01:02Z

Ghillenb:

= Init script example for unoconv on debian =
[[ mod/assign/feedback/editpdf/testunoconv | Back to unoconv installation ]]

This script can be installed to /etc/init.d/unoconvd and then linked to system startup with the command:
<pre>
sudo update-rc.d unoconvd defaults
</pre>

If you are planning to unoconv service for remote access as described [[ mod/assign/feedback/editpdf/testunoconv#Offload_processing_to_a_different_server | here ]], notice that it will be listening on localhost interface by default. To make it listen on the different network interface, you need to create <tt>/etc/default/unoconv</tt> with a content below to override DAEMON_ARGS variable (use specific IP if you have more than one network interface, or 0.0.0.0 to listen on all of them):
<pre>
# Override arguments to make unoconv listening on network interface.
DAEMON_ARGS="--listener -s 0.0.0.0"
</pre>

It is also recommended to add this to the root crontab as it is safe to run "sudo service unoconvd start" over and over (it will check if the process is running and start it if required).

Crontab entry to check and start the process every 5 minutes. This version will print a message when unoconv is restarted so that an email will be sent by cron.
<pre>
*/5 * * * * /usr/bin/service unoconvd status > /dev/null || (/usr/bin/service unoconvd start && echo "Restarted crashed unoconv listener")
</pre>

Here is the script.
<pre>
#! /bin/sh
### BEGIN INIT INFO
# Provides: unoconvd
# Required-Start: $remote_fs $syslog
# Required-Stop: $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Startup script for unoconvd listener
# Description: Startup script for unoconvd listener. Allows starting/stopping/restarting and checking status of unoconvd listener.
### END INIT INFO

# Author: Damyon Wiese <damyon@moodle.com>

# Do NOT "set -e"

# PATH should only include /usr/* if it runs after the mountnfs.sh script
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="Unoconv listener for document conversions"
NAME=unoconv
DAEMON=/usr/bin/$NAME
DAEMON_ARGS="--listener"
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME
APACHEUSER=www-data

# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0

# Read configuration variable file if it is present
[ -r /etc/default/$NAME ] && . /etc/default/$NAME

# Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh

# Define LSB log_* functions.
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
# and status_of_proc is working.
. /lib/lsb/init-functions

#
# Function that starts the daemon/service
#
do_start()
{
# Return
# 0 if daemon has been started
# 1 if daemon was already running
# 2 if daemon could not be started
start-stop-daemon --start --quiet --make-pidfile --background --pidfile $PIDFILE --exec $DAEMON --chuid $APACHEUSER --test > /dev/null \
|| return 1
status_of_proc "$DAEMON" "$NAME" > /dev/null
RETVAL="$?"
[ "$RETVAL" = 3 ] && start-stop-daemon --start --quiet --make-pidfile --background --pidfile $PIDFILE --exec $DAEMON --chuid $APACHEUSER -- \
$DAEMON_ARGS \
|| return 2
# Add code here, if necessary, that waits for the process to be ready
# to handle requests from services started subsequently which depend
# on this one. As a last resort, sleep for some time.
}

#
# Function that stops the daemon/service
#
do_stop()
{
# Return
# 0 if daemon has been stopped
# 1 if daemon was already stopped
# 2 if daemon could not be stopped
# other if a failure occurred
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
RETVAL="$?"
[ "$RETVAL" = 2 ] && return 2
# Wait for children to finish too if this is a daemon that forks
# and if the daemon is only ever run from this initscript.
# If the above conditions are not satisfied then add some other code
# that waits for the process to drop all resources that could be
# needed by services started subsequently. A last resort is to
# sleep for some time.
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
[ "$?" = 2 ] && return 2
# Many daemons don't delete their pidfiles when they exit.
rm -f $PIDFILE

/usr/bin/killall /usr/lib/libreoffice/program/soffice.bin

return "$RETVAL"
}

#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
#
# If the daemon can reload its configuration without
# restarting (for example, when it is sent a SIGHUP),
# then implement that here.
#
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
return 0
}

case "$1" in
start)
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
do_start
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
stop)
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
do_stop
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
status)
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
;;
#reload|force-reload)
#
# If do_reload() is not implemented then leave this commented out
# and leave 'force-reload' as an alias for 'restart'.
#
#log_daemon_msg "Reloading $DESC" "$NAME"
#do_reload
#log_end_msg $?
#;;
restart|force-reload)
#
# If the "reload" option is implemented then remove the
# 'force-reload' alias
#
log_daemon_msg "Restarting $DESC" "$NAME"
do_stop
case "$?" in
0|1)
do_start
case "$?" in
0) log_end_msg 0 ;;
1) log_end_msg 1 ;; # Old process is still running
*) log_end_msg 1 ;; # Failed to start
esac
;;
*)
# Failed to stop
log_end_msg 1
;;
esac
;;
*)
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
exit 3
;;
esac

</pre>

[[ mod/assign/feedback/editpdf/testunoconv | Back to unoconv installation ]]

[[es:mod/assign/feedback/editpdf/testunoconv/initd]]
[[de:Init_Skript_für_Debian]]

mod/assign/feedback/editpdf/testunoconv/launchd

2017-06-14T10:45:54Z

Ghillenb:

This launchd script will start a unoconv listener at boot time and restart it if it crashes. The HOME directory for the unoconv process
will be set to "/tmp/" and the user will be "_www" (default apache user on OS X).

Copy this script to /Library/LaunchDaemons/unoconv.plist to install it, then run:

$ sudo launchctl load /Library/LaunchDaemons/unoconv.plist

to start it.

Here is the script.
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>Unoconv</string>
<key>ProgramArguments</key>
<array>
<string>/usr/local/bin/unoconv</string>
<string>--listener</string>
</array>
<key>EnvironmentVariables</key>
<dict>
<key>HOME</key>
<string>/tmp/</string>
</dict>
<key>KeepAlive</key>
<true/>
<key>UserName</key>
<string>_www</string>
</dict>
</plist>
</pre>

[[de:Launchd Skript für OS X]]

mod/assign/feedback/editpdf/testunoconv/upstart

2017-06-14T10:44:16Z

Ghillenb:

= Upstart script example for unoconv on ubuntu =
[[ mod/assign/feedback/editpdf/testunoconv | Back to unoconv installation ]]

This script can be installed to /etc/init/unoconv.conf and then started with the command:
<pre>
sudo start unoconv
</pre>

Here is the script.
<pre>
# Unoconv listener service

# Install to /etc/init/ folder and start with "sudo service unoconv start"
# This will start a unoconv listener and restart it if it dies. The listener
# will run as the apache user "www-data" and have access to the same files/folders
# as that user.
# The home folder for this listener will point to /tmp/ and any temporary files used by
# libreoffice will be created there.

description "Unoconv Apache Listener"
author "Damyon Wiese <damyon@moodle.com>"

start on filesystem or runlevel [2345]
stop on starting rc RUNLEVEL=[016]

respawn
respawn limit 2 5

env HOME=/tmp
setuid www-data

# The default of 5 seconds is too low for mysql which needs to flush buffers

pre-start script
# Kill any currently running soffice processes.
/usr/bin/killall soffice.bin || true

# Service logging when starting
echo "[`date`] Starting unoconv service" >> /var/log/unoconv.log
end script

script
# pid file...
echo $$ > /var/run/unoconv.pid
exec usr/bin/unoconv --listener
end script

pre-stop script
# Remove pid file first
rm /var/run/unoconv.pid
# Service logging when stopping
echo "[`date`] Stopping unoconv service" >> /var/log/unoconv.log
end script
</pre>

[[ mod/assign/feedback/editpdf/testunoconv | Back to unoconv installation ]]

[[de:Upstart Skript für Ubuntu Systeme]]

mod/assign/feedback/editpdf/testunoconv/upstart

2017-06-14T10:27:52Z

Ghillenb:

Universal Office Converter (unoconv)

2017-06-13T09:40:50Z

Ghillenb:

{{Environment}}
==What is unoconv?==

"unoconv" is a command line program that is used to convert between different office document file formats. It uses an instance of [http://libreoffice.org LibreOffice] to do the conversion and is used by the [[Assignment activity]] to convert documents to pdf so that they can be annotated. If unoconv is not installed - the only impact is that the assignment activities will only allow annotations when students upload a pdf document.

The steps required to install unoconv are different depending on the operating system that you have installed Moodle on.

== Installing unoconv on Linux ==
The required version of unoconv is at least 0.7. Depending on your flavour of linux, this may be available in your package manager and you can install it directly with:

===Ubuntu 16.04 LTS===

<pre>
apt-get install unoconv
</pre>

If your package manager contains an older version of the package, you will have to find a newer version and install it manually ([https://packages.debian.org/stretch/unoconv Debian Testing]). Unoconv itself is just a python script, so it has few dependencies.

Potential problems:
* On some systems the apache user home directory is set to a non existent folder. This can cause unoconv to fail. There are 2 solutions to this - one is to make a (writable) home directory for the apache user (like /home/www-data). The other is to run a unoconv listener (described below) as another user other than the apache user (someone with a valid, writable home directory).
* If you are still running 14.04LTS then unoconv won't work as shipped. This might not be the most efficient route but it worked by first installing unoconv (version 0.6) from the package manager as above. You will then need to grab unoconv 0.7 from Github (https://github.com/dagwieers/unoconv), then upgrade to the latest libreoffice using the PPA (https://launchpad.net/~libreoffice/+archive/ubuntu/ppa). Point moodle at the Github version of unoconv. You need to modify the Python unoconv file by changing 'python' in the first line to 'python3'. You also need to change the permissions on the directory /var/www so that the user www-data can write to it (www-data needs to write to its home directory which it cannot do by default).
On Debian Stable, the cleanest method to install [https://packages.debian.org/jessie-backports/unoconv unoconv] is using Jessie-backports. First, enable backports repo line in /etc/apt/sources.list:
<pre>
#### Jessie-backports ####
deb http://ftp.debian.org/debian jessie-backports main
</pre>

Then, update and install unoconv from jessie-backports:
<pre>
apt-get update
apt-get install -t jessie-backports unoconv
</pre>

The package will bring all necessary dependencies for you.

===Ubuntu 14.04 LTS===

1) Navigate to opt directory
<pre>
cd /opt
</pre>

2) Download unoconv
<pre>
sudo wget https://raw.githubusercontent.com/dagwieers/unoconv/master/unoconv
</pre>

3) Modify the Python unoconv file by changing 'python' in the first line to 'python3'
<pre>
sudo nano /opt/unoconv
</pre><br>
eg. <pre>#!/usr/bin/env python3</pre>

4) Make unoconv executable
<pre>
sudo chmod ugo+x /opt/unoconv
</pre>

5) Add LibreOffice PPA to your system and install the latest version
<pre>
sudo add-apt-repository ppa:libreoffice/ppa
sudo apt-get update
sudo apt-get install libreoffice
</pre>

6) Change permissions so apache can write to its home directory
<pre>
sudo chown www-data /var/www
</pre>

7) From your browser navigate to
''Site administration > Server > System paths'' and add the path to unoconv<br>
/opt/unoconv
*Note: if you would like to preserve the default path add a symbolic link to /usr/bin:
<pre>
sudo ln -s /opt/unoconv /usr/bin/
</pre>

8) Navigate to
''Site administration > Plugins > Activity modules > Assignment > Feedback plugins > Annotate PDF > Test unoconv path'' <br>
You should see: <br>
"The unoconv path appears to be properly configured."<br>
*Download the converted pdf test file. (if the PDF fails to load ensure that www-data can write to its home directory: /var/www)

===CentOS / RedHat===
Just before you start, you might like to consider installing the latest [http://www.tecmint.com/install-libreoffice-on-rhel-centos-fedora-debian-ubuntu-linux-mint/ LibreOffice 5.2] directly from RPM packages, that are not part of the distribution you are using.
As of nov-2016, CentOS and RedHat 7.2 comes with OpenOffice 4.3 . so if you are not interested in using this version and would like to install latest 5.2 independent LibreOffice 5.2 , please remove any openoffice packages you might have on your OS by issuing:
<pre>
yum remove openoffice* libreoffice*
</pre>
And then follow the install instructions [http://www.tecmint.com/install-libreoffice-on-rhel-centos-fedora-debian-ubuntu-linux-mint/ LibreOffice 5.2]. It is recommended to chose your localized libreoffice version for better document conversions. and also please skip the following "yum install openoffice* ..." command.
<pre>
yum install openoffice* openoffice-pyuno
git clone https://github.com/dagwieers/unoconv.git
# copy
cp unoconv/unoconv /usr/bin
# or link unoconv to /usr/bin
ln -s unoconv/unoconv /usr/bin/unoconv
</pre>
Note: depends on what version you are installing, openoffice or libreoffice, make sure you installed the *-pyuno package. (the headless package is already compiled into the core)

Make sure it is properly configured:
http://your-moodle/admin/search.php?query=unoconv

Production servers should consider running unoconv in listener mode, see [[Installing_unoconv#Run_a_unoconv_listener]] or follow directions bellow
<pre>
vi /etc/systemd/system/unoconv.service
</pre>
And then copy and paste the following configuration into it:
<pre>
[Unit]
Description=Unoconv listener for document conversions
Documentation=https://github.com/dagwieers/unoconv
After=network.target remote-fs.target nss-lookup.target

[Service]
Type=simple
Environment="UNO_PATH=/usr/lib64/libreoffice/program"
ExecStart=/usr/bin/unoconv --listener

[Install]
WantedBy=multi-user.target
</pre>
And then enable and start the above service
<pre>
systemctl enable unoconv.service
systemctl start unoconv.service
</pre>

== Installing unoconv on OS X ==
Download and install LibreOffice for Mac. Unfortunately - newer versions of LibreOffice are not currently compatible with unoconv for mac and you will have to install LibreOffice 4.2 (Direct download link - https://downloadarchive.documentfoundation.org/libreoffice/old/4.2.5.2/mac/x86_64/LibreOffice_4.2.5.2_MacOS_x86-64.dmg).

Get the latest version of the unoconv python script. One way to do this is with http://brew.sh/ brew.
<pre>
brew install unoconv
</pre>

If you haven't done it already - install ghostscript. One way to install ghostscript is also with http://brew.sh/ brew
<pre>
brew install ghostscript
</pre>

Set the paths to unoconv and ghostscript in Moodle (''Site administration > Server > System paths''). If you used brew, they will both be installed to /usr/local/bin.

LibreOffice needs write access to the current users home directory to create some temporary files. When unoconv is run as the webserver user (_www) it does not normally have this permission.

There are some ways to get around this - one way is just to give the "_www" user write access to /Library/WebServer.

Another solution is to convince LibreOffice that this users home directory is somewhere else. This can be done by inserting this code into the top of the unoconv python script.
Code to insert:
<pre>
# Set home to a writable folder.
os.environ['HOME'] = '/tmp/'
</pre>

This needs to be inserted at line 36 immediately after the line "exitcode = 0"

== Installing unoconv on Windows ==
Download and install LibreOffice for windows.

Download the latest version of the unoconv script from https://github.com/dagwieers/unoconv/releases (download the zip version).

From the downloaded zip file - extract the one file "unoconv-0.7\unoconv" (no file extension). This is the unoconv script - none of the other files in the package are required.

Rename the downloaded script to C:\unoconv\unoconv.py

Create a batch file C:\unoconv\unoconv.bat with these contents:

<pre>
@"C:\Program Files\LibreOffice 5\program\python.exe" c:\unoconv\unoconv.py %*
</pre>

Set paths in Moodle.

Login as admin and go to ''Site administration > Server > System paths''

Set pathtogs setting to your ghostscript installation binary, (C:\gs\bin\gswin32.exe)

Set pathtounoconv to the batch file created above (C:\unoconv\unoconv.bat)

Test ghostscript and unoconv are working correctly in the admin test pages "Site administration > Plugins > Activity modules > Assignment > Feedback plugins > Annotate PDF".

== Run a unoconv listener ==
Unoconv utilises a client/server process when converting documents. By default, when there is no running server process - each time unoconv runs it will start a server process, send its request and shut down the server process when the request is complete. The drawback of this mode is that if 2 requests are submitted simultaneously - this can cause the first request to shutdown the server process when the second request is still in progress - and the second conversion request fails. A more robust way to configure unoconv is to start a server process at boot time, and/or run a script to monitor it and restart it if it crashes.

To start a unoconv listener at boot time - you need a start up script. Different operating systems and Linux distributions use different startup scripts - but here are some examples of startup scripts for different systems.

[[mod/assign/feedback/editpdf/testunoconv/upstart | Upstart script for Ubuntu based systems]]

[[mod/assign/feedback/editpdf/testunoconv/launchd | Launchd script for OS X]]

[[mod/assign/feedback/editpdf/testunoconv/initd | Init script for Debian]]

[[mod/assign/feedback/editpdf/testunoconv/initdcentos6 | Init script for CentOS/RedHat 6.x]]

[[mod/assign/feedback/editpdf/testunoconv/systemd | SystemD service script for CentOS/RedHat 7.x]]

== Offload processing to a different server ==
Processing office documents can put increased load on your webserver, which may impact on the responsiveness of your site. If you are installing unoconv on a large site you may want to consider running unoconv on a server that is not also serving web requests.

How to do this:

Install unoconv on each webservers and the remote server following the installation instructions above.

Make sure unoconv is started at boot time on the remote server with the "--listener" argument and is monitored and restarted if it exits (see Debian init script for an example of how to do this).

Open the firewall port 2002 between the moodle webservers and the machine running unoconv.

Share the moodle data root between the webservers and the machine running unoconv. This folder must be mounted at the same path on all servers.

Install a wrapper for unoconv on the webservers that forwards the requests to the remote server. Example:
<pre>
#!/bin/bash
# Wrapper script for unoconv to forward processing.
# Install to /usr/bin/unoconv-remote with 755 permissions
/usr/bin/unoconv --server=<ip of remote server> "$@"
</pre>

Configure the path to unoconv in the Moodle admin settings to point to this wrapper script.

==Additional resources==
The unoconv [https://github.com/dagwieers/unoconv documentation] site has additional information on installation of unoconv and troubleshooting tips.

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=335310 Is the unoconv installation a security risk?] forum discussion

[[Category:Site administration]]
[[Category:Assignment]]

[[es:Universal Office Converter (unoconv)]]
[[de:Universal Office Konverter]]

Messaging settings

2017-01-11T15:14:12Z

Ghillenb: /* Email */

{{Messaging}}
==Messaging settings for all users==

*Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See [[Messaging]] and [[Notifications]] for more information.
*Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.

==Enabling / disabling messaging site wide==

The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from 'Advanced features' in Site administration.

==Message outputs ==

Messaging system default settings are set in 'Message outputs' in Site administration.

There are four default types of output methods for messaging: web, Jabber, email and mobile.

By default web and email are both enabled, though email will only work of course if the site has been properly configured to deliver email. Jabber and Mobile notifications are off by default and need to be configured first.

[[File:moodle23-manage-message-outputs.png|center|thumb|500px]]

==== Jabber ====

Jabber must be configured before use.

''(Could someone with working settings fill this out with example?)''

*Host - The server to connect to to send jabber message notifications - full hostname (e.g. jabber.org)
*Server - XMPP host ID (can be left empty if the same as Jabber host)
*Username - The user name to use when connecting to the Jabber server
*Password - The password to use when connecting to the Jabber server
*Port - defaults to 5222

====Mobile notifications====

[[File:mobilenotifications.png]]

The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).

The default messaging server is a free [https://github.com/dongsheng/airnotifier Airnotifier server] maintained by moodle.com which registered sites may use for testing (be aware that all your messages will go via this server). To connect to this, click 'Request access key' and then add it to the Airnotifier access key field. Alternatively, you may install your own private Airnotifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.

Users will need to connect at least once with the latest version of the mobile app to register their phones with the site.

===Default message outputs===

You can specify the default outputs for each type of message that Moodle can send in 'Default message outputs' in Site administration.

You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:

* ''Disallowed'' - This particular type of message is not allowed at all and users will not see any settings related to them. Message of the chosen type will never be delivered.

* ''Permitted'' - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterward in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.

* ''Forced'' - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.

====Logged in/Offline====

You can set whether each of these will be sent when the user is online through the messaging system interface available to users in their profiles, and/or whether each output is sent via email.

====Ordering of messaging settings====

Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.

[[File:ExampleStudentNotification.png|thumb|600px|center|Example notifications preferences screen - student view]]

==== List of message types====

Except for '''Personal messages between users''', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle. These are set in the system by the Administrator in ''Site administration > Plugins > Message outputs > Default message outputs''.

{| class="wikitable"
|-
! Output Name !! Description !! Recipients
|-
| Assignment notifications || Student has submitted an [[Assignment activity|assignment]]|| Teacher
|-
| Warning when your quiz attempt becomes overdue || See [[Quiz settings]] || Student
|-
| Available update notifications || Notice of new releases of Moodle code || Site administrators
|-
| Backup notifications || Automated backup schedule run completed || Site administrators
|-
| Badge creator notifications || Notify creator of a badge when it is awarded to someone || Any badge creator (typically Teacher or Manager role)
|-
| Badge recipient notifications || Notify recipient of a badge when it is awarded to them || Any badge recipient (typically Student role)
|-
| Comment posted on a learning plan || ? || ?
|-
| Comment posted on a competency || ? || ?
|-
| Confirmation of your own quiz submissions || Notice your quiz was successfully submitted || Student
|-
| Course creation request approval notification || Notice a requested course has been approved || Defined in ''Site admin > Courses > Course request > Course request notification''
|-
| Course creation request notification || Notice a course has been requested - See [[Course request]] || Defined in ''Site admin > Courses > Course request > Course request notification''
|-
| Course creation request rejection notification || Notice a requested course has been rejected || Defined in ''Site admin > Courses > Course request > Course request notification''
|-
| Subscribed forum digests || Sets default for this for user profiles || Authenticated users
|-
| Important errors with the site || Important errors - See also [[Debugging]] || Site administrators
|-
| Manual enrolment expiry notifications || Notice if [[Manual enrolment]] about to expire || Manual enrolees
|-
| Self enrolment expiry notifications || Notify users when their enrolment expires || Enroller only, or Enroller & Enrolled user
|-
| Lesson essay graded notification || Notify students a teacher has graded a Lesson essay question || Student
|-
| Personal messages between users || Using the Messaging interface tool || Authenticated Users
|-
| Message to confirm that an inbound message came from you || See [[Incoming mail configuration]] || Authenticated Users
|-
| Feedback reminder || [[Feedback activity|Feedback]] non-respondent reminder message || Student feedback activity non-responders
|-
| Warning when an inbound message could not be processed || See [[Incoming mail configuration]] || Authenticated Users
|-
| Confirmation that a message was successfully processed || See [[Incoming mail configuration]] || Authenticated Users
|-
| Notices about minor problems || || Site administrators
|-
| Notification of rule subscriptions || Notifications from [[Event monitoring]] rules || Event rule subscribers
|-
| Subscribed forum posts || Default for forum subscription handling || Anyone subscribed to a forum
|-
| Feedback notifications || Notices from setting Enable notification of submissions || Teacher, Feedback administrator
|-
| Notification of quiz submissions || Message that student has submitted a quiz || Teacher
|}

==Roles and Messaging capabilities==

The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.

* [[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
* [[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
* [[Capabilities/moodle/site:sendmessage|site:sendmessage - Send messages to any user]]
* [[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
* [[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]

===Email===
Users cannot by default automatically choose to have notifications sent to a different email address from their official Moodle email. However, the administrator has the option to override this so that users can have an alternative email. This is done by ticking the 'Notification email override' (messagingallowemailoverride) box in 'Advanced features' in the Site administration.

Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.

Users can enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.

[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]

Mail configuration

2017-01-11T14:03:27Z

Ghillenb: /* See also */

{{Server settings}}
==Outgoing mail configuration==

{{New features}}In Moodle 3.2 onwards, there is no longer a setting 'Always send from no-reply address'. Instead there is a setting 'Allowed email domains'. If you want to send emails from users' real addresses you need to add domains allowed by your mail server to this list. Sending email from email addresses not matching the sender's domain will be detected by clients and such emails could be classified as spam.

==Incoming mail configuration==
If incoming mail processing is enabled in 'Incoming mail configuration' in Site administration, then users are able to reply to forum posts via email and send files to their private files as email attachments.

===Mailbox configuration===
It is important to have a dedicated email address here. Don't use one you normally use for your personal emails. You do not need to add the @ sign. If you have set up the email mountorangeschool @ besteveremail.com then it would be entered as in the following screenshot:
[[File:emailexampleincoming.png|thumb|center|400px]]

===Incoming mail server settings===
As an example, if you are using gmail you would use '''IMAP.gmail.com''' in the Incoming mail server (messageinbound_host) field. (If using gmail you also need to make sure that you've enabled IMAP for yor gmail account - see https://support.google.com/mail/troubleshooter/1668960?hl=en )

Note1: The SMTP server hosting the mailbox you've configured above must support ''plus addressing'' i.e. any email sent to mountorangeschool+blahblahblah@besteveremail.com is still delivered to mountorangeschool@besteveremail.com.

Note2 : The username and password here must relate to the settings you entered earlier in Mailbox configuration. So if your address was mountorangeschool @ besteveremail.com and your username is ''mountorangeschool'', then enter your username in this section along with the password you use to get into this email account.

Note 3: You may also need to make sure that your host does not block outbound connections to the IMAP ports (some do by default).

Note 4: If using gmail, you may find that IMAP does not work with Google's higher security setting. If IMAP is not working with gmail, check out https://support.google.com/accounts/answer/6010255?hl=en-GB

==Message handlers==

===Email to Private files===
*If you enable this, then users will be able to send attachments via email directly to their private files. See [[Private files]] for details of how the feature works.
*Each user will be provided with an address in their Private files to which they send the email and attached files. You can set the default expiry period for this address here.
*Checking the 'Validate sender address' box will mean that if an email is sent to a user's private files from a different account from that registered with user in Moodle, then Moodle will check first before allowing the file to be stored in the user's Private files.

===Invalid recipient handler===
If a valid message is received but the sender cannot be authenticated, the message is stored on the email server and the user is contacted using the email address in their user profile. The user is given the chance to reply to confirm the authenticity of the original message.This handler processes those replies.

It is not possible to disable sender verification of this handler because the user may reply from an incorrect email address if their email client configuration is incorrect.

===Reply to forum posts===
*If you enable this, then users will be able to reply to forum posts directly from their email inbox. See the section on 'Reply to posts via email' in [[Using Forum]] for details of how the feature works.
*You must set ''Site administration > Plugins > Message outputs > Email'' to 'Always send email from the No reply address'; otherwise users will see the email of the forum poster instead.
*Each user will be provided with reply-to address when they click to reply to a forum post via email. You can set the default expiry period for this address here.

==See also==
* [https://moodle.org/mod/forum/discuss.php?d=277594 Need help configuring forum's "Reply to post" feature] forum discussion

[[es:Configuración del correo entrante]]
[[de:Einstellungen für E-Mails]]

[[Category:Forum]]

Workshop grading strategies

2017-01-10T12:01:20Z

Ghillenb:

{{Workshop}}
Simply said, selected grading strategy determines how the assessment form may look like And how the grade for a submission given by a certain assessment is calculated based on the assessment form. Workshop ships with four standard grading strategies. More strategies can be developed as pluggable extensions.

== Accumulative grading strategy ==
[[Image:Accumulative assessment form.png|200px|thumb|Assessment form using accumulative grading]]
In this case, the assessment form consists of a set of criteria. Each criterion is graded separately using either a number grade (eg out of 100) or a scale (using either one of site-wide scale or a scale defined in a course). Each criterion can have its weight set. Reviewers can put comments to all assessed criteria.

When calculating the total grade for the submission, the grades for particular criteria are firstly normalized to a range from 0% to 100%. Then the total grade by a given assessment is calculated as weighted mean of normalized grades. Scales are considered as grades from 0 to M-1, where M is the number of scale items.

: <math>G_s = \frac{\sum_{i=1}^N \frac{g_i}{max_i} w_i }{\sum_{i=1}^N w_i}</math>
: where <math>g_i \in \mathbb{N}</math> is the grade given to the i-th criterion, <math>max_i \in \mathbb{N}</math> is the maximal possible grade of the i-th criterion, <math>w_i \in \mathbb{N} </math> is the weight of the i-th criterion and <math>N \in \mathbb{N} </math> is the number of criteria in the assessment form.

It is important to realize that the influence of a particular criterion is determined by its weight only, not the grade type or range used. Let us have three criteria in the form, first using 0-100 grade, the second 0-20 grade and the third using a three items scale. If they all have the same weight, then giving grade 50 in the first criteria has the same impact as giving grade 10 for the second criteria.

Take the case above as an example. Suppose that the third criterion uses ''scale: 6 levels''. An assessor gives grade 90 for the first criterion (or aspect 1), grade 16 for the second criterion and grade 9 ''very good'' for the last criterion. And the weights of the three criteria are 1, 2, and 3, respectively. Because for the third criterion, the scale has 6 items and grade 9 ''very good'' is the second one of the grade sequence ordered from highest to lowest, grade 9 will be mapped to 4. That is, in the formula above, g3 = 4 and max3 = 5.Then the final grade given by this assessment will be:
[[Image: Accumulative formula.png|left]]<br clear="all"/>

== Comments ==
[[Image:Comments assessment form.png|200px|thumb|right|Assessment form using comments]]
The assessment form is similar to the one used in accumulative grading strategy but no grades can be given, just comments. The total grade for the assessed submission is always set to 100%. This strategy can be effective in repetitive workflows when the submissions are firstly just commented by reviewers to provide initial feedback to the authors. Then Workshop is switched back to the submission phase and the authors can improve it according the comments. Then the grading strategy can be changed to another one using proper grading and submissions are assessed again using a different assessment form.
<br clear="all"/>

== Number of errors ==
[[Image:Numoferror assessment form.png|200px|thumb|right|Assessment form using Number of Errors]]
In Moodle 1.x, this was called Error banded strategy. The assessment form consists of several assertions, each of them can be marked as passed or failed by the reviewer. Various words can be set to express the pass or failure state - eg Yes/No, Present/Missing, Good/Poor, etc.

The grade given by a particular assessment is calculated from the weighted count of negative assessment responses (failed assertions). Here, the ''weighted count'' means that a response with weight <math>w_i</math> is counted <math>w_i</math>-times. Course facilitators define a mapping table that converts the number of failed assertions to a percent grade for the given submission. Zero failed assertion is always mapped to 100% grade.

This strategy may be used to make sure that certain criteria were addressed in the submission. Examples of such assessment assertions are: ''Has less than 3 spelling errors'', ''Has no formatting issues'', ''Has creative ideas'', ''Meets length requirements'' etc. This assessment method is considered as easier for reviewers to understand and deal with. Therefore it is suitable even for younger participants or those just starting with peer assessment, while still producing quite objective results.

You can edit the original assessment form by following the steps below:
# Write down the corresponding description for each assertion in the blank. Then fill in the blanks of ''word for the error'' and ''word for the success''. Set the weight for each assertion. As you can see, the grade mapping table is still blank now.
# Click the ‘save and close’ button at the end of this page.
# Click the ‘Edit assessment form’ link at the shade area titled ''setup phase'' in the upper part of this page and view the assessment form again. At this time, you can see that the grade mapping table has already been set. (''Note'': Initially all the field are blank. You need to choose the right value from each list to make this grading strategy work properly.)
[[Image:Numberoferrors grade mapping table.png|300px|thumb|none|grade mapping table]]

For example, if an assessment form contains three assertions:

{| class="nicetable"
|-
! Assertion No.
! Content
! Pass or failure state
! Weight
|-
| 1
| Has the suitable title
| Yes/No
| 1
|-
| 2
| Has creative ideas
| Present/Miss
| 2
|-
| 3
| The abstract is well-written
| Yes/No
| 3
|}

In the example above, suppose that a reviewer gives one certain work ''Yes/Miss/Yes'' as the assessment. Since the submission only fails to meet the second criterion and the weight of the second criterion is 2, the total number of errors will be 2. Thus the grade for submission given by this assessment is 66%. Suppose that the maximum grade for submission set in ''grade settings'' is 100, therefore the final grade for this submission given by this assessment is grade 66.

== Rubric ==
[[Image:Rubric assessmentform list.png|200px|thumb|right|Assessment form in list mode]]
See [http://en.wikipedia.org/wiki/Rubric_(academic) the description] of this scoring tool at Wikipedia. The rubric assessment form consists of a set of criteria. For each criterion, several ordered descriptive levels are provided. A number grade is assigned to each of these levels. The reviewer chooses which level answers/describes the given criterion best.

The final grade is aggregated as

: <math>G_s = \frac{\sum_{i=1}^N (g_i - min_i) }{\sum_{i=1}^N (max_i - min_i)}</math>
: where <math>g_i \in \mathbb{N}</math> is the grade given to the i-th criterion, <math>min_i \in \mathbb{N}</math> is the minimal possible grade of the i-th criterion, <math>max_i \in \mathbb{N}</math> is the maximal possible grade of the i-th criterion and <math>N \in \mathbb{N} </math> is the number of criteria in the rubric.
[[Image:Rubric assessmentform grid.png|200px|thumb|right|Assessment Form in grid mode]]
Example of a single criterion can be: ''Overall quality of the paper'' with the levels ''5 - An excellent paper'', ''3 - A mediocre paper'', ''0 - A weak paper'' (the number represent the grade).

There are two modes how the assessment form can be rendered - either in common grid form or in a list form. It is safe to switch the representation of the rubric any time.

''Example of calculation:'' let us have a rubric with two criteria, which both have four levels 1, 2, 3, 4. The reviewer chooses level with the grade 2 for the first criterion and the grade 3 for the second criterion. Then the final grade is:

: <math>G_s = \frac{(2 - 1) + (3 - 1)}{(4 - 1) + (4 - 1)} = \frac{3}{6} = 50 %</math>

Note that this calculation may be different from how you intuitively use rubric. For example, when the reviewer in the previous example chose both levels with the grade 1, the plain sum would be 2 points. But that is actually the lowest possible score so it maps to the grade 0. To avoid confusion, it is recommended to always include a level with the grade 0 in the rubric definition.

'''Note on backwards compatibility:''' This strategy merges the legacy Rubric and Criterion strategies from Moodle 1.x into a single one. Conceptually, legacy Criterion was just one dimension of Rubric. In Workshop 1.x, Rubric could have several criteria (categories) but were limited to a fixed scale with 0-4 points. On the other hand, Criterion strategy in Workshop 1.9 could use custom scale, but was limited to a single aspect of assessment. The new Rubric strategy combines the old two. To mimic the legacy behaviour, the old Workshop are automatically upgraded so that:

* Criterion strategy from 1.9 are replaced with Rubric 2.0 using just one dimension
* Rubric from 1.9 are by Rubric 2.0 by using point scale 0-4 for every criterion.

In Moodle 1.9, reviewer could suggest an optional adjustment to a final grade. This is not supported any more. Eventually this may be supported in the future versions again as a standard feature for all grading strategies, not only rubric.

==Experiencing Real Workshop==
If you would like to try out a real workshop, please log in to the [http://school.demo.moodle.net/ School demo Moodle] with the username ''teacher'' and password ''moodle''. You can access the different stages of and explore the grading and phases of a [http://school.demo.moodle.net/mod/workshop/view.php?id=651 completed workshop with data] on My home country.

[[es:Estrategias de calificación de taller]]
[[de:Bewertungsstrategien bei gegenseitigen Beurteilungen]]

User tours

2017-01-09T13:46:13Z

Ghillenb:

{{Site appearance}}
{{New features}}

User tours are step-by-step guides to various areas of Moodle. Administrators can create new tours or import existing tours from [https://moodle.net/mod/data/view.php?id=17 Moodle.net/tours]. The [[Multi-language_content_filter| multi-lang filters]] allow for tours to display in different languages. Watch the screencast [https://youtu.be/hhLVvyP3DU0 User tours] to see a demonstration.

==How is it set up?==
* As an administrator, access 'User tours' from Site administration
*Here you see any existing user tours and have the option to create a new tour, import a tour or browse user tours on the [https://moodle.net/mod/data/view.php?id=17 Tour repository]. (An administrator and a teacher tour have been added to new and upgraded sites to introduce the [[Boost theme]] and get you started.)
[[File:usertour_listing_page.png|thumb|600px|center]]
*For each of your existing tours, you can click either directly on its name or on its View action icon to view its current listed steps
*Each tour can be individually enabled or disabled as required in its settings page.
'''Note:''' ''You can have multiple tours created for the same page destination, but you should only have one per page enabled at one time.''
*Icons against each tour allow you to view, edit, export or delete it.
*Tours will be displayed on any page whose URL matches the specified path value, for instance:
#/my/% - to match the Dashboard
#/course/view.php?id=2 - to match a specific course
#/mod/forum/view.php% - to match the forum discussion list
#/user/profile.php% - to match the user profile page
*Each tour will be configured with default step settings which you can edit in the settings page:
*Placement: Top, Bottom (Default), Left, Right. This determines where the step shows relative to its matching block or CSS selector on the page.
*Show if target not found: No (Default), Yes. This determines whether the step is shown or not when the target has not been found.
*Show with backdrop: No (Default), Yes. If yes, the step appears surrounded by a darkened backdrop to emphasis its content and location.
*Move on click: No (Default), Yes. If yes, the tour continues to the next step when the user clicks within the block or area targeted by the current step.
'''Note:''' ''If you want users to be able to fill in forms as they work through the tour, then don't use a backdrop.''
*Tour filters allow you to choose the role(s) and theme(s) for which the tour will be displayed.

==How do I add steps to a tour ?==
* Either click directly on its name or on its View action icon to view the currently listed steps.
*Here are the initial steps for a sample tour for the Dashboard page:
[[File:usertour steps page.png|thumb|600px|center]]
*Click on the 'New step' link and select what you want to highlight:
#Block - to display next to a matching block on the page. Select the block you want from the dropdown.
#CSS Selector - to display next to a matching selector on the page. Type in the relevant selector. (See examples below.)
#Display in the middle of the page
*Add the title and content
*For all types, select whether to display the step with a darkened backdrop
*For blocks or selectors, select the Placement option for where to place the display
*For blocks or selectors, select whether to display the step if its target isn’t found
*For blocks or selectors, select whether to move on click, ie move to next step when target is clicked
*Click on 'Save changes'

==How do user tours work?==
[[File:usertours01.png|thumb|600px|center]]
Once a user tour has been created and enabled, the first time that any user views a page which matches that user tour’s page (path) settings, the user tour will automatically start to display, starting with the first step. Each tour step will display its title and content, along with three button options:
*Prev - to return to the previous step in the tour
*Next - to go to the next step in the tour
*End Tour - to exit out of the tour completely
Any time a user wishes to re-run the page's tour, they can click on the "Reset user tour on this page" link at the bottom of the page.

==Help with CSS selectors==
If you wish to use CSS selectors as part of your user tour, your browser's developer tools will be very useful in helping you create these selectors:
*[https://developer.chrome.com/devtools#dom-and-styles Google Chrome]
*[https://developer.mozilla.org/en-US/docs/Tools/DOM_Property_Viewer Mozilla Firefox]
*[https://developer.microsoft.com/en-us/microsoft-edge/platform/documentation/f12-devtools-guide/ Microsoft Edge]
*[https://developer.apple.com/library/content/documentation/AppleApplications/Conceptual/Safari_Developer_Guide/ResourcesandtheDOM/ResourcesandtheDOM.html#//apple_ref/doc/uid/TP40007874-CH3-SW1 Apple Safari]

===Example of a very simple CSS selector===

[[File:CSS_selector_for_user_picture_in_a_user_tour.png|400px]]

The settings above will produce this in the user tour:

[[File:user picture chosen by CSS selector in a user tour.png|400px]]

* How did we know that .userpicture would select just the Moodle user picture?
* By looking at the page with an HTML inspector in Firefox, as described in the 'Help with CSS selectors' section below.

===Other simple CSS selector examples===
'''.breadcrumb''' These site links (known as breadcrumbs) will always show where you are in the site and how to return to a main page, such as your Dashboard or your course main page.

'''.usermenu''' This is the user menu. It contains links to your Dashboard, Messages, Profile, and your Preferences.

'''[value="Customise this page"]''' Add your own blocks of content by clicking here!

==Multi-language capability==

If your Moodle site is already set up or intending to be enabled for multi-lingual usage, tours are completely compatible with this requirement. Using the multi-lang filter formatting, each tour step’s titles and content, displayed to the user, can be edited to cater for multi-lingual requirements. Please see [[Multi-language_content_filter]] for further detailed instructions on how to enable, format and submit multi-lingual strings for your Moodle site.

Please remember to go to '' Dashboard ► Site administration ► Plugins ► Filters ► Manage filters '' in order to enable the [[Multi-language_content_filter]] before importing any multi-language user tours into your site, or the users will see ALL the texts in ALL the languages simultaneously, as the following image illustrates:

[[File:Multilang user tour when multilang filter NOT properly configured.png|300px]]

When properly configured, a multi-language user tour will be automatically displayed in the user's preferred language, as seen in the following Dashboard tours starting pages in Spanish, English and French (in the same server):

[[File:Multilang user tour in Spanish.png|300px]]

[[File:Multilang user tour in English.png|300px]]

[[File:Multilang user tour in French.png|300px]]

==Translating user tours==
See [https://docs.moodle.org/dev/Translating_User_tours_from_Moodle.net how to translate user tours] in the developer's documentation..

==Sharing is caring==

We really hope that you are able to create some really powerful tours to help guide your users around your site. We certainly think you will and we encourage you to share any of the tours you create with others.

We've created a [https://moodle.net/mod/data/view.php?id=17 Moodle.net tour database] where you can share your creations and also find inspiration from the ideas of others.

This work was paid for and sponsored by the kind folk of [http://www.dcu.ie/ Dublin City University].

==User tour capabilities==

There is just one capability, which is allowed for the default role of manager:

* [[Capabilities/tool/usertours:managetours|Create, edit and remove user tours]]

==See also==

* [http://jsonlint.com/ JSONLint - a JSON validator] useful for checking the workings of a JSON file

[[es:Tours para Usuarios]]
[[fr:Visites guidées]]
[[de:Geführte Touren]]

Workshop FAQ

2017-01-09T12:25:08Z

Ghillenb: /* See also */

{{Workshop}}
==How are the grades calculated?==

Make sure you read carefully pages explaining [[Using_Workshop#Workshop_grading|workshop grading]] and [[Workshop grading strategies|grading strategies]].

==How can I get the workshop to switch phase automatically?==

In ''Administration > Workshop Administration > Edit settings'' tick the box 'Switch to the next phase after the submissions deadline' in the access control section. The workshop will then automatically switch to the assessment phase after the next time cron is run.

==How can I make reviewing anonymous?==

If you do not want your students to know whose work they are reviewing and who is reviewing their work, go to ''Administration > Workshop administration > Permissions'' and click the X next to student to prevent "view author names" ''mod/workshop:viewauthornames'' and "view reviewer names" ''mod/workshop:viewreviewernames''

==Can I use Workshop for students to peer assess an offline activity?==
You can, although they will have to submit something, even though that might be a blank document. See this forum post for more information: https://moodle.org/mod/forum/discuss.php?d=220054#p958145

==How can I publish workshop submissions?==
When in the Grading evaluation phase, it is possible to publish (ie make visible to all participants) selected submissions you might consider are helpful examples. To do this, as the teacher, choose a particular submission and click its title.Scroll down and below the submission text you will find a form allowing you to mark the submission as published. Save the form. When the workshop is closed, any such published submissions become visible.
{|
| [[File:publishedsubmissions.png|thumb|Published submissions (click to enlarge)]]
|}

==How can I edit or delete an example submission?==

In the list of example submissions, click on the title of the submission you'd like to delete. Below the submission content, there are buttons to edit, delete and assess the example submission.

==Can a student delete his or her own submission?==

A student can delete their submission as long as they can still edit it and it has not been assessed.

==Can workshop submissions be exported?==
{{New features}}
*Students (and teachers) may export submissions and peer assessments, as for example LEAP2A files, to use in a portfolio such as Mahara.
*See the screencast [https://youtu.be/VdOndCoq5q8 Workshop portfolio export] for a demo.

[[File:docsworkshopexport.png|center]]

==See also==

*[http://moodle.org/mod/forum/view.php?id=740 Workshop forum] on moodle.org

[[Category:FAQ]]

[[de:Gegenseitige Beurteilung FAQ]]
[[es:Taller FAQ]]

Using badges

2017-01-09T12:23:37Z

Ghillenb: /* See also */

{{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.

===Issuer details===

If you add the teacher name here, it will appear when the badge is displayed. An email address is optional.

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

{|
|[[File:firstaiderbadge.png|thumb|Adding a course badge]]
|
| [[File:badge_expired.png|thumb|Example of an expired badge]]
|}

*When the settings are saved, you are then taken to the Manage badges screen where you can decide the criteria for awarding the badge.

===Criteria===

*For course badges, the criteria are: Manual issue by role; course completion and activity completion.
*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.

[[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===
[[File:badge recipients.png|thumb|Badge recipients]]
Badges may be awarded manually from ''Course administration > Badges > Manage badges > Recipients'' and clicking the "Award badge" button.

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.

===Revoking a badge===

{{New features}}If a badge is awarded my mistake, it may be revoked from the 'Badge recipients' page.

==Adding a site badge==

*An administrator can add a site badge from ''Administration > 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.
*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:Badge_criteria.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=262580 Moodle is shrinking badges size] - forum post
*[https://moodle.org/mod/forum/discuss.php?d=235135 Custom Reports for Badges - Get some Here] - forum post
*[http://school.demo.moodle.net/badges/index.php?type=1 School demo example: Managing site badges] (Log in with username: ''manager'', password: ''moodle'')
*[http://school.demo.moodle.net/badges/index.php?type=2&id=62 School demo example: Managing course badges] (Log in with username: ''teacher'', password: ''moodle'')
*[http://school.demo.moodle.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
*[http://www.jiscrsc.ac.uk/media/421718/jiscopenbadgesdesigntoolkit-print_1.pdf Jisc Open Badge Design Toolkit]

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

Logos

2016-12-20T11:31:58Z

Ghillenb:

{{Site appearance}}{{New features}}
==Logo settings==

The settings in Logos in Site administration are for defining two variants of a logo to be used as part of the interface for your site.

These settings were only added in Moodle 3.2 and were intended to allow a basic branding of the site to be independent of the theme used, so that multiple themes could be used or tried without having to set the logo again in each one.

===logo===

A full logo to be used as decoration by some themes (such as core themes). This image can be quite high resolution because it will be scaled down for use (and cached for performance). Logos that are wider than they are high usually give better results. Formats accepted: PNG and JPG.

====Examples====
[[File:logoexample1.jpg]]

===logocompact===

A compact version of the same logo as above, such as an emblem, shield or icon. The image should be clear even at small sizes. Formats accepted: PNG and JPG.

====Examples====
[[File:logocompactexample1.jpg]]

==How they are used in themes==

===Clean and More===

===Boost===

==Tips for getting good results==

[[es:Logos]]
[[de:Logos]]

VideoJS player

2016-12-19T11:54:10Z

Ghillenb:

{{Working with media}}
{{New features}}
VideoJS is the default media player in Moodle 3.2. It is demonstrated in the screencast [https://youtu.be/h1fd-sgvK4o Media players].

VideoJS player settings, such as the supported video and audio file extensions, may be found in 'VideoJS player' in Site administration.

[[File:Docs_AdminMediaPlayer.png|thumbnail|600px|center]]

[[es:Reproductor VideoJS]]
[[de:VideoJS Mediaplayer]]

Media players

2016-12-19T11:46:18Z

Ghillenb:

{{Working with media}}
{{New features}}
Our new default player [[VideoJS player|VideoJS]] in Moodle 3.2 provides industry-leading accessibility and usability for video and audio in your content.

Watch the screencast [https://youtu.be/h1fd-sgvK4o Media players] to view a demonstration.

Additional media players can be enabled in 'Manage media players' in Site administration and new media players can easily be added as plugins.

[[Es:Reproductores de medios]]
[[de:Mediaplayer]]

Boost theme

2016-12-19T11:03:10Z

Ghillenb:

{{Themes}}
{{New features}}
* Boost is a new core theme that gives Moodle sites a fresh new look. See the screencasts [https://www.youtube.com/watch?v=1yOlW_II0DA&list=PLxcO_MFWQBDfrcwIG_jYHr7BrOLD-fPL4&index=1 Boost for admins] and [https://www.youtube.com/watch?v=YjlgrVag6JQ&list=PLxcO_MFWQBDfrcwIG_jYHr7BrOLD-fPL4&index=2 Boost for teachers] to view demonstrations.
* Get better navigation within and between courses in Boost
* With Boost, you can enjoy consistent, clearer way to configure key pages such as courses and activities 
* Enjoy more space on the screen for your content in Boost
* Boost is easy to configure using industry-standard Bootstrap presets
* You always have the option to switch back to the familiar old interface at any time without affecting your custom themes
* For developers, : this new theme is a great new base for your own themes, with Bootstrap 4, built-in SASS compiler, automated RTL support, preset files, new templates which make it easier to customise Moodle components. Share your presets in the [https://moodle.net/mod/data/view.php?id=28 Moodle preset repository]
* With Boost, Moodle is also aiming towards a unified (harmonised) experience with our Moodle Mobile app
[[File:Docs_BoostAdminSettings.png|thumb|600px|center]]

[[es:Tema Boost]]
[[de:Boost Design]]

Redis cache store

2016-12-19T09:59:58Z

Ghillenb:

{{Performance}}{{stub}}

==See also==

* MDL-48468

[[de:Redis Cache]]

APC user cache (APCu)

2016-12-19T09:57:40Z

Ghillenb:

{{Performance}}
==About using APCu in Moodle==

APC provides a shared application cache that is usually very limited in size but provides excellent performance. It doesn't provide the ability to configure multiple instances of itself and as such within Moodle you are only able to create a single APC cache store instance. Because of its incredible performance but very limited size it is strongly suggested that you map only small, crucial caches to the APC store.

Another important thing to understand about the APC store is that it provides no garbage cleaning, or storage reclamation facilities. As such cache data will persist there until APC is restarted or the store is purged. On top of that once the store is full requests to store information within the cache fail until there is once more sufficient space. Because of this it is recommended that you regularly purge or restart APC. Also recommended is to map a secondary application cache instance to any definition with the APC mapped. This ensures that if it does indeed full up that an alternative cache is available.

==Installation of APC==

It is recommended that you read through the APC documentation http://www.php.net/manual/en/book.apc.php before beginning with this plugin. The above documentation recommends installing the PECL APC extension that can be found at http://pecl.php.net/package/apc. http://www.php.net/manual/en/install.pecl.php contains information on installing PECL extensions.

Its also worth noting for this those using Linux that there is usually a php5-apc package that can be installed very easily. If you have installed PHP under Linux through a package manager then this will be by far the easiest way to proceed.

Once installed ensure you restart your web server before proceeding.

==Making use of APC within Moodle==

The first thing you will need to do is create an APC cache store instance. This is done through the Cache configuration interface.

# Log in as an administrator and go to 'Caching > Configuration' in the Site administration.
# Locate the APC row within the Installed cache stores table. You should see an "Add instance" link within that row. If not then the APC extension has not being installed correctly.
# Click "Add instance".
# Give the new instance a name and click "Save changes". You should be directed back to the configuration page.
# Locate the Configured cache store instances table and ensure there is now a row for you APC instance and that it has a green tick in the ready column.

Once done you have an APC instance that is ready to be used. The next step is to map definitions to make use of the APC instance.

# Locate the known cache definitions table. This table lists the caches being used within Moodle at the moment. For each cache you should be able to Edit mappings.
# Find a cache that you would like to map to the APC instance and click Edit mappings.
# One the next screen proceed to select your APC instance as the primary cache and save changes.
# Back in the known cache definitions table you should now see your APC instance listed under the store mappings for the cache you had selected. You can proceed to map as many or as few cache definitions to the APC instance as you see fit.

That is it! you are now using APC within Moodle.

==See also==

* MDL-39117

[[de:APC User Cache]]

Speech tools

2016-12-19T08:29:56Z

Ghillenb:

{{Working with media}}

Moodle has no built-in tools for speech messaging or audioconferencing. However, there are various add-ons which allow video and audio conferencing and direct recording into Moodle's text editor
* [https://moodle.org/plugins/browse.php?list=set&id=2 Big Blue Button] is a popular audio/video conferencing tool available from the plugins directory. It is an open source project which supports real-time sharing of slides (including whiteboard), audio, video, chat, and desktops. It also record lectures for later playback. See [http://www.bigbluebutton.org/ Big Blue Button Big Blue Button] website for more general information.

* [http://openmeetings.apache.org/ Openmeetings] provides video conferencing, instant messaging, white board, collaborative document editing and other groupware tools using API functions of the Red5 Streaming Server for Remoting and Streaming. OpenMeetings is a project of the Apache. See [http://openmeetings.apache.org/MoodlePlugin.html Moodle plugin] for more details.

*[http://poodll.com/ Poodll] allows you to record audio into forums, pages, anywhere with a text editor. Recordings are done via the Poodll server hosted by Amazon and transferred to your Moodle site. The [https://moodle.org/plugins/browse.php?list=set&id=13 Poodll set of tools] (filter, assignment 2.3 type, repository, question type) is available from the plugins directory. It is simple to install and doesn't require any particular PHP expertise.

[[es:Herramientas del habla]]
[[de:Aufzeichnungswerkzeuge]]

Notifications

2016-12-16T09:27:44Z

Ghillenb:

{{Messaging}}{{New features}}
*Notifications alert teachers, students and other users about events in Moodle such as new forum posts, assignments needing grading or badges awarded.
*New notifications are highlighted with a number in the notifications menu at the top of the screen:

[[File:NewNotificationsMenu.png|center]]

Clicking there displays any new notifications, along with the option to mark all as read ''(1 below''), to go to the notifications preferences page ''(2)'' to change how notifications are received, and ''(3)'' to view all notifications.

[[File:NewNotificationsFeatures.png|center]]

Clicking 'View full notification' displays the notification in a full list, whereas clicking the main body of the notification will take you to the location in Moodle that the event happened, as in this example, to the assignment grading screen.

==Receiving notifications==
*Along with a visible alert to new events in the notifications menu, users can configure how they are notified of new events from their notification preferences page accessed from the user menu or from the gear icon in the notifications menu.
*The options they see here depend on the site settings. For example, if the site is set up with the mobile app, they can enable new alerts to be sent to their mobile.
*They can also disable notifications from here.

[[File:NewNotificationsPreferencesPage.png|center|thumb|400px]]

==See also==

* [[Site notifications]] for administrators

[[de:Benachrichtigungen]]

Site notifications

2016-12-13T13:20:11Z

Ghillenb:

{{Security}}
==Update notifications==

An administrator can configure update notifications for both Moodle core code and any contributed plugins installed on the site in ''Settings > Site Administration > Server > Update notifications''. See [[Available update notifications]] for more details.

==Login failure notifications==

An administrator can set up login failure notification in ''Settings > Site Administration > Security > Notifications''.

===Display login failures to===

Set this to administrators to be warned of anyone attempting to steal student or teacher logins. When set, a link stating the number of failed logins appears in the top right corner of the page when an administrator logs in. Click the link to access the login error page.

===Email login failures===

If you're concerned about login failures, you can set up email notification for administrators or any/all users who can change the site configuration.

===Threshold for email notifications===

This sets the number of failed logins for a given user from a single computer that will trigger notification.

Note: The number of failed login attempts that result in account lockout may be set in ''Administration > Site administration > Security > Site policies''.

==Other notifications==

The version of Moodle used may be found in ''Site administration > Notifications''.

Other notifications listed on the page may include

* [[Upgrade warnings|"Alpha" development code warning]]
* [[Cron]] not run for at least 24 hours
* Database tables are using MyISAM database engine - see [[Migration from MyISAM to InnoDB]] for advice on what to do
* "Enabling the PHP setting display_errors is not recommended on production sites because some error messages may reveal sensitive information about your server." What you do about this is not explained. Making a php.ini file with "display_errors = off;" in it in the folder "with the script" (?) is one suggestion found by googling, but that may depend on your server.
* Site not yet [[Site registration|registered]]

==See also==
*[http://youtu.be/d3D77TfI8wA Moodle 2.0 Notifications, Register and Advanced features] MoodleBites video on YouTube

* [[:dev:Available update notifications|Available update notifications developer documentation]]

[[es:Notificaciones]]
[[eu:Jakinarazpenak]]
[[fr:Notifications]]
[[de:Systemmitteilungen]]
[[ja:通知]]

Capabilities/tool/usertours:managetours

2016-12-12T14:19:50Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to create, edit and remove [[User tours]]
*This capability is allowed for the default role of manager

[[Category:Capabilities|Site administration]]

[[es:Capabilities/tool/usertours:managetours]]
[[de:Capabilities/tool/usertours:managetours]]

Capabilities/moodle/site:manageallmessaging

2016-12-12T14:17:38Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to add, remove, block and unblock contacts for any user
*This capability is allowed for the default role of manager

==See also==

*[[Using Messaging]]

[[Category:Capabilities|Messaging]]
[[Category:Messaging]]

[[de:Capabilities/moodle/site:manageallmessaging]]

Capabilities/moodle/site:maintenanceaccess

2016-12-12T14:15:17Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to access the site whilst it is in [[Maintenance mode]]
*This capability is not set for any of the default roles

[[Category:Capabilities]]
[[Category:Site administration]]

[[es:Capabilities/moodle/site:maintenanceaccess]]
[[de:Capabilities/moodle/site:maintenanceaccess]]

Capabilities/moodle/site:configview

2016-12-12T14:13:34Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to view the site admin tree (but not pages in it)
*This capability is allowed for the default role of manager only

[[Category:Capabilities]]
[[Category:Site administration]]

[[de:Capabilities/moodle/site:configview]]

Capabilities/moodle/badges:revokebadge

2016-12-12T14:11:07Z

Ghillenb:

{{Capabilities}}{{New features}}
* This allows a user to revoke a [[Badges|badge]] from a user
* This capability is allowed for the default roles of manager, teacher and non-editing teacher

[[Category:Badges]]
[[Category:Capabilities|Badges]]

[[de:Capabilities/moodle/badges:revokebadge]]

Capabilities/mod/lesson:view

2016-12-12T14:03:31Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to view a [[Lesson activity]]
*This capability is allowed for the default roles of authenticated user and guest

[[Category:Capabilities|Lesson]]
[[Category:Lesson]]

[[de:Capabilities/mod/lesson:view]]

Capabilities/mod/label:view

2016-12-12T14:02:13Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows the user to view a [[Label]]
*This capability is allowed for the default roles of authenticated user and guest

[[Category:Capabilities|Label]]
[[Category:Resource]]

[[de:Capabilities/modl/label:view]]

Capabilities/mod/forum:canoverridediscussionlock

2016-12-12T14:00:39Z

Ghillenb:

{{Capabilities}}{{New features}}
* This allows a user to reply to locked discussions in a [[Forum]]
* This capability is allowed for the default manager, teacher and non-editing teacher roles

[[Category:Capabilities|Forum]]
[[Category:Forum]]

[[de:Capabilities/mod/forum:canoverridediscussionlock]]

Capabilities/mod/data:view

2016-12-12T13:37:53Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to view a [[Database activity]]
*This capability is allowed for the default roles of manager, teacher, non-editing teacher, student and guest

[[Category:Capabilities|Database]]
[[Category:Database activity module]]

[[de:Capabilities/mod/data:view]]

Capabilities/mod/choice:view

2016-12-12T13:36:13Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to view a [[Choice activity]].
*This capability is allowed for the default roles of authenticated user and guest

[[Category:Capabilities|Choice]]
[[Category:Choice]]

[[fr:Capabilities/mod/choice:readresponses]]
[[de:Capabilities/mod/choice:view]]

Capabilities/mod/chat:view

2016-12-12T13:33:41Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user to view a [[Chat activity]]
*This capability is allowed for the default roles of authenticated user and guest

[[Category:Chat]]

[[de:Capabilities/mod/chat:view]]

Capabilities/mod/chat:view

2016-12-12T13:33:29Z

Ghillenb:

Capabilities/mod/assign:manageoverrides

2016-12-12T13:29:39Z

Ghillenb:

{{Capabilities}}{{New features}}
*This allows a user manage [[Assignment]] overrides
*This capability is allowed for the default roles of manager and teacher

[[Category:Capabilities|Assignment]]
[[Category:Assignment]]

[[de:Capabilities/mod/assign:manageoverrides]]

Capabilities/mod/assign:view

2016-12-12T13:26:57Z

Ghillenb:

{{Capabilities}}
*This allows a user to [[Using Assignment|view assignments]]
*This capability is allowed for the default roles of manager, teacher, non-editing teacher, student and guest

Assignment links on the course page and in the navigation are only displayed for users who have this capability.

[[Category:Capabilities|Assignment]]
[[Category:Assignment]]

[[eu:Capabilities/mod/assignment:view]]
[[fr:Capabilities/mod/assignment:view]]
[[ja:ケイパビリティ/mod/assignment:view]]
[[es:Capabilities/mod/assign:view]]
[[de:Capabilities/mod/assign:view]]

More theme

2016-12-12T12:25:55Z

Ghillenb: /* Taking it further */

{{Themes}}

==Customising the 'More' theme==

[[File:MORE.png|center|thumb|500px|The customisable 'More' theme.]]

The 'More' theme allows administrators to customise it from ''Site administration>Appearance>Themes>More''.

Options are:
*'''Text colour/Link colour''' - these may be selected either by typing in the code or by clicking into the colour picker.
*'''Background colour/Background image''' - a background colour may be selected as above or an image of your choice uploaded. (Note: the image will override the background colour.)
*'''Background repeat/position/fixed''' - decide here how you wish your image to be repeated; its position or if you want it to be fixed to the page.
*'''Main content background colour/Secondary background colour''' - these may be selected either by typing in the code or by clicking into the colour picker. (The secondary background colour includes blocks and the navigation bar.)
*'''Invert navbar''' - checking this will swap the text and background colour of the navigation bar between black and white.
*'''Logo''' - a custom logo may be uploaded here
*'''Custom CSS/Footnote''' - custom CSS and footer text may be added and will be reflected throughout the site.

Pro tip: When specifying colours, you can even use advanced colours with transparency values such as '''rgba(255,255,255,0.8)'''

In the color fields you can put things like this if you want to get fancy:

whitesmoke
#0404E6
rgb(0,255,244)
rgba(0,255,244,0.5)
transparent
currentColor
inherit
hsl(207,38%,47%)
hsla(207,38%,47%,0.8)

[[File:moodle27-orange.png|center|500px|'More' with an orange image backound, a logo and custom colours.]]

'More' with an orange image backound, a logo and custom colours.

===Mount Orange: example of a customised More theme===
The theme on the [http://school.demo.moodle.net School demo site] is based on settings from tracker MDLSITE-3095 and MDLSITE-3245

{|
| [[File:MountOrangeFrontPage.png|thumb|450px|Front page view]]
| [[File:SchoolDemoMore.png|thumb|450px|Course view]]
|}

====More theme page settings====
*Text colour: ##595959
*Link colour: #0070a8
*Background colour: #cccccc
*Background image [https://docs.moodle.org/32/en/File:bg6.png bg6.png]
*Background repeat: No repeat
*Background position: Left bottom
*Background fixed: Yes
*Main content background colour: #cccccc
*Secondary background colour: #cccccc
*Invert navbar: No
*Logo: None
*CUSTOM CSS:

body {
background-size: cover;
}
h1, h2, h3, h4, h5, h6 {
color: #f98012;
font-weight: normal;
}
#page-header h1 {
color: #fff;
font-weight: bold;
text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.2);
}
.block .header h2 {
color: #f98012;
font-weight: normal;
}
#page-footer {
color: #ccc;
}
#page-footer a {
color: #eee;
}

.jschooser .choosercontainer #chooseform .instruction,
.jschooser .choosercontainer #chooseform .typesummary {
background-color: #fff;
}
.choosercontainer #chooseform .selected {
background-color: #fff;
}

#page-site-index #page-header {
display:none;
}
#page-site-index #region-main {
padding: 0;
border: 0;
border-radius: 0;
box-shadow: none;
background-color: transparent;
}
#page-site-index .label {
padding: 0;
}
#page-site-index .activity > div {
padding: 0;
}
#page-site-index .mod-indent-outer {
padding-left: 0;
}
#page-site-index .contentwithoutlink {
padding-right: 0;
}

.frontpage.container-fluid {
padding: 0;
}
.frontpage .hero-unit {
padding:0;
border-radius:0;
background: transparent no-repeat right bottom / cover;
line-height: 250px;
}
.frontpage .hero-unit .texts {
color: #fff;
letter-spacing: .5px;
background-color: rgba(255, 99, 0, 0.70);
padding: 0 20px;
margin-bottom:20px;
display: inline-block;
vertical-align: bottom;
}
.frontpage .hero-unit h2 {
color: #fff;
font-size: 32px;
font-weight: 200;
text-shadow: 1px 1px 1px #444;
margin-bottom: 0;
}
.frontpage .hero-unit .lead {
text-shadow: 1px 1px 1px #333;
}
.frontpage .row-fluid {
line-height: 24px;
background-color: #fff;
padding: 10px 20px 20px;
box-sizing: border-box;
}
.frontpage .fp-block {
padding: 10px 20px 0;
}
.frontpage h3 {
font-size: 26px;
line-height: 30px;
font-weight: 200;
}
.frontpage .button {
text-align: right;
}

====Front page topic summary settings====
(Note: these settings allow you to have a large image and two text boxes. Upload your banner image via the image icon in the text editor. Switch to code view and copy its URL.)

<nowiki> <div class="frontpage container-fluid">

<div class="hero-unit" style="background-image: url('INSERT THE FULL URL OF YOUR UPLOADED BANNER HERE.jpg');">
<div class="texts">
<h2>SITE TITLE HERE</h2>
<p class="lead">TAG LINE HERE</p>
</div>
</div>
</nowiki>

<nowiki>
<div class="row-fluid">
<div class="fp-block span6">
<h3>LEFT TEXT BOX TITLE</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor In reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p class="button"><a class="btn btn-primary" href="#">read more »</a></p>
</div>
</nowiki>

<nowiki>
<div class="fp-block span6">
<h3>RIGHT TEXT BOX TITLE</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p class="button"><a class="btn btn-primary" href="#">read more »</a></p>
</div>
</div>

</div>
</nowiki>
=====Taking it further=====
For more advanced customisations, see the post by Mary Evans: [https://moodle.org/mod/forum/discuss.php?d=267662 Adding marketing spots to the front page.]

[[es:admin/setting/themesettingmore]]
[[de:More Design]]

Talk:New features

2016-12-05T12:56:38Z

Ghillenb:

Can you please fix the links at the 3.2 New features page for the Spanish and French translations pages so that they point to 3.2 instead of 3.1 ? [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

:Thanks German; links now fixed. --[[User:Helen Foster|Helen Foster]] ([[User talk:Helen Foster|talk]]) 14:38, 5 December 2016 (AWST)

:Thanks Helen :) [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

Request from the German Docs team: Could you please add a link to the corresponding german page [[Neue Funktionalitäten]]
: German link done - thanks! --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 20:49, 5 December 2016 (AWST)

Thanks for the immediate reply! Another question: How can I add the blue hint "Note: You are currently viewing documentation for Moodle 2.9. Up-to-date documentation for the latest stable version of Moodle may be available here:" to older docs (german 2.8 - german 3.1)?

Talk:New features

2016-12-05T12:22:47Z

Ghillenb:

Moodle Mobile quiz

2016-08-01T15:08:49Z

Ghillenb:

{{Mobile}}
==Features==

Users can attempt a [[Quiz activity|quiz]] on their mobile device using the Moodle Mobile app.

Notes:
* Any quiz with standard [[Question types|question types]] and [[Question behaviours|question behaviours]] is suitable for mobile access, apart from essay questions which require the student to upload a file.
* Quizzes using additional plugins won't work in the app unless the plugin include support for mobile remote add-ons (see in the dev docs [[:dev:Moodle Mobile Remote add-ons|Moodle Mobile Remote add-ons]]).
* Quizzes requiring safe browser are not supported.
* Quizzes including blocked questions (questions that require that the previous question has been answered) are not supported.

== Requirements ==

Moodle Mobile quiz requires Moodle 3.1 onwards.

Alternatively, it may be used with sites running Moodle 2.6 to Moodle 3.0 if the [[Moodle Mobile additional features]] plugin is installed.

If you have quizzes with questions using TeX / MathJAX you must enable the [[TeX notation filter]] enabling all the LaTeX renderer settings. Please note that equations are rendered using LaTeX.

==See also==

* [[Moodle Mobile quiz offline attempts]] for details of how to enable students to download and attempt quizzes offline

[[Category:Quiz]]

[[es:Módulo de Examen Moodle Mobile]]
[[de:Moodle Mobile Tests]]

Blog tags block

2016-08-01T13:10:22Z

Ghillenb:

{{Blocks}}
A '''Blog Tags''' block displays a list of blogs where font size visually indicates each blog's use. The more frequently used blogs appear in a larger font size and least used in smaller fonts. This format is sometimes called a "tag cloud".

[[File:Blogtagsblockexample.png]]

==Adding a Blog Tags block to a course page==

#Click the "Turn editing on" button.
#Select Blog Tags from the Add blocks menu.
#If appropriate, move the Blog Tags block up and/or left, using the arrow icons under the block title.

==Block configuration==

To configure a Blog Tags block, click on the edit icon in the block header.
*Blog tags block title - You can change the title of the block.
*Number of tags display - Here you specify how many tags you want to display in the block.
*Display tags used within this many days - You can specify here how recent the tags that you want to appear are. For example, if it is 90 days then only tags that have been used in the last 90 days will be used.
*Sort the tag display by - Here you can specify in what order you want the tags to appear. You can choose to sort the tag according to tag name. So the tags will be sorted in alphabetical order. Or you can choose to sort them according to last date used. So the most recent tag would appear first.

==See also==

*[[Blogs]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65907 Blogging tags don't show in Blog Tags block] forum discussion

[[Category:Blog]]
[[Category:Tags]]

[[de:Blogschlagwörter]]-Block
[[es:Bloque de marcas (tags) del blog]]

Blog tags block

2016-08-01T13:09:32Z

Ghillenb:

{{Blocks}}
A '''Blog Tags''' block displays a list of blogs where font size visually indicates each blog's use. The more frequently used blogs appear in a larger font size and least used in smaller fonts. This format is sometimes called a "tag cloud".

[[File:Blogtagsblockexample.png]]

==Adding a Blog Tags block to a course page==

#Click the "Turn editing on" button.
#Select Blog Tags from the Add blocks menu.
#If appropriate, move the Blog Tags block up and/or left, using the arrow icons under the block title.

==Block configuration==

To configure a Blog Tags block, click on the edit icon in the block header.
*Blog tags block title - You can change the title of the block.
*Number of tags display - Here you specify how many tags you want to display in the block.
*Display tags used within this many days - You can specify here how recent the tags that you want to appear are. For example, if it is 90 days then only tags that have been used in the last 90 days will be used.
*Sort the tag display by - Here you can specify in what order you want the tags to appear. You can choose to sort the tag according to tag name. So the tags will be sorted in alphabetical order. Or you can choose to sort them according to last date used. So the most recent tag would appear first.

==See also==

*[[Blogs]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65907 Blogging tags don't show in Blog Tags block] forum discussion

[[Category:Blog]]
[[Category:Tags]]

[[de:Blog-Schlagwörter-Block]]
[[es:Bloque de marcas (tags) del blog]]

Blog tags block

2016-08-01T13:09:18Z

Ghillenb:

{{Blocks}}
A '''Blog Tags''' block displays a list of blogs where font size visually indicates each blog's use. The more frequently used blogs appear in a larger font size and least used in smaller fonts. This format is sometimes called a "tag cloud".

[[File:Blogtagsblockexample.png]]

==Adding a Blog Tags block to a course page==

#Click the "Turn editing on" button.
#Select Blog Tags from the Add blocks menu.
#If appropriate, move the Blog Tags block up and/or left, using the arrow icons under the block title.

==Block configuration==

To configure a Blog Tags block, click on the edit icon in the block header.
*Blog tags block title - You can change the title of the block.
*Number of tags display - Here you specify how many tags you want to display in the block.
*Display tags used within this many days - You can specify here how recent the tags that you want to appear are. For example, if it is 90 days then only tags that have been used in the last 90 days will be used.
*Sort the tag display by - Here you can specify in what order you want the tags to appear. You can choose to sort the tag according to tag name. So the tags will be sorted in alphabetical order. Or you can choose to sort them according to last date used. So the most recent tag would appear first.

==See also==

*[[Blogs]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65907 Blogging tags don't show in Blog Tags block] forum discussion

[[Category:Blog]]
[[Category:Tags]]

[[de:Blog-Schlagwörter (Block)]]
[[es:Bloque de marcas (tags) del blog]]

Competencies FAQ

2016-08-01T12:02:29Z

Ghillenb:

{{Competencies}}
==I can't see evidence uploaded by my students==
*Are you a course teacher? You will not be able to see evidence of prior learning unless your administrator has given you a role with the capability moodle/competency:userevidenceview set to ''Allow'' .

==I can't see the Learning plans block==
*Are you a course teacher? You will not be able to see the [[Learning plans block]] unless your administrator has set the capability block/lp:view to Allow for teachers. However, administrators additionally need to set other capabilities in the system context relating to viewing learning plans and evidence for the block to display any useful information.
*It might be helpful to create a custom role, such as 'Supervisor', with the capabilities you wish to allow in the system context.
*If students have no learning plans, or if teachers/supervisors have no competencies needing reviewing, then the Learning plans block is not visible when editing is not turned on.

== I can't see competencies when trying to add them to a learning template==
Make sure you are in the right part of the site. If you added competencies to a category you will need to add the learning template to that category. If you added competencies to the system you will need to add your learning plan template to the system.

==The learning plan shows all competencies met but the course competencies screen shows some are still incomplete.==
*Competencies exist outside a course,so it might be that the competency has been met in another course but not the one you are in
*If a manager or other user who is [[Capabilities/moodle/competency:usercompetencyreview| allowed to review competencies]] chooses to ''rate'' a competency from the learning plan, then the competency will not show as complete inside the course, but it will display as complete in the learning plan.

==The progress bar shows 100% complete but the learning plan is not marked complete.==
*A learning plan does not automatically display as "complete" once all competencies have been met.
*It may be manually marked as complete by a user with the relevant capabilities - or -
* a due date may be set for completion when a learning plan template is created.

[[de:Kompetenzen FAQ]]
[[es:Competencias FAQ]]

Capabilities/moodle/competency:coursecompetencyview

2016-07-29T12:12:18Z

Ghillenb:

{{Capabilities}}
* This allows a user to view course [[Competencies|competencies]]
* This capability is allowed for the default role of authenticated user

[[Category:Capabilities|Competencies]]
[[Category:Competencies]]

[[de:Capabilities/moodle/competency:coursecompetencyview]]

Capabilities/moodle/competency:coursecompetencymanage

2016-07-29T12:10:21Z

Ghillenb:

{{Capabilities}}
* This allows a user to manage course [[Competencies|competencies]]
* This capability is allowed for the default roles of manager and teacher

[[Category:Capabilities|Competencies]]
[[Category:Competencies]]

[[de:Capabilities/moodle/competency:coursecompetencymanage]]

Capabilities/moodle/competency:coursecompetencygradable

2016-07-29T12:08:43Z

Ghillenb:

{{Capabilities}}
* This allows a user to receive [[Competencies|competency marks]]
* This capability is allowed for the default role of student

[[Category:Capabilities|Competencies]]
[[Category:Competencies]]

[[de:Capabilities/moodle/competency:coursecompetencygradable]]

Capabilities/moodle/competency:competencygrade

2016-07-29T12:06:51Z

Ghillenb:

{{Capabilities}}
* This allows a user to set a [[Competencies|competency rating]]
* This capability is allowed for the default roles of manager, teacher and non-editing teacher

[[Category:Capabilities|Competencies]]
[[Category:Competencies]]

[[es:Capabilities/moodle/competency:competencygrade]]
[[de:Capabilities/moodle/competency:competencygrade]]

Capabilities/moodle/competency:templateview

2016-07-29T12:05:19Z

Ghillenb:

{{Capabilities}}
* This allows a user to view [[Learning plans|learning plan templates]]
* This capability is allowed for the default role of manager only

[[Category:Capabilities|Competencies]]
[[Category:Competencies]]

[[de:Capabilities/moodle/competency:templateview]]

Capabilities/moodle/competency:templatemanage

2016-07-29T12:03:48Z

Ghillenb:

{{Capabilities}}
* This allows a user to manage [[Learning plans|learning plan templates]]
* This capability is allowed for the default role of manager only

[[Category:Capabilities|Competencies]]
[[Category:Competencies]]

[[de:Capabilities/moodle/competency:templatemanage]]