MoodleDocs - User contributions [en]

Working with files

2016-05-09T19:22:07Z

Mudrd8mz: Reverted edits by Payal0121 (talk) to last revision by Tsala

{{Managing content}}
==Adding files to your course==

Moodle provides an easy way for a teacher to present materials to their students. These materials may take the form of files such as word-processed documents or slideshow presentations. The materials can be displayed on the page either as individual items or bundled together inside folders. One teacher might for instance wish to share a single research document in pdf format; another might have a folder of sample past examination papers for students to download. Most types of files can be uploaded and accessed through Moodle but the student needs to have the correct software to be able to open them.

To add files to a Moodle course, you must first ensure you have the editing turned on.

===Drag and drop===
*If you are using a modern browser, you can simply click, hold and drag and drop a file directly onto your course page. You will know if drag and drop is available to you because you will (briefly) see a message at the top of your screen:
[[File:dragdropmessage.png]]

To drag and drop a folder, you must first compress/zip it using whichever program your computer has.

===Add a resource or activity===
*Instead of drag and drop, you can click the link 'Add an activity or resource' and select either [[File]] or [[Folder]] from the activity chooser (or choose from the 'Add a resource' drop down menu, if this is present instead.)

{|
| [[File:filefolder23.png|thumb|Selecting a file or folder in the activity chooser]]
| [[File:Workingwithfiles.png|thumb|The "Add a resource" drop down menu]]
|}

*The screen for uploading and displaying a file (or folder of files) includes an "add" button. Clicking on this button takes you to the [[File picker]] which is the name given to the file storage and access area within Moodle. Find out more about the places you can upload or add files from in the [[File picker]] page.
*There is also a block (with an arrow) into which you can drag and drop a file straight from your desktop into Moodle.(Note that this currently doesn't work with Internet Explorer.)

{|
| [[File:newdraganddrop.png|thumb|Area for dragging and dropping files into]]
|}

==Viewing uploaded files==

* Once uploaded, files appear as thumbnails in the file manager for easy recognition.
* Files view can be easily toggled between icons view or a table view with sizes and dates, or a hierarchical list view.

{|
| [[File:truthumbnailsiconsview.png|thumb|File picker icon view]]
| [[File:tableview.png|thumb|File picker table view]]
| [[File:hierarchicallistview.png|thumb|File picker hierarchical list view]]
|}

==Editing or updating uploaded files==

*Clicking on the name of an uploaded file opens up a pop up dialogue box which allows file details quickly to be altered.

{|
| [[File:popupdialogue.png|thumb|File info popup dialogue]]
|}

==Creating an alias/shortcut==

*When an uploaded file - or a file from the Private files, Dropbox, File system or EQUELLA repositories - is re-used elsewhere on Moodle, the teacher has the option to make a copy (a new, unconnected version) or to create a shortcut or ''alias''. (Note: Previously an alias could be made to a file stored in Box.net, however with [[Box.net APIv1 migration |Box.net API v2]] this is no longer possible.)
*If an alias is created, then when the original file is updated, it will change in all instances of the alias. So a teacher might add course notes to their private files for example, and then add them into a number of courses. When the teacher makes an alteration in the file in their private files, this alteration will be reflected in all instances of the course notes.
*An alias can be recognised by its thumbnail. See the difference in the screenshot below between the original file (left) and the alias (right):
*To update a file, go to its original location (for example Private files) and upload your new version ''with the same name'' . You will be prompted to override or rename the file. Choose "override" and this file will replace your original file and the alisas/shortcuts will remain and all be updated to your latest version.
{|
| [[File:alias.png|thumb|Creating an alias]]
| [[File:shortcut1.png|frame]]
|}

===Areas in which aliases cannot be made===

An alias cannot be made in the following areas of Moodle:

* an assignment submission
* a forum post attachment
* a workshop submission
* a quiz essay
* a database activity file field

This is to prevent cases such as a student uploading an item for assessment and then subsequently changing the original in their private files. When a student uses a file from their private files in one of these instances, they do not see the options to "copy" or "create an alias". Below is an example of a file added to an assignment:

{|
| [[File:aliasassignment.png|thumb|Assignment submission with no option to create an alias]]
|}

==Site administration settings==

An administrator can add new file types and view, edit and delete existing file types from ''Site administration > Server > File types''. This means that, for example, if teachers and students on your site use a lot of files specific to a particular program, such files can now be recognised by Moodle, and, when downloaded, they will open in the correct program, rather than presenting themselves as a generic zip file.

[[File:Filetypes1.png|center|thumb|500px||Some examples from the list]]

===Adding a new file type===
1. Scroll down to the bottom of the page and click the "Add" button

2. Add the details of your file type, using the example below as a guide. This example will add the .mobi extension (for a Kindle ebook) with the standard document icon.

[[File:newfiletype.png|thumb|center|500px|Adding a new filetype]]

3. Click to save the changes and you will see your new file type has been added to the list:

[[File:customfileypesuccess.png|thumb|500px|center|New type in the list]]

===File types and Assignments===
Tracker item: https://tracker.moodle.org/browse/MDL-39913

Discussion thread: https://moodle.org/mod/forum/discuss.php?d=217532

===Removing a file type===
*Clicking the X next to a file type will remove it from the site. You will be prompted to confirm before deletion.

===Editing an existing file type===
*Clicking the edit icon next to a file type will allow you to change certain details, for example the associated icon and description. If you don't wish to use the default description, you can specify your own custom description (with multi-language tags if your site supports multi-languages) or you can use an alternative language string from mimetypes.php.
===Google docs and docx===
Importing Google docs files as docx. See https://moodle.org/mod/forum/discuss.php?d=320144

==See also==
*HQ Youtube video tutorial: [http://youtu.be/Wt5Hgv-eouE Dragging and dropping files into Moodle]
*HQ Youtube video tutorial: [http://youtu.be/7i2roZ_OCyI Uploading files to Moodle]
*[http://lewiscarr.co.uk/2014/11/moodle-file-sharing-explained/ File sharing explained] blog post by Lewis Carr
*How to share a single file with students: [[File resource]]
*How to share a folder of files with students: [[Folder]]
*Questions about the file picker: [[File picker FAQ]]
* [[Restoring file aliases]]
*[http://www.youtube.com/watch?v=IrOKxYRJvGU How teachers upload files in Moodle 2 video]

[[de:Arbeiten mit Dateien und Verzeichnissen]]
[[es:Trabajando con archivos]]
[[fr:Utilisation de fichiers]]

Teacher quick guide

2016-05-05T18:49:06Z

Mudrd8mz: Reverted edits by Jhsdifrhdi (talk) to last revision by Kinderjoy

Quicken Toll Free, Intuit@(1-844-231-5378)@ Quicken Tech Support Phone Number provides online solution for all USA/CANADA clients. For any help of query call 1 844 231 5378 to get all Quicken account solution. @@Call, 1-844-231-5378 for all type help by Quicken tech support phone number, Intuit Quicken Tech Support Phone Number, Quicken Help Desk Phone Number, Quicken tech support number, Quicken technical support phone number,@@@ Quicken phone number, Quicken technical support number, Quicken support phone number, Quicken technical support, Quicken Customer Service Phone Number, Quicken Customer Service Number, Quicken Customer Support Phone Number, Quicken Customer Support Number,@@@@ Quicken Customer Service Helpline Number, Quicken Customer Care Number, Quicken support team phone number, @@@@@ Quicken help number-Quicken Helpline Number; Quicken help phone number-Quicken Helpline Number, Quicken Tech Support Toll free Number, Quicken Support Telephone Number, Quicken Tech Support Telephone number, Q.B 1.8442315378 Quicken pro help desk number , Quicken pro support phone numberQuicken Tech Support contact number, Quicken support contact number, Quicken technical support contact number. Call, Quicken tech support phone number, Intuit Quicken Tech Support Phone Number, Quicken Help Desk Phone Number, Quicken tech support number, Quicken technical support phone number, Quicken phone number, Quicken technical support number, Quicken support phone number. It is very popular toll free number which provide by Quicken technical support,Q.B 1.8442315378 Quicken pro help desk number , Quicken pro support phone number Quicken Customer Service Phone Number, Quicken Customer Service Number, Quicken Customer Support Phone Number, Quicken Customer Support Number, Quicken Customer Service Helpline Number, Quicken Customer Care Number, Quicken support team phone number. Call, Quicken tech support phone number, Intuit Quicken Tech Support Phone Number, Quicken Help Desk Phone Number, Quicken tech support number, Quicken technical support phone number, Quicken phone number, Quicken technical support number, Quicken support phone number, Quicken technical support, Quicken Customer Service Phone Number, Quicken Customer Service Number, Quicken Customer Support Phone Number, Quicken Customer Support Number, Quicken Customer Service Helpline Number, Quicken Customer Care Number, Quicken support team phone number, Quicken help number-Quicken Helpline Number; Quicken help phone number, Quicken Helpline Number, Quicken Tech Support Toll free Number, Quicken Support Telephone Number, Quicken Tech Support Telephone number, Quicken Tech Support contact number, Quicken support contact number, Quicken technical support contact number, Quicken pro support phoneber, Quicken payroll support phone number. Quicken payroll customer support phone number Q.B 1.8442315378 Quicken pro help desk number , Quicken pro support phone number 1844-231-5378 Quicken technical help telephone number, Quicken technical help contact number, Quicken technical support contact number, Quicken contact number, Quicken contact phone number, Quicken contact telephone number, Quicken 24 hour contact number, Quicken customer support contact number, Quicken customer service contact number, Quicken official number, Quicken official contact number, Quicken 844 contact number, Quicken toll free number, 844 number for Quicken support, Quicken 24/7 support phone number Quicken PRO support phone number,Quicken PRO support phone number,Quicken PRO help phone number, Quicken PRO technical support number.Quicken PRO support number, Quicken PRO phone number, Quicken PRO tech support number, Quicken PRO customer support number, Quicken PRO customer support phone number, Quicken PRO customer service phone number, Quicken PRO payroll customer service phone number, Quicken PRO support phone number. Q.B 1.8442315378 Quicken pro help desk number , Quicken pro support phone number Help@Call 1-844-231-5378/.Quicken 24/7 support phone number,Quicken telephone number for support? call 1844-231-5378@./Quicken contact number, Quicken contact phone number, Quicken contact telephone numbertelephone number for Quicken online support,Quicken official support number,Quicken official number,Quicken payroll official phone number,phone number for Quicken payroll supportQuicken 24/7 support phone numberQuicken support number,Quicken telephone number for support Quicken PRO phone number,(1-844-231-5378)// Quicken PRO customer care number..... Quicken PRO Toll Free, Intuit@(1-844.231-5378)@-: Quicken PRO Technical Support Number, Quicken PRO help desk phone number provides online solution for all USA/CANADA clients. For any help of query call 1 844 231 5378 to get all Quicken PRO account solution. For any help of query call 1 844 231 5378 to get all Quicken PRO account solution. @@Call, 1-844-231-5378 for all type help by Quicken PRO support telephone number,Quicken PRO support phone number,Quicken PRO support phone number,Quicken PRO help phone number, Quicken PRO technical support number.Quicken PRO support number, Quicken PRO phone number, Quicken PRO tech support number, Quicken PRO customer support number, Quicken PRO customer support phone number, Quicken PRO customer service phone number, Quicken PRO payroll customer service phone number, Quicken PRO support phone number Quicken PRO help number-Quicken PRO Helpline Number; Quicken PRO help phone number-Quicken PRO Helpline Number, Quicken PRO Tech Support Toll free Number, Quicken PRO Support Telephone Number, Quicken PRO Tech Support Telephone number, Quicken PRO Tech Support contact number, Quicken PRO support contact number, Quicken PRO technical support contact number, Quicken PRO help desk phone number. Call, @(1-844-231-5378)@-: It is very popular toll free number which provide by Quicken PRO technical support, Quicken PRO Customer Service Phone Number, Quicken PRO Customer Service Number, Quicken PRO Customer Support Phone Number, Quicken PRO Customer Support Number, Quicken PRO Customer Service Helpline Number, Quicken PRO Customer Care Number, Quicken PRO support team phone number. Call,@(1-844-231-5378)@-: Quicken PRO help number-Quicken PRO Helpline Number; Quicken PRO help phone number, Quicken PRO Helpline Number, Quicken PRO Tech Support Toll free Number, Quicken PRO Support Telephone Number, Quicken PRO Tech Support Telephone number, Quicken PRO Tech Support contact number, Quicken PRO support contact number, Quicken PRO technical support contact number, Quicken PRO pro support phone number, Quicken PRO payroll support phone number. Quicken PRO payroll customer support phone number for all type help by Quicken PRO support telephone number, Quicken PRO help phone number, Quicken PRO technical support number.Quicken PRO support number, Quicken PRO phone number, Quicken PRO tech support number, Quicken PRO customer support number, Quicken PRO customer support phone number, Quicken PRO customer service phone number, Quicken PRO payroll customer service phone number Quicken Pro Support Helpline Number, Quicken Pro contact number 1844-231-5378 Quicken Pro technical help telephone number, Quicken Pro technical help contact number, Quicken Pro technical support contact number, Quicken Pro contact number, Quicken Pro contact phone number, Quicken Pro contact telephone number, Quicken Pro 24 hour contact number, Quicken Pro customer support contact number, Quicken Pro customer service contact number, Quicken Pro official number, Quicken Pro official contact number, Quicken Pro 844 contact number, Quicken Pro toll free number, 844 number for Quicken Pro support, Quicken Pro 24/7 support phone numberCall,1-844-231-5378 for all type help by Quicken payroll support telephone number,Quicken payroll support phone call (1 844 231 5378) to get all Quicken payroll account solution. @@Call,1-844-231-5378 for all type help by Quicken payroll support telephone number,Quicken payroll support phone number,Quicken payroll support phone number,Quicken payroll help phone number, Quicken payroll technical support number.Quicken payroll support number, Quicken payroll phone number, Quicken payroll tech support number, Quicken payroll customer support number, Quicken payroll customer support phone number, Quicken payroll customer service phone number, Quicken payroll payroll customer service phone number, Quicken payroll support phone number Quicken payroll help number-Quicken payroll Helpline Number; Quicken payroll help phone number-Quicken payroll Helpline Number, Quicken payroll Tech Support Toll free Number, Quicken payroll Support Telephone Number, Quicken payroll Tech Support Telephone number, Quicken payroll Tech Support contact number, Quicken payroll support contact number, Quicken payroll technical support contact number, Quicken payroll help desk phone number. Call, @(1-844-231-5378)@~~ @@@@@@@@@@@@@@@@@@@(It is so very fast customer support for Quicken payroll Customer Number, Quicken payroll Customer Service Number, Quicken payroll Customer Support Phone Number, Quicken payroll Customer Support Number, Quicken payroll Customer Service Helpline Number, Quicken payroll Customer Care Number, Quicken payroll support team phone number.Quicken payroll help number-Quicken payroll Helpline Number; Quicken payroll help phone number, Quicken payroll Helpline Number, Quicken payroll Tech Support Toll free Number, Quicken payroll Support Telephone Number, Quicken payroll Tech Support Telephone number, Quicken payroll Tech Support contact number, Quicken payroll support contact number, Quicken payroll technical support contact number, Quicken payroll support phone number, Quicken payroll payroll support phone number. Quicken payroll payroll customer support phone number for all type help by Quicken payroll support telephone number, Quicken payroll help phone number, Quicken payroll technical support number.Quicken payroll support number, Quicken payroll phone number, Quicken payroll tech support number, Quicken payroll customer support number, Quicken payroll customer support phone number, Quicken payroll customer service phone number, Quicken payroll payroll customer service phone number Quicken payroll numebr1(844) 231.5378"Quicken payroll tech support phone number canada, Quicken payroll tech support phone number Quicken payroll enterprise phone number. Quicken payroll enterprise support phone number, Quicken payroll enterprise phone number, Quicken payroll enterprise tech support number, Quicken payroll enterprise customer support number, Quicken payroll enterprise tech support number, Quicken payroll enterprise technical support number, Quicken payroll enterprise tech support phone number Quicken payroll technical support line Quicken payroll enterprise tech support number Quicken payroll proadvisor tech support number Quicken payroll pos tech support number Quicken payroll tech support phone number canada Quicken payroll online tech support number Quicken payroll tech support phone number uk Quicken payroll pro tech support number Quicken payroll online technical support number Quicken payroll enterprise technical support number Quicken payroll tech support numberQuicken payroll technical support australia Quicken payroll technical support phone number australia Quicken payroll tech support contact number Quicken payroll tech support canada Quicken payroll tech support cost Quicken payroll technical support canada Quicken payroll enterprise tech support number, Quicken payroll enterprise technical support phone number Quicken payroll enterprise support number Quicken payroll enterprise technical support number Quicken payroll enterprise support phone number Quicken payroll enterprise support telephone number, Quicken payroll enterprise phone number. Quicken payroll enterprise support phone number, Quicken payroll enterprise phone number, Quicken payroll enterprise tech support number, Quicken payroll enterprise customer support number, Quicken payroll enterprise tech support number, Quicken payroll enterprise technical support number, Quicken payroll enterprise tech support phone number //////////// Quicken payroll Toll Free, Intuit@(1-844-231-5378)@-: Quicken payroll Tech Support Phone Number provides online solution for all USA/CANADA clients. For any help of query call 1 844 231 5378 to get all Quicken payroll account solution. @@Call, 1-844-231-5378 for all type help by Quicken payroll tech support phone number, Intuit Quicken payroll Tech Support Phone Number, Quicken payroll Help Desk Phone Number, Quicken payroll tech support number, Quicken payroll technical support phone number,@@@ Quicken payroll phone number, Quicken payroll technical support number, Quicken payroll support phone number, Quicken payroll technical support, Quicken payroll Customer Service Phone Number, Quicken payroll Customer Service Number, Quicken payroll Customer Support Phone Number, Quicken payroll Customer Support Number,@@@@ Quicken payroll Customer Service Helpline Number, Quicken payroll Customer Care Number, Quicken payroll support team phone number, @@@@@ Quicken payroll help number-Quicken payroll Helpline Number; Quicken payroll help phone number-Quicken payroll Helpline Number, Quicken payroll Tech Support Toll free Number, Quicken payroll Support Telephone Number, Quicken payroll Tech Support Telephone number, Quicken payroll Tech Support contact number, Quicken payroll support contact number, Quicken payroll technical support contact number. Call, Quicken payroll tech support phone number, Intuit Quicken payroll Tech Support Phone Number, Quicken payroll Help Desk Phone Number, Quicken payroll tech support number, Quicken payroll technical support phone number, Quicken payroll phone number, Quicken payroll technical support number, Quicken payroll support phone number. @@@@@@@@@@@@@@@@@@@@@@@It is very popular toll free phone number which provide through Quicken payroll technical support, Quicken payroll Customer Service Phone Number, Quicken payroll Customer Service Number, Quicken payroll Customer Support Phone Number, Quicken payroll Customer Support Number, Quicken payroll Customer Service Helpline Number, Quicken payroll Customer Care Number, Quicken payroll support team phone number. Call, Quicken payroll tech support phone number, Intuit Quicken payroll Tech Support Phone Number, Quicken payroll Help Desk Phone Number, Quicken payroll tech support number, Quicken payroll technical support phone number, Quicken payroll phone number, Quicken payroll technical support number, Quicken payroll support phone number, Quicken payroll technical support, Quicken payroll Customer Service Phone Number, Quicken payroll Customer Service Number, Quicken payroll Customer Support Phone Number, Quicken payroll Customer Support Number, Quicken payroll Customer Service Helpline Number, Quicken payroll Customer Care Number, Quicken payroll support team phone number, Quicken payroll help number-Quicken payroll Helpline Number; Quicken payroll help phone number, Quicken payroll Helpline Number, Quicken payroll Tech Support Toll free Number, Quicken payroll Support Telephone Number, Quicken payroll Tech Support Telephone number, Quicken payroll Tech Support contact number, Quicken payroll support contact number, Quicken payroll technical support contact number, Quicken payroll pro support phone number, Quicken payroll payroll support phone number. Quicken payroll payroll customer support phone number Quicken payroll technical supportQuicken Toll Free, Intuit@(1-844-231-5378)@-: Quicken Tech Support Phone Number provides online solution for all USA/CANADA clients. For any help of query call 1 844 231 5378 to get all Quicken account solution. @@Call, 1-844-231-5378 for all type help by Quicken tech support phone number, Intuit Quicken Tech Support Phone Number, Quicken Help Desk Phone Number, Quicken tech support number, Quicken technical support phone number,@@@ Quicken phone number, Quicken technical support number, Quicken support phone number,

Installing plugins

2016-04-21T12:41:30Z

Mudrd8mz: /* A file permissions error has occurred */

{{Installing Moodle}}
Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the plugin does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If a plugin modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing a plugin==

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the plugin code can be deployed into Moodle.

Plugin code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new plugin is to be installed in order to use either of these methods.

Alternatively, a plugin may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Confirm the installation request
# Check the plugin validation report

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if your plugin is not automatically detected.
# If your target directory is not writeable, you will see a warning message.
# Check the plugin validation report

{|
| [[File:plugin1.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

===Installing manually at the server===

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow the plugin instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

On certain 3.0.x versions, when installing plugins via the administration interface, the Moodle uses the configuration settings <tt>$CFG->directorypermissions</tt> and <tt>$CFG->filepermissions</tt>. If these are not defined explicitly in your config.php, the default value is set automatically to 777 (rwxrwxrwx) for directories and 666 (rw-rw-rw-) for files (see lib/setup.php).

If this default behaviour does not fit your needs and hosting environment, you may wish to specify more strict setting such as

$CFG->directorypermissions = 02750;

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===Default exception handler: Error writing to database Debug: Duplicate entry 'en_us-...===
* These errors are usually caused by a third party plugin.
* To find the involved plugin, go to [http://lang.moodle.org http://lang.moodle.org] and use the AMOS tool to find all the strings with the given string identifier.
* Remove the suspected plugin and check if the error has disappeared. If so, please contact the plugin maintainer and report this issue.
* Please see [https://moodle.org/mod/forum/discuss.php?d=219504 this forum thread] for known causes and fixes.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the plugin in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name, then it won't work.

===Obtaining help===

Ask in a forum in [http://moodle.org/course/view.php?id=5 Moodle in English]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

==Uninstalling a plugin==

To uninstall a plugin
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the plugin you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|center|400px|Plugins overview highlighting available check button]]

The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number,release, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

An administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing plugins from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==See also==
* [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
* [[Notifications]] for further details of update notifications
* [[Plugin Review Criteria]]
* [[Plugins FAQ]]
* Moodle in English [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick
*[http://youtu.be/RxlmVzIllVk Moodle 2 Plugins Administration] MoodleBites video on YouTube
* [http://youtu.be/K3MYE8am7M4 Install a New Theme] MoodleBites video on YouTube

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalar complementos]]

Installing plugins

2016-04-21T09:41:02Z

Mudrd8mz: /* A file permissions error has occurred */ Add note about file permission

{{Installing Moodle}}
Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the plugin does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If a plugin modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing a plugin==

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the plugin code can be deployed into Moodle.

Plugin code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new plugin is to be installed in order to use either of these methods.

Alternatively, a plugin may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Confirm the installation request
# Check the plugin validation report

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if your plugin is not automatically detected.
# If your target directory is not writeable, you will see a warning message.
# Check the plugin validation report

{|
| [[File:plugin1.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

===Installing manually at the server===

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow the plugin instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

When installing plugins via the administration interface, the Moodle respects the configuration settings <tt>$CFG->directorypermissions</tt> and <tt>$CFG->filepermissions</tt>. If these are not defined explicitly in your config.php, the default value is set automatically to 777 (rwxrwxrwx) for directories and 666 (rw-rw-rw-) for files (see lib/setup.php).

If this default behaviour does not fit your needs and hosting environment, you may wish to specify more strict setting such as

$CFG->directorypermissions = 02750;

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===Default exception handler: Error writing to database Debug: Duplicate entry 'en_us-...===
* These errors are usually caused by a third party plugin.
* To find the involved plugin, go to [http://lang.moodle.org http://lang.moodle.org] and use the AMOS tool to find all the strings with the given string identifier.
* Remove the suspected plugin and check if the error has disappeared. If so, please contact the plugin maintainer and report this issue.
* Please see [https://moodle.org/mod/forum/discuss.php?d=219504 this forum thread] for known causes and fixes.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the plugin in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name, then it won't work.

===Obtaining help===

Ask in a forum in [http://moodle.org/course/view.php?id=5 Moodle in English]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

==Uninstalling a plugin==

To uninstall a plugin
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the plugin you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|center|400px|Plugins overview highlighting available check button]]

The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number,release, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

An administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing plugins from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==See also==
* [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
* [[Notifications]] for further details of update notifications
* [[Plugin Review Criteria]]
* [[Plugins FAQ]]
* Moodle in English [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick
*[http://youtu.be/RxlmVzIllVk Moodle 2 Plugins Administration] MoodleBites video on YouTube
* [http://youtu.be/K3MYE8am7M4 Install a New Theme] MoodleBites video on YouTube

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalar complementos]]

Sandbox

2016-04-05T13:02:23Z

Mudrd8mz:

Test page for docs

Testing email notification yet again

-Testing-

-Testing 2-

-Testing 3-

{| cellpadding="2" cellspacing="0" border="1"
!Col1
!Col2
|-
|Test1
|Test2
|-
|Test1
|Test2
|-
|Test1
|Test2
|}

==Functions and Examples==

Following are the functions that constitute the basic log API for Moodle.
<code>
add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0)
user_accesstime_log($courseid=0)
get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount)
get_logs_usercourse($userid, $courseid, $coursestart)
get_logs_userday($userid, $courseid, $daystart)
</code>
The basic working of these functions can be categorized into two categories:-
# Adding data to logs
# Fetching data from logs
Let us take a deeper look into both of these:-

<pre>something in pre tags</pre>
<code>and something in code tags</code>

<math>Insert formula here</math>==First edit in sandbox==
An additional edit to sandbox
This is where you can edit the content.
Another edit to sandox

==Testing gallery==
==Testing gallery==8/11
==Testing gallery==8/11 again
<gallery mode="packed-hover">
File:Atto_27.jpg|Atto
File:Clean27.jpg|Clean
File:MathJax.jpg|MathJax
</gallery>

==Bootstrap stuff==

<div class="alert alert-block"><span class="close" data-dismiss="alert">×</span>'''Warning!''' Click the cross to close this label ...</div>

[[de:Hauptseite]]
[[es:Zona de Pruebas]]

Talk:Upgrade warnings

2016-03-14T19:33:02Z

Mudrd8mz:

Shouldn't we change MOODLE_2X_STABLE to MOODLE_3X_STABLE ? [[User:German Valero|German Valero]] ([[User talk:German Valero|talk]])

: Good point. I just did it, and also I tried to simplify the page a bit. --[[User:David Mudrak|David Mudrak]] ([[User talk:David Mudrak|talk]]) 03:32, 15 March 2016 (AWST)

Upgrade warnings

2016-03-14T19:31:51Z

Mudrd8mz: Update Moodle version and simplify

If you reached this page from a warning during an upgrade from a stable version then it's probable that some of our branch changes have affected you.

If you intend to stay with the most recent stable version of Moodle, then you need to switch your checkout over to use the appropriate MOODLE_3x_STABLE branch (such as MOODLE_30_STABLE, MOODLE_31_STABLE etc).

If you are using Git, then you must create new local branch that will track the remote stable branch and switch to it.

git checkout -b MOODLE_30_STABLE origin/MOODLE_30_STABLE
git pull

Replace 30 with the relevant Moodle version. At the first line, the new local branch MOODLE_30_STABLE is created and set to track the remote branch of the same name. At the second line, the git-pull command fetches recent changes from the upstream and merges them into your local branch. To update your Moodle next week, you can run just this second line.

For more about how Moodle versions are managed in Git, see our [[dev:Moodle_versions]] page.

==See also==

* [[Git for Administrators]]

[[es:Advertencias al actualizar]]
[[fr:Notifications de mise à jour]]

About Moodle

2016-02-12T08:05:01Z

Mudrd8mz: Use a better variant "knowledgeable" instead of "knowledgable"

{{Main page}}

Moodle is a learning platform designed to provide educators, administrators and learners with a '''single robust, secure and integrated system''' to create personalised learning environments. You can [http://download.moodle.org/ download the software] onto your own web server or ask one of our knowledgeable [http://moodle.com/partners/ Moodle Partners] to assist you.

Moodle is built by the Moodle project which is led and coordinated by [http://moodle.com/hq Moodle HQ], an Australian company of 30 developers which is financially supported by a network of over [http://moodle.com/partners 60 Moodle Partner service companies] worldwide.

==Built for learning, globally==

===Proven and trusted worldwide===
Powering [https://moodle.org/stats/ tens of thousands of learning environments globally], Moodle is trusted by institutions and organisations large and small, including Shell, London School of Economics, State University of New York, Microsoft and the Open University. Moodle’s worldwide numbers of more than [https://moodle.org/stats/ 79 million users] across both academic and enterprise level usage makes it the world’s most widely used learning platform.

===Designed to support both teaching and learning===
With over 10 years of development guided by [[Philosophy|social constructionist pedagogy]], Moodle delivers a powerful set of learner-centric tools and collaborative learning environments that empower both teaching and learning.

===Easy to use===
A simple interface, drag-and-drop features, and [[Main page|well-documented resources]] along with ongoing usability improvements make Moodle easy to learn and use.

===Free with no licensing fees===
Moodle is provided freely as [http://opensource.org/docs/osd Open Source] software, under the [[:dev:License|GNU General Public License]]. Anyone can adapt, extend or modify Moodle for both commercial and non-commercial projects without any licensing fees and benefit from the cost-efficiencies, flexibility and other advantages of using Moodle.

===Always up-to-date===
The Moodle project’s open-source approach means that Moodle is continually being reviewed and improved on to suit the current and evolving needs of its users.

===Moodle in your language===
Moodle’s [[Language|multilingual]] capabilities ensure there are no linguistic limitations to learning online. The Moodle community has begun [[:dev:Translation|translating]] Moodle into more than 120 languages (and counting) so users can easily localise their Moodle site, along with plenty of resources, support and [https://moodle.org/course/ community discussions] available in various languages.

==All-in-one learning platform==
Moodle provides the most flexible tool-set to support both blended learning and 100% online courses. Configure Moodle by [[Advanced features|enabling or disabling core features]], and easily integrate everything needed for a course using its complete range of built-in features, including external collaborative tools such as [[Forum|forums]], [[Wiki|wikis]], [[Chat|chats]] and [[Blog|blogs]].

==Highly flexible and fully customisable==
Because it is open-source, Moodle can be customised in any way and tailored to individual needs. Its modular set up and interoperable design allows developers to [[:dev:Plugins|create plugins]] and integrate external applications to achieve specific functionalities. Extend what Moodle does by using freely available [https://moodle.org/plugins/ plugins and add-ons] - the possibilities are endless!

==Scalable to any size==
From a few students to millions of users, Moodle can be scaled to support the needs of both small classes and large organisations. Because of its flexibility and scalability, Moodle has been adapted for use across education, business, non-profit, government, and community contexts.

==Robust, secure and private==
Committed to safeguarding data [[Security|security]] and [[Privacy|user privacy]], [https://moodle.org/security/ security controls are constantly being updated] and implemented in Moodle development processes and software to protect against unauthorised access, data loss and misuse. Moodle can be easily deployed on a private secure cloud or server for complete control.

==Use any time, anywhere, on any device==
Moodle is web-based and so can be accessed from anywhere in the world. With a default mobile-compatible (soon to be responsive) interface and cross-browser compatibility, content on the Moodle platform is easily accessible and consistent across different web browsers and devices.

==Extensive resources available==
Access extensive [https://docs.moodle.org/overview/ Moodle documentation] and [https://moodle.org/course/ user forums] in multiple languages, free [http://moodle.net/ content and courses] shared by Moodle users across the world, as well as hundreds of [https://moodle.org/plugins/ plugins] contributed by a large global community.

==Backed by a strong community==
The Moodle project is well-supported by an active [https://moodle.org/dev/ international community], a [https://moodle.com/hq/ team of dedicated full-time developers] and a network of certified [https://moodle.com/partners/ Moodle Partners]. Driven by open collaboration and great community support, the project continues to achieve rapid bug fixes and improvements, with [[:dev:Releases|major new releases]] every six months. Come [http://moodle.org/community/ moodle with us] in our community forums!

<div class="content">
*[[Features]]
*[[New features|New features in 3.0]]
*[[Philosophy]]
*[[Pedagogy]]
*[[Standards]]
*[[History]]
*[[Usage]]
*[[Moodle site - basic structure]]
*[[Moodle key terms]]
*[[About Moodle FAQ]]
</div>

==See also==

* [[:dev:Future|The future of Moodle]] (in the developer documentation)

[[Category:About Moodle]]

[[es:Acerca de Moodle]]
[[eu:Moodle-ri buruz]]
[[fr:À propos de Moodle]]
[[de:Was ist Moodle?]]
[[ja:Moodleとは]]

Maintenance mode

2015-11-05T01:13:25Z

Mudrd8mz: /* CLI maintenance mode */ Clarify info about the template

{{Server settings}}
Maintenance mode is for preventing any users other than administrators from using the site while maintenance is taking place, though ''it's not designed to prevent user access during version upgrades''.

When users attempt to access a course when your site is in maintenance mode, they obtain a message informing them that the site is in maintenance mode. If you wish, you can create a customized maintenance mode message, perhaps stating when the site will be available again or giving the reason for doing maintenance.

Note: The front page of your site will appear as normal when your site is in maintenance mode. Users will only see the maintenance mode message when they attempt to access a course.

==Setting maintenance mode==

An administrator can put the site into maintenance mode in ''Administration > Site administration > Server > Maintenance mode''.

When a site is in maintenance mode, the link "In Maintenance Mode" is displayed near the top right of each page (except the front page) for admins.

If your session finished while still in Mainenance mode, you can re-login by typing the login URL directly (http://yoursitename/login/)

==CLI maintenance mode==

Admins can enable CLI maintenance mode by adding a file <tt>$CFG->dataroot/climaintenance.html</tt>. If it exists, this file will be sent to the navigator instead of the standard Moodle home page.
The difference from the standard maintenance mode is that all web access is prevented, CLI scripts continue to work (with the exception of admin/cli/cron.php). This CLI maintenance mode is often used during CLI version upgrades.

It is possible to use the admin/cli/maintenance.php to schedule the CLI maintenance mode and then to display a message to users warning them when the site will become unavailable. In the scheduled maintenance mode, the maintenance message is taken from admin setting, template file <tt>$CFG->dataroot/climaintenance.template.html</tt> and the language pack, in this order. See MDL-37596 for details.
{|
|[[File:maintenancecli25.png|thumb|Scheduled maintenance mode]]
|}
See also the section on maintenance mode in [[Administration via command line]].

==See also==

Forum discussions:
*[https://moodle.org/mod/forum/discuss.php?d=245299 Maintenance mode cannot be switched off]
*[https://moodle.org/mod/forum/discuss.php?d=251954 Moodle for Windows stuck in Maintenance mode]
*[https://moodle.org/mod/forum/discuss.php?d=318890 Turned on Maintenance and can't get back in]

[[es:Modo de mantenimiento]]
[[fr:Mode de maintenance]]
[[ja:メンテナンスモード]]
[[de:Wartungsmodus]]

Installing plugins

2015-10-27T20:03:55Z

Mudrd8mz: /* Installing a plugin */

{{Installing Moodle}}
Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the plugin does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If a plugin modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing a plugin==

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the plugin code can be deployed into Moodle.

Plugin code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new plugin is to be installed in order to use either of these methods.

Alternatively, a plugin may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Confirm the installation request
# Check the plugin validation report

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if your plugin is not automatically detected.
# If your target directory is not writeable, you will see a warning message.
# Check the plugin validation report

{|
| [[File:plugin1.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

===Installing manually at the server===

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow the plugin instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the plugin in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name then it won't work.

===Obtaining help===

Ask in the appropriate forum in [http://moodle.org/course/view.php?id=5 Using Moodle]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

==Uninstalling a plugin==

To uninstall a plugin
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the plugin you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|center|400px|Plugins overview highlighting available check button]]

The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number,release ''(new in 2.7)'', availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

An administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing plugins from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==See also==

* [[Notifications]] for further details of update notifications
* [[Plugin Review Criteria]]
* [[Plugins FAQ]]
* Moodle in English [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick
*[http://youtu.be/RxlmVzIllVk Moodle 2 Plugins Administration] MoodleBites video on YouTube
* [http://youtu.be/K3MYE8am7M4 Install a New Theme] MoodleBites video on YouTube

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalar complementos]]

File:add-on package validation.png

2015-10-27T19:58:48Z

Mudrd8mz: Mudrd8mz uploaded a new version of File:add-on package validation.png

Automatic updates deployment

2015-10-27T19:57:03Z

Mudrd8mz: /* Errors and exceptions */ mdeploy removed in 3.0

Automatic updates deployment

2015-10-27T19:55:57Z

Mudrd8mz: /* Plugin files not writable */ Write access to the plugin type directory is needed because we are moving the whole plugin directory

{{Installing Moodle}}
==Enabling updates deployment==

This functionality requires [[Available update notifications]] to be enabled. The feature is enabled by default as long as the web server has write access to the folders with plugins being updated.

== Disabling updates deployment ==

In a few circumstances (such as completely managed servers, which may have a lot of local modifications, or sites that have their own solution for updates deployment - for example via [[Git for Administrators|Git checkouts]]) it is desirable to not to allow automatic updates deployment. The feature may be disabled completely by adding the following code to the [[Configuration file|config.php file]]:

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==Possible problems==

=== Missing install button ===

If the updates deployment feature is not enabled (or if it is disabled in the config.php file), no button to install the update is displayed. When the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, information with a help pop-up is displayed.

=== Plugin files not writable ===

During the deployment, Moodle will replace the whole folder with the plugin code with a new version of the code. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path in the [[:dev:Plugins|Plugins developer docs]].

Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your activity modules to update them:

# cd /var/www/vhosts/moodle/htdocs
# chown -R www-data mod
# chmod -R u+w mod

See also more about [[Installing plugins]].

=== Can not download the package ===

Make sure that http://moodle.org/plugins is up. If the site is down, your Moodle site will not be able to fetch the ZIP packages from it. Wait for http://moodle.org/plugins to be up again and then try to repeat the deployment procedure.

There can also be a problem with the validation of the SSL certificate. See [[SSL certificate for moodle.org]] for more info.

== Errors and exceptions ==

[[File:mdeploy-exception.png|thumb|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the cause of the failure.

When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the 'Install this update' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work, as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''

The following section describes some errors that you may encounter and how to deal with them.

=== Unable to download the package (download_file_exception) ===

Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.

; cURL error 7 couldn't connect to host : Make sure that the site http://download.moodle.org is up and running at the moment. If it is down, your site can't call the web service to fetch the available updates info. Wait for http://download.moodle.org to be up again then re-check.

; cURL error 60 (SSL certificate problem) : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. See [[SSL certificate for moodle.org]] for more info.

[[de:Automatische Aktualisierungen]]
[[es:Implementar actualizaciones automáticas]]

Automatic updates deployment

2015-10-27T19:52:18Z

Mudrd8mz: mdeploy does not exist any more

{{Installing Moodle}}
==Enabling updates deployment==

This functionality requires [[Available update notifications]] to be enabled. The feature is enabled by default as long as the web server has write access to the folders with plugins being updated.

== Disabling updates deployment ==

In a few circumstances (such as completely managed servers, which may have a lot of local modifications, or sites that have their own solution for updates deployment - for example via [[Git for Administrators|Git checkouts]]) it is desirable to not to allow automatic updates deployment. The feature may be disabled completely by adding the following code to the [[Configuration file|config.php file]]:

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==Possible problems==

=== Missing install button ===

If the updates deployment feature is not enabled (or if it is disabled in the config.php file), no button to install the update is displayed. When the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, information with a help pop-up is displayed.

=== Plugin files not writable ===

During the deployment, Moodle will replace the whole folder with the plugin code with a new version of the code. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path in the [[:dev:Plugins|Plugins developer docs]].

Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:

# cd /var/www/vhosts/moodle/htdocs
# cd mod
# chown -R www-data stampcoll
# chmod -R u+w stampcoll

See also more about [[Installing plugins]].

=== Can not download the package ===

Make sure that http://moodle.org/plugins is up. If the site is down, your Moodle site will not be able to fetch the ZIP packages from it. Wait for http://moodle.org/plugins to be up again and then try to repeat the deployment procedure.

There can also be a problem with the validation of the SSL certificate. See [[SSL certificate for moodle.org]] for more info.

== Errors and exceptions ==

[[File:mdeploy-exception.png|thumb|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the cause of the failure.

When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the 'Install this update' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work, as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''

The following section describes some errors that you may encounter and how to deal with them.

=== Unable to download the package (download_file_exception) ===

Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.

; cURL error 7 couldn't connect to host : Make sure that the site http://download.moodle.org is up and running at the moment. If it is down, your site can't call the web service to fetch the available updates info. Wait for http://download.moodle.org to be up again then re-check.

; cURL error 60 (SSL certificate problem) : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. See [[SSL certificate for moodle.org]] for more info.

[[de:Automatische Aktualisierungen]]
[[es:Implementar actualizaciones automáticas]]

Automatic updates deployment

2015-10-27T19:49:47Z

Mudrd8mz: /* Enabling updates deployment */ No need to explicitly enable this feature since 3.0

{{Installing Moodle}}
==Enabling updates deployment==

This functionality requires [[Available update notifications]] to be enabled. The feature is enabled by default as long as the web server has write access to the folders with plugins being updated.

If required, updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

== How it works ==

# Information about available updates, including URLs of ZIP packages of new versions of installed plugins, are available as a web service at download.moodle.org.
# When a 'Install this update' button is pressed and the the deployment is confirmed on the following page, a standalone utility called ''mdeploy.php'' is executed.
# The mdeploy utility authorizes the request to make sure you are coming ''exactly'' from the confirmation page displayed in the previous step.
# The ZIP package of the new version is fetched from the [https://moodle.org/plugins Moodle plugins directory].
# A simple integrity check is performed to make sure the ZIP was downloaded correctly.
# The current version of the plugin code is archived into a folder ''moodledata/mdeploy/archive/'' as a backup (just in case you had some local tweaks in the code, for example).
# The current folder containing the plugin is removed and replaced with the contents of the downloaded ZIP.
# Your browser is redirected to the page where the normal upgrade procedure happens.

At this moment, you can deploy another available update (if there is one) or perform the upgrade procedure the same as if you had uploaded the ZIP contents to your site manually.

== Disabling updates deployment ==

In a few circumstances (such as completely managed servers, which may have a lot of local modifications, or sites that have their own solution for updates deployment - for example via [[Git for Administrators|Git checkouts]]) it is desirable to not to allow automatic updates deployment. The feature may be disabled completely by adding the following code to the [[Configuration file|config.php file]]:

$CFG->disableupdateautodeploy = true;

==Possible problems==

=== Missing install button ===

If the updates deployment feature is not enabled (or if it is disabled in the config.php file), no button to install the update is displayed. When the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, information with a help pop-up is displayed.

=== Plugin files not writable ===

During the deployment, Moodle will replace the whole folder with the plugin code with a new version of the code. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path in the [[:dev:Plugins|Plugins developer docs]].

Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:

# cd /var/www/vhosts/moodle/htdocs
# cd mod
# chown -R www-data stampcoll
# chmod -R u+w stampcoll

See also more about [[Installing plugins]].

=== Can not download the package ===

Make sure that http://moodle.org/plugins is up. If the site is down, your Moodle site will not be able to fetch the ZIP packages from it. Wait for http://moodle.org/plugins to be up again and then try to repeat the deployment procedure.

There can also be a problem with the validation of the SSL certificate. See [[SSL certificate for moodle.org]] for more info.

== Errors and exceptions ==

[[File:mdeploy-exception.png|thumb|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the cause of the failure.

When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the 'Install this update' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work, as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''

The following section describes some errors that you may encounter and how to deal with them.

=== Unable to download the package (download_file_exception) ===

Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.

; cURL error 7 couldn't connect to host : Make sure that the site http://download.moodle.org is up and running at the moment. If it is down, your site can't call the web service to fetch the available updates info. Wait for http://download.moodle.org to be up again then re-check.

; cURL error 60 (SSL certificate problem) : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. See [[SSL certificate for moodle.org]] for more info.

[[de:Automatische Aktualisierungen]]
[[es:Implementar actualizaciones automáticas]]

Installing plugins

2015-10-27T19:43:58Z

Mudrd8mz: /* Preventing installing plugins from within Moodle */ Since 3.0, the disableonclickaddoninstall is not used any more

{{Installing Moodle}}
Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the plugin does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If a plugin modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing a plugin==

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the plugin code can be deployed into Moodle.

Plugin code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new plugin is to be installed in order to use either of these methods.

Alternatively, a plugin may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install plugin'.

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# '''New in 2.9:''' Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if your plugin is not automatically detected.
#If your target directory is not writeable, you will see a warning message.
# On the next screen you will then see an acknowledgement message that you are take responsibility for installing the plugin.

{|
| [[File:plugin1.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

===Installing manually at the server===

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow the plugin instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the plugin in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name then it won't work.

===Obtaining help===

Ask in the appropriate forum in [http://moodle.org/course/view.php?id=5 Using Moodle]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

==Uninstalling a plugin==

To uninstall a plugin
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the plugin you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|center|400px|Plugins overview highlighting available check button]]

The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number,release ''(new in 2.7)'', availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

An administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing plugins from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==See also==

* [[Notifications]] for further details of update notifications
* [[Plugin Review Criteria]]
* [[Plugins FAQ]]
* Moodle in English [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick
*[http://youtu.be/RxlmVzIllVk Moodle 2 Plugins Administration] MoodleBites video on YouTube
* [http://youtu.be/K3MYE8am7M4 Install a New Theme] MoodleBites video on YouTube

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalar complementos]]

Upgrade key

2015-10-26T09:58:53Z

Mudrd8mz:

{{New features}}
'''Upgrade key''' protects your Moodle site during the upgrade.

[[File:upgradekeyrequired.png|frame|Upgrade key required - the user must provide the key defined in the config.php to trigger the upgrade]]
When the Moodle site is being upgraded as a result of the Moodle core update and/or a plugin installation/update, no authentication and authorization mechanisms are reliable. Any anonymous visitor of your site can potentially trigger the upgrade process by navigating their browser to your admin page. This can be seen as a security risk because a lot of sensitive information (server environment, plugin versions etc) are available at the upgrade screens.

To improve the protection of your site during the upgrade, it is recommended to configure the upgrade key in your main config.php file:

<code php>$CFG->upgradekey = 'put_some_shared_secret_here';</code>

If the upgrade key is defined in the config.php file, its value must be provided to access the admin pages during the site upgrade.

Do not use your admin user password as the upgrade key.

Upgrade key

2015-10-26T09:52:19Z

Mudrd8mz: Created page with "{{New features}} '''Upgrade key''' protects your Moodle site during the upgrade. When the Moodle site is being upgraded as a result of the Moodle core update and/or a plugin..."

{{New features}}
'''Upgrade key''' protects your Moodle site during the upgrade.

When the Moodle site is being upgraded as a result of the Moodle core update and/or a plugin installation/update, no authentication and authorization mechanisms are reliable. Any anonymous visitor of your site can potentially trigger the upgrade process by navigating their browser to your admin page. This can be seen as a security risk because a lot of sensitive information (server environment, plugin versions etc) are available at the upgrade screens.

To improve the protection of your site during the upgrade, it is recommended to configure the upgrade key in your main config.php file:

<code php>$CFG->upgradekey = 'put_some_shared_secret_here';</code>

If the upgrade key is defined in the config.php file, its value must be provided to access the admin pages during the site upgrade.

[[File:upgradekeyrequired.png|frame|left|Upgrade key required - the user must provide the key defined in the config.php to trigger the upgrade]]

File:upgradekeyrequired.png

2015-10-26T09:51:21Z

Mudrd8mz:

MoodleDocs:Templates

2015-10-26T09:34:57Z

Mudrd8mz: Add info about New features template

{{Help}}This page lists the most commonly used templates used in Moodle Docs. In addition to displaying a message, many templates also automatically add pages to a category.

==New features==

Type <code><nowiki>{{New features}}</nowiki></code> to obtain the following message (with X.Y replaced with the current docs version):
<span class="small-info-right">New feature<br />in '''Moodle X.Y'''!</span>

This automatically adds pages to [[:Category:New features]]

==Improve==

Type <code><nowiki>{{Improve}}</nowiki></code> to obtain the following message:
<p class="note">''This page really needs improving.'' Please see the page comments for suggestions of what to write.</p>

This automatically adds pages to [[:Category:Pages needing improvement]].

==Stub==

Type <code><nowiki>{{stub}}</nowiki></code> to obtain the following message:
<p class="note">''This article is a [[MoodleDocs:Stub|stub]]. Please help improve Moodle Docs by [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} editing it] and adding some content.''</p>

This automatically adds pages to [[:Category:Stubs]].

==Update==

Type <code><nowiki>{{Update}}</nowiki></code> to obtain the following message:
<p class="note">''This page requires updating.'' Please do so and remove this template when finished.</p>

This automatically adds pages to [[:Category:Pages requiring updating]].

==Review==

Type <code><nowiki>{{Review}}</nowiki></code> to obtain the following message:
<p class="note">''This page requires a review.'' Please do so and remove this template when finished.</p>

This automatically adds pages to [[:Category:Pages requiring a review]].

==Work in progress==

Type <code><nowiki>{{Work in progress}}</nowiki></code> to obtain the following message:
<p class="note">'''Note:''' This article is a work in progress. Please use the page comments or an appropriate [{{{forumurl|http://moodle.org/course/view.php?id=5}}} moodle.org forum] for any recommendations/suggestions for improvement.</p>

==Infobox Project==
{| style="margin: 0 0 1em 1em; border-collapse: collapse; float: right; width: 350px; font-size: 90%;" border="1"
|-
! style="text-align: center; padding: 0.2em; background-color: #ccc; font-size: 120%;" colspan="2" | '''{{{name}}}'''
|-
| style="padding: 0.2em;" | Project state
| style="padding: 0.2em;" | {{{state}}}
|-
| style="padding: 0.2em;" | Tracker issue
| style="padding: 0.2em;" | {{{tracker}}}
|-
| style="padding: 0.2em;" | Discussion
| style="padding: 0.2em;" | {{{discussion}}}
|-
| style="padding: 0.2em;" | Assignee
| style="padding: 0.2em;" | {{{assignee}}}
|-
|}
Type <code><nowiki>{{Infobox Project}}</nowiki></code> to obtain an information box.
<br />
<br />
<br />
<br />

==Page for deletion==

Type <code><nowiki>{{Deletion}}</nowiki></code> at the top of the page to obtain the following message:
<p class="note">'''This page requires deletion.''' Please use the page comments if necessary to state the reason for deletion.</p>

==Page fully-protected==

Type <code><nowiki>{{Pp-protection|reason}}</nowiki></code> at the top of fully-protected page to indicate that the page can only be edited by administrators and the reason for why this is the case. See {{Tl|Pp-protection}} for more information about this template.

==Unsigned==
Type <code><nowiki>{{Unsigned|Terri Teacher}}</nowiki></code> after an unsigned talk page comment to obtain the following message:

<small>(''The preceding comment was added by'' [[User:Terri Teacher]])</small>

==See also==

* [https://docs.moodle.org/20/en/index.php?title=Special%3AAllPages&from=&to=&namespace=10 All pages (Template namespace)] - full list of templates used in Moodle Docs

[[Category:Templates]]

[[es:MoodleDocs:Plantillas]]

Upgrading

2015-10-26T09:13:07Z

Mudrd8mz: /* Before upgrading */ Add info about upgrade key.

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

==Check the requirements==

Check that your server meets all requirements for 3.0 in ''Administration > Site administration > Server > [[Environment]]''. Please note that if you use MySQL you must upgrade the engine to InnoDB since it has become a requirement in Moodle 3.0. See [[Migration from MyISAM to InnoDB]].

Note: You can only upgrade to Moodle 3.0 from Moodle 2.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 upgrade to 2.2] as a first step.

==Before upgrading==

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

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

== Backup important data ==

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

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

== Check for plugin updates ==

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

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

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

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

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

== Install the new Moodle software ==
You can fetch the current (3.0) version of the software through

wget http://sourceforge.net/projects/moodle/files/Moodle/stable30/moodle-latest-30.tgz

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle.
# Dont forget to also copy over your moodledata folder / directory. If you don't you will get a "fatal error $cfg- dataroot is not configured properly".

====Linux====
mv moodle moodle.backup
tar xvzf moodle-3.0.tgz

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

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

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

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

if necessary.

=== Using Git ===

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

===Command line upgrade===

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

== Finishing the upgrade ==

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

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

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

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

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

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

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

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

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 3.0 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 3.0 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and ad hoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade to 3.0, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade to 3.0.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 3.0 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 3.0, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

==Possible issues that may affect you in Moodle 3.0==

''Please add issues here...''

See the [[dev:Moodle 3.0 release notes|Moodle 3.0 release notes]] for the full list of changes in Moodle 3.0.

=== Moodle 2.3, 2.4, 2.5, 2.6, 2.7, 2.8 and 2.9 improvements ===

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

* [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3]
* [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4]
* [https://docs.moodle.org/25/en/Upgrading Upgrading to Moodle 2.5]
* [https://docs.moodle.org/26/en/Upgrading Upgrading to Moodle 2.6]
* [https://docs.moodle.org/27/en/Upgrading Upgrading to Moodle 2.7]
* [https://docs.moodle.org/28/en/Upgrading Upgrading to Moodle 2.8]
* [https://docs.moodle.org/29/en/Upgrading Upgrading to Moodle 2.9]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
* [[dev:Moodle 3.0 release notes|Moodle 3.0 release notes]]

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

Poster module

2015-05-21T10:31:54Z

Mudrd8mz: Creating the page

{{stub}}

See [https://moodle.org/plugins/view/mod_poster the module record] in the Plugins directory.

Stamp collection module

2015-01-09T11:44:46Z

Mudrd8mz:

{{Activities}}
{{Infobox plugin
|type = Activity module
|entry = http://moodle.org/plugins/view.php?plugin=mod_stampcoll
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10271
|discussion = http://moodle.org/plugins/view.php?plugin=mod_stampcoll
|maintainer = [[User:David Mudrak|David Mudrak]]
}}

By default, the module allows a teacher to give "stamps" (i.e. picture with a comment) to students so they collect these stamps. The activity can be used in many ways, such as motivative bonus marks, absence marks,
certification records etc.

The module uses capabilities to declare who can e.g. collect stamps or give stamps. Therefore, student can be allowed to give stamps to other students, the stamps may be given to teachers etc. Teachers can setup the module to show all stamps to all students, to show stamps only to the individual student to whom it was awarded or to hide stamps completely.

The module was created and is currently maintained by [[User:David Mudrak|David Mudrak]].

<mediaplayer>http://www.youtube.com/watch?v=eDi_PcMkzZM</mediaplayer>

==Installation==

* Moodle 2.x - see the instructions at the [http://moodle.org/plugins/view.php?plugin=mod_stampcoll plugin entry] in the Plugins directory.
* Moodle 1.9 - download [http://download.moodle.org/plugins19/mod/stampcoll.zip 1.9 build]
* Moodle 1.8 - download [http://download.moodle.org/plugins18/mod/stampcoll.zip 1.8 build]
* Moodle 1.7 - is not supported nor tested. Maybe it works, maybe not. It was reported that the version for 1.6 worked in Moodle 1.7
* Moodle 1.6 - download [http://download.moodle.org/plugins16/mod/stampcoll.zip 1.6 build]
* Earlier version are not supported

Since Moodle 2.0, the source code is managed using Git. The official public repository of the plugin is at http://github.com/mudrd8mz/moodle-mod_stampcoll.

==How to report a bug==

Please, use [[Tracker]]. Stamp collection if one of the components in "Non-core contributed modules" project. See the list of tracked issues at http://tracker.moodle.org/browse/CONTRIB/component/10271

==Capabilities==

Roles and capabilities are supported since the version for Moodle 1.9. During the upgrade, the module settings "Publish" and "Teacher can collect stamps" are converted automatically into the role overrides.

{| cellpadding="3" cellspacing="0" border="1"
!Capability
!Description
!Status
|-
|mod/stampcoll:collectstamps
|a user can be given a stamp
|implemented in 1.9
|-
|mod/stampcoll:givestamps
|a user can give a stamp from her own pool (and the collection pool) to the other user
|partially implemented in 1.9 (the pools not supported yet)
|-
|mod/stampcoll:viewotherstamps
|a user can view stamps given to other users
|implemented in 1.9
|-
|mod/stampcoll:viewownstamps
|a user can view stamps given to her
|implemented in 1.9
|-
|mod/stampcoll:managestamps
|a user can do anything with stamps, i.e. give, remove and update them
|implemented in 1.9
|}

==Feature ideas and requests==

''Note: This section will be moved to the tracker feature reguests.''

===Stamps pools (banks?)===
There might be settings of a maximum number of stamps given in one collection (so called collection pool), given by a user (personal pool) and given to a user. All these limits can be combined (logical AND). Then there might be statistics like percentual/total number given from the collection/personal pool, the number of available (unassigned, free) stamps in pools etc.

Another scenario: you have student teams. You allow team leaders to give stamp (via [[capability]]) and set a limited number of stamp they can give. Team leader can dispatch stamps from his/her pool to team members according to their contribution.

===Grade based on the number of stamps collected===
When the feature of maximum number of stamps that can be collected within particular collection is implemented, it is possible to compute the grade based on the number of stamps collected.

===Ranking===
Similar to overall feedback in the [[Quiz module]], provide a possibility to map a number of collected stamp to a rank (letter or word "grade"). E.g. no stamps collected => Novice, 1 stamp collected => Beginner, 2 stamps collected => Advanced user, 3 stamps collected => Expert.

===Forum patch===
The [[patch]] adding a possibility to tie a stamp collection with a [[Forum module]]. Display similar selection box as for forum grading and allow adding stamp for a forum post.

===Ajax support===
Give stamps by drag and drop from the pool (bank) to a user.

===Site level settings===
The list of URLs to default stamp images (e.g. to some files at frontpage files section etc.)

===Exports===
* text, CVS and Excel support

===Group mode stamp awarding===
A handy way to organize group competitions. Teachers should be able to award stamps for contributions (typically, forum posts and chat participation but other ideas are welcome too). Such stamps would be attributed not to the person who contributed but to his/her team and be accumulated by teams for later evaluation.

David's note: Or, keep collecting stamps by individuals but display them in per-group (or grouping?) report. Simply sum all stamps collected by student in a given group and display them.

==Example stamp images==

[[File:stamp-peer-reviewed.svg]]

==See also==

* [http://moodle.org/mod/data/view.php?rid=1338 The module record in Modules and plugins database]
* [http://moodle.org/mod/forum/view.php?id=7175 The module forum in Using Moodle at moodle.org]
* [http://howto.nicubunu.ro/rubber_stamp_inkscape/ Designing own rubber stamp image with Inkscape] at Nicu's How-to

[[es:Módulo para colección de sellos]]

Stamp collection module

2014-11-19T15:45:19Z

Mudrd8mz: /* See also */

{{Activities}}
{{Infobox plugin
|type = Activity module
|entry = http://moodle.org/plugins/view.php?plugin=mod_stampcoll
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10271
|discussion = http://moodle.org/mod/forum/view.php?id=7175
|maintainer = [[User:David Mudrak|David Mudrak]]
}}

By default, the module allows a teacher to give "stamps" (i.e. picture with a comment) to students so they collect these stamps. The activity can be used in many ways, such as motivative bonus marks, absence marks,
certification records etc.

The module uses capabilities to declare who can e.g. collect stamps or give stamps. Therefore, student can be allowed to give stamps to other students, the stamps may be given to teachers etc. Teachers can setup the module to show all stamps to all students, to show stamps only to the individual student to whom it was awarded or to hide stamps completely.

The module was created and is currently maintained by [[User:David Mudrak|David Mudrak]].

<mediaplayer>http://www.youtube.com/watch?v=eDi_PcMkzZM</mediaplayer>

==Installation==

* Moodle 2.x - see the instructions at the [http://moodle.org/plugins/view.php?plugin=mod_stampcoll plugin entry] in the Plugins directory.
* Moodle 1.9 - download [http://download.moodle.org/plugins19/mod/stampcoll.zip 1.9 build]
* Moodle 1.8 - download [http://download.moodle.org/plugins18/mod/stampcoll.zip 1.8 build]
* Moodle 1.7 - is not supported nor tested. Maybe it works, maybe not. It was reported that the version for 1.6 worked in Moodle 1.7
* Moodle 1.6 - download [http://download.moodle.org/plugins16/mod/stampcoll.zip 1.6 build]
* Earlier version are not supported

Since Moodle 2.0, the source code is managed using Git. The official public repository of the plugin is at http://github.com/mudrd8mz/moodle-mod_stampcoll.

==How to report a bug==

Please, use [[Tracker]]. Stamp collection if one of the components in "Non-core contributed modules" project. See the list of tracked issues at http://tracker.moodle.org/browse/CONTRIB/component/10271

==Capabilities==

Roles and capabilities are supported since the version for Moodle 1.9. During the upgrade, the module settings "Publish" and "Teacher can collect stamps" are converted automatically into the role overrides.

{| cellpadding="3" cellspacing="0" border="1"
!Capability
!Description
!Status
|-
|mod/stampcoll:collectstamps
|a user can be given a stamp
|implemented in 1.9
|-
|mod/stampcoll:givestamps
|a user can give a stamp from her own pool (and the collection pool) to the other user
|partially implemented in 1.9 (the pools not supported yet)
|-
|mod/stampcoll:viewotherstamps
|a user can view stamps given to other users
|implemented in 1.9
|-
|mod/stampcoll:viewownstamps
|a user can view stamps given to her
|implemented in 1.9
|-
|mod/stampcoll:managestamps
|a user can do anything with stamps, i.e. give, remove and update them
|implemented in 1.9
|}

==Feature ideas and requests==

''Note: This section will be moved to the tracker feature reguests.''

===Stamps pools (banks?)===
There might be settings of a maximum number of stamps given in one collection (so called collection pool), given by a user (personal pool) and given to a user. All these limits can be combined (logical AND). Then there might be statistics like percentual/total number given from the collection/personal pool, the number of available (unassigned, free) stamps in pools etc.

Another scenario: you have student teams. You allow team leaders to give stamp (via [[capability]]) and set a limited number of stamp they can give. Team leader can dispatch stamps from his/her pool to team members according to their contribution.

===Grade based on the number of stamps collected===
When the feature of maximum number of stamps that can be collected within particular collection is implemented, it is possible to compute the grade based on the number of stamps collected.

===Ranking===
Similar to overall feedback in the [[Quiz module]], provide a possibility to map a number of collected stamp to a rank (letter or word "grade"). E.g. no stamps collected => Novice, 1 stamp collected => Beginner, 2 stamps collected => Advanced user, 3 stamps collected => Expert.

===Forum patch===
The [[patch]] adding a possibility to tie a stamp collection with a [[Forum module]]. Display similar selection box as for forum grading and allow adding stamp for a forum post.

===Ajax support===
Give stamps by drag and drop from the pool (bank) to a user.

===Site level settings===
The list of URLs to default stamp images (e.g. to some files at frontpage files section etc.)

===Exports===
* text, CVS and Excel support

===Group mode stamp awarding===
A handy way to organize group competitions. Teachers should be able to award stamps for contributions (typically, forum posts and chat participation but other ideas are welcome too). Such stamps would be attributed not to the person who contributed but to his/her team and be accumulated by teams for later evaluation.

David's note: Or, keep collecting stamps by individuals but display them in per-group (or grouping?) report. Simply sum all stamps collected by student in a given group and display them.

==Example stamp images==

[[File:stamp-peer-reviewed.svg]]

==See also==

* [http://moodle.org/mod/data/view.php?rid=1338 The module record in Modules and plugins database]
* [http://moodle.org/mod/forum/view.php?id=7175 The module forum in Using Moodle at moodle.org]
* [http://howto.nicubunu.ro/rubber_stamp_inkscape/ Designing own rubber stamp image with Inkscape] at Nicu's How-to

File:stamp-peer-reviewed.svg

2014-11-19T15:44:47Z

Mudrd8mz: Mudrd8mz uploaded a new version of "File:stamp-peer-reviewed.svg"

File:stamp-peer-reviewed.svg

2014-11-19T15:39:25Z

Mudrd8mz:

Stamp collection module

2014-11-19T15:00:36Z

Mudrd8mz: /* See also */

{{Activities}}
{{Infobox plugin
|type = Activity module
|entry = http://moodle.org/plugins/view.php?plugin=mod_stampcoll
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10271
|discussion = http://moodle.org/mod/forum/view.php?id=7175
|maintainer = [[User:David Mudrak|David Mudrak]]
}}

By default, the module allows a teacher to give "stamps" (i.e. picture with a comment) to students so they collect these stamps. The activity can be used in many ways, such as motivative bonus marks, absence marks,
certification records etc.

The module uses capabilities to declare who can e.g. collect stamps or give stamps. Therefore, student can be allowed to give stamps to other students, the stamps may be given to teachers etc. Teachers can setup the module to show all stamps to all students, to show stamps only to the individual student to whom it was awarded or to hide stamps completely.

The module was created and is currently maintained by [[User:David Mudrak|David Mudrak]].

<mediaplayer>http://www.youtube.com/watch?v=eDi_PcMkzZM</mediaplayer>

==Installation==

* Moodle 2.x - see the instructions at the [http://moodle.org/plugins/view.php?plugin=mod_stampcoll plugin entry] in the Plugins directory.
* Moodle 1.9 - download [http://download.moodle.org/plugins19/mod/stampcoll.zip 1.9 build]
* Moodle 1.8 - download [http://download.moodle.org/plugins18/mod/stampcoll.zip 1.8 build]
* Moodle 1.7 - is not supported nor tested. Maybe it works, maybe not. It was reported that the version for 1.6 worked in Moodle 1.7
* Moodle 1.6 - download [http://download.moodle.org/plugins16/mod/stampcoll.zip 1.6 build]
* Earlier version are not supported

Since Moodle 2.0, the source code is managed using Git. The official public repository of the plugin is at http://github.com/mudrd8mz/moodle-mod_stampcoll.

==How to report a bug==

Please, use [[Tracker]]. Stamp collection if one of the components in "Non-core contributed modules" project. See the list of tracked issues at http://tracker.moodle.org/browse/CONTRIB/component/10271

==Capabilities==

Roles and capabilities are supported since the version for Moodle 1.9. During the upgrade, the module settings "Publish" and "Teacher can collect stamps" are converted automatically into the role overrides.

{| cellpadding="3" cellspacing="0" border="1"
!Capability
!Description
!Status
|-
|mod/stampcoll:collectstamps
|a user can be given a stamp
|implemented in 1.9
|-
|mod/stampcoll:givestamps
|a user can give a stamp from her own pool (and the collection pool) to the other user
|partially implemented in 1.9 (the pools not supported yet)
|-
|mod/stampcoll:viewotherstamps
|a user can view stamps given to other users
|implemented in 1.9
|-
|mod/stampcoll:viewownstamps
|a user can view stamps given to her
|implemented in 1.9
|-
|mod/stampcoll:managestamps
|a user can do anything with stamps, i.e. give, remove and update them
|implemented in 1.9
|}

==Feature ideas and requests==

''Note: This section will be moved to the tracker feature reguests.''

===Stamps pools (banks?)===
There might be settings of a maximum number of stamps given in one collection (so called collection pool), given by a user (personal pool) and given to a user. All these limits can be combined (logical AND). Then there might be statistics like percentual/total number given from the collection/personal pool, the number of available (unassigned, free) stamps in pools etc.

Another scenario: you have student teams. You allow team leaders to give stamp (via [[capability]]) and set a limited number of stamp they can give. Team leader can dispatch stamps from his/her pool to team members according to their contribution.

===Grade based on the number of stamps collected===
When the feature of maximum number of stamps that can be collected within particular collection is implemented, it is possible to compute the grade based on the number of stamps collected.

===Ranking===
Similar to overall feedback in the [[Quiz module]], provide a possibility to map a number of collected stamp to a rank (letter or word "grade"). E.g. no stamps collected => Novice, 1 stamp collected => Beginner, 2 stamps collected => Advanced user, 3 stamps collected => Expert.

===Forum patch===
The [[patch]] adding a possibility to tie a stamp collection with a [[Forum module]]. Display similar selection box as for forum grading and allow adding stamp for a forum post.

===Ajax support===
Give stamps by drag and drop from the pool (bank) to a user.

===Site level settings===
The list of URLs to default stamp images (e.g. to some files at frontpage files section etc.)

===Exports===
* text, CVS and Excel support

===Group mode stamp awarding===
A handy way to organize group competitions. Teachers should be able to award stamps for contributions (typically, forum posts and chat participation but other ideas are welcome too). Such stamps would be attributed not to the person who contributed but to his/her team and be accumulated by teams for later evaluation.

David's note: Or, keep collecting stamps by individuals but display them in per-group (or grouping?) report. Simply sum all stamps collected by student in a given group and display them.

==See also==

* [http://moodle.org/mod/data/view.php?rid=1338 The module record in Modules and plugins database]
* [http://moodle.org/mod/forum/view.php?id=7175 The module forum in Using Moodle at moodle.org]
* [http://howto.nicubunu.ro/rubber_stamp_inkscape/ Designing own rubber stamp image with Inkscape] at Nicu's How-to

Installations 30000 plus

2014-07-27T12:56:23Z

Mudrd8mz: Added dl.cuni.cz

{{Template:Large Installations}}

==Austria==

* Federal Ministry of Education - [http://www.eduhi.at/ education highway]: [http://www.edumoodle.at Free Moodle for Austrian schools.]
(Nov/2009)
- 26.000 courses
- 230.000 users
- 1.711 schools
- 2 hosting centers, about 15 servers, shared moodle sources

==Brazil==

* [https://moodle.eadesaf.serpro.gov.br Escola de Administração Fazendária - ESAF]
Hospeda mais de 1.770 cursos, com 69.883 Estudantes e 1.869 Tutores (em 01/08/2010), atendendo a vários segmentos do serviço público do Brasil.

* [http://aprender.unb.br Universidade de Brasília] - 66,587 users (04/30/2009)
* [http://ead.mackenzie.br/mackenzievirtual/ Universidade Presbiteriana Mackenzie] - 43,237 users (25/06/2009)

==Czech Republic==

* [http://dl.cuni.cz/ Charles University in Prague] - ~50,000 Users (July 2014)

==Germany==
* [https://moodle.fernuni-hagen.de/ FernUniversität Hagen] - ~75,000 Users (June 2013)

==Italy==

* [http://elearning.uniroma1.it/ InfoSapienza - University of Rome La Sapienza] InfoSapienza's Moodle hosts more than 700 courses for about 48.000 students from about 25 faculties, ranging from enginering scientific courses to literature and medicine. (April, 9th 2009)
* [http://www.aulaweb.unige.it/ AulaWeb - University of Genoa] AulaWeb is an university-wide installation of Moodle, organized in virtual instances, one for each laurea degree. In July 2013, it has over 34000 users, 1670 courses and 20 sites (in virtual hosting).

==Norway==

* [http://www.laerdal.com Laerdal Medical] Laerdal Medical has set up two Moodle installations for The Norwegian Resuscitation Council and The Swedish Resuscitation Council respectively. Together we now host 102 000 users in 5 different courses in the area of Resuscitation and Acute Care. It is estimated that by the end of 2013 the sites will have close to 200 000 users. (October, 17th 2012)

==Saudi Arabia==
* [http://computerworld.co.nz/news.nsf/news/catalyst-delivers-major-saudi-arabian-training-project NCEL] - the Saudi Arabian National Centre for E-learning and Distance Learning, an agency established by the Saudi Arabian government runs a Moodle site with 2 million users supported by the Moodle Partner [http://catalyst.net.nz/node/23540 Catalyst IT]

==South Africa==

* [http://www.liberty.co.za Liberty Life] in Johannesburg runs an instance of Moodle as its institutional LMS, the Wealth Learning University, with 41,000+ registered users as of January 2012.

==Spain==

* [http://www.ehu.es Universidad del Pais Vasco - Euskal Herriko Unibertsitatea (UPV/EHU)]: . 34.000 users and 1.650 teachers (different) in aprox. 3.650 courses. Our University have 50.000 students, 3.500 teachers. We started with Moodle 1.6 (four years ago) as a test pilot project for a small number of courses. Currently we are using version 1.9 (since 2009, February) with LDAP authentication.

==Taiwan==

* [http://moodle.mcu.edu.tw Ming Chuan University]
- More then 63,000 users
- 33,000 users login in one day(Max)

==United Kingdom==

* The UK's [http://www.open.ac.uk/ Open University], a world leading institution and innovator in distance learning based in Milton Keynes, Buckinghamshire is one of the world's largest Moodle users with over 100,000 students on their main installation, and two other public Moodles: http://www.open.edu/openlearnworks/ and https://learn5.open.ac.uk/

==United States==

* [http://www.sfsu.edu San Francisco State University (SFSU)] - 89,543 users (02/07/2008). Among these 89K users, about 35,430 users are considered as currently active.

* [http://www.oit.umn.edu/moodle University of Minnesota (UofM)]
** For AY12-13 (Moodle 2.2) Approximately 145,000 user accounts in 16,784 course sites
** For AY13-14 (Moodle 2.4) Approximately 83,500 user accounts in 13,302 course sites

* [http://moodle.pcsb.org Pinellas County Schools] - 71,864 registered users who have logged in and created profiles. Over 9,000 course sites that are used for everything from K12 virtual instruction to teacher professional development.

Sandbox

2013-10-21T10:04:48Z

Mudrd8mz: Test http://www.mediawiki.org/wiki/Manual:$wgEnotifWatchlist

[http://www.youtube.com/watch?v=3xUqnoIzSbo Youtube embedded video test]

testing email notification of watched pages...
What is the name of the plant family characterized by the following three botanical parts: banner, wing, and keel? For extra credit, what is the common name of the plant pictured?

The notification of this should not be emailed out.

Using Workshop

2013-09-27T20:17:00Z

Mudrd8mz: /* Grade for assessment */

{{Workshop}}
==Workshop phases==
The work flow for the Workshop module can be viewed as having five phases. The typical workshop activity can cover days or even weeks. The teacher switches the activity from one phase to another.

The typical workshop follows a straight path from Setup to, Submission, Assessment, Grading/Evaluation, and ending with the Closed phased. However, an advanced recursive path is also possible.

The progress of the activity is visualized in so called Workshop planner tool. It displays all Workshop phases and highlights the current one. It also lists all the tasks the user has in the current phase with the information of whether the task is finished or not yet finished or even failed.

===Setup phase===

In this initial phase, Workshop participants cannot do anything (neither modify their submissions nor their assessments). Course facilitators use this phase to change workshop settings, modify the grading strategy of tweak assessment forms. You can switch to this phase any time you need to change the Workshop setting and prevent users from modifying their work.

===Submission phase===

In the submission phase, Workshop participants submit their work. Access control dates can be set so that even if the Workshop is in this phase, submitting is restricted to the given time frame only. Submission start date (and time), submission end date (and time) or both can be specified.

===Assessment phase===

If the Workshop uses peer assessment feature, this is the phase when Workshop participants assess the submissions allocated to them for the review. As in the submission phase, access can be controlled by specified date and time since when and/or until when the assessment is allowed.

===Grading evaluation phase===

The major task during this phase is to calculate the final grades for submissions and for assessments and provide feedback for authors and reviewers. Workshop participants cannot modify their submissions or their assessments in this phase any more. Course facilitators can manually override the calculated grades. Also, selected submissions can be set as published so they become available to all Workshop participants in the next phase.

===Closed===

[[File:workshop final grades.png|thumb|A closed workshop]]Whenever the Workshop is being switched into this phase, the final grades calculated in the previous phase are pushed into the course [[Gradebook]].This will result in the Workshop grades appearing in the Gradebook and in the workshop (new in Moodle 2.4 onwards). Participants may view their submissions, their submission assessments and eventually other published submissions in this phase.

==Workshop grading==

The grades for a Workshop activity are obtained gradually at several stages and then they are finalized. The following scheme illustrates the process and also provides the information in what database tables the grade values are stored.

[[Image:workshop_grades_calculation.png|400px|thumb|left|The scheme of grades calculation in Workshop]]
<br clear="all"/>

As you can see, every participant gets two numerical grades into the course Gradebook. During the Grading evaluation phase, course facilitator can let Workshop module to calculate these final grades. Note that they are stored in Workshop module only until the activity is switched to the final (Closed) phase. Therefore it is pretty safe to play with grades unless you are happy with them and then close the Workshop and push the grades into the Gradebook. You can even switch the phase back, recalculate or override the grades and close the Workshop again so the grades are updated in the Gradebook again (should be noted that you can override the grades in the Gradebook, too).

During the grading evaluation, Workshop grades report provides you with a comprehensive overview of all individual grades. The report uses various symbols and syntax:

{| class="nicetable"
|-
! Value
! Meaning
|-
| - (-) < Alice
| There is an assessment allocated to be done by Alice, but it has been neither assessed nor evaluated yet
|-
| 68 (-) < Alice
| Alice assessed the submission, giving the grade for submission 68. The grade for assessment (grading grade) has not been evaluated yet.
|-
| 23 (-) > Bob
| Bob's submission was assessed by a peer, receiving the grade for submission 23. The grade for this assessment has not been evaluated yet.
|-
| 76 (12) < Cindy
| Cindy assessed the submission, giving the grade 76. The grade for this assessment has been evaluated 12.
|-
| 67 (8) @ 4 < David
| David assessed the submission, giving the grade for submission 67, receiving the grade for this assessment 8. His assessment has weight 4
|-
| 80 (<del>20</del> / <ins>17</ins>) > Eve
| Eve's submission was assessed by a peer. Eve's submission received 80 and the grade for this assessment was calculated to 20. Teacher has overridden the grading grade to 17, probably with an explanation for the reviewer.
|}

=== Grade for submission ===

The final grade for every submission is calculated as weighted mean of particular assessment grades given by all reviewers of this submission. The value is rounded to a number of decimal places set in the Workshop settings form.

Course facilitator can influence the grade for a given submission in two ways:

* by providing their own assessment, possibly with a higher weight than usual peer reviewers have
* by overriding the grade to a fixed value

=== Grade for assessment ===

Grade for assessment tries to estimate the quality of assessments that the participant gave to the peers. This grade (also known as ''grading grade'') is calculated by the artificial intelligence hidden within the Workshop module as it tries to do typical teacher's job.

During the grading evaluation phase, you use a Workshop subplugin to calculate grades for assessment. At the moment, only one standard subplugin is available called ''Comparison with the best assessment'' (other grading evaluation add-ons can be found in the [https://moodle.org/plugins/browse.php?list=category&id=17 Moodle plugins directory]). The following text describes the method used by this subplugin.

Grades for assessment are displayed in the braces () in the Workshop grades report. The final grade for assessment is calculated as the average of particular grading grades.

There is not a single formula to describe the calculation. However the process is deterministic. Workshop picks one of the assessments as the ''best'' one - that is closest to the mean of all assessments - and gives it 100% grade. Then it measures a 'distance' of all other assessments from this best one and gives them the lower grade, the more different they are from the best (given that the best one represents a consensus of the majority of assessors). The parameter of the calculation is how strict we should be, that is how quickly the grades fall down if they differ from the best one.

If there are just two assessments per submission, Workshop can not decide which of them is 'correct'. Imagine you have two reviewers - Alice and Bob. They both assess Cindy's submission. Alice says it is a rubbish and Bob says it is excellent. There is no way how to decide who is right. So Workshop simply says - ok, you both are right and I will give you both 100% grade for this assessment. To prevent it, you have two options:

* Either you have to provide an additional assessment so the number of assessors (reviewers) is odd and workshop will be able to pick the best one. Typically, the teacher comes and provide their own assessment of the submission to judge it
* Or you may decide that you trust one of the reviewers more. For example you know that Alice is much better in assessing than Bob is. In that case, you can increase the weight of Alice's assessment, let us say to "2" (instead of default "1"). For the purposes of calculation, Alice's assessment will be considered as if there were two reviewers having the exactly same opinion and therefore it is likely to be picked as the best one.

'''Backward compatibility note'''

In Workshop 1.x this case of exactly two assessors with the same weight is not handled properly and leads to wrong results as only the one of them is lucky to get 100% and the second get lower grade.

'''It's not final grades what is compared'''

It is very important to know that the grading evaluation subplugin ''Comparison with the best assessment'' does not compare the final grades. Regardless the grading strategy used, every filled assessment form can be seen as n-dimensional vector of normalized values. So the subplugin compares responses to all assessment form dimensions (criteria, assertions, ...). Then it calculates the distance of two assessments, using the variance statistics.

To demonstrate it on example, let us say you use grading strategy Number of errors to peer-assess research essays. This strategy uses a simple list of assertions and the reviewer (assessor) just checks if the given assertion is passed or failed. Let us say you define the assessment form using three criteria:

# Does the author state the goal of the research clearly? (yes/no)
# Is the research methodology described? (yes/no)
# Are references properly cited? (yes/no)

Let us say the author gets 100% grade if all criteria are passed (that is answered "yes" by the assessor), 75% if only two criteria are passed, 25% if only one criterion is passed and 0% if the reviewer gives 'no' for all three statements.

Now imagine the work by Daniel is assessed by three colleagues - Alice, Bob and Cindy. They all give individual responses to the criteria in order:

* Alice: yes / yes / no
* Bob: yes / yes / no
* Cindy: no / yes / yes

As you can see, they all gave 75% grade to the submission. But Alice and Bob agree in individual responses, too, while the responses in Cindy's assessment are different. The evaluation method ''Comparison with the best assessment'' tries to imagine, how a hypothetical absolutely fair assessment would look like. In the [[Development:Workshop 2.0 specification]], David refers to it as "how would Zeus assess this submission?" and we estimate it would be something like this (we have no other way):

* Zeus 66% yes / 100% yes / 33% yes

Then we try to find those assessments that are closest to this theoretically objective assessment. We realize that Alice and Bob are the best ones and give 100% grade for assessment to them. Then we calculate how much far Cindy's assessment is from the best one. As you can see, Cindy's response matches the best one in only one criterion of the three so Cindy's grade for assessment will not be as high.

The same logic applies to all other grading strategies, adequately. The conclusion is that the grade given by the best assessor does not need to be the one closest to the average as the assessment are compared at the level of individual responses, not the final grades.

==Groups and Workshop==
When a workshop is used in a course using separate or visible groups and groupings, it is possible to filter by group in a drop-down menu at the Assessment phase, manual allocation page, grades report and so on.

[[File:workshopdropdown.png |thumb|none|upright=2.0|alt="Group filtering" | Group filtering drop down]]

==See also==

* [http://www.ascilite.org.au/conferences/wellington12/2012/images/custom/cox,_julian_moodle.pdf Research paper] ''Moodle Workshop activities support peer review in Year 1 Science: present and future'' by Julian M Cox, John Paul Posada and Russell Waldron
* Using Moodle [http://moodle.org/mod/forum/view.php?id=740 Workshop module forum]
* Using Moodle forum discussion [http://moodle.org/mod/forum/discuss.php?d=153268] where David explains a particular Workshop results
* [http://www.slideshare.net/mark.drechsler/moodle-workshop-20-a-simplified-explanation Moodle Workshop 2.0 - a (simplified) explanation] presentation by Mark Drechsler
* [[Development:Workshop]] for more information on the module infrastructure and ways how to extend provided functionality by developing own Workshop subplugins
* [http://moodlefairy.posterous.com/a-brief-journey-into-the-moodle-20-workshop A Brief Journey into the Moodle 2.0 Workshop] at moodlefairy's posterous

[[de:Workshop nutzen]]

Text editor

2013-08-21T15:40:48Z

Mudrd8mz: /* Custom configuration */ How to add bootstrap based styles

{{Editing text}}
The text editor (sometimes referred to as the 'HTML editor' or even 'TinyMCE') has many icons to assist the user in entering content. Many of these icons and functions should be familiar to anyone who uses a word processor. Some examples of where you will see the text editor include: Editing Section headings, description of an activity, writing an answer to a quiz question or editing the content of many blocks.

'''Note:''' It's possible to disable the TinyMCE editor and only use a plain text editor from ''Administration>Site administration>Plugins>Text editors>Manage editors.''

==The collapsed editor==
Since Moodle 2.5, the text editor appears collapsed with no formatting in many places to save space. To access the full editor, click "Show editing tools" as in (1) in the screenshot below. You can use keyboard shortcuts for quick formatting as in (2) in the screenshot below. (See [[Text editor FAQ]] for a list of shortcuts.) To increase the size of the editor, drag the bottom right once you have clicked "Show editing tools" as in (3) in the screenshot below.

{|
|[[File:collapsededitor1.png|thumb|The collapsed editor]]
|[[File:expandeditor.png|thumb|The expanded editor]]
|}

==The full editor==
{|
|[[Image:HTMLeditor tools M2 1.png|thumb|The standard version of the text editor tool bar]]
|}

==List of groups==
For those who are not familiar with the tool bar, here are the functions listed by group using the above example. Remember that the site administrator can edit or provide additional toolbars.

Row 1
*[[Image:HTML_editor_group_font_style.png]] - Font, size and heading group
*[[Image:HTML_editor_group_undo_redo.png]] - Undo and Redo group
*[[Image:HTML_editor_group_find_replace.png]] - Find and Replace group
*[[Image:HTML_editor_group_fullscreen_1.png]]|Full screen toggle
Row 2
*[[Image:HTML editor group text effects.png]] - Text effect group
*[[Image:HTML editor group line format.png]] - Line format group
*[[Image:HTML_editor_group_formatting.png]] - Formatting group
*[[Image:HTML_editor_group_color.png]] - Color group
*[[Image:HTML_editor_group_paragraph.png]] - Paragraph group

Row 3
*[[Image:HTML_editor_group_lists.png]] - Number and Bullets and indents
*[[Image:HTML_editor_group_link.png]] - Link group
*[[Image:HTML_editor_group_insert.png]] - Insert group
*[[Image:HTML_editor_group_HTML_spell.png]] - HTML source toggle and spellchecker (IE 9/8 only)

==Special features==

===Color pickers===
*[[Image:HTML_editor_group_color.png]]
There are four levels of selecting a font or background color,
*A quick pick 5x8 matrix of colors
*"More colors" that links to Picker, Pallet and Named tabs
<gallery>
Image:HTML_editor_color_selector_basic_1.png|A quick pick 5x8 matrix of colors
Image:HTML_editor_color_selector_more_picker_1.png|A rainbow color picker tab
Image:HTML_editor_color_selector_more_pallet_1.png|A Pallet tab with a 18x12 matrix of colors
Image:HTML_editor_color_selector_more_named_1.png|A Named tab with custom pallets
</gallery>

===Insert images and media===
[[Image:HTML_editor_group_insert_MU_1.png|thumb|The Insert images and media group]]

* 1 Insert Image - uses [[File picker]]
* 2 Insert Emoticon
* 3 Insert Media - uses [[File picker]]
* 4 Insert Equation - uses java script editor
* 5 Insert Non breaking space
* 6 Insert Custom character - Special keyboard characters
* 7 Insert Table -

<gallery widths="300px">
Image:Files_File_picker_upload_files_add_1.png|File picker Upload file screen
Image:HTML editor equation editor 1.png|Equation editor
Image:HTML_editor_custom_character_selector_1.png|Custom character selector
</gallery>

====Insert table====
<gallery widths="300px">
Image:HTMLeditor_Insert_Table_general_1.png|General tab
Image:HTMLeditor_Insert_Table_advanced_1.png|Advanced tab
</gallery>

'''To add borders to a table'''

Cell borders are crucial for helping readers to follow the rows across the screen. If they aren’t showing already you can add them as follows:

#In the Wiki page containing your table, click its Edit tab
#Carefully select all the cells of the table
#Then right click (Macs: Command+click or Ctrl+Click) over any part of your selection to get a context menu; from it select Cell > Table Cell Properties; the cell properties dialog box then loads.
#Click on its Advanced tab, set Border Color to black (for instance), then click Apply, and then click Update.
#Click Save; the Wiki page containing your table will then load displaying its borders.

==Site administration settings==

===Manage editors===

A site administrator can enable / disable text editors in ''Settings > Site administration > Plugins > Text editors > Manage editors''. By default the TinyMCE HTML editor and plain text area are enabled.

===TinyMCE editor settings===

The TinyMCE HTML editor has its own settings page ''Administration>Site administration>Plugins>Text editors>TinyMCE HTML editor>General settings'' with the following options:

====Plugins====
*Buttons for equations, emoticons,images, media, automatic linking, and legacy spell-checking may be enabled, disabled or uninstall here by clicking on their eye.
*Additionally the equation, emoticon and spell check buttons have links to their Settings screens.

[[File:legacyspellchecker.png |thumb|none|upright=2.0|alt="The TinyMCE editor plugins screen" | The TinyMCE editor plugins screen]]

=====Insert equation=====

Accessed from ''Administration>Site administration>Plugins>Text editors>TinyMCE HTML editor>Edit equation'', this allows you to enable or disable the TeX filter in the editor context and thereby display the Dragmath button. If you have a global custom TeX filter, then disable this setting.

=====Insert emoticon=====
Accessed from ''Administration>Site administration>Plugins>Text editors>TinyMCE HTML editor>Insert emoticon'', this allows you to enable or disable the emoticon filter in the editor context and thereby display the emoticon button.

===== Legacy spell checker=====
The legacy spell checker is visible in IE9 and lower only, but not in other browsers. If you want to disable it and and rely on browser spell checker functionality instead, you can do this by disabling the ''legacy spellchecker'' plugin by clicking its eye in ''Administration > Site administration > Plugins > Text editors > TinyMCE HTML editor > General settings''

To spell-check via your browser, type your word (which if incorrectly spelt will have red lines under it) and press right click + CTRL
{|
|[[File:Browserspellcheck.png|thumb|Right-click+CTRL for browser spellcheck]]
|}

You can select a different spell engine from ''Administration> Site administration > Plugins > Text editors > TinyMCE HTML editor>Check spelling''

{|
|[[File:Spellengine.png|thumb|Choosing a different spell engine]]
|}
According to: http://php.net/manual/en/book.pspell.php

"As of php 5.3. Pspell is no longer supported/bundled. Instead you can use the enchant which is bundled by default in 5.3."

If PSpell is selected then aspell 0.50 or later must be installed on your server and the path to aspell set in Administration > Site administration > Server > System Paths.

===Customising the editor toolbar===

An administrator can remove or add buttons to the TinyMCE editor toolbar by altering the Editor toolbar box in ''Administration>Site administration>Plugins>Text editors>TinyMCE HTML editor>General settings'' as demonstrated in the screencast [http://youtu.be/vTW1DImro9c Customise the text editor in 2.4]

{|
| [[File:editortoolbar.png|thumb|The Editor toolbar box]]
|[[File:horizontalrule.png|thumb|Example of simpler toolbar with added horizontal rule button]]
|[[File:inserttime.png|thumb|An "insert time" button has been added]]

|}

====Available fonts list====

In addition to the default fonts, a site administrator can add extra fonts by typing their name and string in the box in ''Administration > Site administration > Plugins > Text editors > TinyMCE HTML editor>General settings'' as demonstrated in the screencast [http://youtu.be/udP7Bnur30Y How to add extra fonts].

{|
|[[File:comicsans.png|thumb|Example of custom font]]
|}

====Custom configuration====

A setting in ''Administration>Site administration>Plugins>Text editors>TinyMCE HTML editor>General settings'' provides a box in which an administrator can apply custom formats. See MDL-37186 for more details with examples, and see also the [http://www.tinymce.com/wiki.php/Configuration:formats TinyMCE configuration page]

{|
|[[File:bottomtoolbar.png|thumb| Example 1:Toolbar at the bottom]]
|[[File:customstyles.png|thumb| Example 2: Custom styles]]
|}

*Example: Moving the toolbar to the bottom:

Add the following:
{"theme_advanced_toolbar_location" : "bottom"}

*Example: Adding your own custom styles.
(This might be useful for example if you want a "house style" for important notes, key points or similar)
In the editor toolbar, enter "styleselect" and then in the custom box add the following code, changing it to suit your purposes:
{"style_formats" : [
{"title" : "Bold text", "inline" : "b"},
{"title" : "Red text", "inline" : "span", "styles" : {"color" : "#ff0000"}},
{"title" : "Red header", "block" : "h1", "styles" : {"color" : "#ff0000"}} ]}

The following will let you use bootstrap CSS classes if you use a bootstrap based theme:

{"style_formats" : [
{"title" : "Well", "block" : "div", "classes" : "well"},
{"title" : "Label", "inline" : "span", "classes" : "label"},
{"title" : "Label - success", "inline" : "span", "classes" : "label label-success"},
{"title" : "Label - warning", "inline" : "span", "classes" : "label label-warning"},
{"title" : "Label - important", "inline" : "span", "classes" : "label label-important"},
{"title" : "Label - info", "inline" : "span", "classes" : "label label-info"},
{"title" : "Label - inverse", "inline" : "span", "classes" : "label label-inverse"},
{"title" : "Button", "inline" : "a", "classes" : "btn btn"},
{"title" : "Button - primary", "inline" : "a", "classes" : "btn btn-primary"},
{"title" : "Button - info", "inline" : "a", "classes" : "btn btn-info"},
{"title" : "Button - success", "inline" : "a", "classes" : "btn btn-success"},
{"title" : "Button - warning", "inline" : "a", "classes" : "btn btn-warning"},
{"title" : "Button - danger", "inline" : "a", "classes" : "btn btn-danger"},
{"title" : "Button - inverse", "inline" : "a", "classes" : "btn btn-inverse"}
]}

*Example: Enabling copy of rich content with styles from MS Word (tm) and paste into TineMCE without removing important styles:

{"paste_retain_style_properties" : "margin, padding, width, height, font-size,
font-weight, font-family, color, text-align, ul, ol, li,
text-decoration, border, background, float, display"}

==See also==

* [[Text editor FAQ]]

[[Category:Site administration]]

[[de:Text-Editor]]

Using Workshop

2013-06-28T08:23:25Z

Mudrd8mz: /* See also */ Add link to a research paper by Cox, Posada and Waldron at ascilite.org.au

{{Workshop}}
==Workshop phases==
The work flow for the Workshop module can be viewed as having five phases. The typical workshop activity can cover days or even weeks. The teacher switches the activity from one phase to another.

The typical workshop follows a straight path from Setup to, Submission, Assessment, Grading/Evaluation, and ending with the Closed phased. However, an advanced recursive path is also possible.

The progress of the activity is visualized in so called Workshop planner tool. It displays all Workshop phases and highlights the current one. It also lists all the tasks the user has in the current phase with the information of whether the task is finished or not yet finished or even failed.

===Setup phase===

In this initial phase, Workshop participants cannot do anything (neither modify their submissions nor their assessments). Course facilitators use this phase to change workshop settings, modify the grading strategy of tweak assessment forms. You can switch to this phase any time you need to change the Workshop setting and prevent users from modifying their work.

===Submission phase===

In the submission phase, Workshop participants submit their work. Access control dates can be set so that even if the Workshop is in this phase, submitting is restricted to the given time frame only. Submission start date (and time), submission end date (and time) or both can be specified.

===Assessment phase===

If the Workshop uses peer assessment feature, this is the phase when Workshop participants assess the submissions allocated to them for the review. As in the submission phase, access can be controlled by specified date and time since when and/or until when the assessment is allowed.

===Grading evaluation phase===

The major task during this phase is to calculate the final grades for submissions and for assessments and provide feedback for authors and reviewers. Workshop participants cannot modify their submissions or their assessments in this phase any more. Course facilitators can manually override the calculated grades. Also, selected submissions can be set as published so they become available to all Workshop participants in the next phase.

===Closed===

[[File:workshop final grades.png|thumb|A closed workshop]]Whenever the Workshop is being switched into this phase, the final grades calculated in the previous phase are pushed into the course [[Gradebook]].This will result in the Workshop grades appearing in the Gradebook and in the workshop (new in Moodle 2.4 onwards). Participants may view their submissions, their submission assessments and eventually other published submissions in this phase.

==Workshop grading==

The grades for a Workshop activity are obtained gradually at several stages and then they are finalized. The following scheme illustrates the process and also provides the information in what database tables the grade values are stored.

[[Image:workshop_grades_calculation.png|400px|thumb|left|The scheme of grades calculation in Workshop]]
<br clear="all"/>

As you can see, every participant gets two numerical grades into the course Gradebook. During the Grading evaluation phase, course facilitator can let Workshop module to calculate these final grades. Note that they are stored in Workshop module only until the activity is switched to the final (Closed) phase. Therefore it is pretty safe to play with grades unless you are happy with them and then close the Workshop and push the grades into the Gradebook. You can even switch the phase back, recalculate or override the grades and close the Workshop again so the grades are updated in the Gradebook again (should be noted that you can override the grades in the Gradebook, too).

During the grading evaluation, Workshop grades report provides you with a comprehensive overview of all individual grades. The report uses various symbols and syntax:

{| class="nicetable"
|-
! Value
! Meaning
|-
| - (-) < Alice
| There is an assessment allocated to be done by Alice, but it has been neither assessed nor evaluated yet
|-
| 68 (-) < Alice
| Alice assessed the submission, giving the grade for submission 68. The grade for assessment (grading grade) has not been evaluated yet.
|-
| 23 (-) > Bob
| Bob's submission was assessed by a peer, receiving the grade for submission 23. The grade for this assessment has not been evaluated yet.
|-
| 76 (12) < Cindy
| Cindy assessed the submission, giving the grade 76. The grade for this assessment has been evaluated 12.
|-
| 67 (8) @ 4 < David
| David assessed the submission, giving the grade for submission 67, receiving the grade for this assessment 8. His assessment has weight 4
|-
| 80 (<del>20</del> / <ins>17</ins>) > Eve
| Eve's submission was assessed by a peer. Eve's submission received 80 and the grade for this assessment was calculated to 20. Teacher has overridden the grading grade to 17, probably with an explanation for the reviewer.
|}

=== Grade for submission ===

The final grade for every submission is calculated as weighted mean of particular assessment grades given by all reviewers of this submission. The value is rounded to a number of decimal places set in the Workshop settings form.

Course facilitator can influence the grade for a given submission in two ways:

* by providing their own assessment, possibly with a higher weight than usual peer reviewers have
* by overriding the grade to a fixed value

=== Grade for assessment ===

Grade for assessment tries to estimate the quality of assessments that the participant gave to the peers. This grade (also known as ''grading grade'') is calculated by the artificial intelligence hidden within the Workshop module as it tries to do typical teacher's job.

During the grading evaluation phase, you use a Workshop subplugin to calculate grades for assessment. At the moment, only one subplugin is available called ''Comparison with the best assessment''. The following text describes the method used by this subplugin. Note that more grading evaluation subplugins can be developed as Workshop extensions.

Grades for assessment are displayed in the braces () in the Workshop grades report. The final grade for assessment is calculated as the average of particular grading grades.

There is not a single formula to describe the calculation. However the process is deterministic. Workshop picks one of the assessments as the ''best'' one - that is closest to the mean of all assessments - and gives it 100% grade. Then it measures a 'distance' of all other assessments from this best one and gives them the lower grade, the more different they are from the best (given that the best one represents a consensus of the majority of assessors). The parameter of the calculation is how strict we should be, that is how quickly the grades fall down if they differ from the best one.

If there are just two assessments per submission, Workshop can not decide which of them is 'correct'. Imagine you have two reviewers - Alice and Bob. They both assess Cindy's submission. Alice says it is a rubbish and Bob says it is excellent. There is no way how to decide who is right. So Workshop simply says - ok, you both are right and I will give you both 100% grade for this assessment. To prevent it, you have two options:

* Either you have to provide an additional assessment so the number of assessors (reviewers) is odd and workshop will be able to pick the best one. Typically, the teacher comes and provide their own assessment of the submission to judge it
* Or you may decide that you trust one of the reviewers more. For example you know that Alice is much better in assessing than Bob is. In that case, you can increase the weight of Alice's assessment, let us say to "2" (instead of default "1"). For the purposes of calculation, Alice's assessment will be considered as if there were two reviewers having the exactly same opinion and therefore it is likely to be picked as the best one.

'''Backward compatibility note'''

In Workshop 1.x this case of exactly two assessors with the same weight is not handled properly and leads to wrong results as only the one of them is lucky to get 100% and the second get lower grade.

'''It's not final grades what is compared'''

It is very important to know that the grading evaluation subplugin ''Comparison with the best assessment'' does not compare the final grades. Regardless the grading strategy used, every filled assessment form can be seen as n-dimensional vector of normalized values. So the subplugin compares responses to all assessment form dimensions (criteria, assertions, ...). Then it calculates the distance of two assessments, using the variance statistics.

To demonstrate it on example, let us say you use grading strategy Number of errors to peer-assess research essays. This strategy uses a simple list of assertions and the reviewer (assessor) just checks if the given assertion is passed or failed. Let us say you define the assessment form using three criteria:

# Does the author state the goal of the research clearly? (yes/no)
# Is the research methodology described? (yes/no)
# Are references properly cited? (yes/no)

Let us say the author gets 100% grade if all criteria are passed (that is answered "yes" by the assessor), 75% if only two criteria are passed, 25% if only one criterion is passed and 0% if the reviewer gives 'no' for all three statements.

Now imagine the work by Daniel is assessed by three colleagues - Alice, Bob and Cindy. They all give individual responses to the criteria in order:

* Alice: yes / yes / no
* Bob: yes / yes / no
* Cindy: no / yes / yes

As you can see, they all gave 75% grade to the submission. But Alice and Bob agree in individual responses, too, while the responses in Cindy's assessment are different. The evaluation method ''Comparison with the best assessment'' tries to imagine, how a hypothetical absolutely fair assessment would look like. In the [[Development:Workshop 2.0 specification]], David refers to it as "how would Zeus assess this submission?" and we estimate it would be something like this (we have no other way):

* Zeus 66% yes / 100% yes / 33% yes

Then we try to find those assessments that are closest to this theoretically objective assessment. We realize that Alice and Bob are the best ones and give 100% grade for assessment to them. Then we calculate how much far Cindy's assessment is from the best one. As you can see, Cindy's response matches the best one in only one criterion of the three so Cindy's grade for assessment will not be as high.

The same logic applies to all other grading strategies, adequately. The conclusion is that the grade given by the best assessor does not need to be the one closest to the average as the assessment are compared at the level of individual responses, not the final grades.

==Groups and Workshop==
When a workshop is used in a course using separate or visible groups and groupings, it is possible to filter by group in a drop-down menu at the Assessment phase, manual allocation page, grades report and so on.

[[File:workshopdropdown.png |thumb|none|upright=2.0|alt="Group filtering" | Group filtering drop down]]

==See also==

* [http://www.ascilite.org.au/conferences/wellington12/2012/images/custom/cox,_julian_moodle.pdf Research paper] ''Moodle Workshop activities support peer review in Year 1 Science: present and future'' by Julian M Cox, John Paul Posada and Russell Waldron
* Using Moodle [http://moodle.org/mod/forum/view.php?id=740 Workshop module forum]
* Using Moodle forum discussion [http://moodle.org/mod/forum/discuss.php?d=153268] where David explains a particular Workshop results
* [http://www.slideshare.net/mark.drechsler/moodle-workshop-20-a-simplified-explanation Moodle Workshop 2.0 - a (simplified) explanation] presentation by Mark Drechsler
* [[Development:Workshop]] for more information on the module infrastructure and ways how to extend provided functionality by developing own Workshop subplugins
* [http://moodlefairy.posterous.com/a-brief-journey-into-the-moodle-20-workshop A Brief Journey into the Moodle 2.0 Workshop] at moodlefairy's posterous

[[de:Workshop nutzen]]

Upgrading

2013-05-15T03:53:34Z

Mudrd8mz: Do not suggest to to upgrade add-ons that early in the process (it did not make sense as the whole tree is to be removed anyway)

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

==Check the requirements==

Check that your server meets all requirements for 2.5 in ''Settings > Site administration > Server > [[Environment]]''.

Note: You can only upgrade to Moodle 2.5 from Moodle 2.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 upgrade to 2.2] as a first step.

==Before you upgrade your site for real==

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

== Backup important data ==

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

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

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in.

== Check for add-on updates ==

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

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

The upgrade of the add-on will then happen as part of the Moodle upgrade process.

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

== Install the new Moodle software ==

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any custom add-ons on your site you should add them to the new code tree now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle.

====Linux====
mv moodle moodle.backup
tar xvzf moodle-2.5.tgz

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

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

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

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

if necessary.

=== Using Git ===

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

===Command line upgrade===

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

== Finishing the upgrade ==

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

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

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

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

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

==After upgrading==

The config.php file from your 2.2, 2.3 or 2.4 installation should work fine but if you take a look at config-dist.php that came with Moodle 2.5 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 2.5 config-dist.php.

==Possible issues that may affect you in Moodle 2.5==

===Renamed settings block===

The settings block has been renamed 'Administration' and reports are now located there.

===Course listing improvements===

Course listings are now displayed consistently throughout the site. See [[:dev:Courses lists upgrade to 2.5]] for details of admin setting changes and possible custom theme changes required.

===Multi-server architectures with different PHP versions ===

Moodle has moved to use a more secure mechanism for securing passwords, from 2.5 new passwords will be generated using bcrypt rather than md5. Because bcrypt is only supported for PHP version 5.3.7 and above, it is important that all servers within a cluster use the same version of PHP (MDL-35332).

===Restoring Moodle 2.5 backups to sites with old PHP versions===

Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.

The same issue would occur if you downgraded the PHP version on the server running your site from 5.3.7+ to less than 5.3.7 (MDL-35332).

===Manual grading option in the quiz settings===

Before Moodle 2.5, you could set 'How questions behave' in the [[Quiz settings]] to 'Manually graded'. This caused all questions in the quiz, including multiple choice questions, to require manual grading. This option was not necessary because essay questions, the only ones that need to be graded manually, will always work that way whatever behaviour is selected.

Since the only effect of that setting was that people somehow choose it by mistake, we have hidden it. There should be no circumstances for which you would need to re-enable it, but if necessary, it can be restored by going to ''Administration > Site administration > Plugins > Question behaviour''.

=== Moodle 2.3 and 2.4 improvements ===

If you are upgrading to Moodle 2.5 from 2.2 or 2.3, please see the section 'Possible issues that may affect you' in the documentation [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3] and [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4].

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
* [[dev:Moodle 2.5 release notes|Moodle 2.5 release notes]]
* [[dev:Upgrade API|Upgrade API]]

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

Installing plugins

2013-05-03T16:02:27Z

Mudrd8mz: Merging with my version of the page update

{{Installing Moodle}}
An add-on is an optional plugin for adding additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

==What is meant by the words 'plugin' and 'add-on'?==

Moodle = core code + plugins

Plugins may be either standard plugins (included in the Moodle download package) or add-ons.

== Before you do anything else... ==

'''VERY IMPORTANT''' Warning: Please be aware that some add-ons have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all.

* Do you '''really''' need the add-on? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the add-on supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the add-on does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches''! If an add-on modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing an add-on==

To install an add-on, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the add-on code can be deployed into Moodle.

{{New features}}In Moodle 2.5 onwards, an add-on code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new add-on is to be installed in order to use either of these methods.

Alternatively, an add-on code may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''.
# Click the button 'Install add-ons from Moodle plugins directory'.
# Search for a plugin with an Install button (i.e. suitable for 2.5), click the Install button then click Continue.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select Moodle 2.5 as version, then choose an add-on with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''.
# Upload the ZIP file, select the appropriate plugin type, tick the acknowledgement checkbox, then click the button 'Install add-on from the ZIP file'.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.

{|
| [[File:install add-ons.png|thumb|Install add-ons]]
| [[File:add-on package validation.png|thumb|Add-on package validation]]
|}

For both of the above methods, after clicking the button 'Install add-on', you will then be automatically redirected to ''Settings > Site administration > Notifications'' and the installation process (i.e. creating required database tables etc) will happen.

===Installing manually at the server===

If you can't deploy the add-on code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the add-on type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory], select Moodle 2.5 as version, then choose an add-on with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow add-on instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the add-on is installed).

Note: The add-on may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the add-on in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name then it won't work.

===Obtaining help===

Ask in the appropriate forum in [http://moodle.org/course/view.php?id=5 Using Moodle]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the add-on you downloaded (some have very similar names).

==Uninstalling an add-on==

To uninstall an add-on
# Go to ''Settings > Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the add-on you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

Note: Certain plugin types offer the removal from the disk as well, though not yet all.

==Plugins overview==

[[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]The Plugins overview page in ''Settings > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available to standard plugins or add-ons installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing add-ons from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

// Use the following flag to completely disable the On-click add-on installation
// feature and hide it from the server administration UI.
//
// $CFG->disableonclickaddoninstall = true;

==See also==

*[[Notifications]] for further details of update notifications
*[[Add-on FAQ]]
*Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalando plugins]]

Upgrading

2013-05-03T14:11:21Z

Mudrd8mz: /* Backup important data */

Installing plugins

2013-05-03T14:10:01Z

Mudrd8mz: /* Installing an add-on */

SSL certificate for moodle.org

2013-01-10T20:10:27Z

Mudrd8mz: /* Solutions */ Adding a note about Windows servers

{{Security}}
== Synopsis ==

When you, as an administrator, [[Notifications|check for available updates]] or [[Automatic updates deployment|install an update]], your Moodle site needs to communicate with moodle.org. This communication is done via the secure HTTPS protocol. Your Moodle site validates the SSL certificate of moodle.org (such as the [https://moodle.org/plugins Moodle plugins directory]) and verifies its identity. To pass this verification, there must be a certificate (in the PEM format) of the [http://en.wikipedia.org/wiki/Certificate_authority certificate authority (CA)] that issued the certificate for moodle.org installed on your server.

The SSL certificate for moodle.org has been issued by the [https://www.digicert.com/digicert-root-certificates.htm DigiCert CA].

== Problem ==

If this CA certificate is missing, the remote site (moodle.org) can not be verified and so your Moodle site will refuse to fetch the data (to protect you against so called man-in-the-middle attack). The exact location of the certificate on your server depends on the OS type and other settings. On Linux servers it may be typically found at ''/usr/share/ca-certificates/mozilla/DigiCert_High_Assurance_EV_Root_CA.crt'' for example.

A missing CA certificate results in an error when checking for available updates and attempting to install them.

== Solutions ==

=== Update your operating system (recommended) ===

The recommended way to fix this problem is to update your server's operating system so that it contains recent SSL certificates from common certificate authorities. This does not seem to help for Windows servers though. At Windows, the cURL library bundled with PHP does not use the CA certificates installed in the OS and you will have to use the alternative solution described below.

For Debian and RedHat based distributions, CA certificates are distributed in the ''ca-certificates'' package. Gentoo servers provide them via the ''app-misc/ca-certificates'' ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and cURL libraries (libcurl) are up-to-date on your server.

=== Provide the CA certificate manually ===

If updating the operating system is not an option for you, or the administrator of the server refuses to update the CA certificates on the server (despite there being no good reason for not doing so), or updating the CA installed in the OS did not help (such as in case of Windows servers), a possible workaround is to download the bundle of required certificates from the [http://curl.haxx.se/ca/ cURL] site. You need to download the file [http://curl.haxx.se/ca/cacert.pem cacert.pem] from there and put it into your ''moodledata/moodleorgca.crt'' file (i.e. download the cacert.pem file, rename it to moodleorgca.crt and upload it into your mooodledata). If this file is found in moodledata, Moodle will use it instead of relying on certificates provided by the operating system.

It must be highlighted that having the CA certificate on your server's operating system as described above is really the recommended solution. The solution based on moodleorgca.crt should only be considered as a temporary fix (although it seems to be the only way to make it work at Windows servers).

[[es:SSL certificate for moodle.org]]

Workshop FAQ

2013-01-04T08:14:33Z

Mudrd8mz: Added the grades calculation FAQ

{{Workshop}}
==How the heck these grades are 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 ''Settings > 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.

==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 ''Settings>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''

==See also==

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

[[Category:FAQ]]

[[de:Workshop FAQ]]

Using Workshop

2013-01-04T08:10:06Z

Mudrd8mz: /* Grade for assessment */ Typos and headings

{{Workshop}}
==Workshop phases==
The work flow for the Workshop module can be viewed as having five phases. The typical workshop activity can cover days or even weeks. The teacher switches the activity from one phase to another.

The typical workshop follows a straight path from Setup to, Submission, Assessment, Grading/Evaluation, and ending with the Closed phased. However, an advanced recursive path is also possible.

The progress of the activity is visualized in so called Workshop planner tool. It displays all Workshop phases and highlights the current one. It also lists all the tasks the user has in the current phase with the information of whether the task is finished or not yet finished or even failed.

===Setup phase===

In this initial phase, Workshop participants cannot do anything (neither modify their submissions nor their assessments). Course facilitators use this phase to change workshop settings, modify the grading strategy of tweak assessment forms. You can switch to this phase any time you need to change the Workshop setting and prevent users from modifying their work.

===Submission phase===

In the submission phase, Workshop participants submit their work. Access control dates can be set so that even if the Workshop is in this phase, submitting is restricted to the given time frame only. Submission start date (and time), submission end date (and time) or both can be specified.

===Assessment phase===

If the Workshop uses peer assessment feature, this is the phase when Workshop participants assess the submissions allocated to them for the review. As in the submission phase, access can be controlled by specified date and time since when and/or until when the assessment is allowed.

===Grading evaluation phase===

The major task during this phase is to calculate the final grades for submissions and for assessments and provide feedback for authors and reviewers. Workshop participants cannot modify their submissions or their assessments in this phase any more. Course facilitators can manually override the calculated grades. Also, selected submissions can be set as published so they become available to all Workshop participants in the next phase.

===Closed===

[[File:workshop final grades.png|thumb|A closed workshop]]{{New features}}Whenever the Workshop is being switched into this phase, the final grades calculated in the previous phase are pushed into the course [[Gradebook]].This will result in the Workshop grades appearing in the Gradebook and in the workshop (new in Moodle 2.4 onwards). Participants may view their submissions, their submission assessments and eventually other published submissions in this phase.

==Workshop grading==

The grades for a Workshop activity are obtained gradually at several stages and then they are finalized. The following scheme illustrates the process and also provides the information in what database tables the grade values are stored.

[[Image:workshop_grades_calculation.png|400px|thumb|left|The scheme of grades calculation in Workshop]]
<br clear="all"/>

As you can see, every participant gets two numerical grades into the course Gradebook. During the Grading evaluation phase, course facilitator can let Workshop module to calculate these final grades. Note that they are stored in Workshop module only until the activity is switched to the final (Closed) phase. Therefore it is pretty safe to play with grades unless you are happy with them and then close the Workshop and push the grades into the Gradebook. You can even switch the phase back, recalculate or override the grades and close the Workshop again so the grades are updated in the Gradebook again (should be noted that you can override the grades in the Gradebook, too).

During the grading evaluation, Workshop grades report provides you with a comprehensive overview of all individual grades. The report uses various symbols and syntax:

{| class="nicetable"
|-
! Value
! Meaning
|-
| - (-) < Alice
| There is an assessment allocated to be done by Alice, but it has been neither assessed nor evaluated yet
|-
| 68 (-) < Alice
| Alice assessed the submission, giving the grade for submission 68. The grade for assessment (grading grade) has not been evaluated yet.
|-
| 23 (-) > Bob
| Bob's submission was assessed by a peer, receiving the grade for submission 23. The grade for this assessment has not been evaluated yet.
|-
| 76 (12) < Cindy
| Cindy assessed the submission, giving the grade 76. The grade for this assessment has been evaluated 12.
|-
| 67 (8) @ 4 < David
| David assessed the submission, giving the grade for submission 67, receiving the grade for this assessment 8. His assessment has weight 4
|-
| 80 (<del>20</del> / <ins>17</ins>) > Eve
| Eve's submission was assessed by a peer. Eve's submission received 80 and the grade for this assessment was calculated to 20. Teacher has overridden the grading grade to 17, probably with an explanation for the reviewer.
|}

=== Grade for submission ===

The final grade for every submission is calculated as weighted mean of particular assessment grades given by all reviewers of this submission. The value is rounded to a number of decimal places set in the Workshop settings form.

Course facilitator can influence the grade for a given submission in two ways:

* by providing their own assessment, possibly with a higher weight than usual peer reviewers have
* by overriding the grade to a fixed value

=== Grade for assessment ===

Grade for assessment tries to estimate the quality of assessments that the participant gave to the peers. This grade (also known as ''grading grade'') is calculated by the artificial intelligence hidden within the Workshop module as it tries to do typical teacher's job.

During the grading evaluation phase, you use a Workshop subplugin to calculate grades for assessment. At the moment, only one subplugin is available called ''Comparison with the best assessment''. The following text describes the method used by this subplugin. Note that more grading evaluation subplugins can be developed as Workshop extensions.

Grades for assessment are displayed in the braces () in the Workshop grades report. The final grade for assessment is calculated as the average of particular grading grades.

There is not a single formula to describe the calculation. However the process is deterministic. Workshop picks one of the assessments as the ''best'' one - that is closest to the mean of all assessments - and gives it 100% grade. Then it measures a 'distance' of all other assessments from this best one and gives them the lower grade, the more different they are from the best (given that the best one represents a consensus of the majority of assessors). The parameter of the calculation is how strict we should be, that is how quickly the grades fall down if they differ from the best one.

If there are just two assessments per submission, Workshop can not decide which of them is 'correct'. Imagine you have two reviewers - Alice and Bob. They both assess Cindy's submission. Alice says it is a rubbish and Bob says it is excellent. There is no way how to decide who is right. So Workshop simply says - ok, you both are right and I will give you both 100% grade for this assessment. To prevent it, you have two options:

* Either you have to provide an additional assessment so the number of assessors (reviewers) is odd and workshop will be able to pick the best one. Typically, the teacher comes and provide their own assessment of the submission to judge it
* Or you may decide that you trust one of the reviewers more. For example you know that Alice is much better in assessing than Bob is. In that case, you can increase the weight of Alice's assessment, let us say to "2" (instead of default "1"). For the purposes of calculation, Alice's assessment will be considered as if there were two reviewers having the exactly same opinion and therefore it is likely to be picked as the best one.

'''Backward compatibility note'''

In Workshop 1.x this case of exactly two assessors with the same weight is not handled properly and leads to wrong results as only the one of them is lucky to get 100% and the second get lower grade.

'''It's not final grades what is compared'''

It is very important to know that the grading evaluation subplugin ''Comparison with the best assessment'' does not compare the final grades. Regardless the grading strategy used, every filled assessment form can be seen as n-dimensional vector of normalized values. So the subplugin compares responses to all assessment form dimensions (criteria, assertions, ...). Then it calculates the distance of two assessments, using the variance statistics.

To demonstrate it on example, let us say you use grading strategy Number of errors to peer-assess research essays. This strategy uses a simple list of assertions and the reviewer (assessor) just checks if the given assertion is passed or failed. Let us say you define the assessment form using three criteria:

# Does the author state the goal of the research clearly? (yes/no)
# Is the research methodology described? (yes/no)
# Are references properly cited? (yes/no)

Let us say the author gets 100% grade if all criteria are passed (that is answered "yes" by the assessor), 75% if only two criteria are passed, 25% if only one criterion is passed and 0% if the reviewer gives 'no' for all three statements.

Now imagine the work by Daniel is assessed by three colleagues - Alice, Bob and Cindy. They all give individual responses to the criteria in order:

* Alice: yes / yes / no
* Bob: yes / yes / no
* Cindy: no / yes / yes

As you can see, they all gave 75% grade to the submission. But Alice and Bob agree in individual responses, too, while the responses in Cindy's assessment are different. The evaluation method ''Comparison with the best assessment'' tries to imagine, how a hypothetical absolutely fair assessment would look like. In the [[Development:Workshop 2.0 specification]], David refers to it as "how would Zeus assess this submission?" and we estimate it would be something like this (we have no other way):

* Zeus 66% yes / 100% yes / 33% yes

Then we try to find those assessments that are closest to this theoretically objective assessment. We realize that Alice and Bob are the best ones and give 100% grade for assessment to them. Then we calculate how much far Cindy's assessment is from the best one. As you can see, Cindy's response matches the best one in only one criterion of the three so Cindy's grade for assessment will not be as high.

The same logic applies to all other grading strategies, adequately. The conclusion is that the grade given by the best assessor does not need to be the one closest to the average as the assessment are compared at the level of individual responses, not the final grades.

==Groups and Workshop==
When a workshop is used in a course using separate or visible groups and groupings, it is possible to filter by group in a drop-down menu at the Assessment phase, manual allocation page, grades report and so on.

[[File:workshopdropdown.png |thumb|none|upright=2.0|alt="Group filtering" | Group filtering drop down]]

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=740 Workshop module forum]
* Using Moodle forum discussion [http://moodle.org/mod/forum/discuss.php?d=153268] where David explains a particular Workshop results
* [http://www.slideshare.net/mark.drechsler/moodle-workshop-20-a-simplified-explanation Moodle Workshop 2.0 - a (simplified) explanation] presentation by Mark Drechsler
* [[Development:Workshop]] for more information on the module infrastructure and ways how to extend provided functionality by developing own Workshop subplugins
* [http://moodlefairy.posterous.com/a-brief-journey-into-the-moodle-20-workshop A Brief Journey into the Moodle 2.0 Workshop] at moodlefairy's posterous

[[de:Workshop nutzen]]

Template:Workshop

2013-01-03T19:00:24Z

Mudrd8mz: Added link to grading strategies

<div class="navtrail">[[Main page]] ► [[Managing a Moodle course]] ► [[Activities]] ► [[Workshop module]] ► [[{{PAGENAME}}]]</div>
<div class="sideblock right" style="width: 14em;">
<div class="header">[[Workshop module]]</div>
<div class="content">
* [[Workshop settings]]
* [[Using Workshop]]
* [[Workshop grading strategies|Grading strategies]]
* [[Workshop_module_FAQ|Workshop FAQ]]
</div>
</div>

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

Workshop activity

2013-01-03T18:58:48Z

Mudrd8mz: Added link to grading strategies

{{Activities}}
[[Image:workshop_icon_logo.gif]]'''Workshop''' is a peer assessment activity with many options. Students submit their work via an on line text tool and attachments. There are two grades for a student: their own work and their peer assessments of other students' work.

[[Image:Workshopexample.png]]

* [[Workshop settings]]
* [[Using Workshop]]
* [[Workshop grading strategies|Grading strategies]]
* [[Workshop_module_FAQ|Workshop FAQ]]

== Key features ==

Workshop is similar to the [[Assignment module]] and extends its functionality in many ways. However, it is recommended that both course facilitator (teacher) and course participants (students) have at least some experience with the Assignment module before the Workshop is used in the course.

* As in the Assignment, course participants submit their work during the Workshop activity. Every course participant submits their own work. The submission may consist of a text and attachments. Therefore, Workshop submission merges both ''Online text'' and ''Upload file'' types of the Assignment module. Support for team work (in the sense of one submission per group of participants) is out of scope of Workshop module.
* The submissions are assessed using a structured assessment form defined by the course facilitator (teacher). Workshop supports several types of assessment forms. All of them allows multi-criteria assessment in comparison to the Assignment module where only one grade is given to a submission.
* Workshop supports peer assessment process. Course participants may be asked to assess selected set of their peers' submissions. The module coordinates the collection and distribution of these assessments.
* Course participants get actually two grades in a single Workshop activity - grade for their submission (that is how good their submitted work is) and grade for assessment (that is how well they assessed their peers). Workshop activity creates two grade items in the course [[Gradebook]] and they can be aggregated there as needed.
* The process of peer assessment and understanding the assessment form can be practised in advance on so called example submissions. These examples are provided by the facilitator together with a reference assessment. Workshop participants can assess these examples and compare their assessment with the reference one.
* The course facilitator can select some submissions and publish them so they are available to the others at the end of Workshop activity (in comparison to the Assignment module where submitted work is available only to the author and the facilitator).

Workshop in Moodle 2.0 video:

<mediaplayer>http://www.youtube.com/watch?v=8QypkOcAEaE</mediaplayer>

[[de:Workshop]]
[[cs:Modul Workshop]]
[[fr:Atelier]]

SSL certificate for moodle.org

2013-01-03T10:59:07Z

Mudrd8mz: Confirming the solution based on cacert.pem file from the cURL site

{{Security}}
== Synopsis ==

When you, as an administrator, [[Notifications|check for available updates]] or [[Automatic updates deployment|install an update]], your Moodle site needs to communicate with moodle.org. This communication is done via the secure HTTPS protocol. Your Moodle site validates the SSL certificate of moodle.org (such as the [https://moodle.org/plugins Moodle plugins directory]) and verifies its identity. To pass this verification, there must be a certificate (in the PEM format) of the [http://en.wikipedia.org/wiki/Certificate_authority certificate authority (CA)] that issued the certificate for moodle.org installed on your server.

The SSL certificate for moodle.org has been issued by the [https://www.digicert.com/digicert-root-certificates.htm DigiCert CA].

== Problem ==

If this CA certificate is missing, the remote site (moodle.org) can not be verified and so your Moodle site will refuse to fetch the data (to protect you against so called man-in-the-middle attack). The exact location of the certificate on your server depends on the OS type and other settings. On Linux servers it may be typically found at ''/usr/share/ca-certificates/mozilla/DigiCert_High_Assurance_EV_Root_CA.crt'' for example.

A missing CA certificate results in an error when checking for available updates and attempting to install them.

== Solutions ==

=== Update your operating system (recommended) ===

The recommended way to fix this problem is to update your server's operating system so that it contains recent SSL certificates from common certificate authorities. For Debian and RedHat based distributions, these certificates are distributed in the ''ca-certificates'' package. Gentoo servers provide them via the ''app-misc/ca-certificates'' ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and cURL libraries (libcurl) are up-to-date on your server.

=== Provide the CA certificate manually ===

If updating the operating system is not an option for you and the administrator of the server refuses to update the CA certificates on the server (despite there being no good reason for not doing so), a possible workaround is to download the bundle of required certificates from the [http://curl.haxx.se/ca/ cURL] site. You need to download the file [http://curl.haxx.se/ca/cacert.pem cacert.pem] from there and put it into your ''moodledata/moodleorgca.crt'' file (i.e. download the cacert.pem file, rename it to moodleorgca.crt and upload it into your mooodledata). If this file is found in moodledata, Moodle will use it instead of relying on certificates provided by the operating system.

It must be highlighted that having the CA certificate on your server's operating system as described above is really the recommended solution. The solution based on moodleorgca.crt should only be considered as a temporary fix.

SSL certificate for moodle.org

2013-01-03T06:21:14Z

Mudrd8mz: Undo revision 102620 by Rezeau (talk)

{{Security}}
== Synopsis ==

When you, as an administrator, [[Notifications|check for available updates]] or [[Automatic updates deployment|install an update]], your Moodle site needs to communicate with moodle.org. This communication is done via the secure HTTPS protocol. Your Moodle site validates the SSL certificate of moodle.org (such as the [https://moodle.org/plugins Moodle plugins directory]) and verifies its identity. To pass this verification, there must be a certificate (in the PEM format) of the [http://en.wikipedia.org/wiki/Certificate_authority certificate authority (CA)] that issued the certificate for moodle.org installed on your server.

The SSL certificate for moodle.org has been issued by the [https://www.digicert.com/digicert-root-certificates.htm DigiCert CA] and signed by their ''DigiCert High Assurance EV Root CA'' certificate.

== Problem ==

If this CA certificate is missing, the remote site (moodle.org) can not be verified and so your Moodle site will refuse to fetch the data (to protect you against so called man-in-the-middle attack). The exact location of the certificate on your server depends on the OS type and other settings. On Linux servers it may be typically found at ''/usr/share/ca-certificates/mozilla/DigiCert_High_Assurance_EV_Root_CA.crt'' for example.

A missing CA certificate results in an error when checking for available updates and attempting to install them.

== Solutions ==

=== Update your operating system (recommended) ===

The recommended way to fix this problem is to update your server's operating system so that it contains recent SSL certificates from common certificate authorities. For Debian and RedHat based distributions, these certificates are distributed in the ''ca-certificates'' package. Gentoo servers provide them via the ''app-misc/ca-certificates'' ebuild. It's also a good idea to make sure that the OpenSSL libraries (libssl) and cURL libraries (libcurl) are up-to-date on your server.

=== Provide the CA certificate manually ===

If updating the operating system is not an option for you and the administrator of the server refuses to update the CA certificates on the server (despite there being no good reason for not doing so), a possible workaround is to download the [https://www.digicert.com/testroot/DigiCertHighAssuranceEVRootCA.crt DigiCert High Assurance EV Root CA] certificate from [https://www.digicert.com/digicert-root-certificates.htm digicert.com] and put it into your ''moodledata/moodleorgca.crt'' file. If the certificate is found there, Moodle will use it instead of relying on the one provided by the operating system.

It must be highlighted that having the CA certificate on your server's operating system as described above is really the recommended solution. The solution based on moodleorgca.crt should only be considered as a temporary fix.

error/core plugin/err response http code

2012-12-04T15:18:34Z

Mudrd8mz: Redirected page to Available update notifications

#REDIRECT [[Available update notifications]]

error/core plugin/err response format version

2012-12-04T15:18:13Z

Mudrd8mz: Redirected page to Available update notifications

#REDIRECT [[Available update notifications]]

error/core plugin/err response curl

2012-12-04T15:17:13Z

Mudrd8mz: Redirect to Available update notifications

#REDIRECT [[Available update notifications]]

Available update notifications

2012-12-04T15:16:10Z

Mudrd8mz: Added infor about errors

[[File:Pluginsoverview.png|thumb|left|Checking for available updates via the plugins overview page]]An administrator can configure update notifications for both Moodle core code and any contributed plugins installed on the site (from the [http://moodle.org/plugins plugins directory]) in ''Settings > Site Administration > Server > Update notifications''.

If the automatic check for available updates is enabled and there is a new update available, a notification will be sent to all site admins via email and/or popup message (according to the admin's messaging preferences in their profile settings).

{{New features}}In Moodle 2.4 onwards, updates deployment i.e. the option to update installed plugins from within Moodle may be enabled by ticking the updateautodeploy checkbox. When updates are available, ''Install this update'' buttons are shown on the [[Plugins overview]] page (''Settings > Site Administration > Plugins > Plugins overview''). See [[Automatic updates deployment]] for more details.

An administrator can specify the required code maturity (stable, alpha, beta or release candidate) for update notifications, also whether notifications of new builds (normally released each week) are sent.

[[File:updates check button.png|thumb|Checking for available updates via the notifications page]]An admin can also check for available updates for contributed plugins installed on the site using the 'Check for available updates' button in ''Settings > Site Administration > Plugins > [[Installing plugins|Plugins overview]]''. Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

Available updates for core code can also be checked via ''Settings > Site administration > Notifications''.<br clear="all" />

== How it works ==

# The information about available updates are available as a web service at download.moodle.org
# When ''Check for updates'' button is pressed (or daily via cron), your Moodle fetches information about available updates from the web service and stores it locally.
# The list of installed plugins is compared with the list of available updates. If a newer version of Moodle or a plugin is available, the Moodle informs site administrators.

When calling the web service, your site must provide its own version and the list of all installed add-ons. No sensitive data (like the location of your site, any user data etc) are submitted.

== Disabling update notifications ==

In a few circumstances (such as completely managed servers, which may have a lot of local modifications) it is desirable to not have the check for updates active. The feature may be disabled completely by adding the following code to the [[Configuration file|config.php file]]:

$CFG->disableupdatenotifications = true;

== Errors and exceptions ==

When experiencing an error, please turn debugging on. The debug info will contain additional information about the reason of the error.

=== Unable to fetch available updates data - unexpected cURL error ===

See the debug info for the actual cURL error number and the error text.

; cURL error 7 couldn't connect to host : Make sure that the site http://download.moodle.org is up and running at the moment. If it is down, your site can't call the web service to fetch the available updates info. Wait for the download.moodle.org site is up again and try to re-check.
; cURL error 60 (SSL certificate problem) : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. See [[SSL certificate for moodle.org]] for more info.

This error may also raise if your Moodle is configured to run behind a mis-configured proxy server.

=== Unable to fetch available updates data - unexpected HTTP response code ===

See the debug info for the actual HTTP response code. On success, the HTTP response code is 200. All other response codes throw this error.

=== Unexpected version of the response format ===

This could happen if you check for updates during the major Moodle upgrade. Please try to re-check for available updates once you finish upgrading your Moodle.

Automatic updates deployment

2012-12-04T14:44:10Z

Mudrd8mz: Available update notifications page moved

{{New features}}[[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Settings > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on Plugins overview and Plugins check pages.

This functionality requires that [[Available update notifications]] are enabled at the site.<br clear="all" />

== How it works ==

As a part of the information about available updates for the site, URL of the ZIP package with the new version of an installed plugin is returned. When ''Install this update'' button is pressed and the the deployment is confirmed at the next page, a standalone utility called ''mdeploy.php'' is executed.

# The mdeploy utility authorizes the request to make sure you are coming ''exactly'' from the confirmation page displayed in the previous step.
# The ZIP package with the new version is fetched from the [https://moodle.org/plugins Moodle plugins directory].
# A simple integrity check is performed to make sure the ZIP was downloaded correctly.
# The current version of the plugin code is archived into a directory at ''moodledata/mdeploy/archive/'' so you have a backup (just in case you had some local tweaks in the code, for example).
# The current directory with the plugin is removed and replaced with the content of the downloaded ZIP.
# Your browser is redirected to the page where the normal upgrade procedure happens.

At this moment, you can deploy another available update (if there is such) or perform the upgrade procedure as if you uploaded the ZIP contents to your site manually.

== Disabling updates deployment ==

In a few circumstances (such as completely managed servers, which may have a lot of local modifications, or sites that have their own solution for updates deployment - for example via [[Git for Administrators|Git checkouts]]) it is desirable to not to allow automatic updates deployment. The feature may be disabled completely by adding the following code to the [[Configuration file|config.php file]]:

$CFG->disableupdateautodeploy = true;

== Missing install button ==

If the updates deployment feature is not enabled (or if it was disabled at the config.php file), no button to install the update is displayed. If the feature is enabled, the page displaying the list of available updates performs some pre-checks to make sure the deployment will work. If a pre-check fails, a short information with a help pop-up is displayed.

=== Plugin files not writable ===

During the deployment, Moodle will replace the whole folder with the plugin code with a new version. The web server process has to have write access to the folder and all its contents. There are several ways how to achieve this, depending on your web server setup and personal preferences. The exact location of the plugin folder depends on the type of the plugin. For a full list of locations see the Moodle path on https://docs.moodle.org/dev/Plugins

Example: Let us assume your web server is an Apache running at a Linux server as the user ''www-data''. Your Moodle is installed at ''/var/www/vhosts/moodle/htdocs''. You want to give it write access to the folder with your Stamp collection activity module:

# cd /var/www/vhosts/moodle/htdocs
# cd mod
# chown -R www-data stampcoll
# chmod -R u+w stampcoll

See also more about [[Installing plugins]].

=== Can not download the package ===

Make sure that the site http://moodle.org/plugins is up and running at the moment. If it is down, your site can't fetch the ZIP packages from it. Wait for the moodle.org site is up again and try to repeat the deployment procedure.

There can also be a problem with the validation of the SSL certificate of the moodle.org site. See [[SSL certificate for moodle.org]] for more info.

== Errors and exceptions ==

[[File:mdeploy-exception.png|thumb|left|Error screen during the plugin deployment]]If anything goes wrong during the deployment, please read the error page carefully and copy the error message together with the debugging information for later reference. Also, check the mdeploy.log file. The mdeploy utility logs all the steps into this file located at ''moodledata/mdeploy/mdeploy.log''. The log file usually contains additional details and debugging information describing the reason of the failure.

When you navigate back from the error screen, always remember to go back up to the screen with the list of available plugins (where you clicked the ''Install this update'' button originally). Just going back to the previous confirmation screen or even reloading the current page will not work as the request would not be authorized any more. Doing so leads to the ''unauthorized_access_exception'' with the message ''Unable to read the passphrase file.''

The following section describes some errors that may raise and how to deal with them.<br clear="all" />

=== Unable to download the package (download_file_exception) ===

Check the bottom of the mdeploy.log file. It will probably contain a line starting with "cURL error" followed by the error number and the cURL error description.

==== cURL error 7 couldn't connect to host ====

Make sure that the site http://moodle.org/plugins is up and running at the moment. If it is down, your site can't fetch the ZIP packages from it. Wait for the moodle.org site is up again and try to repeat the deployment procedure.

==== cURL error 60 SSL certificate problem ====

This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site when fetching the ZIP package. See [[SSL certificate for moodle.org]] for more info.

Notifications

2012-12-04T14:42:51Z

Mudrd8mz: Update notifications moved to a separate page

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

==Other notifications==

The version of Moodle used may be found in ''Settings > 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
* Site not yet [[Site registration|registered]]

==See also==

* [[:dev:Available update notifications|Available update notifications developer documentation]]
* [[error/moodle/errortoomanylogins]]

[[es:Notificaciones]]
[[eu:Jakinarazpenak]]
[[fr:Notifications]]
[[de:Benachrichtigungen]]

Available update notifications

2012-12-04T14:41:32Z

Mudrd8mz: Added missing bit from the original page