MoodleDocs - User contributions [en]

Cron with Unix or Linux

2020-06-02T15:56:23Z

Mudrd8mz: /* High performance cron tasks */ Update to contain info valid for 3.8

{{Installing Moodle}}
On Unix and Linux use the built in ''cron'' program which is standard on nearly all systems. You are required to add a command to the 'crontab' (the table that holds cron commands) for the web server user.

There are two different methods that can be used to invoke the Moodle cron process:

'''NOTE:''' The commands shown need to be added to the crontab to function (described in a moment). However, you can - and should - run them on the command line to check they work first.

== Method 1: The command line (cli) cron ==

If you have a choice, this is normally the best way to run Moodle cron.

PHP is also capable of running programs directly from the command line. Your system needs to be set up to do this; specifically you need the 'CLI' version of PHP to be installed. Most systems with PHP installed will have this by default. If you have the PHP CLI version installed then this is the recommended method of invoking cron. The correct command will be something like...
<pre>
/usr/bin/php /path/to/moodle/admin/cli/cron.php
</pre>
(substitute the correct path to moodle and for php as required)

You can simply type this on the command line this to see if it works. If you are not sure about the path to PHP you can type "<code>which php</code>".

'''Tip:''': If you have problems, see the [[PHP]] page. In particular, suspect an alternate php.ini for the CLI PHP command which may not have suitable settings.

== Method 2: Web based cron ==

'''NOTE:''' In order to use the web based cron script you must first check [[Cron settings]] to make sure this method is permitted.

The idea is to call the following web page (you can try this from your browser):
<pre>
http://url.of.your/moodle/admin/cron.php
</pre>

A command line (text based) browser is needed to run this on the server. Possibilities are as follows (OSX, for example, only ships with curl)...
<pre>
/usr/bin/wget -q -O /dev/null/ http://url.of.your/moodle/admin/cron.php
</pre>
(no output is displayed - remove the ''-O /dev/null/'' to test)

...OR...

<pre>
/usr/bin/curl http://url.of.your/moodle/admin/cron.php -o /dev/null/ -silent
</pre>
(no output is displayed - remove the ''-o /dev/null/ -silent'' to test)

==Using the crontab program on Unix/Linux==

Once you have selected (and tested!) an appropriate command to invoke the Moodle cron it must be added to the web users 'crontab' to schedule it to run regularly. 'Crontab' is both a file containing the user's cron commands and is also the name of the (command line) program used to edit it. Use the following command (as root) substituting the correct user in place of 'www-data' (e.g. 'apache' for Centos, 'www-data' for Debian/Ubuntu - Google will know!)
<pre>
# crontab -u www-data -e
</pre>
This will bring up an editor window (the first time it may ask you which editor to use). Add the command onto the end of the file in this way (it may be empty or it may have some instructional comments):
<pre>
*/1 * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php >/dev/null
</pre>
The first five entries specify the times, followed by the command, to run. This says to run the command every minute which is normally ok. On a hosted system you may get complaints if you do not run it a lot less often (e.g. to run every two hours use '0 */2 * * *' for the first five entries). If you want to use the wget/curl version, the first five entries remain the same - just change the command part.

== High performance cron tasks ==

Each time cron is run, after the scheduled tasks the adhoc tasks are also run. But adhoc tasks can be queued at any moment, and generally you want them processed as soon as possible and to not have to wait for the scheduled task to run first. You can run one or more dedicated adhoc task processors:

<pre>
* * * * * /usr/bin/php /path/to/moodle/admin/tool/task/cli/adhoc_task.php --execute >/dev/null
</pre>

If you have a very high low number of adhoc tasks, or scheduled tasks, you can also spawn multiple cron.php and adhoc_task.php processes to get more throughput. By default Moodle will make sure than no more than 3 processes run at any time, you can tune these limits as needed in Site administration > Server > Tasks > Task processing

== See also ==

* [http://linuxweblog.com/node/24 A basic crontab tutorial]
* [http://www.freebsd.org/cgi/man.cgi?query=crontab&apropos=0&sektion=5&manpath=FreeBSD+6.0-RELEASE+and+Ports&format=html Online version of the man page]
* [http://www.easycron.com/predictor Predicting Cron job's run time]

[[es:Cron con Unix o Linux]]

Markdown

2020-05-21T07:10:51Z

Mudrd8mz: /* Lists */

{{Editing text}}
== About Markdown ==

Markdown expands upon the simple text entry format available in Moodle by allowing you to easily add emphasis (bold, italics), structure (bullet points and headings) and links (to images or other web resources).

To enter text simply type into the text entry area or text box, pressing the return key twice at the end of a paragraph to leave a blank line between the end of one paragraph and the start of the next.

==Using Markdown==

To use Markdown:

# Go to your editor preferences (via the user menu) and select 'Plain text area'
# Click the 'Save changes' button
# Select 'Markdown format' from the dropdown menu below any text entry area.

=== Emphasising Text ===

You can add three levels of emphasis with Markdown, italic text, bold text, or bold and italic text. This is achieved by surrounding the text you wish to emphasise with asterisks e.g.

*italic*
**bold**
***bold italic***

Emphasis can be added to single words, a sequence of words, or even parts of words:

a *single* word
***a sequence of words***
in**distinguish**able

Underscores (_) can be used interchangeably with asterisks for this purpose.

=== Headings===

Markdown allows you to subdivide your text with headings; six different levels are available though it is unusual for a normal text to use more than three. For example, there are three levels of heading used in the text you are currently reading.

You can create a heading by starting a line with one or more hash characters (#). One hash is the largest and most important heading, and six hashes gives you the least important or smallest heading.

# section heading
## sub-section heading
### sub-sub-section heading

etc.

The first two levels of headings are most common and can be created in alternative ways that make them stand out more in the text version (though the output is identical to the previous method). This alternative uses a line of equal signs (=) or hyphens (-) under the title as follows:

Section heading
===============

Subsection heading
------------------

=== Lists ===
To be recognised as a list, all lists must have a blank line before them. Without a blank line, the text will not be rendered as a list.

==== Bullet point lists ====

Bullet point lists can be created by starting each line with an asterisk followed by a space before the content of the bullet point. Note that the space is important and should not be forgotten.

* first point
* second point
* third point

==== Numbered lists ====

Similarly, numbered lists can be created by starting each line with a number followed by a space and then the relevant text.

1. first point
2. second point
3. third point

==== Indented lists ====

You can nest or indent bullet and numbered lists, even mixing bullet point and numbered lists in one structure:

* top level bullet one
* sub-bullet
* sub-bullet 2
* top level bullet two
1. numbered point one
1. nested numbered point
2. numbered point two

=== Quoted paragraphs ===

You can indicate a quoted section of text by beginning each line with an angle bracket (>). This character was chosen as many email programs use it to indicate quoted sections. The output will generally indent the quoted section in from both margins.

> This is a quoted paragraph
> spread over two lines

You can save some typing by only using a a single angle bracket at the beginning of the first line of the paragraph

> this is all one single quoted
paragraph even though it is spread
over several lines.

=== Web links ===

There are two ways to create links to web resources: the first is to include the link inline, placing the text you wish readers to click on in square brackets, and the URL of the page they will be taken to immediately afterwards in parentheses with no space or gap between the two sets of brackets; you can also add an optional title for the link in quotes after the URL.

An [example link](<nowiki>http://example.com/</nowiki> "Optional Title") in a sentence.

The title, if supplied, is displayed in a 'tooltip' which appears when the user hovers their mouse over the link text. Try it on the link that appears above.

For longer links you can avoid disrupting the flow of text by using a footnote style, attaching a short identifying name to the link in a second set of square brackets (either using a short explanatory word, phrase or simply a number).

An [example link][ex] in a sentence.

Then, anywhere else in the document, but preferably either directly after the paragraph with the link, or collected with other link URLs at the bottom of the document, you can define the URL associated with the id:

[ex]: <nowiki>http://example.com/</nowiki> "Optional Title"

The output of this second example would be indistinguishable from the first. It is simply a matter of keeping the working document neatly organised to aid further editing (particularly if you are working with others).

A final shortcut, if you wish your linked text to be the same as the URL, is to place the URL within angled brackets like so:

<<nowiki>http://moodle.org/</nowiki>>

=== Images ===

Images are included in a very similar manner to web links, but are preceded by an exclamation mark. The 'alt text' (alt meaning alternative) is provided to users that cannot see the image for various reasons, thus the text should make sense without any visual cues. Doing this will also provide a reminder or hint to those editing the text in Markdown as to the purpose of the image.

The 'title' is displayed in a small pop up when the user hovers over the image and so can provide additional information.

![alt text](/path/img.jpg "Optional Title")

And, like web links, you can organise your document by keeping all the URLs together with 'footnote' style references. Just give the image a short, unique name:

![alt text][photo]

and anywhere else in your document, associate that name with an image file:

[photo]: /url/to/img.jpg "Optional Title"

Here is an example:

![Google logo](<nowiki>http://www.google.com/images/logo.gif</nowiki> "The Google logo")

The 'alt text', which is also important for accessibility reasons, will often be used by browsers when links to images are broken or temporarily unavailable:

![alt text for broken image](<nowiki>http://example.com/intentionally.broken.link</nowiki> "This image will never display")

== See also ==

* [[Formatting text]]
* [[Advanced use of Markdown]]

Location

2020-05-06T14:31:07Z

Mudrd8mz: /* GeoIP City data file */ Due to data privacy regulations, maxmind changed how you access the free GeoLite2 database

{{Managing a Moodle site}}
==Location settings==
An administrator can change the following location settings in ''Administration > Site administration > Location > Location settings''.

===Time zone settings===

The time zone is used to help convert the raw timestamps in the database to human readable dates and times, for the user who is requesting the page.

====Default time zone====
Use this to set the default time zone for your site. This should be the time zone that most users use, or if that is difficult, where you When available, choose the Area/Location that is proper for you rather than use the UTC settings. These [http://en.wikipedia.org/wiki/Tz_database names are standardized by the IANA].

Note: As of Moodle 2.9, the older setting and button to allow you to update time zone codes from Moodle.org has been replaced with standard PHP date and time code. If your PHP version is over 6 months old, time zone data should be updated using the [http://pecl.php.net/package/timezonedb PECL timezonedb package].

====Force timezone====
If a particular time zone is forced, users will see the name of the time zone on their edit profile page and will be not be able to change it. If you wish to allow individual users to choose their own time zone, leave this at the default "Users can choose their own time zone."

====Default country====
Select the country to appear by default on a new user account page form.

==== Default city====
Enter a default city for new user profiles. This may be left blank.

===IP address lookup===
====GeoIP City data file====
Location of GeoIP City binary data file. This is a non-invasive way to determine geographical and other information about Internet visitors in real-time. This file is not part of Moodle distribution and must be obtained separately from MaxMind.

There is a GeoIPLite version for free at [http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz]. Extract the GeoLietCity.dat file and upload it to /moodledata/geoip/GeoLiteCity.dat.

Since Moodle 3.2 looking up IPv6 addresses using the [http://dev.maxmind.com/geoip/geoip2/geolite2/ GeoLite2] database from [http://www.maxmind.com/ Maxmind] is supported (more info [https://docs.moodle.org/32/en/Upgrading#IP_address_lookups here]). This replaces the existing GeoLite legacy database used in previous versions and the new GeoIP2 database will need to be installed to use this functionality. See [https://dev.maxmind.com/geoip/geoip2/geolite2/ maxmind.com page] for how to obtain the database.

You can check to see if the GeoIP data file is available to Moodle by going to: Administration > Site administration > Location > Location settings, under IP Address Lookup.

====Google Maps API key====
Google Maps for IP address lookup visualization key. The Google Maps API lets you embed Google Maps with JavaScript. This is free.

'''NOTE:''' There is no longer support for Google maps API V2 as it has been deprecated since 2010. V3 is now used. See here for details: https://developers.google.com/maps/documentation/javascript/tutorial#api_key

After updating the information in this section, IPs that are displayed as a link, such as in reports, when clicked will open new window with a Google Map indicating the location of the IP, if found and if not a private address.

====All country codes====
This is the list of countries that may be selected in various places, for example in a user's profile. If blank (the default) the list in countries.php in the standard English language pack is used. Otherwise, you can specify a comma-separated list of codes, for example 'GB,FR,ES' in [http://en.wikipedia.org/wiki/ISO_3166-1 ISO-3166-1 format].

The list of countries is based on the ISO 3166 list of official country short names, but is not exactly the same. See the comment in MDL-56181 for more details.

[[es:Localización]]
[[eu:Kokagunea]]
[[de:Lokales]]
[[fr:Localisation]]

Upload courses

2020-02-19T13:08:18Z

Mudrd8mz: /* Short file example */

{{Courses}}
{{Note|This page is about creating courses with a text (.csv) file. If you want to upload a course backup in .mbz or .tgz format, see [[Course restore]].}}

==Upload courses==

In addition to creating new courses, the upload courses functionality may also be used to update or delete courses, or import content from another course. For information on using this functionality to create course templates, see [[Adding a new course]].

To upload one or more courses

# Go to ''Administration > Site administration > Courses > Upload courses''
# Either drag and drop the CSV file or click the 'Choose a file' button and select the file in the file picker
# Select appropriate import options carefully, then click the preview button.

{|
|[[File:26uploadcourses.png|250px|thumb|Upload courses admin screen]]
|
|[[File:uploadcoursesresults.png|250px|thumb|Courses successfully uploaded]]
|}

Note: It is also possible to use the command-line tool ''admin/tool/uploadcourse/cli/uploadcourse.php''.

When using the web interface, use the ''Preview'' option to see if any errors were detected in the previewed rows. If you proceed with the upload and there were something wrong detected with a course, it will be ignored.

=== Short file example ===
uploadcourse.csv:

Note: shortname, fullname, and category are required.

The category field takes the id of the category, with the default category Miscellaneous having id 1. Categories must already exist. If you put a category id that does not exist, you will receive a "Could not resolve category by ID" error during upload preview, and courses in that category will not be created.

<code>
shortname,fullname,category,summary,enrolment_1,enrolment_1_role,enrolment_1_enrolperiod,role_student
courserestored,Course restored,1,a summary,manual,student,1 month,
courserestored2,Course restored 2,1,a summary,,,,
courserestored3,Course restored 3,1,a summary,,,,padawan
courserestored4,Course restored 4,1,"a summary, with comma",manual,student,1 month,padawan
</code>
Notice there are no spaces between the items.

==Creating the text file==

The text file to upload courses must be a CSV file. It accepts the following columns which are divided in two categories, the course information, and the course actions.

===Course information fields===

Most of those settings are available on the settings page of a course. Please refer to [[Course settings]] for more information. Field names must be lower-case.

;shortname
: The shortname
;fullname
: The full name
;idnumber
: The ID number (found on the ‘Edit Category’ page)
;category
: This is the ID of the category to place the course in. This takes precedence over ''category_idnumber'' and ''category_path''.
;category_idnumber
: The ID number of the category to place the course in (found in the category url). This takes precedence over ''category_path''.
;category_path
: The path of the category to place the course in. If you want to place the course in a category named "Science-Fiction" which is located under the category "Movies", the value to provide is: <code>Movies / Science-Fiction</code>. Note that the separator must be <code>[space]/[space]</code>. Also note that the category MUST exist, it will not be created. If you want to place the course in the top-level category "Movies", the value to provide is: <code>Movies</code>
;visible
: 1 if the course is visible, 0 if hidden
;startdate
: The time at which the course starts. Please note that this value is passed to the PHP function [http://php.net/manual/en/function.strtotime.php strtotime] to generate a timestamp. Example 01.12.2014 (1st December 2014)
;enddate
: The time at which the course ends. Please note as with startdate that this value is passed to the PHP function [http://php.net/manual/en/function.strtotime.php strtotime] to generate a timestamp. Example 01.12.2014 (1st December 2014)
;summary
: The summary of the course
;format
: The course format to use, this must be a valid course format plugin name. E.g. ''weeks'', ''topics''.
;theme
: The theme to use
;lang
: The language to use
;newsitems
: The number of news items
;showgrades
: 1 to show the gradebook to students, 0 to hide it.
;showreports
: 1 to show the activity reports, 0 to hide it.
;legacyfiles
: 1 to enable the legacy course files, 0 not to.
;maxbytes
: The maximum upload size of the course in bytes. Use 0 for the site limit.
;groupmode
: 0 for ''No groups'', 1 for ''Separate groups'' and 2 for ''Visible groups''.
;groupmodeforce
: 1 to force the group mode, otherwise enter 0.
;enablecompletion
: 1 to enable the activity completion, 0 not to.
;tags
: A comma-separated list of tags to add to the course. Existing tags will be deleted. Enclose multiple tags in quotes.

====Enrolment fields====

Some fields can be constructed to enable and configure enrolment methods. The fields must be named ''enrolment_[number]'' for the enrolment method name, and ''enrolment_[number]_property'' for its properties.

;enrolment_[number]
: The name of the enrolment method (eg, manual, guest, self)
;enrolment_[number]_delete
: 1 to delete this enrolment method from the course, if set to 1 all the other properties will be ignored.
;enrolment_[number]_disable
: 1 to disable this enrolment method from the course, if set to 1 all the other properties will be ignored.
;enrolment_[number]_startdate
: The enrolment start date. This value is passed to the PHP function strtotime().
;enrolment_[number]_enddate
: The enrolment end date. This value is passed to the PHP function strtotime().
;enrolment_[number]_enrolperiod
: Number of seconds, or if not a value understood by strtotime() such as "4 days".
;enrolment_[number]_role
: The role short name
;enrolment_[number]_[property]
: Where property is understood by the specified enrolment method
;enrolment_[number]_password
: The course enrolment key

Note: Upload courses is not yet compatible with all [[Enrolments|enrolment methods]] (MDL-43127).

'''Example'''

enrolment_1: manual
enrolment_1_role: student
enrolment_1_enrolperiod: 1 month

enrolment_2: self
enrolment_2_startdate: 2013-01-30

====Role renaming====

To rename some roles, using the following pattern:

;role_[shortname]
: The new name of the role ''[shortname]''.

'''Example'''

role_student: Apprentice
role_teacher: Master
role_mycustomrole: Jedi

It is worth noting that the short name for the teacher role is ''editingteacher'' and the short name for the non-editing teacher is ''teacher''.

===Course action fields===

Those settings take precedence over the ''Course process'' parameters.

;delete
: 1 to delete the course
;rename
: The shortname to rename the course to
;backupfile
: An absolute path to a backup file (.mbz) to import in the course.

(This means the full path to your course, for example ''/home/yourmoodle/public_html/moodle27/transfert/backup.mbz'' . If you are unsure of this, look at include_path in ''Site administration>Server>PHP info.)''
;templatecourse
: The short name of a course to import the content from
;reset
: 1 to reset the course

===Mandatory fields===

;shortname
: This field is mandatory for every operation, with the only exception of creating new courses. See details on the course process parameter ''Shortname template'' for more information.
;fullname
: Required when creating a new course.
;category, category_idnumber, category_path
: One of these is required when creating a course.

===Import options===

To prevent unexpected behaviour, you have to specify what you want the tool to be able to do.

;Upload mode
: This allows you to specify if courses can be created and/or updated.
;Update mode
: If you allow courses to be updated, you also have to tell the tool what to update the courses with.
;Allow deletes
: Whether the ''delete'' field is accepted or not
;Allow renames
: Whether the ''rename'' field is accepted or not
;Allow resets
: Whether the ''reset'' field is accepted or not

===Course process===

This allows you to specify actions to be taken for every course uploaded.

;Shortname template
: If you are creating courses without a shortname, you can use this field to automatically generate a shortname. This field accepts two placeholders: %i for the ID number, %f for the summary.
;Restore file
: A backup file (.mbz) to import in the course after create/update.
;Restore from course
: The shortname of a course to import content from after create/update.
;Reset after upload
: Whether to reset the course after creating/updating it.

===Default course values===

Those are values that can be set in the web interface for all the fields that are not specified in the CSV file. Note that they are always used when creating a course, but only when specified during update (see ''Update mode'').

==Increasing speed==

When importing the content of a backup file, or another course, you are advised to enable the setting ''keeptempdirectoriesonbackup''. This will considerably speed up the process of the upload if you are importing multiple times from the same source.

==See also==

* Demo screencast: [http://youtu.be/MzK2jb-9SwE Bulk course creation]
* [[Upload users]]
* [http://www.moodleblog.net/2013/11/24/creating-course-templates-in-moodle-2-6/ Creating course templates in Moodle 2.6] blog post by Mary Cooch

[[fr:Modifier des cours en lots]]
[[de:Kurse hochladen]]
[[es:Subir cursos]]
[[ja:コースをアップロードする]]

Learning Analytics Enriched Rubric

2019-04-26T11:32:22Z

Mudrd8mz: /* Grade calculation */

{{Advanced grading methods}}
{{Infobox plugin
|type = Rubric
|set = [[Advanced grading methods|Advanced Grading Methods]]
|entry = [https://moodle.org/plugins/gradingform_erubric Learning Analytics Enriched Rubric]
|tracker = [https://github.com/johndimopoulos/moodle-gradingform_erubric/issues Bug tracker]
|discussion = [https://moodle.org/plugins/gradingform_erubric Learning Analytics Enriched Rubric plugin for advance grading]
|maintainer = [[User:John Dimopoulos|John Dimopoulos]]
|
}}
[[image:gradingform-erubric-icon.png]] The '''Learning Analytics Enriched Rubric (LAe-R)''' is an [[Advanced grading methods|advanced grading method]] used for criteria-based assessment. As a rubric, it consists of a set of criteria. For each criterion, several descriptive levels are provided. A numerical grade is assigned to each of these levels.

An enriched rubric contains criteria and related grading levels that are associated to data from the analysis of learners’ interaction and learning behavior in a Moodle course, such as number of post messages, times of accessing learning material, assignments grades and so on.

Using learning analytics from log data that concern collaborative interactions, past grading performance and inquiries of course resources, the LA e-Rubric can automatically calculate the score of the various levels per criterion. The total rubric score is calculated as a sum of the scores per each criterion.

You may click this link to view the [https://www.youtube.com/watch?v=aeIWqthm-BE Introduction to Learning Analytics Enriched Rubric] video.

== Version 3.0 release notes ==
The new version of LAe-R plugin embeds the following enhancements and characteristics:

* Up-to-date coding according to Moodle’s latest code guidelines.
* Code re-development for better performance of Data Mining and Learning Analytics generation.
* The use of Tab key to jump to the next level/criteria and even to add new criteria or levels.
* Criteria duplication for faster rubric creation.
* Negative points can be assigned in levels, for example as a late submission penalty.
* Improved rubric display for editing, viewing and grading, according to Moodle’s standard themes: Clean, ([https://docs.moodle.org/en/Boost_theme Boost]) and ([https://docs.moodle.org/en/More_theme More]) and responsive design for all devices (desktop – tablet – smartphone).
* GDPR compliant

The new version was produced using Moodle 3.5 for testing with themes Clean, Boost and More as layouts.

== Creating a new Learning Analytics Enriched Rubric ==

=== Selecting a Learning Analytics Enriched Rubric ===

There are two ways a user can choose a LA e-Rubric as an advanced grading method.
* Make the selection during the creation of an assignment, in the Grade section of the creation form.
[[image:gradingfrom-learning-analytics-e-rubric-select1.png]]

* Click Advanced grading in the settings block of the assignment and then make the selection from the Change active grading method to select form field.
[[image:gradingfrom-learning-analytics-e-rubric-select2.png]]

=== Editing a Learning Analytics Enriched Rubric ===
[[image:gradingfrom-learning-analytics-e-rubric-editor.png|thumb|right|LA e-Rubric editor]]

In the Advanced grading page of the assignment, the user can
* ''Define a new grading form from scratch'' or,
* ''Create a new grading form from a template'' or,
* ''Edit a current form definition''

Either way, the grading form editor page appears where the LA e-Rubric can be created or edited.

In that form, the user provides a name for the LA e-Rubric, an optional description, adds or edits the criteria and chooses the options meeting his requirements.

Then the LA e-Rubric can be saved as a draft (for further editing), or saved and made ready for use.

=== Adding or editing criteria in a Learning Analytics Enriched Rubric ===
[[image:gradingfrom-learning-analytics-e-rubric-add-or-edit-criterion.png|thumb|right|LA e-Rubric add or edit criterion]]
[[image:gradingfrom-learning-analytics-e-rubric-criterion-enrichment-explained.png|thumb|right|LA e-Rubric enrichment of criteria]]
In order to add or edit a criterion, the user can:
* Add or edit the criterion description.
* Add or edit the level description and points values.
* Add or edit the enrichment criterion type (collaboration-grade-study).
* Add or edit the enrichment collaboration type (simple occurrences, file submissions, forum replies, people interacted), in case ''collaboration'' is chosen as the criterion type.
* Add or delete the corresponding course modules according to criterion type, from which data mining is conducted.
* Add or edit the operator used for enrichment calculations between the enrichment benchmark found and level enrichment check values (equal-more than). This defines if discrete or continuous range values are checked for comparison operations.
* Add or edit the checking scope of calculations according to individual student or all students.
* Add or edit the level enrichment check values needed for setting the check points in comparison operations.

Before adding or editing the above form fields the user should consider the following:
* To keep a rubric criterion simple, leave enrichment fields blank. Criteria enrichment is not mandatory!
* In case of criterion enrichment all enrichment fields and level values must be edited.
* A ''criterion type'' must be selected first in order for all other enrichment fields to be edited.
* The ''criterion type'' defines the kind of course modules that will be included in the enrichment.
* In case of ''collaboration check'', the ''collaboration type'' field is available and mandatory.
* The ''collaboration type'' defines what kind of checking will be made from the course modules.
* Collaboration type '''posts & talks''' checks simple ''add post'' and ''talk'' instances from logs in the selected course modules.
* Collaboration type '''file submissions''' checks number of files uploaded ONLY in selected '''forum''' course modules.
* Collaboration type '''forum replies''' checks user(s) replies to posts ONLY in selected '''forum''' course modules.
* Collaboration type '''people interacted''' checks the number of classmates a student has interacted with, in the selected course modules.
* One or more course modules of the selected criterion type and of the particular course should be added.
* The ''criterion operator'' is used for calculating logical conditions associated with the levels enrichment values.
* Related to All (students) or One (student) defines whether the calculations will be according to the student evaluated, thus absolute values will be processed or according to all other students, thus percentages will be processed.
* If the relation of the criterion is according to percentage, the arithmetic mean of all other students from all selected course modules will be considered as the students benchmark.
* Level enrichment values should be ascending (or descending) according to level ordering, otherwise logical errors may occur during evaluation.

=== Checking options of a Learning Analytics Enriched Rubric ===
The following options can be checked while editing a LA e-Rubric:

==== Rubric options ====
[[image:gradingfrom-learning-analytics-e-rubric-options.png|thumb|right|LA e-Rubric options]]
* Sort order for levels Sort level viewing according to grade points ascending or descending. '''Important:''' ordering of levels is taken into account in enrichment in order to pick the appropriate level according to enrichment check points. For example if level grade values are 0 – 10 – 20 – 30, enrichment check points should be ascending accordingly, for instance 5 – 6 – 7 – 8. Using this example, if the enrichment operator is more than (>=), the enrichment benchmark is calculated to 9 and the enrichment check points are 5 – 6 – 8 – 7, then 7 will be picked as opposed to 8!
* Calculate grade based on the rubric having a minimum score of 0 This setting only applies if the sum of the minimum number of points from each criterion is greater than 0. If ticked, the minimum achievable grade for the rubric will be greater than 0. If unticked, the minimum possible score for the rubric will be mapped to the minimum grade available for the activity (which is 0 unless a scale is used). If you are using a criterion without a 0-points level or with a level with negative points, then the rubric option 'When converting rubric score to points/scale assume that minimum number of points is 0' (new since Moodle 3.2) should be ticked to avoid unexpected grades.
* Allow users to preview rubric used in the module (otherwise rubric will only become visible after grading) Checking this option, provides the student the ability to preview the LA e-Rubric before the student submits his assignment or been graded.
* Display rubric description during evaluation
* Display rubric description to those being graded
* Display points for each level to those being graded
* Display points for each level during evaluation
* Allow grader to add text remarks for each criteria
* Show remarks to those being graded

==== Enriched criteria options ====
* Display enrichment check points for each level to those being graded
* Display enrichment check points for each level during evaluation
* Display enrichment of criteria to those being graded Un-check this option to hide enrichment of rubric criteria.
* Display enrichment of criteria during evaluation Un-check this option to hide enrichment of rubric criteria.
* Override automatic criterion evaluation in case of enrichment logical error (If enrichment logical error exists, evaluation is not possible without overriding it!) Check this option to enable the evaluator to pick a level according to his own judgment in case an enrichment benchmark is not found or there is a logical error in the enrichment criteria and a level can't be automatically picked.
* Enrichment calculations are conducted from assignment available date (if enabled) If an availability date is defined for the assignment, check this option to time stamp enrichment calculations on data mining.
* Enrichment calculations are conducted until submission due date (if enabled) If an due date is defined for the assignment, check this option to time stamp enrichment calculations on data mining.
* Display calculated enrichment benchmark to those being graded
* Display calculated enrichment benchmark during evaluation

=== Saving and Previewing a Learning Analytics Enriched Rubric ===
The user can save this form as a draft for further checking or save and make it ready to be used immediately. Either way, afterwards the user can preview the LA e-Rubric form as is was created or edited.

=== Video tutorial ===
You may click this link to view the tutorial on how to [https://www.youtube.com/watch?v=jCuNm463yTU Create Criteria in Learning Analytics Enriched Rubric] video.

== Using a Learning Analytics Enriched Rubric to evaluate students ==
[[image:gradingfrom-learning-analytics-e-rubric_v2-student-evaluation.png|thumb|right|LA e-Rubric evaluation editor]]
[[image:gradingfrom-learning-analytics-e-rubric_v2-student-evaluation-explained.png|thumb|right|LA e-Rubric evaluation explained]]
The grading process is where the Learning Analytics Enriched Rubric performs its magic. Analysis of data from log files is performed in order that all enriched criteria can automatically be evaluated and the corresponding criterion level gets a value. The evaluator can provide optional remarks, and just click ‘save’ or ‘save and grade next’, in order to grade a student.

First, the user clicks on ''View/grade all submissions'' in the assignment view page, or in the assignment's settings box. In the grading page of the assignment the user clicks on the grade icon, or chooses ''Grade'' from the editing icon in the edit column on the left.

Inside the evaluation form, the user sees all enriched criteria with the enrichment benchmark displayed and the appropriate level chosen for each one. If the enrichment evaluation procedure succeeded, in each criterion the user can see the checking icon of the enriched level whose value corresponds to the benchmark according to enrichment.

=== Handling enrichment evaluation failure ===
If the enrichment evaluation failed for an enriched criterion, the evaluator can pick a level according to his own judgment ONLY IF ''Override automatic criterion evaluation'' is enabled from the LA e-Rubric options. If there is a failure on enrichment evaluation and the evaluator can't pick a level himself, student evaluation won't be possible because all criteria will not have a level checked. In such cases it is strongly recommended to check the enrichment criteria again to avoid these errors, rather than override the enrichment evaluation procedure.

=== Evaluation according to student ===
If criterion enrichment evaluation is conducted according to student values, the student's benchmark appears upon succession in order for the evaluator to get the exact view of student performance.

=== Evaluation according to global scope ===
If the enrichment evaluation is conducted according to all students participating, then upon successful findings, the evaluator views two benchmarks. One that represents the student currently evaluated, and another for the score of all the participating students' average score. Again this is done in order for the evaluator to gain a better scope of student performance in reference to all participating students.

Something very important about global scope evaluation is that '''only students actively participating''' in the selected course modules of the enrichment are accounted for, which means that they may be, less than all students enrolled in a course. This is done for 2 reasons:
# Because the LA e-Rubric performs qualitative evaluation to students according to those participating, not to all. We want to measure true participation and collaboration results that concern active students only.
# Another equally important reason could be explained with an example: Let's say that we have 20 students attending a course and we want to evaluate them according to how much they collaborated the past week. Let's also say that 5 of them were sick the past week, or could not attend. It wouldn't be right for 5 students missing to bring down the hole week's average.
The above estimates are effective only for checking collaboration! For checking grades and studying, all enrolled students are accounted in the process.

=== Video tutorial ===
You may click this link to view the tutorial on how to perform [https://www.youtube.com/watch?v=Qa_Dan06o3o Student Evaluation in Learning Analytics Enriched Rubric] video.

== How students view the Learning Analytics Enriched Rubric ==

=== Preview of a Learning Analytics Enriched Rubric ===
[[image:gradingfrom-learning-analytics-e-rubric_v2-preview.png|thumb|right|LA e-Rubric preview]]
If the corresponding option is engaged, students can preview the LA e-Rubric before they are graded. This is an excellent method to let students know how they are evaluated and get a better view of their evaluation criteria.

In order for the students to preview the LA e-Rubric they just click ''Submissions grading'' in the submenu of their assignment on the left.

=== View grading results produced by a Learning Analytics Enriched Rubric ===
[[image:gradingfrom-learning-analytics-e-rubric_v2-evaluation-results.png|thumb|right|LA e-Rubric view evaluation results]]
[[image:gradingfrom-learning-analytics-e-rubric_v2-evaluation-results-explained.png|thumb|right|LA e-Rubric evaluation results explained]]
After graded, students can view how their evaluation occurred and they can also view their own benchmarks according to the LA e-Rubric criteria that affected their evaluation outcome.

The LA e-Rubric elements displayed to students, are defined in the LA e-Rubric options.

Students view their completed LA e-Rubric when the visit their corresponding assignment page.

=== Video tutorial ===
You may click this link to view the tutorial on how students [https://www.youtube.com/watch?v=XK5oFdeLIcY View Evaluation Results in Learning Analytics Enriched Rubric] video.

== Backup & restore, template sharing and importing a Learning Analytics Enriched Rubric ==

Procedures concerning backup, restore, import or template sharing are carried out according to all advanced grading methods of Moodle.

However, regarding the LA e-Rubric there are some restrictions.

The LA e-Rubric uses specific and resident course modules belonging to the moodle course in which the assignment is created. Thus when a LA e-Rubric is restored or imported or shared in another course, the particular course modules won't exist. The structure of the entire LA e-Rubric stays intact, but the user has to replace the missing course modules with similar ones obtained by the new course.

When an entire course is restored, the expected scenario is that most course modules have been given a new id, thus this restriction may still be in effect. Again, the structure of the entire LA e-Rubric stays intact, but the user has to replace the missing course modules with the same ones obtained by the restored course, in order to update the course modules ids.

During the sharing procedure of a LA e-Rubric, user gets an information message concerning this restriction.

If the user imports or restores or uses a LA e-Rubric from another course, another message appears informing the user about the course modules missing from the enriched criteria and advises him to make the appropriate changes so that the LA e-Rubric may be operational.

Images below display all these messages.

{|
| [[image:gradingfrom-learning-analytics-e-rubric-modules-missing-error.png|thumb|LA e-Rubric missing course modules error]]
| [[image:gradingfrom-learning-analytics-e-rubric-sharing-warning.png|thumb|LA e-Rubric form sharing warning]]
| [[image:gradingfrom-learning-analytics-e-rubric-view-imported-edit-error.png|thumb|LA e-Rubric edit with errors warning]]
|}

== Grade calculation and Data mining for enrichment in a Learning Analytics Enriched Rubric ==

=== Grade calculation ===
Grade calculation is done the same way as in simple rubrics.

The rubric normalized score (ie basically a percentage grade) is calculated as

: <math>G_s = \frac{\sum_{i=1}^N (g_i - min_i) }{\sum_{i=1}^N (max_i - min_i)}</math>

where <math>g_i \in \mathbb{Z}</math> is the number of points given to the i-th criterion, <math>min_i \in \mathbb{Z}</math> is the minimal possible number of points for of the i-th criterion, <math>max_i \in \mathbb{N}</math> is the maximal possible number of points for the i-th criterion and <math>N \in \mathbb{N} </math> is the number of criteria in the rubric.

If you are using a criterion without a 0-points level or with a level with negative points, then the rubric option 'Calculate grade based on the rubric having a minimum score of 0' should be ticked to avoid unexpected grades. Then, the rubric total score is calculated as

: <math>G_s = \frac{\sum_{i=1}^N g_i }{\sum_{i=1}^N max_i }</math>

where <math>g_i \in \mathbb{Z}</math> is the number of points given to the i-th criterion and <math>max_i \in \mathbb{N}</math> is the maximal possible number of points for the i-th criterion and <math>N \in \mathbb{N} </math> is the number of criteria in the rubric.

Let's examine a simple rubric with 1 criterion and 4 levels as bellow:

{| class="wikitable"
|+ Example 1: simple rubric with 1 criterion containing 4 levels
|-
!
! style="background:LightGray" | level 1
! style="background:LightGray" | level 2
! style="background:LightGray" | level 3
! style="background:LightGray" | level 4
|-
| style="background:LightGray" | criterion 1
| 1 point
| style="background:Lime" | 2 points
| 3 points
| 4 points
|}

The example above has the second level with 2 points checked. According to the above calculating methods, the first method resolves the normalized score as:

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

According to the second method the normalized score is:

: <math>G_s = \frac{2}{4} = 50 %</math>

So, for someone who build the above rubric presuming that a student who receives 2 points in a 4 point scale should be graded with a score of 50%, the second method meets their assumption.

For a second example we add another level in the previous rubric with a 0 points level like so:

{| class="wikitable"
|+ Example 2: simple rubric with 1 criterion containing 5 levels with 0 points minimum score
|-
!
! style="background:LightGray" | level 1
! style="background:LightGray" | level 2
! style="background:LightGray" | level 3
! style="background:LightGray" | level 4
! style="background:LightGray" | level 5
|-
| style="background:LightGray" | criterion 1
| 0 points
| 1 point
| style="background:Lime" | 2 points
| 3 points
| 4 points
|}

According to the first method the normalized score is:

: <math>G_s = \frac{(2 - 0)}{(4 - 0)} = \frac{2}{4} = 50 %</math>

According to the second method the normalized score is:

: <math>G_s = \frac{2}{4} = 50 %</math>

So, if the rubric's lowest possible score is zero (0), both methods calculate the same score result.

A more complex rubric example where both methods calculate the same score result (because the lowest possible score is zero (0)), is the one below:

{| class="wikitable"
|+ Example 3: complex rubric with 4 criteria containing 5 levels with 0 points lowest possible score
|-
!
! style="background:LightGray" | level 1
! style="background:LightGray" | level 2
! style="background:LightGray" | level 3
! style="background:LightGray" | level 4
! style="background:LightGray" | level 5
|-
| style="background:LightGray" | criterion 1 (simple criterion)
| 1 points
| 2 point
| 3 points
| style="background:Lime" | 4 points
| 5 points
|-
| style="background:LightGray" | criterion 2 (double weight criterion)
| 2 points
| style="background:Lime" | 4 point
| 6 points
| 8 points
| 10 points
|-
| style="background:LightGray" | criterion 3 (penalty points criterion)
| -3 point
| -2 points
| -1 points
| style="background:Lime" | 0 points
| 1 points
|-
| style="background:LightGray" | criterion 4 (simple criterion)
| 0 point
| 1 points
| 2 points
| 3 points
| style="background:Lime" | 4 points
|}

According to the first method the normalized score is:

: <math>G_s = \frac{(4 - 1) + (4 - 2) + (0 - (-3)) + (4 - 0)}{(5 - 1) + (10 - 2) + (1 - (-3)) + (4 - 0)} = \frac{3 + 2 + 3 + 4}{4 + 8 + 4 + 4} = \frac{12}{20} = 60 %</math>

According to the second method the normalized score is:

: <math>G_s = \frac{4 + 4 + 0 + 4}{5 + 10 + 1 + 4} = \frac{12}{20} = 60 %</math>

=== Learning Analytics for enriching the grading method ===
The data acquired during the log file analysis are distinguished according to analysis indicators as presented in these cases below.

* For simple occurrences in collaboration, moodle log data concern forum ''add posts'' and chat ''talks''.
* For file submissions in collaboration, the number of ''files'' attached to forum post messages.
* For forum replies in collaboration, forum reply post messages are counted (not including the replies one has made to himself).
* For people interacted, forum post and chat messages data are measured.
* For checking study behavior, the number of students' views upon selected course recourses are taken into account.
* For checking grades, moodle grading scores on selected assignments are processed.

== General advices - tips – instructions ==

* Create rubrics with an odd number of levels (3 or 5), so students can grasp the point of low - mid - high assessment values.
* Use double weight criteria to signify important lesson objectives.
* Use penalty points (e.g. -1) in levels in moderation, or not a all (use positive reinforcement rather than negative punishment).
* Use criteria with 2 levels with definite description (e.g. YES - NO) to clarify simple yet important lesson objectives (e.g Student always submits assignments in time).
* Rubric criteria doesn't have to have levels of the same description or number for each criterion. Moodle rubrics are flexible and adjustable. Use that to meet your assessment needs!
* An enriched-Rubric can have simple criteria. They don't all have to be enriched. The difference is that simple criteria must be manually picked by the evaluator during assessment.
* Use the keyboard's tab key or the new copy criterion button [[image:gradingform-erubric-copy-icon.png]] to create rubrics quickly.
* First create all course resources and activities and then generate a LA e-Rubric.
* Create enrichment criteria carefully and thoroughly to avoid logical errors.
* Don’t delete course resources or activities used in a LA e-Rubric.
* Log data are needed for evaluation so don't purge or empty Moodle data logs, until students grading is complete.
* If there is a request for user assessment data deletion according to GDPR regulations, best delete these data after the course is completed and student grades have been published.

== GDPR Compliance ==

This plugin is now GDPR compliant. Users with appropriate access can view, download or delete all user assessment data that is stored by this tool. Even if assessment data are deleted, students' grade will not be affected in the gradebook, but the graded rubric will be blank.

== Future improvements ==

Future improvements may be done in order to:
* Visualize Learning Analytics with graphs and charts during evaluation for each criterion.
* Export evaluation outcomes to various formats.
* Import LA e-Rubrics from known rubric creation tools.
* Provide default rubric templates for faster rubric creation.

== See also ==

=== Moodle Docs ===
* [[Advanced grading methods|Advanced grading methods]] regarding general concepts about advanced grading in Moodle
* [[Rubrics|Moodle Rubrics]] regarding guidelines about using rubrics in a Moodle course

=== Wikipedia ===
* [https://en.wikipedia.org/wiki/Rubric_(academic) Rubric description]
* [https://en.wikipedia.org/wiki/Learning_analytics Learning Analytics]
* [https://en.wikipedia.org/wiki/Educational_data_mining Educational Data Mining]

=== Academic documents ===
* [https://link.springer.com/article/10.1007%2Fs12351-009-0047-5 Enriched assessment rubrics: a new medium for enabling teachers to easily assess student's performance when participating in complex interactive learning scenarios] written by O. Petropoulou, M. Vassilikopoulou and Symeon Retalis published in Operational Research journal
* [https://novapublishers.com/shop/evaluation-in-e-learning/ Evaluation in e-Learning] written by Y. Psaromiligkos, A. Spyridakos and S. Retalis
* [http://earthlab.uoi.gr/thete/index.php/thete/article/view/38 Student evaluation in collaborative educational environments through enriched rubrics] Greek article written by O. Petropoulou, M. Vassilikopoulou and Symeon Retalis, published in Themes in Science and Technology Education journal
* [https://dl.acm.org/citation.cfm?id=2460335 Assessing students' performance using the Learning Analytics Enriched Rubrics] written by I. Dimopoulos, O. Petropoulou and S. Retalis
* [https://research.moodle.net/19/ Using Learning Analytics in Moodle for assessing students’ performance] written by I. Dimopoulos, O. Petropoulou and S. Retalis
* [https://www.researchgate.net/publication/287297028_LAe-R_A_new_learning_analytics_tool_in_moodle_for_assessing_students'_performance LAe-R: A new learning analytics tool in Moodle for assessing students’ performance] written by O. Petropoulou, K. Kasimatis, I. Dimopoulos and S. Retalis
* [https://www.dcu.ie/sites/default/files/smec/pdfs/AKasimata-Using-moodle-and-eassessment-methods-using-a-collaborative-inquiry-learning-scenario.pdf Using Moodle and e-Assessment Methods During a Collaborative Inquiry Learning Scenario] written by A. Kasimatis, O. Petropoulou, S. Retalis, I. Dimopoulos, I. Psaromiligkos and K. Karaggelis

=== Youtube channel ===
* [https://www.youtube.com/user/johnnydpadila/ John Dimopoulos channel on Youtube]

[[el:Learning_Analytics_Enriched_Rubric]]

Template:MediaPlayer

2018-10-30T11:20:31Z

Mudrd8mz: Fix the urlargs parameter syntax (upstream documentation seems to be wrong)

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

Displays an embedded media player of the given YouTube video.

== Syntax ==

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

</noinclude>

Template:MediaPlayer

2018-10-30T11:17:09Z

Mudrd8mz: Improve playing videos on YouTube: (1) prevent the YouTube logo from displaying in the control bar; (2) When playback of the initial video ends, show related videos from the same channel as the video that was just played

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

Displays an embedded media player of the given YouTube video.

== Syntax ==

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

</noinclude>

Calculated multichoice question type

2018-09-11T10:21:37Z

Mudrd8mz: /* Text added to choice */ Add info on distractors

{{Questions}}
Calculated multichoice questions are like multichoice questions with the additional property that the elements to select can include formula results from numeric values that are selected randomly from a set when the quiz is taken.
They use the same wildcards than Calculated questions and their wildcards can be shared with other Calculated multichoice or regular Calculated questions.

The main difference is that text and the formula can be included in the answer choice as {=...}.

===Text added to choice===
In this example we want the student to see text in the answer along with the answer. Given a question written by the teacher as:
Calculate the area of a rectangle where l = {A} cm and h = {B}cm.

The correct answer choice text written by the teacher would be:
The rectangle's area is {={A}*{B}} cm2.

The correct answer's choice will display as:
The rectangle area is 10.0 cm2

The variables picked by the dataset in the example were {A} = 4.0 {B} = 2.5 .

You will also need to provide distractors - additional incorrect options presented to the student to choose from. In this example with rectangle's area, example formulas for incorrect answers could be

The rectangle's area is {={A}*{B}-{B}} cm2.

and

The rectangle's area is {={A}*{B}+{A}} cm2.

===Showing a formula as a choice===
In this example, we want the student to demonstrate they know how to correctly factor out a binomial equation. We want every student to have a unique problem to solve.

For example the teacher enters the question as:
Given the binomial equation 3x2+5xy+2y2, where x = {A} and y={B} how would you simplify it before solving it?

The correct choice would be written:
This polynomial can be reduced to (3*{A}+2*{B})({A}+{B}).

This choice would display as:
This polynomial can be reduced to (3+4)(1+2).

==See also==
These sections in the Calculated question type page are useful.
*[[Calculated_question_type#Wildcards_and_datasets|Handling of the wild cards]], *[[Calculated_question_type#Available_functions|available functions]]

[[Category:Mathematics]]

[[de:Berechnete Multiple-Choice-Fragen]]
[[es:Tipo de Pregunta Calculada mutiopción]]
[[fr:Question calculée à choix multiple]]

Groups

2018-08-22T09:55:10Z

Mudrd8mz: Fix section level

{{Grouping users}}
==Why use groups?==
*You are a teacher in a course where you have several classes and you want to filter your activities and gradebook so you only see one class at a time.
*You are a teacher sharing a course with other teachers and you want to filter your activities and gradebook so you don’t see the students from your colleagues’ classes.
*You want to allocate a particular activity, resource or topic section to just one class or set of users and you don’t want others to see it.
*This [https://youtu.be/pKAFWItexUY screencast about using groups] also highlights the benefits of using groups.

==Group levels==
[[File:groupmodecourse.png|thumb|Groups settings in course settings]]
A group or grouping can be used on two levels:

*Course level - The group mode defined at the course level is the default mode for all activities defined within that course. To use groups you need first to set a group mode in ''Administration > Course administration > Edit settings.''

*Activity level - Each activity that supports groups can also have its own group mode defined. If the course setting "Force group mode" is set to "Yes" then the option to define the group mode for individual activities is not available. If it is set to "No", then the teacher may change the group mode:

===Group modes===

There are three group modes

*No groups - There are no sub groups, everyone is part of one big community
*Separate groups - Each group can only see their own group, others are invisible.
*Visible groups - Each group works in their own group, but can also see other groups. (The other groups' work is read-only.)

For example, enabling either separate or visible groups on an assignment drop-box enables staff to filter the student submissions to see only those from a particular tutor group. With visible groups, students can see which other groups are doing the same activities as they are; with separate groups, they do not know which other groups are doing the same activities.

Using groups with discussion forums allow teachers to restrict interaction between students. Separate groups mean only students in the same group can see and participate in discussions within a particular forum. Visible groups allow students to see other group's discussions, but only participate in their own group's discussions.

'''Note:''' Where visible groups are used or the participant can access all groups, the user's own group is shown first, followed by other groups:

[[File:mygroupsfirst.png]]

==Creating a group==
#Click the 'Create group' button in ''Administration > Course administration > Users > Groups''
#Add a group name and optional description (displayed above the list of group members on the participants page), [[Enrolment key|enrolment key]] and picture (displayed on the participants page and next to forum posts)
#Click the 'Save changes' button
#Select the group to which you want to add participants, then click the 'Add/remove users button
# In the "Potential members" list, select the users you want to add to the group. Multiple users may be selected using the Crtl key.
# Click the Add button to add the users to the group

An optional group ID number (an advanced setting) may be added for matching the group against external systems. Group ID numbers are not displayed anywhere on the site. Within a course, all group ID numbers must be unique. Thus it's not possible to create a group with a duplicate group ID number.

==Auto-create groups==
[[File:autocreategroups.png|thumb|Auto-create groups]]
Groups may be created automatically via the 'Auto-create groups' button in ''Administration > Course administration > Users > Groups''. To see all the settings, click the ''Expand all'' link top right.

===General===
A '''naming scheme''' can be created automatically. # is replaced by sequential numbers, and @ by letters. For example:
*''Group @'' will create group with a naming scheme Group A, Group B, Group C . . .
*''Group #'' will create group with a naming scheme Group 1, Group 2, Group 3 . . .

You can specify if you would like to create
*x number of Groups or
*each group contain x number of students

=== Prevent last small group ===

When selecting '''Members per group''', depending on the number of users in the course, the last group can end up with significantly fewer members than expected. You can select '''Prevent last small group''' to avoid the situation. If the last group would be smaller than 70% of the expected size, it will not be created. Instead, Moodle will allocate additional members to existing groups rather then create a new group with few members.

Example 1:
:You have a course with 80 students and you let auto-create groups with 30 members per group. There would be just 20 students in the third group which is 66% out of expected 30. Moodle will auto-create only two groups with 40 students in each.

Example 2:
:You have a course with 81 students and you let auto-create groups with 30 members per group. Moodle will create three groups with 30, 30 and 21 members respectively because 21 is 70% out of expected 30.

Hint: If you need to customize the 70% ratio used in these calculations on your site, ask your administrator to set the constant `AUTOGROUP_MIN_RATIO` in the main config.php.

define('AUTOGROUP_MIN_RATIO', 0.95); // Means the smallest group will have at least 95% of the expected size.

===Group members===
''Select members from ...'' allows you to choose from roles assigned within the course, available cohorts, groups or groupings.
'''Specify''' and '''Group/Member count''' work together.

The setting 'Select members from cohort' lists all cohorts which users enrolled on the current course are part of. The number in brackets is the number of users enrolled on the course in that cohort.

The 'Ignore users in groups' checkbox should be ticked to only select group members from users that are NOT already in a group in the course.

The 'Include only active enrolments' checkbox provides the option to choose whether to include suspended users in groups. The checkbox is only displayed to users with the [[Capabilities/moodle/course:viewsuspendedusers|capability to view suspended users]].

===Grouping===

'''Create in grouping''' and '''Grouping name''' allows you to create a new grouping and allocate the new auto-created groups to be created to it.

Prior to creating the groups, you can view the groups.

==Restricting an activity, resource or course topic to a particular group==
[[File:group restriction.png|frame|Restricting an activity to a particular group]]
To be able to restrict an activity, resource or course topic to a group, [[Restrict access]] must be enabled. This will result in a 'Restrict access' section in the activity, resource or topic settings and a group restriction can then be added.

==Groups and enrol plugins==

Where groups are created automatically with enrol plugins such as IMS Enterprise, members cannot be unenrolled manually via the groups screen inside a course. This has to be done from the plugin. Additionally, when group members are owned by a plugin like this, there is information below their name on the groups screen.

==Groups overview==

A overview of groups and groupings is available via the Overview tab in ''Administration > Course administration > Users > Groups''.

The table may be filtered to display particular [[Groupings|groupings]] or groups and it will also display students who are ''not'' in a group:
[[File:notinagroup1.png|center]]

==Groups capabilities==

*[[Capabilities/moodle/course:managegroups|Manage groups]]
*[[Capabilities/moodle/site:accessallgroups|Access all groups]]
*[[Capabilities/moodle/calendar:managegroupentries|Manage group calendar entries]]

==See also==

*[[Upload users]] - for importing users into groups
*[[Enrolment key]]

[[de:Gruppen]]
[[fr:Groupes]]
[[ja:グループ]]
[[es:Grupos]]

Groups

2018-08-22T09:54:18Z

Mudrd8mz: Clarify the behaviour of the Prevent last small group setting

{{Grouping users}}
==Why use groups?==
*You are a teacher in a course where you have several classes and you want to filter your activities and gradebook so you only see one class at a time.
*You are a teacher sharing a course with other teachers and you want to filter your activities and gradebook so you don’t see the students from your colleagues’ classes.
*You want to allocate a particular activity, resource or topic section to just one class or set of users and you don’t want others to see it.
*This [https://youtu.be/pKAFWItexUY screencast about using groups] also highlights the benefits of using groups.

==Group levels==
[[File:groupmodecourse.png|thumb|Groups settings in course settings]]
A group or grouping can be used on two levels:

*Course level - The group mode defined at the course level is the default mode for all activities defined within that course. To use groups you need first to set a group mode in ''Administration > Course administration > Edit settings.''

*Activity level - Each activity that supports groups can also have its own group mode defined. If the course setting "Force group mode" is set to "Yes" then the option to define the group mode for individual activities is not available. If it is set to "No", then the teacher may change the group mode:

===Group modes===

There are three group modes

*No groups - There are no sub groups, everyone is part of one big community
*Separate groups - Each group can only see their own group, others are invisible.
*Visible groups - Each group works in their own group, but can also see other groups. (The other groups' work is read-only.)

For example, enabling either separate or visible groups on an assignment drop-box enables staff to filter the student submissions to see only those from a particular tutor group. With visible groups, students can see which other groups are doing the same activities as they are; with separate groups, they do not know which other groups are doing the same activities.

Using groups with discussion forums allow teachers to restrict interaction between students. Separate groups mean only students in the same group can see and participate in discussions within a particular forum. Visible groups allow students to see other group's discussions, but only participate in their own group's discussions.

'''Note:''' Where visible groups are used or the participant can access all groups, the user's own group is shown first, followed by other groups:

[[File:mygroupsfirst.png]]

==Creating a group==
#Click the 'Create group' button in ''Administration > Course administration > Users > Groups''
#Add a group name and optional description (displayed above the list of group members on the participants page), [[Enrolment key|enrolment key]] and picture (displayed on the participants page and next to forum posts)
#Click the 'Save changes' button
#Select the group to which you want to add participants, then click the 'Add/remove users button
# In the "Potential members" list, select the users you want to add to the group. Multiple users may be selected using the Crtl key.
# Click the Add button to add the users to the group

An optional group ID number (an advanced setting) may be added for matching the group against external systems. Group ID numbers are not displayed anywhere on the site. Within a course, all group ID numbers must be unique. Thus it's not possible to create a group with a duplicate group ID number.

==Auto-create groups==
[[File:autocreategroups.png|thumb|Auto-create groups]]
Groups may be created automatically via the 'Auto-create groups' button in ''Administration > Course administration > Users > Groups''. To see all the settings, click the ''Expand all'' link top right.

===General===
A '''naming scheme''' can be created automatically. # is replaced by sequential numbers, and @ by letters. For example:
*''Group @'' will create group with a naming scheme Group A, Group B, Group C . . .
*''Group #'' will create group with a naming scheme Group 1, Group 2, Group 3 . . .

You can specify if you would like to create
*x number of Groups or
*each group contain x number of students

==== Prevent last small group ====

When selecting '''Members per group''', depending on the number of users in the course, the last group can end up with significantly fewer members than expected. You can select '''Prevent last small group''' to avoid the situation. If the last group would be smaller than 70% of the expected size, it will not be created. Instead, Moodle will allocate additional members to existing groups rather then create a new group with few members.

Example 1:
:You have a course with 80 students and you let auto-create groups with 30 members per group. There would be just 20 students in the third group which is 66% out of expected 30. Moodle will auto-create only two groups with 40 students in each.

Example 2:
:You have a course with 81 students and you let auto-create groups with 30 members per group. Moodle will create three groups with 30, 30 and 21 members respectively because 21 is 70% out of expected 30.

Hint: If you need to customize the 70% ratio used in these calculations on your site, ask your administrator to set the constant `AUTOGROUP_MIN_RATIO` in the main config.php.

define('AUTOGROUP_MIN_RATIO', 0.95); // Means the smallest group will have at least 95% of the expected size.

===Group members===
''Select members from ...'' allows you to choose from roles assigned within the course, available cohorts, groups or groupings.
'''Specify''' and '''Group/Member count''' work together.

The setting 'Select members from cohort' lists all cohorts which users enrolled on the current course are part of. The number in brackets is the number of users enrolled on the course in that cohort.

The 'Ignore users in groups' checkbox should be ticked to only select group members from users that are NOT already in a group in the course.

The 'Include only active enrolments' checkbox provides the option to choose whether to include suspended users in groups. The checkbox is only displayed to users with the [[Capabilities/moodle/course:viewsuspendedusers|capability to view suspended users]].

===Grouping===

'''Create in grouping''' and '''Grouping name''' allows you to create a new grouping and allocate the new auto-created groups to be created to it.

Prior to creating the groups, you can view the groups.

==Restricting an activity, resource or course topic to a particular group==
[[File:group restriction.png|frame|Restricting an activity to a particular group]]
To be able to restrict an activity, resource or course topic to a group, [[Restrict access]] must be enabled. This will result in a 'Restrict access' section in the activity, resource or topic settings and a group restriction can then be added.

==Groups and enrol plugins==

Where groups are created automatically with enrol plugins such as IMS Enterprise, members cannot be unenrolled manually via the groups screen inside a course. This has to be done from the plugin. Additionally, when group members are owned by a plugin like this, there is information below their name on the groups screen.

==Groups overview==

A overview of groups and groupings is available via the Overview tab in ''Administration > Course administration > Users > Groups''.

The table may be filtered to display particular [[Groupings|groupings]] or groups and it will also display students who are ''not'' in a group:
[[File:notinagroup1.png|center]]

==Groups capabilities==

*[[Capabilities/moodle/course:managegroups|Manage groups]]
*[[Capabilities/moodle/site:accessallgroups|Access all groups]]
*[[Capabilities/moodle/calendar:managegroupentries|Manage group calendar entries]]

==See also==

*[[Upload users]] - for importing users into groups
*[[Enrolment key]]

[[de:Gruppen]]
[[fr:Groupes]]
[[ja:グループ]]
[[es:Grupos]]

PayPal enrolment

2018-02-27T21:55:30Z

Mudrd8mz: Remove the legacy part on replacing the dollar icon.gif

{{Enrolment}}
The PayPal enrolment plugin allows users to pay for courses and then be automatically enrolled.

==PayPal side setup==

# Create a PayPal account at https://www.paypal.com
#* Although not required, it may be wise to upgrade your account to "Premier" status and get "Verified".
# Set the encoding to UFT-8.
#* Go to Profile > Profile and settings > My selling tools > More selling tools > PayPal button language encoding
#* Make sure you have your website's language set to Western European Languages
#* Click the "More Options" button
#* Set encoding to "UTF-8" and let the same encoding be used for IPN, too.
# Enable instant payment notifications (IPN)
#* Go to Profile > Profile and settings > My selling tools > Getting paid and managing my risk > Instant payment notifications > Update
#* Turn IPN on and set the notification URL to your site's enrol/paypal/ipn.php (so it reads for example like <nowiki>https://my.school.edu/moodle/enrol/paypal/ipn.php</nowiki>).

You may wish to log in to https://developer.paypal.com/developer/accounts/ and experiment with PayPal Sandbox first. If doing do, put this to your config.php:

$CFG->usepaypalsandbox = 1;

==Enabling PayPal enrolment==

An administrator can enable PayPal file enrolment as follows:

# ''Go to Site administration > Plugins > Enrolments > Manage enrol plugins'' and click the eye icon opposite PayPal. When enabled, it will no longer be greyed out. [[Manual enrolment]] must also be enabled, since the PayPal plugin requires it.
# Click the settings link, configure as required (see details of settings below), then click the 'Save changes' button.

* PayPal business email - This setting is case sensitive and must exactly match that in PayPal
* Default role assignment - This means the role that a new user will automatically be given in a course when they purchase access. Usually this would be "student" unless you have a special reason for choosing another role. As for other default settings, it may be overridden in individual courses.

Tip: If you wish to allow users to create their own accounts on your site then you need to set up [[Email-based_self-registration|Email based self registration]].

==Course settings for PayPal==

===Checking you have PayPal in your course===

# If you are using the [[Boost theme]], click the gear menu from the Participants link and then click Enrolment methods. If you are using a different theme, go to ''Course administration > Users > Enrolment methods''
# If you do not see PayPal, use the pull down menu "Add method" and select PayPal
# Make sure PayPal has its "eye" opened:

[[File:Paypalenrolmentmethod.png]]
{{Note|Make sure you don't have [[Self enrolment]] enabled as this would allow users to access the course without paying. If you do need some users to self enrol for free, then add an [[Enrolment key]] in the self enrolment settings.}}

===Setting a price for your course===

# In ''Course Administration > Users > Enrolment methods'', click the edit/hand/pen icon to the right of the PayPal option.
# Optional: Give a name to this enrolment method if you wish in "Custom Instance name"
# Ensure that "Allow PayPal enrolments" is set to "yes"
# In "Enrol cost", type in the cost of your course and in "Currency" choose your currency.
# Usually you would leave the "Assign role" as "student" unless you have a very special reason for allowing your users to enrol as, say, editing teachers etc
# Choose an enrolment period and/or start/end dates if desired.
# Click the "Save changes" button.

[[File:Paypalcoursesettings.png]]

===What the new user sees===

When a new user clicks on your course link, they will see a message inviting them to go to PayPal to purchase access to the course. In the list of courses, PayPal courses have a "P" icon next to them.
{|
| [[File:Paypaluserview.png|frame|left|Message inviting user to pay via PayPal]]
| [[File:Paypalicon.png|frame|left|PayPal course listed with "P" icon]]
|}

==PayPal capabilities==

*[[Capabilities/enrol/paypal:config|Configure PayPal enrol instances]]
*[[Capabilities/enrol/paypal:manage|Manage enrolled users]]
*[[Capabilities/enrol/paypal:unenrol|Unenrol users from course]]
*[[Capabilities/enrol/paypal:unenrolself|Unenrol self from the course]]

== See also ==
*[http://moodle.org/mod/forum/discuss.php?d=171745#p977221 Testing the PayPal plugin in the PayPal Sandbox]

[[de:Paypal-Einschreibung]]
[[es:Inscripción por Paypal]]
[[fr:Inscription Paypal]]

PayPal enrolment

2018-02-27T21:51:38Z

Mudrd8mz: /* What the new user sees */ PayPal enrolment does not use a dollar icon any more

{{Enrolment}}
The PayPal enrolment plugin allows users to pay for courses and then be automatically enrolled.

==PayPal side setup==

# Create a PayPal account at https://www.paypal.com
#* Although not required, it may be wise to upgrade your account to "Premier" status and get "Verified".
# Set the encoding to UFT-8.
#* Go to Profile > Profile and settings > My selling tools > More selling tools > PayPal button language encoding
#* Make sure you have your website's language set to Western European Languages
#* Click the "More Options" button
#* Set encoding to "UTF-8" and let the same encoding be used for IPN, too.
# Enable instant payment notifications (IPN)
#* Go to Profile > Profile and settings > My selling tools > Getting paid and managing my risk > Instant payment notifications > Update
#* Turn IPN on and set the notification URL to your site's enrol/paypal/ipn.php (so it reads for example like <nowiki>https://my.school.edu/moodle/enrol/paypal/ipn.php</nowiki>).

You may wish to log in to https://developer.paypal.com/developer/accounts/ and experiment with PayPal Sandbox first. If doing do, put this to your config.php:

$CFG->usepaypalsandbox = 1;

==Enabling PayPal enrolment==

An administrator can enable PayPal file enrolment as follows:

# ''Go to Site administration > Plugins > Enrolments > Manage enrol plugins'' and click the eye icon opposite PayPal. When enabled, it will no longer be greyed out. [[Manual enrolment]] must also be enabled, since the PayPal plugin requires it.
# Click the settings link, configure as required (see details of settings below), then click the 'Save changes' button.

* PayPal business email - This setting is case sensitive and must exactly match that in PayPal
* Default role assignment - This means the role that a new user will automatically be given in a course when they purchase access. Usually this would be "student" unless you have a special reason for choosing another role. As for other default settings, it may be overridden in individual courses.

Tip: If you wish to allow users to create their own accounts on your site then you need to set up [[Email-based_self-registration|Email based self registration]].

==Course settings for PayPal==

===Checking you have PayPal in your course===

# If you are using the [[Boost theme]], click the gear menu from the Participants link and then click Enrolment methods. If you are using a different theme, go to ''Course administration > Users > Enrolment methods''
# If you do not see PayPal, use the pull down menu "Add method" and select PayPal
# Make sure PayPal has its "eye" opened:

[[File:Paypalenrolmentmethod.png]]
{{Note|Make sure you don't have [[Self enrolment]] enabled as this would allow users to access the course without paying. If you do need some users to self enrol for free, then add an [[Enrolment key]] in the self enrolment settings.}}

===Setting a price for your course===

# In ''Course Administration > Users > Enrolment methods'', click the edit/hand/pen icon to the right of the PayPal option.
# Optional: Give a name to this enrolment method if you wish in "Custom Instance name"
# Ensure that "Allow PayPal enrolments" is set to "yes"
# In "Enrol cost", type in the cost of your course and in "Currency" choose your currency.
# Usually you would leave the "Assign role" as "student" unless you have a very special reason for allowing your users to enrol as, say, editing teachers etc
# Choose an enrolment period and/or start/end dates if desired.
# Click the "Save changes" button.

[[File:Paypalcoursesettings.png]]

===What the new user sees===

When a new user clicks on your course link, they will see a message inviting them to go to PayPal to purchase access to the course. In the list of courses, PayPal courses have a "P" icon next to them.
{|
| [[File:Paypaluserview.png|frame|left|Message inviting user to pay via PayPal]]
| [[File:Paypalicon.png|frame|left|PayPal course listed with "P" icon]]
|}

==Changing the dollar symbol==
[[File:PaypalGBP.png|frame|PayPal course listed with GBP sign icon]]
The default currency symbol for PayPal is a dollar sign. If you are using GBP or Euros or another currency, you can change this by creating your own customised icon with your choice of currency. Make it 16x 16 pixels and call it ''icon.gif'' Upload your new icon via FTP to your ''moodle directory>enrol>paypal>pix''. Your icon.gif will override the dollar sign. Make sure you refresh your page to be sure of the changes.

==PayPal capabilities==

*[[Capabilities/enrol/paypal:config|Configure PayPal enrol instances]]
*[[Capabilities/enrol/paypal:manage|Manage enrolled users]]
*[[Capabilities/enrol/paypal:unenrol|Unenrol users from course]]
*[[Capabilities/enrol/paypal:unenrolself|Unenrol self from the course]]

== See also ==
*[http://moodle.org/mod/forum/discuss.php?d=171745#p977221 Testing the PayPal plugin in the PayPal Sandbox]

[[de:Paypal-Einschreibung]]
[[es:Inscripción por Paypal]]
[[fr:Inscription Paypal]]

File:Paypalicon.png

2018-02-27T21:48:26Z

Mudrd8mz: Mudrd8mz uploaded a new version of File:Paypalicon.png

screenshot of PayPal icon on a Moodle front page

PayPal enrolment

2018-02-27T21:43:02Z

Mudrd8mz: /* PayPal account creation */ Update the instructions for setting up the PayPal

{{Enrolment}}
The PayPal enrolment plugin allows users to pay for courses and then be automatically enrolled.

==PayPal side setup==

# Create a PayPal account at https://www.paypal.com
#* Although not required, it may be wise to upgrade your account to "Premier" status and get "Verified".
# Set the encoding to UFT-8.
#* Go to Profile > Profile and settings > My selling tools > More selling tools > PayPal button language encoding
#* Make sure you have your website's language set to Western European Languages
#* Click the "More Options" button
#* Set encoding to "UTF-8" and let the same encoding be used for IPN, too.
# Enable instant payment notifications (IPN)
#* Go to Profile > Profile and settings > My selling tools > Getting paid and managing my risk > Instant payment notifications > Update
#* Turn IPN on and set the notification URL to your site's enrol/paypal/ipn.php (so it reads for example like <nowiki>https://my.school.edu/moodle/enrol/paypal/ipn.php</nowiki>).

You may wish to log in to https://developer.paypal.com/developer/accounts/ and experiment with PayPal Sandbox first. If doing do, put this to your config.php:

$CFG->usepaypalsandbox = 1;

==Enabling PayPal enrolment==

An administrator can enable PayPal file enrolment as follows:

# ''Go to Site administration > Plugins > Enrolments > Manage enrol plugins'' and click the eye icon opposite PayPal. When enabled, it will no longer be greyed out. [[Manual enrolment]] must also be enabled, since the PayPal plugin requires it.
# Click the settings link, configure as required (see details of settings below), then click the 'Save changes' button.

* PayPal business email - This setting is case sensitive and must exactly match that in PayPal
* Default role assignment - This means the role that a new user will automatically be given in a course when they purchase access. Usually this would be "student" unless you have a special reason for choosing another role. As for other default settings, it may be overridden in individual courses.

Tip: If you wish to allow users to create their own accounts on your site then you need to set up [[Email-based_self-registration|Email based self registration]].

==Course settings for PayPal==

===Checking you have PayPal in your course===

# If you are using the [[Boost theme]], click the gear menu from the Participants link and then click Enrolment methods. If you are using a different theme, go to ''Course administration > Users > Enrolment methods''
# If you do not see PayPal, use the pull down menu "Add method" and select PayPal
# Make sure PayPal has its "eye" opened:

[[File:Paypalenrolmentmethod.png]]
{{Note|Make sure you don't have [[Self enrolment]] enabled as this would allow users to access the course without paying. If you do need some users to self enrol for free, then add an [[Enrolment key]] in the self enrolment settings.}}

===Setting a price for your course===

# In ''Course Administration > Users > Enrolment methods'', click the edit/hand/pen icon to the right of the PayPal option.
# Optional: Give a name to this enrolment method if you wish in "Custom Instance name"
# Ensure that "Allow PayPal enrolments" is set to "yes"
# In "Enrol cost", type in the cost of your course and in "Currency" choose your currency.
# Usually you would leave the "Assign role" as "student" unless you have a very special reason for allowing your users to enrol as, say, editing teachers etc
# Choose an enrolment period and/or start/end dates if desired.
# Click the "Save changes" button.

[[File:Paypalcoursesettings.png]]

===What the new user sees===

When a new user clicks on your course link, they will see a message inviting them to go to PayPal to purchase access to the course. In the list of courses, PayPal courses have a dollar sign icon next to them.
{|
| [[File:Paypaluserview.png|frame|left|Message inviting user to pay via PayPal]]
| [[File:Paypalicon.png|frame|left|PayPal course listed with dollar sign icon]]
|}

==Changing the dollar symbol==
[[File:PaypalGBP.png|frame|PayPal course listed with GBP sign icon]]
The default currency symbol for PayPal is a dollar sign. If you are using GBP or Euros or another currency, you can change this by creating your own customised icon with your choice of currency. Make it 16x 16 pixels and call it ''icon.gif'' Upload your new icon via FTP to your ''moodle directory>enrol>paypal>pix''. Your icon.gif will override the dollar sign. Make sure you refresh your page to be sure of the changes.

==PayPal capabilities==

*[[Capabilities/enrol/paypal:config|Configure PayPal enrol instances]]
*[[Capabilities/enrol/paypal:manage|Manage enrolled users]]
*[[Capabilities/enrol/paypal:unenrol|Unenrol users from course]]
*[[Capabilities/enrol/paypal:unenrolself|Unenrol self from the course]]

== See also ==
*[http://moodle.org/mod/forum/discuss.php?d=171745#p977221 Testing the PayPal plugin in the PayPal Sandbox]

[[de:Paypal-Einschreibung]]
[[es:Inscripción por Paypal]]
[[fr:Inscription Paypal]]

EQUELLA repository

2018-01-31T20:49:07Z

Mudrd8mz: Provide link to equella.github.io guides

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

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

==Requirements==

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

==Setup==

Warning: This page may be outdated. Please see https://equella.github.io/guides/MoodleIntegrationGuide.html

===EQUELLA configuration===

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

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

For further information, please consult the [http://support.thelearningedge.com.au/downloads/5.2/Documentation/EQUELLA%205.2%20Moodle%20Configuration%20Guide.pdf EQUELLA Moodle Configuration Guide].

===Moodle configuration===

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

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

==Capabilities==

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

==See also==

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

[[de:EQUELLA Repository]]

GDPR

2018-01-11T21:02:59Z

Mudrd8mz: Redirect to the existing page

#REDIRECT [[:dev:GDPR for Administrators]]

GDPR

2018-01-11T20:37:41Z

Mudrd8mz: Create a page for the future guidelines on making the Moodle site complying with GDPR.

'''GDPR''' - General Data Protection Regulation is a regulation intended to strengthen and unify data protection for all individuals within the European Union (EU). GDPR becomes enforceable from 25 May 2018. It affects any Moodle site used by EU citizens, even if the site itself is not hosted in the EU.

This page will provide guidelines on how to make a Moodle site complying with the GDPR regulations. It is a work in progress at the moment to be finished around March - April 2018.

=== See also ===

* [https://en.wikipedia.org/wiki/General_Data_Protection_Regulation General Data Protection Regulation] article on wikipedia
* [https://www.eugdpr.org/ Home Page of EU GDPR]

MoodleNet

2017-11-15T08:57:22Z

Mudrd8mz: Added a disambiguation note to avoid confusion with MNet technology

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

* Note: shorter, easier-to-remember URL for this page: '''https://moodle.com/moodlenet'''
* Note: This page describes a new project started in 2017 to improve the features provided by the moodle.net and moodle.org community portals. For the legacy mechanism of inter-connecting multiple Moodle and Mahara sites into a network, please see the [[MNet]] page.

== What is MoodleNet? ==

MoodleNet is currently described by Martin Dougiamas, CEO of Moodle as, "a new open social media platform for educators, focussed on professional development and open content". A visual overview of the intended elements of MoodleNet are given in the diagram below;

[[File:moodlenet-vision.jpeg|800px]]

MoodleNet will be an integral part of the Moodle ecosystem.

[[File:moodlenet-ecosystem.png|800px]]

We'll be building out this page as the MoodleNet project develops.

== MoodleMoot Miami ==

At the MoodleMoot in Miami (November 2017) we ran sessions on MoodleNet. The output of those sessions, including feedback from participants, can be found here: https://docs.moodle.org/38/en/MoodleNet-MootUS17

[[es:MoodleNet]]

Workshop settings

2017-11-09T14:31:30Z

Mudrd8mz: /* Random Allocation */ fix the setting name

{{Workshop}}
==Adding a new workshop==

*With the editing turned on, in the section you wish to add your workshop, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Workshop.''
*On the next screen, in the General section, give the workshop a name and a description which explains to the students what the workshop will be about. You can display this description by ticking the checkbox
*All settings may expanded by clicking the "Expand all" link top right

==Description==
This displays for students on the Workshop's summary page just under the Planner. You can use it to give a brief orientation to the activity (instructions for each phase come later).

==Grading settings==

===Grading Strategy===
What you choose here determines the assessment form students will use and also the strategy for grading submissions. For more detailed descriptions see [[Workshop_grading_strategies| Grading Strategies]]. '''Note:''''' Grading strategies can't be changed once we have entered the submission phase of a workshop''

* ''' Accumulative grading:''' Each assessment criterion has its own numeric grade along with optional weighting and optional comments; a final grade is calculated on the basis of the separate grades and their respective weightings.

* '''Comments:''' No numeric grade but feedback only, as comments either in a single field or as responses to a series of guiding questions.

* '''Number of Errors:''' Markers decide whether the work has passed or failed each criterion (e.g. has original ideas; answers its question). They can comment on their judgements.

* '''Rubric''': Generates a numeric grade based on the level of achievement markers choose for each criterion. You'll be able to define your criteria and, for each criterion, as many levels as you need. (If you need more levels, save the form, then when you edit it again, an extra level will be available.) The Rubric will display with a free text field for Overall Feedback. Do note that Rubric will generate a numeric grade and cannot be set to feedback-only - in other words you will need to assign a single numeric grade to each level, and those marks must be unique. Note too that it is not currently possible to import or reuse rubrics created elsewhere.

===Grade for Submission===
This sets the maximum grade a student can attain from a teacher for a given submission. It is scaled between 0-100. If you have set up any Grade Categories, you will see a picklist.
===Submission grade to pass===
Here you can set a passing grade for the workshop submission. This may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade.

===Grade for Assessment===
Sets the maximum grade a student can receive for assessing other students’ work. It is also scaled between 0-100. If you have set up any Grade Categories, you will see a picklist.
===Assessment grade to pass===

Here you can set a passing grade for the workshop assessment. This may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required grade.

==Submission settings==
===Instructions for submission===
Students see this when they click on the link to the Workshop. Explain here what they need to do to make a successful submission (It may also help to refer them back to general instructions for using the Workshop - how to find out when the deadlines are and what they do at each stage).

If you wish students to attach files, select how many here, up to a maximum of 7. If you leave it at 0 then they can only enter text. You can also specify the maximum upload size of the files they upload - depending on the course limit.

You can also specify which types of file they are allowed to upload. (Ask your admin to check ''Server > File types'' if you want to include an uncommon file type.)

===Late Submissions===

Ticking this box will allow students to submit after the deadline. Any late submissions cannot be edited by the student - they just have one chance to submit.

If late submissions are allowed, you'll need to regularly allocate submissions by clicking the link. You can allocate submissions manually or randomly.

(Allocation settings are explained below - they will be made after these workshop settings have been saved by clicking the “Allocate Submissions” link highlighted with a red box in the picture of the dashboard. See the section [[#Submission phase|Submission phase]].)

[[File:workshopsubmissions33.png|thumb|450px|center|alt="Where to locate more settings for submissions" | Submission settings for allocating reviewers to submissions]]

==Assessment settings==
===Instructions for assessment===
Students see these instructions when the Workshop is in Assessment Phase. They are important to students' understanding of the task before assessing their classmates’ submissions.

After these workshop settings have been saved, Teachers can access further settings related to allocating assessments. See the section [[#Setup phase|Setup phase]].

===Use self-assessment===
Checking this box means that students may be allocated their own work to assess. This will depend on Moodle's allocation i.e. the larger the group of students the less likely it is that anyone will be allocated their own work.

==Feedback==

===Overall feedback mode===
If this is enabled, a text box appears at the bottom of each assessment form for reviewers to give an overall comment about the submission. You can make this required or optional, and you can also specify a number of attachments and maximum upload size of these attached files, dependent on the course upload limit.

You can also specify which file types they are allowed to upload.(Ask your admin to check ''Server > File types'' if you want to include an uncommon file type.)

===Conclusion===
Text you add here will be shown to the students when the workshop is over. It is a good idea to signpost students to how they can access the assessments they have received. It might also include suggestions on what students should do next.

==Example submissions==
In some situations, it might be helpful to the students to see one or more examples of what they must submit. If you offer example submission, you can choose whether students are required to assess them or if is optional. If they are required to assess the example submissions, then you can also decide whether they assess them before they submit their own work or afterwards, but before peer assessing.

Note: Assessments of the example submission are not counted when calculating the grade for assessment.

==Availability==
This section deals with setting submission times and assessment times for the workshop. That is the time when students can start submitting as well as the deadline for submitting, and similarly the time assessments for other students’ work start and when they must finish assessing other students work.

All dates - open for submissions from, submissions deadline, open for assessment from and assessment deadline - are displayed in the course [[Calendar|calendar]].

Availability lets a teacher decide if they want a workshop with a closed schedule or one that is open ended. Setting an opening time but leaving the deadline open makes it an ongoing activity. To set the opening time and deadline for either submissions or assessments teachers must click the enable button next to the option they want to set. Once the enabled has been checked the 5 drop down boxes will be activated and available for change.

The first three boxes correspond to the date and we can either set this box by box or by selecting the date in the calendar that pops up when any of the date boxes are selected.
The last two boxes correspond to the time in 24 hour time, the first of the two being hours and the second being minutes. Teachers simply set the desired time for each of the sections they wish to activate.

If teachers check the box "''Switch to the next phase after the submissions deadline"'', the workshop will automatically switch to the assessment phase after the next cron job.

'''Note that even if Switch to the next phase after the submissions deadline is enabled, a teacher will need to manually move the workshop into Submission Phase and click on Close to conclude the workshop and reveal the assessments.'''

==Common module settings==
See [[Common module settings]]
==Restrict access/Activity completion==
These settings are visible if [[Restrict access]] and [[Activity completion]] have been enabled in the site and the course.

==Click Save and Display to access further settings==

==Setup phase==
{|
|[[Image:Setup assessment form.png|100px]]
|}

*You must now click 'Edit assessment form' to set the criteria students will need for when they do their peer assessments later on.
*''Include an example submission if you want students to be able to see this form when they submit.''
*You can choose from several grading strategies. See [[Workshop grading strategies]] for more information.

==Submission phase==

To decide how students will receive the submissions of their peers, click the 'Allocate submissions' link in the Submission phase section.
{|
|[[File:allocationtypesworkshop.png|thumb|right|upright 1.0|alt="Manual Allocation menu" | Manual Allocation options]]
|[[File:randomallocation.png|thumb|right|upright 1.0|alt="Random Allocation menu" | Random Allocation options]]
|[[File:scheduledallocation.png|thumb|right|upright 1.0|alt="Scheduled Allocation menu|Scheduled Allocation options]]
|}

===Manual Allocation===

Here,a teacher can manually choose which students review whose work. A student can review work even if they have not submitted anything themselves.

===Random Allocation===

The teacher is given 5 settings that determine how the random allocation will work.

* '''Number of reviews:''' Here the teacher picks between 0 and 30 reviews for either each submission or per reviewer. That is the teacher may choose to either set the number of reviews each submission must have or the number of reviews each student has to carry out
* '''Prevent reviews by peers from the same group:''' If the teacher wishes for students of the same group to never review each other’s work, as most likely it is their work too in a group submission, then they can check this box and moodle will ensure that they are only allocated other students out of their group’s work to access
* '''Remove current allocations:''' Checking this box means that any manual allocations that have been set in the Manual Allocation menu will be removed
* '''Can access with no submission:''' Having this box checked allows students to assess other students’ work without having already submitted their own work.
* ''' Add self assessments:''' This options when checked make sure that as well as assessing other students’ work they must also assess their own. This is a good option to teach students how to be objective towards their own work.

===Scheduled Allocation===
If you set the workshop to automatically switch to the Assessment phase once the deadline for submissions is over, then enabling Scheduled allocation means that Moodle will automatically allocate (randomly) the submissions to be assessed. As with manual random allocation, you can specify the number of reviews, whether or not students need to have submitted something in order to be able to assess, and so on.

==Assessment phase==
* '''Examples:''' 
Students can assess example submissions for practice before assessing their peers' work if this feature is enabled. They can compare their assessments with reference assessments made by the teacher. The grade will not be counted in the grade for assessment.

Teachers need to upload one or more example submissions and the corresponding reference assessment to support this function.

Teachers can also edit the reference assessment later by clicking the ‘re-assess’ button in the first page.

*'''Peer assessment:''' 
If this feature is enabled, a student will be allocated a certain amount of submissions from his peers to assess. He will receive a grade for each assessment, which will be added together with the grade for his own submission and this will be used as his final grade for this assignment.

This is the key feature of workshop: To encourage students to assess the work of their peers and learn from each other. Through this, they will see the strengths of their classmates’ submissions and have a better understanding about how to do a good job. In addition, the advices they get from their peers will give them a more comprehensive view of their own work: The comments from their peers will point out the weakness of their work, which is generally difficult to find out by themselves.

* '''Self-assessment:''' 
If this option is turned on, a student may be allocated his own work to assess. The grade he receives from assessment of his own work will be counted into the grade for assessment, which will be added together with the grade for submission and used to calculate his final grade for this assignment.

This setting enables teachers to see whether students can find out the strength and weakness of their own submissions and judge them objectively. It is a good way to help students think more comprehensively.

==Grading evaluation phase==

===Grading evaluation settings===
{|
|[[Image:gradingevaluation25.png|200px|thumb|Grading evaluation settings]]
|}
Here you can choose your settings for calculation of the grade for assessments.

===Grade calculation method===
This setting determines how to calculate grade for assessments. Currently there is only one option- ''comparison with the best assessment''.

The ''Comparison with the best assessment'' tries to imagine what a hypothetical absolutely fair assessment would look like.

For example, a teacher uses ''Number of errors'' as grading strategy to peer-assess one assignment. This strategy uses a couple of assertions and assessors just need to check if the given assertion is passed or failed. That is, they only need to choose ‘yes’ or ‘no’ for each criterion in the assessment form. In this case, there are three assessors, Alice, Bob and Cindy. And the assessment form contains three criteria. The author will get 100% grade if all the criteria are passed, 75% if two criteria are passed, 25% if only one criterion is passed and 0% if the assessor gives ‘no’ for all three assertions. Here are the assessments they give to one certain work:

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

Then the best assessment will be: 
Yes/yes/no 

Second, the workshop will give the best assessment 100% grade. Next it will measure the ‘distance’ from other assessments to this best assessment. The farther the distance, the lower grade the assessment will receive. And ''Comparison of assessments'' setting, next to the ''Grade evaluation setting'', will determine how quickly the grade falls down if the assessment differs from the best one.

''Note'': ''Comparison with the best assessment'' method will compare responses to each individual criterion instead of comparing the final grades. In the example above, all of the three assessors give 75% to the submission. However, only Alice and Bob will get 100% grade for their assessments, while Cindy will get a lower grade. Because Alice and Bob agree in individual responses too, while the responses in Cindy’s assessment are different.
*'''Comparison of assessments:'''
This setting has 5 options: ''very lax'', ''lax'', ''fair'', ''strict'' and ''very strict''. It specifies how strict the comparison of assessment should be. By using ''comparison with the best assessment'' method, all assessments will be compared with the best assessment picked up by workshop. The more similar one assessment is with the best assessment, the higher grade this assessment will get, and vice versa. This setting determines how quickly the grades fall down when the assessments differ from the best assessment.

====Workshop toolbox====
{|
|[[Image:Workshop toolbox.png|thumb|Workshop toolbox]]
|}

====Clear all aggregated grades====
Clicking this button will reset aggregated grades for submission and grades for assessment. Teachers can re-calculate these grades from scratch in Grade evaluation phase.

====Clear assessments====
By clicking this button, grades for assessments along with grades for submission will be reset. The assessment form will remain the same but all the reviewers need to open the assessment form again and re-save it to get the given grades calculated again.

==Site administration settings==

The workshop module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Workshop''. The settings enable default values to be set for all edit workshop settings.

==See also==

* http://rubistar.4teachers.org/ - a free tool to help teachers create rubrics

[[de:Gegenseitige Beurteilung konfigurieren]]
[[es:Configuraciones de taller]]

Upgrading

2017-11-08T11:06:23Z

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

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

==Check the requirements==

Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.0 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/30/en/Upgrading_to_Moodle_3.0 upgrade to 3.0] as a first step.
* The minimum PHP version has increased and is now 7.0.0.
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended).

==Before upgrading==

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

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

== Backup important data ==

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

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

== Check for plugin updates ==

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

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

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

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

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

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

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

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

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

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

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

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

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

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

=== Using Git ===

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

===Command line upgrade===

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

== Finishing the upgrade ==

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

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

To do this just go to ''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, 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.

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

* You cannot run your Moodle 3.4 site on PHP 5.6 or lower (please refer to requirements section for details).
* Some authentication methods were removed from the standard distribution (fc, imap, nntp, pam, pop3). If you use them, you must provide them manually during the upgrade (MDL-50925).
* The Messages block has been removed from the standard distribution (MDL-57115).

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

=== Moodle 3.1, 3.2 and 3.3 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/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]

==See also==

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

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

Upgrading

2017-11-08T10:57:59Z

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

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

==Check the requirements==

Check that your server meets all requirements for {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

See the [{{Release notes}} release notes] in the dev docs for software requirements.

Notes:

* You can only upgrade to Moodle {{Version}} from Moodle 3.0 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/30/en/Upgrading_to_Moodle_3.0 upgrade to 3.0] as a first step.
* The minimum PHP version has increased and is now 7.0.0.
* The PHP extension '''intl''' is now required in Moodle 3.4 (previously it was only recommended).

==Before upgrading==

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

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

== Backup important data ==

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

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

== Check for plugin updates ==

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

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

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

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

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

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

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

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

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

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

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

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

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

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

=== Using Git ===

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

===Command line upgrade===

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

== Finishing the upgrade ==

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

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

To do this just go to ''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, 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.

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

* Moodle now requires PHP 7.0 and will not work any more on lower versions.
* PHP extension '''intl''' is now required (it was recommended in previous versions).
* Some authentication methods were removed from the core (fc, imap, nntp, pam, pop3. If you use them, you must provide them manually during the upgrade (MDL-50925)

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

=== Moodle 3.1, 3.2 and 3.3 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/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]
* [https://docs.moodle.org/33/en/Upgrading Upgrading to Moodle 3.3]

==See also==

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

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

Course search

2017-10-26T12:22:33Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Work_in_progress}}
{{Infobox plugin
|type = Course search plugin
|entry = https://moodle.org/plugins/view.php?plugin=tool_coursesearch
|tracker = https://tracker.moodle.org/browse/CONTRIB-4335
|discussion = https://moodle.org/mod/forum/discuss.php?d=230469
|maintainer = [https://moodle.org/user/profile.php?id=1565325 Shashikant Vaishnav]
|float = right
}}

== Introduction ==

'''"Advance course search"''' is a plugin that makes course search more flexible, fast , case-insensitive and can sort results by relevance. The plugin
also have the capability to search into course attachments(course overview files and summary files). Its gives more powerful way of searching
into courses via features like results caching, Sorting with different aspects, spelling correction(Did you mean?) feature, fuzzy search
(alternate form of words).

== Installation ==

{{MediaPlayer | url = http://www.youtube.com/watch?feature=player_embedded&v=oe2KgGznnBg}}

=== Prerequisite ===

Java 5 or higher (a.k.a. 1.5.x), PHP 5.1.4 or higher, moodle 2.5 or higher.

=== Installing admin tool ===

1. Download the admin tool from here. (https://moodle.org/plugins/view.php?plugin=tool_coursesearch)

2. Extract the Course Search folder. Put it under moodle installation/admin/tool directory.

3. It should be named coursesearch. If you are already logged in just refreshing the browser should trigger your moodle
site to begin the install 'Plugins Check'.

4. If not then navigate to Administration > Notifications.

=== Installing search_cleantheme OR replacing/copying the renderer.php file ===

Here is two options either you may replace/copy your existing theme renderer with the one found in
search_cleantheme(https://github.com/shashirepo/moodle-theme_cleantheme).
OR you may install cleantheme itself.

replacing /copying the renderer file to your theme.

1. Copy renderer.php file from search_cleantheme replace it with your theme's renderer file.

2. Standard moodle theme doesn't have any renderer file so you may simply copy this to your
theme directory.

3. Rename renderer class name according to your theme name.

for example if you are using theme 'clean'.
then rename the class names to 'theme_clean_core_renderer' & 'theme_clean_core_course_renderer'.

OR you may either use search_cleantheme. This is based on bootstrap clean theme.

1. Download the cleantheme from here (https://github.com/shashirepo/moodle-theme_cleantheme)

2. Extract the theme folder. and put it under moodle installation theme directory.

3. If you are already logged in just refreshing the browser should trigger your Moodle
site to begin the install 'Plugins Check'.

4. If not then navigate to Administration > Notifications.

=== Installing Solr & placing the plugin Schema ===

Download the latest Solr 4.4.0 release from:
http://lucene.apache.org/solr/

Unpack the tarball somewhere not visible to the web (not in your apache docroot
and not inside of your moodle directory).

The Solr download comes with an example application that you can use for
testing, development, and even for smaller production sites. This
application is found at apache-solr-4.4.0/example.

Move apache-solr-4.4.0/example/solr/collection1/conf/schema.xml and rename it to
something like schema.bak. Then move the schema.xml that comes
with moodle course search admin tool plugin to take its place.

Similarly, move apache-solr-4.4.0/example/solr/collection1/conf/solrconfig.xml and rename
it like solrconfig.bak. Then move the solrconfig.xml that comes with the
moodle course search admin tool plugin to take its place.

Finally, move apache-solr-4.4.0/example/solr/collection1/conf/protwords.txt and rename
it like protwords.bak. Then move the protwords.txt that comes with the
moodle course search admin tool plugin to take its place.

Make sure that the conf directory includes the following files - the Solr core
may not load if you don't have at least an empty file present:
solrconfig.xml
schema.xml
elevate.xml
mapping-ISOLatin1Accent.txt
protwords.txt
stopwords.txt
synonyms.txt

Now start the solr application by opening a shell, changing directory to
apache-solr-4.4.0/example, and executing the command java -jar start.jar

Test that your solr server is now available by visiting
http://localhost:8983/solr/admin/

=== Testing with ping to solr ===

1. Advance Course can be found under :-

Administration->course->Course search settings(URL:- http://127.0.0.1/MoodleInstalltionURL/admin/tool/coursesearch)

2. Give the solr configuration options here:-

Solr Host:- localhost or 127.0.0.1
Solr Port:- 8983 (Default port for Solr )
Solr path :- /solr (Configuration directory for solr)

3. Click on "Check Solr instance Setting". if it Shows ping successful(with an success image). Now click save changes.

4. Now click on "Index courses" to index all the courses. After successful indexing. It will come up with a success image.

5. Click on "Optimize" to optimize the existing indexes And improve solr performance.

Enjoy the Search by going on page (http://127.0.0.1/MoodleInstallationURL/course/search.php)

To configure navigation with the course search page goto Site administration -> Front page -> Front page settings.

== Features ==

* works consistently on different DB engines and different content languages( Non latin languages support)

* Search results with relevance( Score )

* Case insensitive search capability

* Searchable Document Formats

* Hyper Text Markup Language
* XML and derived formats
* Microsoft Office document formats
* Open Document Format
* Portable Document Format
* Rich Text Format
* Compression and packaging formats [See Rebuilding Solr Cell]
* Text formats

* Autocomplete ( autosuggest with non-latin languages too )

* Very fast than existing course search implementation.

* Spell Checking capability ( Did you mean ?)

* Keyword Matching (Searching within specific field)

Example :- "summary:Getting started with python" searches for the "Getting started with python" in summary field of courses.

* Proximity Search

Example :- "moodle perth"~4 Search for "moodle perth" within 4 words from each other.

* Wildcard Search

* Fuzzy search support ( Alternate form of words )

* Filtering results by startdate (Range queries)

* Pagination & sorting results by relevance, startdate, shortname.

== How it works ? ==

* '''Flow diagram'''

[[File:coursesearch_flow.png]]

== How to report a bug ==

Please, use Tracker[https://tracker.moodle.org/browse/CONTRIB-4335]

== Credits ==

* '''Mentors:''' [https://moodle.org/user/profile.php?id=1334243&course=5 Marina Glancy] & [https://moodle.org/user/profile.php?id=381842 Michael de Raadt]

== See also ==

* [https://docs.moodle.org/dev/GSOC/2013 Moodle GSoC projects for 2013]
* [https://docs.moodle.org/dev/GSOC Moodle GSoC Overview page]
* [http://www.google-melange.com/gsoc/proposal/review/google/gsoc2013/shashitechno/1 GSOC Proposal]
* [https://docs.moodle.org/dev/Projects_for_new_developers#Course_search Original idea]

Course sharing

2017-10-26T12:22:33Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Community hubs}}
Publishing a course is a method of sharing your course on a special Moodle site called a community hub. Moodle.net is an example of a community hub.

When you publish a course, you can choose whether to make it available
* for download (as a course backup file) OR
* to enrol in on your site

==Connecting to a community hub==

An administrator first needs to check in ''Administration > Site Administration > Registration'' that your Moodle site is [[Site_registration|registered]] with the community hub(s) that you wish to publish courses to.

Thus, if you'd like to share your course on [http://moodle.net Moodle.net], your site needs to be registered with moodle.org.

Note: Only sites which are publicly available on the Internet can register with moodle.org.

==Publishing a course for download==
[[Image:Backup_publication.png|thumb|First page of the backup process]]

# Go to ''Administration > Course administration > Publish'' (only available to users with the capability [[Capabilities/moodle/course:publish|moodle/course:publish]])
# Click the button 'Share this course for people to download'
# Select the hub where you want to share your course
# Enter information about the course
# Click the 'Upload this course' button
# Select the data to be included in the backup
# Create the course backup

The course will then need to be approved by the hub administrator before it appears in the course listing.

How to upload a Moodle course to Moodle.net video:

{{MediaPlayer | url = http://www.youtube.com/watch?v=nz7_pHkaCoQ}}

===Updating a course backup===

If you improve the course and wish to update the course backup, firstly remove it from the hub, then re-share it. You may also share different versions of the same course.

==Publishing a course for people to enrol in==

You can display a link to your course on any hub your site is registered on. The hub will redirect users your course.

# Go to ''Settings > Course administration > Publish'' (only available to users with the capability [[Capabilities/moodle/course:publish|moodle/course:publish]])
# Click the button 'Advertise this course for people to join'
# Select the hub where you want to advertise your course
# Enter information about the course
# Click the 'Advertise this course' button

The course will then need to be approved by the hub administrator before it appears in the course listing.

You can change the information about the course by clicking the 'Update' button in the actions column.

''Note: You also need to make sure that users can actually enrol in the course you have just published.'' This normally means having [[Email-based self-registration|email-based self-registration]] enabled for the site and enabling [[Self enrolment|self-enrolment]] for the course.

:Tip! When you advertise a course try to make the course easy to see for people not registered on your site (allow [https://docs.moodle.org/en/Course_settings#Guest_access guest access in your course settings] / allow [https://docs.moodle.org/en/User_policies#Auto-login_guest Auto-login guests] / allow people to register themself).

== Hub listing ==

You can check whether your course has been approved by the hub administrator and is listed on the hub as follows:

# Go to ''Settings > Course administration > Publish''
# Click the 'Check it now' link in the hub listing column

Your Moodle site will contact the hub and will then update the status of your course.

[[File:published on list.png]]

==Removing a course from a hub==

If you wish, you can remove your course from a hub at any time.

# Go to ''Settings > Course administration > Publish''
# Click the 'Remove from hub' button in the actions column

==Capabilities==

Only users with the capability [[Capabilities/moodle/course:publish|moodle/course:publish]] (by default only users with the role of manager) can publish their course to a community hub. The capability [[Capabilities/moodle/backup:backuptargethub|moodle/backup:backuptargethub]] is also required for publishing courses for download.

==Enabling teachers to publish their courses==

An administrator can enable teachers to publish their courses on a hub by allowing the capability ''moodle/course:publish'' for the teacher role.

# Go to ''Settings > Site administration > Users > Permissions > Define roles''
# Click the edit icon opposite the teacher role
# On the editing role page, paste ''moodle/course:publish'' into the filter box
# Tick the checkbox opposite ''moodle/course:publish'' to allow the capability
# Click the 'Save changes' button

[[fr:Publier un cours]]
[[ja:コースを公開する]]

Wiki activity

2017-10-26T12:22:32Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Activities}}
A wiki is a collection of collaboratively authored web documents. Basically, a wiki page is a web page everyone in your class can create together, right in the browser, without needing to know HTML. A wiki starts with one front page. Each author can add other pages to the wiki by simply creating a link to a page that doesn't exist yet.

[[Image:Wikiexample.png]]

* [[Wiki settings]]
* [[Using Wiki]]
* [[Wiki_module_FAQ|Wiki FAQ]]

Wikis get their name from the Hawaiian term "wiki wiki," which means "very fast." A wiki is indeed a fast method for creating content as a group. It's a hugely popular format on the Web for creating documents as a group. There is usually no central editor of a wiki, no single person who has final editorial control. Instead, the community edits and develops its own content. Consensus views emerge from the work of many people on a document.

In Moodle, wikis can be a powerful tool for collaborative work. The entire class can edit a document together, creating a class product, or each student can have their own wiki and work on it with you and their classmates.

Wiki in Moodle 2.0 video:

{{MediaPlayer | url = http://www.youtube.com/watch?v=TfkunrqQVS8}}

[[Category:Wiki]]

[[de:Wiki]]
[[es:Wikis]]
[[eu:Wikiak]]
[[fr:Wiki]]
[[ja:Wikiモジュール]]

Stamp collection module

2017-10-26T12:22:30Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{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 | url = http://www.youtube.com/watch?v=eDi_PcMkzZM}}

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

Course formats

2017-10-26T12:22:29Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Courses}}
A course format refers to the layout of a course. The course format can be selected in ''Administration > Course administration > Edit settings''.

An administrator can enable, disable or delete course formats for courses in ''Administration > Site administration > Plugins > Course formats > Manage course formats.'' They can also change the order in which available course formats are displayed to teachers in the course settings.

{|
|[[File:DefaultCourseFormatTopics.png|thumb|Manage course formats screen for admins]]
|}

==Standard course formats==

===Weekly format===
[[Image:Weeklyoutline.png|thumb|Weekly format example]] The course is organized week by week, with a clear start date and a finish date. Moodle will create a section for each week of your course. You can add content, forums, quizzes, and so on in the section for each week.

:''TIP:'' If you want all your students to work on the same materials at the same time, this would be a good format to choose.

:''NOTE:'' Make sure your course start date is correct. If it is not your weeks will have the wrong date on it. This is especially important if you are restoring a course to use with a new section of students.

===Topics format===
[[Image:Topicoutline.png|thumb|Topic format example]]The course is organised into topic sections that a teacher can give titles to. Each topic section consists of activities, resources and labels. In new installations of Moodle, this is the default format.

TIP: This is great to use if your course is objective based and each objective may take different amounts of time to complete. An example of this would be scaffolding where the students are building upon the knowledge from earlier topics.

===="Show only one section"====

With the Weekly, Topics and any contributed format that implements the functionalty, it is possible via ''Administration > Course administration > Edit settings'' to "show one section per page". Here is a course with eight topics, with the third one currently shown. The links left and right lead to topics two and four:

[[Image:Single_section_page.png|frame|center|Single section page]]

''Notes:''
*The course home page shows just the section names and any text in the section description along with activity and resource numbers, with the names being click-able. This is what you see the first time you access the course. Once you have selected a topic by clicking on its name, you then see one section at a time.
*If editing is ON, then the Main course page will display all the content in all the sections.
*There is a 'Jump to...' menu at the bottom of each single section page

===Social format===
This format is oriented around one main [[Forum module|forum]],the social forum, which appears listed on the main page. It is useful for situations that are more free form. They may not even be courses. The [http://moodle.org/course/view.php?id=55 Moodle Lounge] is an example of a social format course.

[[Image:SocialFormatN.png|thumb|center|500px|Social format example - click to enlarge]]

When selecting the social format, it is possible to specify how many discussions you wish to display on the course page:

[[File:socialformatdiscussions.png]]

The social forum can be edited by clicking the 'Update this forum' button on the social forum page. The forum introduction is displayed at the top of the course page. Activities and resources can be added on the side by using the [[Social activities block]].

===Single activity format===
The single activity format only has 1 section, and allows the teacher to add one activity only to the course. When the single activity format is selected, a drop down menu appears for the teacher to choose the activity they wish to use. See the "See also" section below for a screencast and working example of the single activity course format.

{|
|[[File:26singleactivity.png|200px|thumb|Selecting the Single activity format]]
|}

Note: This course format replaces the SCORM format in earlier versions of Moodle, as it is possible here to select a SCORM package as the single activity.

Single activity format with a forum as the activity and social format are very similar. The only difference is when the course contains other activities. The single activity format displays them as "orphaned" and for teachers only; the social format displays them in an activities block and available for students.

==Contributed Course Formats==
The Moodle community has developed a number of course formats, available in the [https://moodle.org/plugins/browse.php?list=category&id=19 plugins directory]. If you plan to create a new one, see [https://docs.moodle.org/dev/Course_formats Developers documentation].

See MDL-27646 and MDL-28555 and maybe the discussion http://moodle.org/mod/forum/discuss.php?d=175758#p770737

===Buttons course format===

The Buttons course format creates a menu with buttons in JavaScript to access the sections, one by one. It has features to create group of sections (example: modules, period) and change the button colors. For more information, please visit [[Buttons course format]].

[[File:Buttons course format 9 buttons section 2.png|600px]]

===Collapsed Topics===

This is a format that is essentially the same as the standard Topic and Weekly formats but with a 'toggle' for each section except '0'. The toggles' purpose is to reduce the amount of initial information presented to the user thus reducing the 'scroll of death' that can plague courses with a lot of content. The 'state' of the toggles is remembered on a per course per user basis. For more information, please visit [[Collapsed_Topics_course_format]].

==== Overview ====

For an overview of 'Collapsed Topics' please see this video:

{{MediaPlayer | url = https://www.youtube.com/watch?v=c9NaEAPPC5E}}

===Daily format===
The [https://moodle.org/plugins/view.php?plugin=format_days daily format] is a modification of the weekly format that shows sections by day rather than by week.

===Grid format===
The [https://moodle.org/plugins/view.php?plugin=format_grid grid format] is a modular and visual course format. Hides all topics and creates a grid of icons (one for each topic) with short titles. Clicking on an icon brings up the content from the corresponding topic in a "lightbox" style display.

===Menutopic format===
The [https://moodle.org/plugins/view.php?plugin=format_menutopic menutopic format] allows you to display the topics/sections in a menu.

===Noticeboard format===
The [https://moodle.org/plugins/view.php?plugin=format_noticebd Noticeboard format] presents the latest post in the news forum at the top of the course.

===Onetopic format===
The [https://moodle.org/plugins/view.php?plugin=format_onetopic onetopic format] shows each topic in a tab, keeping the current tab between calls to resources, in such a way that when it returns from a module as the blog or the glossary it returns to tab from where you started. This format is based on the Moodle standard format: “Topics”.

===Topic format (colors)===
The [https://moodle.org/plugins/view.php?plugin=format_colours colored topic format] is based on the 'Topics' standard format and allows a teacher to specify the foreground and background colours for each course section.

===Flexible sections format===
The [https://moodle.org/plugins/view.php?plugin=format_flexsections flexible sections format] for Moodle 2.4+ allows to have nested sections and each section may be displayed expanded (with all content on the parent section page) or collapsed (as a link to a separate page)

Other contributed course formats are available from the [http://moodle.org/plugins modules and plugins database].

==See also==

*Screencast: [http://www.youtube.com/watch?v=bkdgPGHJi3Q&feature=share&list=SPxcO_MFWQBDe8RRnGjoUDqbcm9PSlIoWn&index=2 Single Activity course format]
*Example of a single activity course format on school.demo.moodle.net: [http://school.demo.moodle.net/mod/quiz/view.php?id=1511 Moodle History Quiz] (Log in with username: ''parent'' and password: ''moodle'')

*Using Moodle [http://moodle.org/mod/forum/view.php?id=47 Course formats forum]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=116428 Social format: where to put an introduction]
*[http://moodle.org/mod/forum/discuss.php?d=136453 RSS Feed for forum in a Social Format course]

[[de:Kursformate]]
[[es:Formatos de curso]]
[[fr:Formats de cours]]

EJSApp

2017-10-26T12:22:28Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

==The EJSApp Set of Plugins==
EJSApp are a set of plugins for Moodle that let you:

* To deploy applications written in [http://www.um.es/fem/EjsWiki/ Easy Java Simulations (EJS)].
* To control user access to the deployed EJS applications and distinguish between virtual labs (or simulations) and remote labs based on Java and/or Javascript.
* To set several resizing options for displaying the embedded EJS applets.
* To personalize the simulations created with EJS for each of your students.
* To backup and restore thanks to Moodle course backups.
* To use cloud storage for any data, image or state file created by the EJS application.
* To create sessions for synchronous collaborative working with the Java applets created with Easy Java Simulations.
* To manage and control the access to EJS remote laboratories by means of a booking system that gets integrated into Moodle.

==EJSApp Activity==

The EJSApp activity plugin allows users to embedd [http://www.um.es/fem/EjsWiki/ Easy Java Simulations (EJS)] applications (such as simulations, virtual and remote laboratories) into a Moodle course. This plugin works with version 2.0 or higher of Moodle.

EJSApp plugin can be downloaded from [https://moodle.org/plugins/view.php?plugin=mod_ejsapp Moodle Plugins Directory] and from [https://github.com/UNEDLabs/moodle-mod_ejsapp Github].

As with any customization, it is recommended that you have a good backup of your Moodle site before attempting to install contributed code. While those contributing code make every effort to provide the best code that they can, using contributed code nevertheless entails a certain degree of risk as contributed code is not as carefully reviewed and/or tested as the Moodle core code.

EJSApp is useful for adding simulations or remote laboratories into your Moodle courses, which is of especial interest for those of scientific or technical nature. More information about EJS and EJSApp can be obtained at [http://www.um.es/fem/EjsWiki/Main/UsingEJSWithMoodle http://www.um.es/fem/EjsWiki/Main/UsingEJSWithMoodle].

===Installation===
* Code - Copy the files into your Moodle mod folder ($CFG->dirroot/mod)

'''WARNING:''' If you are updating ejsapp from a previous version, DO NOT replace/delete your old jarfiles directory inside your old ejsapp directory.

'''IMPORTANT:''' For Unix Moodle servers (e.g., Linux and Mac systems), EJSApp requires that (i) the apache user is the owner of the "jarfiles" dir inside the "ejsapp" dir, and (ii) it has permissions to read, write and execute the jarfiles dir.

The following points describe how to do it:

1) go to the ejsapp dir:
$ cd ejsapp

2) Change the owner of the jarfiles dir to apache.
For instance,
2.a) in Linux CentOS, the apache user is "apache", so you should write
$ chown -R apache jarfiles
2.b) in Linux OpenSuse, the apache user is "wwwrun", so you should write
$ chown -R wwwrun jarfiles

3) Change the permissions of the apache user:
$ chmod -R 700 jarfiles

* Database - Login in as a Moodle Administrator and go to the Administration notifications page to create the required EJSApp tables.

* Settings - During the previous step you will come across the setting configuration page for the EJSApp plugin. Default values might be valid for you. However, read the description of each parameter there and change any value you want. The README.txt file that comes along with the EJSApp plugin has even more information about these parameters.

===Configuration===
When installing ejsapp for the first time, you will need to set six variables:

*''certificate_path'': This variable defines the absolute path to the trust certificate file, if you have one for signing your Java applets.

*''certificate_password'': This variable must contain the password of the trust certificate.

*"certificate_alias": This variable stores the alias given to your trust certificate.

*''sarlab_IP'': This variable defines the IP(s) address(es) of the SARLAB system(s) used for managing the access to the remote laboratories. If left empty, the plugin understands that SARLAB is not used.

*''sarlab_port'': This variable defines the port(s) used to communicate with the SARLAB system(s). If left empty, the plugin understands that SARLAB is not used.

*"sarlab_enc_key": This 16 characters long variable must be configure to match exactly the key set in the SARLAB system(s).

If you are not sure what values you should be setting for these parameters, use the ones by default.

===Languages===
The EJSApp activity plugin is available in:
*English (en_utf8)
*Spanish (es_utf8)

If you would like to supply translations for other languages, please create an issue in the tracker and attach a zip file of the language files.

===Related Plugins===
The EJSApp activity plugin works autonomously and does not require any other plugin to be installed in your Moodle site. However, there are three more plugins (the EJSAppBooking activity plugin and the EJSAppFileBrowser and the EJSAppCollabSession block plugins) that add new features to the system and might enhance the use of your EJS applications embedded into Moodle.

These additional plugins can also be downloaded from the [https://moodle.org/plugins/browse.php?list=set&id=27 EJSApp Set Webpage] at Moodle Plugins Directory and from [https://github.com/UNEDLabs Github].

===Contributor/Maintainer===
The EJSApp activity plugin and the other three mentioned in the ''Related Plugins'' section are contributed and maintained by Luis de la Torre and Rubén Heradio, from the Spanish Open University (UNED).

==EJSApp File Browser==

This plugin is a modification of the "Private Files" block of Moodle and lets Java applets, created with Easy Java Simulations (EJS) and added to a Moodle course by means of the ejsapp module activity, to store data files saved from these applets. It also includes a little
AJAX feature that let users to refresh their files block without refreshing the entire page.

===Installation===
This is a block plugin for Moodle so you should place the ejsapp_file_browser folder in your /blocks folder, inside you Moodle installation.

===Dependencies===
This module needs the ejsapp module to be of any use. It works with version 1.3 (or later) of EJSApp.

===Contributor/Maintainer===
The EJSApp file browser block is contributed and maintained by Luis de la Torre and Rubén Heradio, from the Spanish Open University (UNED).

==EJSApp Collab Sessions==

This plugin lets you to create sessions for synchronous collaborative work with Java applets created with Easy Java Simulations (EJS) and added to a Moodle course by means of the ejsapp activity module.

===Installation===
This is a block plugin for Moodle so you should place the ejsapp_file_browser folder in your /blocks folder, inside you Moodle installation.

===Dependencies===
This module needs the ejsapp module to be of any use. It works with version 1.3 (or later) of EJSApp.

===Contributor/Maintainer===
The EJSApp collaborative sessions block is contributed and maintained by Luis de la Torre and Rubén Heradio, from the Spanish Open University (UNED).

==EJSApp Booking System==

This plugin allows adding a booking system to handle the conections to the remote laboratories developed using EJS and added to a Moodle course using the ejsapp activity module.

===Installation===
This is a module plugin for Moodle so you should place the ejsappbooking folder in your /mod folder, inside you Moodle installation.
This module has been tested in all Moodle 2.x versions.

===Dependencies===
This module needs the ejsapp module to be of any use. It works with version 1.4 (or later) of EJSApp.

===Contributor/Maintainer===
The EJSApp file browser block is contributed and maintained by Luis de la Torre, Rubén Heradio and Francisco José Calvillo, from the Spanish Open University (UNED).

==OSP Repository==

This plugin lets you download any Easy Java (and Javascript) Simulations (EJS) application stored in the vast OSP-Compadre collection (http://www.compadre.org/osp) directly from your Moodle.

===Installation===
This is a repository plugin for Moodle so you should place the osp folder in your /repository folder, inside you Moodle installation.

===Dependencies===
This module DOES NOT need the ejsapp module. That being said, when used in combination with the EJSApp plugin, you will be able not only to access, search and download these applications but also to add them automatically to your Moodle courses as activities. Javascript simulations from the OSP library are only accesible with OSP 1.1 version of this plugin and only get well embedded when EJSApp 1.6 or superior is used.

===Contributor/Maintainer===
The OSP repository plugin is contributed and maintained by Luis de la Torre and Rubén Heradio, from the Spanish Open University (UNED).

==Video tutorials==

===What is EJSApp?===
A general vision of the EJSApp plugins and the ideas behind them.
{{MediaPlayer | url = http://youtu.be/RsRS_ERQs0c}}

===EJSApp: core plugins===
Presenting the EJSApp activity module and the EJSApp File Browser block.
{{MediaPlayer | url = http://youtu.be/Oql5h_ravGE}}

===Collaborative Web-labs===
Presenting the EJSApp Collab Session block and the synchronous collaborative experimental sessions feature of EJS.
{{MediaPlayer | url = http://youtu.be/DOOoq2rUJYE}} (Activate the subtitles!)

===Remote Labs and the EJSApp Booking System===
Keys for configuring your EJS applications in Moodle as remote laboratories and using the EJSApp booking system.
{{MediaPlayer | url = http://youtu.be/YGlTTMmkaC0}}

===What is UNEDLabs?===
A general view of UNEDLabs; a Moodle web portal of collaborative, virtual and remote laboratories.
{{MediaPlayer | url = http://youtu.be/QC6-bmW1Y4c}}

===Easy Java Simulations (EJS) and the ComPADRE library===
A brief description about EJS and how to find and access hundreds of EJS applications for free from the Open Source Physics (OSP) collection at the ComPADRE library.
{{MediaPlayer | url = http://youtu.be/6rUgWDkoZKM}}

==See also==
EJSApp Set Moodle modules webpage: https://moodle.org/plugins/browse.php?list=set&id=27

EJSApp UNEDLabs Github repository: https://github.com/organizations/UNEDLabs

EJSApp Moodle forum discussion: https://moodle.org/mod/forum/discuss.php?d=217163

UNILabs webpage (a Moodle site hosting a network of virtual and remote laboratories based on EJS and EJSApp): http://unilabs.dia.uned.es/

Youtube channel: http://www.youtube.com/user/UNEDLabs

EJSApp tutorial: http://www.um.es/fem/EjsWiki/Main/UsingEJSWithMoodle

EJS webpage: http://www.um.es/fem/EjsWiki/

[[Category:Contributed code]]

Dataform building

2017-10-26T12:22:27Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Dataform | innertrail = ► Creating an Activity }}

==Building a simple activity==
{{MediaPlayer | url = http://www.youtube.com/watch?v=Ab9jLl8ZV90}}

[[es:Dataform Hello World]]

==Preventing participants from viewing other entries==
One setting and two permissions can affect whether the user can is limited to viewing only his/her entries.

===Separate participants by activity setting===
[[File:df-activity-settings-separate-participants.png]]

The activity setting 'Separate participants' set to 'Yes' will restrict all roles which do not have the 'mod/dataform:manageentries' capability to their own entries. By default permissions, that's all roles below editing teacher. This means that non-editing teachers are also restricted to their own entries by this setting. If you want to allow non-editing teachers (graders/TAs) access to certain entries you can use an Entry access rule and set the rule with entry filter to fetch the designated entries and a role override where you assign the designated non-editing teacher to the editing teacher role.

===Separate participants by permission===
[[File:df-activity-permissions-entryanyview.png]]

By default the mod/dataform:entryanyview permission is granted to everyone. You can exclude certain roles in the activity level by removing the role from the permission (Prevent), or by adding the role under Prohibited. Note that if you want to then grant the permission to particular users from the excluded role, use the Prevent method and then add an Entry access rule with a proper override.

==Setting entry actions to open in different views==
Yes. There are many other patterns which are not visible via the UI and only some are currently listed in the docs.

In the entry level you can use (note redundant spaces between brackets)

[ [EAC:more:viewname]]

[ [EAC:edit:viewname]]

Which will send you to view or edit (respectively) the entry in the specified view.

Also

[ [EAC:moreurl:viewname]]

which you can use in the href of a tag to create a custom link to the target view.

In the view level you can use:

##viewurl:viewname##

which displays the url of the specified view and you can use in the href of a tag.

##viewlink:viewname##

which displays a link to the specified view

There is also a composite version of the viewlink pattern which looks like this:

##viewlink:Single view;Add a new entry;editentries=-1;##

This particular instance will mimic the addnewentry pattern but in the specified view. Details on the syntax should be available in this post: https://moodle.org/mod/forum/discuss.php?d=256813#p1123734.

The view patterns are also parsed in the entry level so you can use the composite viewlink pattern in the entry with the entry id pattern:

##viewlink:Edit view;Edit this submission;editentries=[ [entryid]];##

or

##viewlink:Details view;More details ...;eids=[ [entryid]];##

Another relevant view function is redirection of the view to another view in the activity after form submission. The setting under the 'Submission' section in the view configuration form. There you can also set the redirection timeout and message, and also add additional submission buttons as well as custom labels for these buttons.

File picker

2017-10-26T12:22:26Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Working with files and folders}}
==What is the file picker?==
The file picker enables files to be selected and displayed in Moodle - for example, when an editing teacher clicks ''Add an activity or resource > File'', or when a forum participant adds an attachment to a post.

Usually the file is copied into Moodle from wherever you have chosen it from (e.g. a repository or your computer), though for certain repositories, such as the [[Youtube videos repository]], a link is created, and in some situations an alias/shortcut may be created.

An "add" button appears which is clicked on to access the file picker:

[[File:addbutton.png]]

Screencast: What is the file picker?
{{MediaPlayer | url = http://youtu.be/iREGAIcGt_I}}

==Getting files from the file picker==

When the file picker screen appears, a number of links are listed down the side. These are links to [[Repositories]] which hold files you might want to use. There is also a link [[Upload a file repository| Upload a file]] which you would click on to add a file yourself from your computer.

Which repositories are included depends on which ones have been enabled by the administrator and also the context in which you access the file picker. For example, if you have reached the file picker by clicking on the media icon in the TinyMCE text editor then you might see the [[Youtube videos repository]] link. If you have reached the file picker by clicking on the image icon in the TinyMCE text editor then you might see the [[Flickr repository]] repository link.

[[File:23filepickerrepos1.png]]

See [[Repositories]] for the list of available repositories.

Note: The order in which repositories are listed in the file picker is set by an administrator in ''Settings > Site administration > Plugins > Repositories > Manage repositories''.

== Viewing your files in the file picker ==

There are three ways to view files in the File picker, depending on your personal preference;
===View as icons===
This shows the files as easily identifiable thumbnails:

[[File:filepickericonview.png]]

===View as table===
This shows the files with details such as licence, date uploaded, size etc:

[[File:filepickertableview1.png]]

===View as a list===
This shows the files in a hierarchical list:

[[File:fiepickerlistview.png]]

[[Category:Files]]

[[eu:Fitxategi-hautatzailea]]
[[fr:Sélecteur de fichiers]]
[[de:Datei-Browser]]
[[es:Selector de archivos]]

Community hubs

2017-10-26T12:22:26Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Managing a Moodle site}}
A community hub provides a directory of courses for public use or for private communities.
[[File:Community-hubs-flowchart.png|200px|thumb|left|Click to enlarge]]

The diagram shows the basic idea. The systems in this diagram are:

;Ordinary Moodle site: A typical Moodle site with teachers who want to download course templates and/or users who want to connect (enrol) with external communities
;Publishing site: A Moodle site that wants to make some of its courses available for download
;Community site: A Moodle site that provides courses that are enrollable
;Moodle Hub Server: A new Moodle plugin for listing registered courses that are ''downloadable'' or ''enrollable''. The default hub is at moodle.net, but there can be many others.

Community Hubs in Moodle 2.0 video:

{{MediaPlayer | url = http://www.youtube.com/watch?v=kFLDOcJ3cbg}}

==Downloadable courses==

# Sites that want to publish certain courses and make them downloadable can register them with one or more hub servers.
# The hub will check the data and make sure the course zip is downloadable, caching a copy locally. The hub may also have a security process to check the download for trojan horses, bad content, etc.
# The download process may trigger the backup process on the original server if it hasn't been done already.
# Later, Moodle users (who have permissions to do so) can connect to a hub to search for downloadable courses and choose one.
# The Moodle site downloads the file and makes it available to the Moodle user so they can now continue to restore it normally.

==Enrollable courses==

# Sites that want to publish certain courses for the public to enrol in can register them with one or more hub (including the main one at moodle.org).
# Later, any Moodle user can connect to a hub (via Community block in their site) to search and find courses they want to join.
# They click on a link to be sent to the other site so that they can enrol there.

==See also==

*[[Publishing a course]]
*[[Hub administration]]
*[[Hub FAQ]]
*[[Community finder block]]
*[[MNet]] - a Moodle network

[[Category:Hub]]

[[ja: コミュニティハブ]]
[[en:Community hubs]]
[[de:Community Hubs]]

Progress Bar block

2017-10-26T12:22:23Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Infobox plugin
|type = Block, Progress bar
|entry = https://moodle.org/plugins/view.php?plugin=block_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/10489/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}{{Note|This plugin has been replaced by the [[Completion Progress block]]. Please see [[Completion Progress block]] instead.}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Bar_in_block_-_with_details.png|right|A progress bar for a student]]
* The Progress Bar is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour coded so students can quickly see what they have and have not completed/viewed.
* The teacher selects which pre-existing activities/resources are to be included in the Progress Bar and when they should be completed/viewed.
* Ordering can be done by times/deadlines or by the ordering of activities in the course.
* There is an overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Progress Bar block to the [[Dashboard]] shows users a combined view of their progress on all courses (where the block is set up).
[[Image:Overview_of_students.png|The overview page]]

== Installation ==

The Progress Bar block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Progress Bar block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Progress Bar.
[[Image:Progress_Bar_Global_settings.png|thumb|Global settings]]
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Progress Bar block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the Progress Bar. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Progress_Bar_Capabilities.png|thumb|Global settings]]
* ''Add a Progress Bar block to My home'' (block/progress:myaddinstance) Controls whether the Progress Bar can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Progress Bar block'' (block/progress:addinstance) Controls whether the Progress Bar block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Progress bars for all students'' (block/progress:overview) Controls whether the Overview page and the button on the Progress Bar block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Progress Bar block'' (block/progress:showbar) Controls whether the bar in the Progress Bar block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Progress Bar in a course ==

Once the progress bar is installed, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Add the Progress Bar block to your page ([[Blocks|How to add a block]])
# Move your Progress Bar block into a prominent position (click and drag the block title)
# Choose to:
#* Monitor all activities (pre-fills configuration page)
#* Select which activities to monitor (start from scratch)
# Set the activities/resources you want shown in the block to "Yes" and those you don't to "No".
# Set the date and time when the activity/resource is expected to be completed/viewed by (some activities have deadlines set, if so, that deadline can be used or another can be set in the Progress Bar block configuration).
# Save changes.

Hidden items will not appear in the Progress Bar until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_progress Block code in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/10489 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_progress Git repository]

==Available translations==
This plugin has been (partly or completely) [https://docs.moodle.org/dev/Translation translated] in [http://lang.moodle.org/ AMOS] to these 26 languages by May 2016:
* Basque (eu)
* Catalan (ca)
* Chinese (Traditional/Big5) (zh_tw)
* Croatian (hr)
* Czech (cs)
* Danish (da)
* Dutch (nl)
* Finnish (fi)
* French (fr)
* German (de)
* Hebrew (he)
* Italian (it)
* Japanese (ja)
* Lietuvių (lt)
* Macedonian (mk)
* Mongolian (mn)
* Norwegian (no)
* Polish (pl)
* Português (pt)
* Portuguese (Brazil) (pt_br)
* Romanian (ro)
* Russian (ru)
* Serbian (Cyrillic) (sr_cr)
* Serbian (Latin) (sr_lt)
* Spanish (International) (es)
* Spanish - Mexico (es_mx)

The documentation (this page that you are reading now) is available in spanish at [https://docs.moodle.org/all/es/Bloque_de_barra_de_progreso Bloque de barra de progreso].

== Acknowledgements ==

* Thanks to:
** Toshimi Hatanaka for contributing a Japanese translation
** Yvonne Schneider and Joachim Vogelgesang for contributing a German translation
** Maria João Spilker for contributing a Portuguese-Brazilian translation
** Pieter Wolters for contributing a Dutch translation
** Fernando Sánchez for contributing a Spanish translation
** Fabien Sartoretti for contributing a French translation
** Adam Levy for contributing queries and strings for Hot Potatoes support
** Petras Virzintas for contributing queries for Turnitin support
** Willian Mano for helping with the modern look CSS
** Matthieu Rolland for contributing queries for the Questionnaire module
** Johan Reinalda for contributing global config changes for block colours
** German Valero for Spanish - Mexico translation of the block and this page.

===Videos===

{{MediaPlayer | url = http://www.youtube.com/watch?v=06LA5Cv9Fhw}}

{{MediaPlayer | url = http://www.youtube.com/watch?v=ekH8IfCyGzM}}

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de barra de progreso]]

Heatmap block

2017-10-26T12:22:23Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_heatmap
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738
|discussion = https://moodle.org/mod/forum/discuss.php?d=329136
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Heatmap_in_course.png|thumb|right|A heatmap applied to a course]]
* The Heatmap block overlays a heatmap onto a course to highlight activities with more or less activity.
* Counts of visits and unique users to each activity is also shown.
* The Heatmap can be toggled off when it is not needed.

== Installation ==

The Heatmap block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Heatmap block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Heatmap.
[[Image:Heatmap_global_settings.png|thumb|Global settings]]
* ''Cache lifespan'' A cache is used to retain results and reduce impact on the log table. The lifespan of the cache can be controlled. A longer-lived cache means the burden of querying the log table is reduced. A shorter-lived cache will show more recent results.
* ''Check for activity'' You can limit the timespan that is covered by the log entries queried by the block can be controlled. You can choose to search back to the start of the course (default) or to the beginning of the log. This option can be changed if courses are re-run and teachers want to see beyond the start of the current instance. Searching further back in the log may cause additional load.
* ''What to show on course page'' Two things can be added to course pages: a background colour for activities with visits and icons showing the count of visits and count of unique users. You can select to show both (default) or one or the other.

'''Note: Changes to cache-related settings may not appear immediately in the user interface unless you also purge caches after saving these settings.'''

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Heatmap_capabilities.png|thumb|Capabilities]]
* ''Add a new Heatmap block'' (block/heatmap:addinstance) Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)
* ''View the Heatmap'' (block/heatmap:view) Controls who can see the Heatmap block and subsequently the overlay of the heatmap on the course. This is something that will usually be relevant to Teachers, so it is hidden from students.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)

== Setting up a Heatmap in a course ==

Once the Heatmap block is installed, you can use it in a course as follows.
# Turn editing on
# Add the Heatmap block to your page ([[Blocks|How to add a block]])
# Toggle the Heatmap off and on as needed

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_heatmap Entry in Plugins repository]
* [https://tracker.moodle.org/browse/CONTRIB/component/15738 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_heatmap Git repository]

===Videos===

{{MediaPlayer | url = https://www.youtube.com/watch?v=jqZP0T0rR4U}}

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque Heatmap]]

File handling

2017-10-26T12:22:21Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

{{Working with files and folders}}
{{Improve}}

The way files are handled in Moodle 2.0 has changed from earlier versions. Students and teachers will use the [[File picker]] to upload and organize their files in areas called [[Repositories]]. Repositories can be located on the Moodle site or externally. Site administrators can [[Manage repositories|reveal, restrict, add, edit or create repositories]] for the site.

* Previously, if a file was used in different courses, it was duplicated. In Moodle 2.0, files are stored only once, saving disk space.
* Full support for Unicode file names on all operating systems.
* Metadata about each file (author, date, license, etc) and what the file is used for are stored in the database.
* Files are no longer just "uploaded to the course". Files are connected to the particular bit of Moodle content that uses them. (For example, a file may belong to a file resource, a forum post or a wiki page). Access to these files is controlled by the same [[Context|contextual]] [[Roles and capabilities|rules]] as as that bit of Moodle, increasing security.
* File picker has a list (file tree) or icon view

A video on file handling in Moodle 2.0:

{{MediaPlayer | url = http://www.youtube.com/watch?v=2bUwx675Pqo}}
== How is Moodle 2.0 better? ==
*There is no course Files space - good because you don't have to keep it tidy any more.
*Access to a file is based on the resource or activity to which it's connected; from any context you can easily get to a file - good because you can now easily link to files between areas you have editing access to.
*You can access the File Picker from many more places - good because it helps to avoid tedious and overwhelming front pages.
*Deleting a link to a file will delete the file - good because your files area won't become unkempt and unwieldy any longer, and because it will help to keep Moodle's database small.
*At the same time you can't delete a file which is linked elsewhere - good because it is now impossible to break a link.

== Typical Moodle 2.0 workflow ==
Edit text or activity. Use the file picker to easily select the file from any local or remote repository. The file is then copied to Moodle and stored securely with the text or activity.

Or Edit text or url resource. Use the file picker to select a file from any local or remote repository and select "link". The file URL is then embedded into the text and when viewed, the media comes directly from the open repository.

The standard Moodle install has 4 default areas (repositories) displayed in file picker for the teacher to select:
*Server -
*Recent -
*Upload -
*[[Private files]]

The site administrator can expand the above list to include 15 other predefined repository areas. For example, the teacher may see a file picker link to a Google Docs or UTube repositories where they can find files. As in the previous versions, the teacher can create a folder structure to store the files at the time files are uploaded.

==FAQ==
Caveat: these are just making a start on these. Subject to quality, style and accuracy improvements.

===What are ways to make files available to other teachers/designers?===
In Moodle 2, this is going to require a change of habits. Some of the philosophy is written up in a small essay on course files [[Course_files|here]]

One approach is to use a [[Repositories| repository]]. One of the easiest to set up is a [[File_system_repository_configuration|File System Repository]]

This needs server access. One such example:

[[Image:Repository-filesystem-filepicker.png]]

===What are ways to make ONE change in a file and have this reflected across a Moodle site?===
This also will require a change in thinking. You cannot just go to the file in the file picker and change it's name or upload a new file. This would cause problems if it was linked to elsewhere.

One answer is again to use repositories. '''Link''' to the files in the repository. Change the files (according to the permissions on the repository) and this is reflected everywhere in the course instantly.

==See also==
* [http://www.youtube.com/watch?v=JtePGeffl3o&feature=player_embedded Video: How teachers can upload files in Moodle 2.0]
* [[Course files]]
* [[Development:File API]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=160067 File Manager In Moodle 2.0] forum discussion

[[Category:Files]]

[[de:Dateiverwaltung in Moodle 2.0]]
[[fr:Gestion des fichiers 2.0]]
[[es:Manejo de archivos en Moodle 2.x]]

Collapsed Topics course format

2017-10-26T12:22:21Z

Mudrd8mz: Text replacement - "<mediaplayer>(.*)<\/mediaplayer>" to "{{MediaPlayer | url = $1}}"

The Collapsed Topics course format is a contributed code module. The format is similar to the standard [[Course_sections#Topics_format |Topics]] format except that all topics (except '0') can be 'toggled' on and off. This reduces clutter in courses that have a large number of topics, lots of content in the topics or a combination of the two.

[[Image:ct_23_main.png|center|Collapsed Topics format example]]

{{Courses}}

== Download ==

You can download the format from the [http://moodle.org/plugins/view.php?plugin=format_topcoll Modules and Plugins Database] or by going to [https://github.com/gjb2048/moodle-format_topcoll GitHub] and cloning the repository alternatively by selecting one of the [https://github.com/gjb2048/moodle-format_topcoll/tags downloads] for your version of Moodle if the database is unavailable. Full installation instructions are in the included 'Readme.txt' file.

== Installing ==

Please follow the instructions in the supplied 'Readme.txt' file and if desired, follow this video:

{{MediaPlayer | url = http://www.youtube.com/watch?v=ydFdES-pKYc}}

== Overview ==

For an overview please see this video:

{{MediaPlayer | url = https://www.youtube.com/watch?v=c9NaEAPPC5E}}

== Usage ==

'''Selecting'''

To select the format, simply choose it from the list of course formats in the [https://docs.moodle.org/en/Course_settings course settings]. To show / hide a topic just click on its toggle.

[[Image:Collapsed topics image4.png|thumb|center|Course Format]]

'''Setting the Toggle Text'''

Tick off 'Use default section name' and type in the 'Section name' box. This allows the summary to be shown as it normally is in the Topics course format ([[Course_homepage#Topic_format_example]]).

[[Image:Collapsed_topics_image6_moo20.png|center|Summary description Moodle 2.2]]

'''Toggle State'''

When refreshing the page, the state of the 'toggles' is remembered. This is on a per browser session per course basis for as long as the browser remains open. If you would like it to persist longer, please follow the instructions in the included 'Readme.txt' file.

== Changing the look ==

=== Introduction ===

Since versions 1.9.8.1, 2.0.5.1, 2.1.5.1, 2.2.3.1 and 2.3.3.1 for Moodle 1.9.14+, 2.0.5+, 2.1.2+, 2.2+ and 2.3+ respectively, which were released on the 5th March 2012 the format now incorporates a means of customising the 'elements' and 'structure' of the course within Moodle on a course by course basis. The 'elements' are such things as the 'Toggle' word showing / not showing. The 'structure' is the way the sections are presented, in effect the ability to switch to the 'Collapsed Weeks' format without installing another course format. Two other structures 'Latest Week First' and 'Current Topic First' have also been added.

All of the settings can be changed through the course settings page as demonstrated on the overview video above.

=== Structure descriptions ===

* 'Topics' - Where each section is presented as a topic in section number order. This is identical to previous versions of the format.

* 'Weeks' - Where each section is presented as a week in ascending week order. This is identical to the 'Collapsed Weeks' course format.

* 'Latest Week First' - The same as 'Weeks' but the current week is shown at the top and preceding weeks in decending order are displayed below execpt in editing mode where the structure is the same as 'Weeks'.

* 'Current Topic First' - The same as 'Topics' except that the current topic is shown at the top if it has been set.

* 'Day' - where each section is presented as a day in ascending day order from the start date of the course.

== Fine tuning the look ==

'''Formatting'''

Most of the formatting is contained within the file 'styles.css' which is fully commented to facilitate easy manipulation of specific elements. For example, if you found that in your particular web browser the 'Topic ''x'' ' text was too big...

[[Image:Collapsed topics image2.png|center|Topic text too big]]

Then you can change the 'font-size:0.7em;' in the '.course-content ul.ctopics li.section .content .toggle a' selector class:

[[Image:ct_23_font.png|center|Changing the css]]

'''The Arrow'''

If you want to change the look and style of the arrow you can either change 'arrow_down.png' and 'arrow_up.png' in the 'pix' folder or if you would like a per theme look then override the CSS in your theme. To change the up and down arrow for the toggle you need to override some or all of the following depending on the size of your arrow:

[[Image:ct23_arrow.png|center|Toggle arrow css]]

The selector without the 'body.jsenabled' prefix is for when the user has disabled JavaScript and all the sections default to open.

To override the 'Open / Close all sections' arrows you need to override some or all of the following depending on the size of your arrow:

[[Image:ct23_tarrow.png|center|Toggle all arrow css]]

In both cases use 'pix:' URLs that pertain to your theme in line with standard theme design.

== FAQ ==

Q. How do I report an issue with Collapsed Topics?

:A. Raise an issue on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker] or post a discussion on the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]

Q. Is Collapsed Topics [https://docs.moodle.org/en/Moodle_2.0_release_notes Moodle 2.0], [https://docs.moodle.org/en/Moodle_2.1_release_notes Moodle 2.1], [https://docs.moodle.org/en/Moodle_2.2_release_notes Moodle 2.2], [https://docs.moodle.org/en/Moodle_2.3_release_notes Moodle 2.3], [https://docs.moodle.org/en/Moodle_2.4_release_notes Moodle 2.4] & [https://docs.moodle.org/en/Moodle_2.5_release_notes Moodle 2.5] compatible?

:A. Yes. It incorporates a change where the section name of the topic summary is used instead of the summary itself to form the words on the toggle.

== Credits ==

Collapsed Topics has been developed by and is maintained by [http://moodle.org/user/view.php?id=442195 Gareth Barnard] with invaluable input from:

*[https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow]
*Frank Ralf, Matt Gibson, Howard Miller and Tim Hunt who commented on the [http://moodle.org/mod/forum/discuss.php?d=124264 Developer Forum]
*Craig Grannell - [http://www.snubcommunications.com/ Snub Communications] who wrote the article 'Collapsed Tables' in [http://www.netmag.co.uk/zine/latest-issue/issue-186 .Net Magazine Issue 186]

==See also==
*[http://moodle.org/plugins/view.php?plugin=format_topcoll Collapsed Topics] is the Modules and plugins database page for downloads and more information on this module. There are versions for Moodle 1.9, 2.0, 2.1, 2.2, 2.3 , 2.4 and 2.5. The Moodle 1.8 version for reference and legacy use is available from [https://github.com/gjb2048/moodle-format_topcoll GitHub] and in the [https://github.com/gjb2048/moodle-format_topcoll/downloads downloads].
*Discussions: please create or find a discussion topic in the [http://moodle.org/mod/forum/view.php?id=47 Moodle Course Formats Forum]
*Bugs can be reported on [http://tracker.moodle.org/browse/CONTRIB/component/10406 Moodle Tracker]

[[Category:Contributed code]]
[[Category:Course format]]

Vendor directory security check

2017-09-07T07:37:35Z

Mudrd8mz: Improve formatting of the directory name

== Vendor directory security check ==

'''The vendor directory should not be present on public sites.'''

The directory <tt>vendor</tt> inside the Moodle dirroot contains various third-party libraries and their dependencies, typically installed by the PHP Composer. It may be needed for local development, such as for installing the PHPUnit framework. But it can also contain potentially dangerous code exposing your site to remote attacks.

It is strongly recommended to remove the directory if the site is available via a public URL, or at least prohibit web access to it.

report/security/report security check nodemodules

2017-09-07T07:35:32Z

Mudrd8mz: Initial version of the page, content copied from Moodle

== Node.js modules directory security check ==

'''The node_modules directory should not be present on public sites.'''

The directory <tt>node_modules</tt> inside the Moodle dirroot contains Node.js modules and their dependencies, typically installed by the NPM utility. These modules may be required for Moodle development. They are not needed to run a Moodle site and they can contain potentially dangerous code exposing your site to remote attacks.

It is strongly recommended to remove the directory if the site is available via a public URL, or at least prohibit web access to it.

Vendor directory security check

2017-09-07T07:31:49Z

Mudrd8mz: Initial version of the page, with the info simply copied from Moodle

== Vendor directory security check ==

'''The vendor directory should not be present on public sites.'''

The vendor directory inside the Moodle dirroot contains various third-party libraries and their dependencies, typically installed by the PHP Composer. It may be needed for local development, such as for installing the PHPUnit framework. But it can also contain potentially dangerous code exposing your site to remote attacks.

It is strongly recommended to remove the directory if the site is available via a public URL, or at least prohibit web access to it.

Administration via command line

2017-08-08T16:31:27Z

Mudrd8mz: /* Scheduled tasks */ Double backslashes are not needed when quoting the task name - and it makes copy&paste easier

{{Installing Moodle}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins provide their CLI functionality via scripts in their own cli folder. For example, the enrol_db sync script is located in <code>enrol/db/cli/</code>.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:

$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params

Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:

$ sudo -u apache /usr/bin/php admin/cli/install.php --help

{{Note|These scripts are supposed to be run under the identity of the web server user. Examples on this page use the <tt>apache</tt> user for illustration. The particular value depends on your OS distribution and local set-up. Typical values may be <tt>apache</tt>, <tt>www-data</tt> or <tt>httpd</tt>.}}

== Upgrading ==

Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)

$ sudo -u apache /usr/bin/php admin/cli/upgrade.php

Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:

$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

== Installation ==

There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.

$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs

If required, the database install may be skipped, with just config.php populated.

$ sudo -u apache /usr/bin/php admin/cli/install.php --skip-database

== Maintenance mode ==

To switch your site into the maintenance mode via CLI, you can use

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable

To turn maintenance mode off, just execute the same script with the --disable parameter.

This script will also create and remove the climaintenance.html file for "Offline" mode.

== Offline mode ==

In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.

$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html

You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.

== Custom site defaults ==

During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like

<code php>
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</code>

These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.

== Reset user password ==

If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.

$ sudo -u apache /usr/bin/php admin/cli/reset_password.php

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

==Converting InnoDB tables to Barracuda==

Sites using MySQL with database tables using Antelope as the file format are recommended to convert the tables to the Barracuda file format.

This is because tables using Antelope as the file format cannot handle more than 10 text columns. This file formats only supports ''compact'' and ''redundant'' row formats for backward compatibility reasons. This may cause a problem on larger sites when restoring a course, in which case the following error will be displayed:

Row size too large (>8126). Changing some columns to TEXT or BLOB or using ROW_FORMAT=DYNAMIC or ROW_FORMAT=COMPRESSED may help.

Barracuda is the newest innoDB file format. In addition to supporting ''compact'' and ''redundant'' row formats, Barracuda also supports ''compressed'' and ''dynamic'' row formats.

However, converting tables to Barracuda is only recommended, and not required, since not all MySQL users are affected. (It may only be a problem for larger sites.)

===Tool for converting tables===

A command line tool is included in Moodle for converting tables to Barracuda.

To view tables requiring conversion, use the list option:

$ php admin/cli/mysql_compressed_rows.php --list

Here is an example output:

mdl_data Compact (needs fixing)
mdl_data_fields Compact (needs fixing)
mdl_enrol_paypal Compact (needs fixing)

To proceed with the conversion, run the command using the fix option:

$ php admin/cli/mysql_compressed_rows.php --fix

Successful table conversion will be reported in the output, for example:

mdl_data ... Compressed
mdl_data_fields ... Compressed
mdl_enrol_paypal ... Compressed

Please note that the commands must be executed on your moodle directory. Once tables are fixed, the warning message will no longer be displayed.

For further information on InnoDB file formats see the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_antelope MySQL InnoDB glossary - Antelope] and the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_barracuda MySQL InnoDB glossary - Barracuda].

If you get errors due to having insufficient privileges to run these commands (this is quite likely) then the easiest solution is to generate the required SQL commands using,

$ php admin/cli/mysql_compressed_rows.php --showsql

You can then copy the generated SQL into your mysql client running as the 'root' user.

== Running cron via command line ==

In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.

== Scheduled tasks ==

Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/tool/task/cli/schedule_task.php script.

This script accepts the following arguments:

--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:

<pre>php schedule_task.php --list</pre>

will return something like:

<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>

To run the first task in that list, you would execute

php schedule_task.php --execute='\enrol_imsenterprise\task\cron_task'

Be aware of the single quotes. Without them, you would need to use double backlashes to avoid escaping by the shell.

==Database transfer==

A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

==Fix course / module sequences==

In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:

php admin/cli/fix_course_sequence.php -c=* --fix

This will check every course in Moodle and report which ones had errors and were fixed.

==Fix orphaned question categories==

When a quiz is created, a new question category for the quiz is automatically created. In versions of Moodle prior to 2.9.1, if the quiz is deleted, the question category and any questions in the category remain in database. These orphaned question categories may be fixed by running the admin/cli/fix_orphaned_question_categories.php script with the --fix option.

==Search and replace text==

This script can be used to search and replace text throughout the whole database. Use carefully and backup first always. More info in [[Search and replace tool]].

php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost

==See also==

* MDL-35736 - Manage plugins via command line
* MDL-36237 - Resort course list via CLI
* [http://moosh-online.com/ MOOSH] - MOOdle SHell. It is a commandline tool that will allow you to perform most common Moodle tasks.

[[fr:Administration en ligne de commande]]
[[de:Administration über Kommandozeile]]
[[ja:コマンドライン経由の管理]]
[[es:Administración por línea de comando]]

Upgrading

2017-05-10T07:30:01Z

Mudrd8mz: /* Possible issues that may affect you in Moodle {{Version}} */ MDL-12689 - auth plugins converted to use settings.php

{{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 {{Version}} in ''Administration > Site administration > Server > [[Environment]]''.

The minimum required PHP version in Moodle 3.2 onwards is 5.6.5.

Note: You can only upgrade to Moodle {{Version}} from Moodle 2.7 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/27/en/Upgrading_to_Moodle_2.7 upgrade to 2.7] as a first step.

==Before upgrading==

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

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

== Backup important data ==

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

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

== Check for plugin updates ==

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

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

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

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

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

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

wget http://sourceforge.net/projects/moodle/files/Moodle/stable{{Version2}}/moodle-latest-{{Version2}}.tgz

=== Standard install package ===

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

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

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

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

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

chown -R www-data:www-data moodle (Linux debian - change to appropriate user and group for your OS version)
chmod -R 755 moodle

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

=== Using Git ===

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

===Command line upgrade===

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

== Finishing the upgrade ==

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

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

To do this just go to ''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, 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.

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

* Block "Course overview" was removed and replaced with the new block. Third party modules may not yet be compatible with the new dashboard block, in this case you can download the legacy block from [https://moodle.org/plugins/block_course_overview here]
* The repository Skydrive is deprecated; please migrate to the newer [https://docs.moodle.org/38/en/OneDrive_repository OneDrive repository]
* Tagging functionality was added to Forums posts, Glossaries entries and Book pages. It will be enabled by default after upgrade, if you don not want it to be enabled go to Site administration > Appearance > Tags and disable individual tag areas.
* PHPMailer was updated to [https://github.com/PHPMailer/PHPMailer/releases/tag/v5.2.20 5.2.20] that contains important security fix with possible side effect - complex sender addresses (such as those used in VERP addressing) may no longer work. PHPMailer advises switching to the SMTP transport if you need that functionality, and it offers higher performance anyway.
* The way how authentication plugins settings are internally stored has been updated and improved. In rare cases, the settings may be falsely reported as newly added during the upgrade. No functionality should be negatively affected but it may be wise to review configuration of your enabled authentication methods before and after the upgrade.

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

=== Moodle 2.9, 3.0, 3.1 and 3.2 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/29/en/Upgrading Upgrading to Moodle 2.9]
* [https://docs.moodle.org/30/en/Upgrading Upgrading to Moodle 3.0]
* [https://docs.moodle.org/31/en/Upgrading Upgrading to Moodle 3.1]
* [https://docs.moodle.org/32/en/Upgrading Upgrading to Moodle 3.2]

==See also==

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

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

Course overview (legacy)

2017-05-04T14:35:46Z

Mudrd8mz: Update the info block

{{Infobox plugin
|type = Block
|entry = [https://moodle.org/plugins/block_course_overview block_course_overview]
|tracker = [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Course%20overview%20(legacy)%22 CONTRIB tracker]
|discussion =
|maintainer = [https://moodle.org/user/profile.php?id=1455465 Moodle HQ]
}}

{{Note|This page describes a legacy version of the standard [[Course overview]] block which used to be part of the standard Moodle installation. Starting with Moodle 3.3, the block has been moved to the plugins directory and can be installed as an additional plugin.}}

The Course overview block is visible on a user's [[Dashboard]] and shows a list of all courses in which a user is enrolled/has an assigned role.

By default this block appears in the central content block on the Dashboard but can be moved to the left or right column.

Activities with due dates and unread forum posts are displayed for each of the courses in the block. Clicking on an icon (''1 in screenshot below'') will expand the setting to give more information and direct the user to the relevant activity ''(2 in screenshot below''): In the case of assignments, they will only display when the student needs to submit - or resubmit - and for teachers, when they have assignments which need grading.

[[File:assignmentsalert.png|thumb|center|500px|Expanding the alert for more details]]

==Customising the course order==

When a user clicks the "customise this page" button, they can then rearrange their courses by dragging them into different places. They can also choose how many courses they wish to display:
{|
|[[File:myhome1.png|thumb|Deciding how many courses to display]]
|[[File:myhome2.png|thumb|Moving a course]]
|[[File:myhome3.png|thumb|Courses have been reordered]]
|}

==Site administration settings==

*An administrator can set the default maximum number of courses and whether to force this number in '' Administration > Site administration > Plugins > Blocks > Course overview''.
*The setting 'Showchildren" allows for child courses to be listed under the main course settings. Child courses in this context are courses enrolled using Metalink enrollments.
*'Show welcome area" when checked will display a welcome area above the course list.

Categories (and subcategories) may be displayed below each course with the setting 'Categories to show'.
[[File:courseoverviewsettings.png|center|thumb|300px]]

[[Category:Course]]
[[de:Kursübersicht-Block]]
[[es:Bloque de vista general del curso]]

Course overview (legacy)

2017-05-04T14:06:50Z

Mudrd8mz:

{{Infobox plugin
|type = Block
|entry =
|tracker =
|discussion =
|maintainer =
}}

{{Note|This page describes a legacy version of the standard [[Course overview]] block which used to be part of the standard Moodle installation. Starting with Moodle 3.3, the block has been moved to the plugins directory and can be installed as an additional plugin.}}

The Course overview block is visible on a user's [[Dashboard]] and shows a list of all courses in which a user is enrolled/has an assigned role.

By default this block appears in the central content block on the Dashboard but can be moved to the left or right column.

Activities with due dates and unread forum posts are displayed for each of the courses in the block. Clicking on an icon (''1 in screenshot below'') will expand the setting to give more information and direct the user to the relevant activity ''(2 in screenshot below''): In the case of assignments, they will only display when the student needs to submit - or resubmit - and for teachers, when they have assignments which need grading.

[[File:assignmentsalert.png|thumb|center|500px|Expanding the alert for more details]]

==Customising the course order==

When a user clicks the "customise this page" button, they can then rearrange their courses by dragging them into different places. They can also choose how many courses they wish to display:
{|
|[[File:myhome1.png|thumb|Deciding how many courses to display]]
|[[File:myhome2.png|thumb|Moving a course]]
|[[File:myhome3.png|thumb|Courses have been reordered]]
|}

==Site administration settings==

*An administrator can set the default maximum number of courses and whether to force this number in '' Administration > Site administration > Plugins > Blocks > Course overview''.
*The setting 'Showchildren" allows for child courses to be listed under the main course settings. Child courses in this context are courses enrolled using Metalink enrollments.
*'Show welcome area" when checked will display a welcome area above the course list.

Categories (and subcategories) may be displayed below each course with the setting 'Categories to show'.
[[File:courseoverviewsettings.png|center|thumb|300px]]

[[Category:Course]]
[[de:Kursübersicht-Block]]
[[es:Bloque de vista general del curso]]

Course overview (legacy)

2017-05-04T14:06:36Z

Mudrd8mz:

{{Infobox plugin
|type = Block
|entry =
|tracker =
|discussion =
|maintainer =
}}

{Note|This page describes a legacy version of the standard [[Course overview]] block which used to be part of the standard Moodle installation. Starting with Moodle 3.3, the block has been moved to the plugins directory and can be installed as an additional plugin.}}

The Course overview block is visible on a user's [[Dashboard]] and shows a list of all courses in which a user is enrolled/has an assigned role.

By default this block appears in the central content block on the Dashboard but can be moved to the left or right column.

Activities with due dates and unread forum posts are displayed for each of the courses in the block. Clicking on an icon (''1 in screenshot below'') will expand the setting to give more information and direct the user to the relevant activity ''(2 in screenshot below''): In the case of assignments, they will only display when the student needs to submit - or resubmit - and for teachers, when they have assignments which need grading.

[[File:assignmentsalert.png|thumb|center|500px|Expanding the alert for more details]]

==Customising the course order==

When a user clicks the "customise this page" button, they can then rearrange their courses by dragging them into different places. They can also choose how many courses they wish to display:
{|
|[[File:myhome1.png|thumb|Deciding how many courses to display]]
|[[File:myhome2.png|thumb|Moving a course]]
|[[File:myhome3.png|thumb|Courses have been reordered]]
|}

==Site administration settings==

*An administrator can set the default maximum number of courses and whether to force this number in '' Administration > Site administration > Plugins > Blocks > Course overview''.
*The setting 'Showchildren" allows for child courses to be listed under the main course settings. Child courses in this context are courses enrolled using Metalink enrollments.
*'Show welcome area" when checked will display a welcome area above the course list.

Categories (and subcategories) may be displayed below each course with the setting 'Categories to show'.
[[File:courseoverviewsettings.png|center|thumb|300px]]

[[Category:Course]]
[[de:Kursübersicht-Block]]
[[es:Bloque de vista general del curso]]

Course overview block (old)

2017-05-04T14:05:14Z

Mudrd8mz: Mudrd8mz moved page Course overview block (old) to Course overview (legacy): Renaming to the page started independently by David, to keep the page history

#REDIRECT [[Course overview (legacy)]]

Course overview (legacy)

2017-05-04T14:05:14Z

Mudrd8mz: Mudrd8mz moved page Course overview block (old) to Course overview (legacy): Renaming to the page started independently by David, to keep the page history

{{Infobox plugin
|type = Block
|entry =
|tracker =
|discussion =
|maintainer =
}}

{{Note|The Course overview block (old) was replaced in Moodle 3.3 with a new block with the same name - [[Course overview]].}}

The Course overview block is visible on a user's [[Dashboard]] and shows a list of all courses in which a user is enrolled/has an assigned role.

By default this block appears in the central content block on the Dashboard but can be moved to the left or right column.

Activities with due dates and unread forum posts are displayed for each of the courses in the block. Clicking on an icon (''1 in screenshot below'') will expand the setting to give more information and direct the user to the relevant activity ''(2 in screenshot below''): In the case of assignments, they will only display when the student needs to submit - or resubmit - and for teachers, when they have assignments which need grading.

[[File:assignmentsalert.png|thumb|center|500px|Expanding the alert for more details]]

==Customising the course order==

When a user clicks the "customise this page" button, they can then rearrange their courses by dragging them into different places. They can also choose how many courses they wish to display:
{|
|[[File:myhome1.png|thumb|Deciding how many courses to display]]
|[[File:myhome2.png|thumb|Moving a course]]
|[[File:myhome3.png|thumb|Courses have been reordered]]
|}

==Site administration settings==

*An administrator can set the default maximum number of courses and whether to force this number in '' Administration > Site administration > Plugins > Blocks > Course overview''.
*The setting 'Showchildren" allows for child courses to be listed under the main course settings. Child courses in this context are courses enrolled using Metalink enrollments.
*'Show welcome area" when checked will display a welcome area above the course list.

Categories (and subcategories) may be displayed below each course with the setting 'Categories to show'.
[[File:courseoverviewsettings.png|center|thumb|300px]]

[[Category:Course]]
[[de:Kursübersicht-Block]]
[[es:Bloque de vista general del curso]]

Course overview

2017-05-04T12:31:38Z

Mudrd8mz:

{{Blocks}}
The new course overview block in Moodle 3.3 onwards enables students to check their course progress and view upcoming deadlines.

[[File:33CourseOverview.png|600px]]

## See also ##

* For the documentation related to the previous version of the block, please refer to [[Course overview (legacy)]].

Moderator guide

2017-03-09T18:29:11Z

Mudrd8mz: Attempt to fix the layout problem by changing the order of templates

{{stub}}
{{Infobox plugin
|type = Block, Moderator guide
|entry = https://moodle.org/plugins/block_moderator_guide
|tracker = https://bitbucket.org/covuni/moodle-block_moderator_guide/issues?status=new&status=open
|discussion = https://moodle.org/plugins/block_moderator_guide
|maintainer = [[User:Jérôme Mouneyrac|Jérôme Mouneyrac]]
|float = right
}}

==Iintroduction==
* This block displays guides for external teachers/graders.
* These guides are created by teachers and are based on templates created by administrators.
* The template creation system allows the generation of Moodle forms containing textarea, file uploader and links.

'''Sometimes an institution uses a Moodle site to run exams and they contract external teachers to grade the students. To help the external teachers conform with the institution grading rules, the institution provides the external teachers access to a course guide on how to grade. The Moderator Guide block allows the creation of guides for external teachers.'''

It is the responsibility of each main course teacher to create a course guide for the external teachers. However, a main teacher cannot create his own "free style" guide, he needs to follow a template created by the Moodle administrator. The block template creator allows administrators to create templates using placeholders for text area, file manager and links (a placeholder is like a Wordpress shortcode).

On another hand, a Moodle site is sometimes used to manage multiple educational organizations. The Moderator Guide block allows administrators to restrict access to the templates and guides as needed.

==Moodle Administrator==

The administrator role is to install the block, set up the block in Moodle and provide the teachers with guide templates.

===Installation===

install the plugin files in a blocks/moderator_guide folder.

===Block setup===

The goal of this block is to be displayed on all course main pages.

In order to achieve this result you need to add the block on the Moodle front page. Edit the block and select display this block through the entire site. Then go to a course page, edit the block and select display on course main pages only. You can also change the name of the block in the same page.

===Create a template===

The teachers cannot create a guide if you don’t provide them a guide template.

Go to Site Administration > Plugins > Blocks > Moderator Guide > Manage templates

[[File:Block_Moderator_guide_Manage template.PNG]]

Click on Add template

[[File:Block_Moderator_guide_Add template.PNG]]

Enter the following:

* template name: when creating a guide, the teacher must select a template so you need to give it a name)
* default guide name: it will prefilled the Guide name when a teacher creates a guide. The teacher still can change the guide name
* organization: you can restrict the visibility of a template (and the guide based on this template) per organisation. See the section about organization
* description: some notes about the template, only seen by other administrator when they edit a template
* template: this is the guide template. All text and images you enter will be displayed in the guide created by the teachers. The teachers won’t be able to edit the text and image you enter this way. To allow teachers to enter text and image when they create a guide, you must type an editor placeholder

===Placeholder types===

The templates allow you to enter placeholders. When the guide creation form is display to a teacher, these placeholders are replaced by respective form elements (input text, input link, input files).

* [X:files] : the teacher will be asked to add files in a Moodle file manager.
* [X:html] : the teacher will be asked to enter text and images in the Moodle HTML editor.
* [X:html:BEGIN] some default HTML [X:html:END] : the teacher will be asked to enter text and images in the Moodle HTML editor. You can pre-fill this editor with some default text and images.
* [X:link] : the teacher will be asked to enter a web page link.

In the placeholder syntax, X must be an integer and it should be unique for each placeholder (apart from [X:html:BEGIN] and [X:html:END] which share the same X value.). X is an identifier used internally by the code - it has no use for you but it is required otherwise the block will not properly display the guides.

===Preview a template===

Once a template has been created you can preview the guide creation page when the teacher selects this template. Click on the Preview link.

[[File:Block_Moderator_guide_preview.PNG]]

===Hide / Show a template===

When a template is hidden no teacher can create a new guide using this template. However hidden a template has no impact on the visibility of guides based on this template (guide visibility can be changed in the Manage guides pages). When a template is shown then teachers can use it to create new guides. Click on Hide / Show in the Manage templates page.

===Access the template guides===

If guides have been created using a template, you can access all guides of this template clicking on the respective Guides link.

===Edit a template===

Editing a template is similar to adding a template. Note that if at least one guide has been created using a template then you can not edit the template field (but you can still edit the name, default name, description and organization). Click on Edit in the Manage templates page.

===Delete a template===
You can delete a template. If you do it, then all guides created with this template will be deleted too. Click on Delete in the Manage templates page.

===Add / Edit / Delete guides===

Managing guides as an administrator is similar to managing guides as teacher. Go to the teacher section for more information.

==Restricting access per organization==

If your Moodle site is used to manage multiple organizations it is possible to restrict access to template and guides to a specific organization.

# Create a new user profile field (see the Moodledocs documentation on how to create a profile fields). For our example, call the profile field shortname “faculty”
# Set the “faculty” profile field to the users you want to restrict the access (For example it could be “Faculty of Science”)
# Go to Site Administration > Plugins > Blocks > Moderator Guide
# Type “faculty” is the organization field (it must be a profile field shortname).
# Go to Site Administration > Plugins > Blocks > Moderator Guide > Manage templates
# Edit all templates you want to restrict to one specific faculty. In the organisation field enter the faculty (for example “Faculty of Science”)

From this point you have restricted access per organization.

It has the following impact:
* when the teacher profile field is empty (i.e. the teacher “Faculty” profile field is empty), the teacher can create guides based on any templates.
* when the external teacher profile field is empty , the external teacher can see any guide.
* when a template has no organization, all teachers can create a guide based on this template and the guide can be viewed by external teachers.
* when the template organization matches the teacher profile field (i.e. the teacher “Faculty” profile field is equal to “Faculty of Science”), the teacher can create guides based on this specific template.
* when the template organization matches the external teacher profile field, the external teacher can see the guide based on this specific template.
* in all other cases, the teachers cannot create a guide and the guides can not be viewed by external teachers.

==Teachers==

As a Teacher your role is to create a Guide for the external teachers.

===Create a guide===

Go to a course.

[[File:Block_Moderator_guide_coursemainpage.PNG]]

In the Moderator Guide block, click on Manage guides.

[[File:Block_Moderator_guide_manageguides.PNG]]

Click on Add guide.

[[File:Block_Moderator_guide_add guide page.PNG]]

On this page you first must select a guide Template. Guide template are preformatted guide forms. They contains hard coded text and images you are not allowed to modified (often it would be the header and footer of the guide which your institutions may want to keep control of). They usually also contains at least one input field for you to enter your own text and images. Sometimes you can even upload files or enter links.

Once you selected your guide template, enter a Name. Sometimes a field would have been prefilled to help you following a good naming convention.

Finally you can create your guide content filling the text editor with text and images, uploading files in the file managers and creating link. These inputs will changed depending on the template you selected.

===Update a guide===

You can update a guide at any time. Click on Edit in the Manage guides page.

===Delete a guide===

You can delete a guide at any time. Click on Delete in the Manage guides page.

===Hide / Show a guide===

You can decide to hide a guide to the external teachers. Click on Hide / Show in the Manage guides page. On creation all guides are hidden. This is useful to keep you working on your guide before showing it. Hide / Show is the equivalent of Unpublish / Publish in Wordpress.

==External teachers==

As an external teachers your role is to read the guides to help you grading the students. On each main course page you should see a “Moderator Guide” block providing you with one or multiple grading guides to follow.

[[File:Block_Moderator_guide_external teacher course main page.PNG]]

Click on a Guide to view it. Guides may contain text, images, links and files to download.

[[File:Block_Moderator_guide_a guide.PNG]]

==Students==

Students are not allowed to use this plugin.

==Demo==

[https://youtu.be/jISpfobm8H4 https://youtu.be/jISpfobm8H4]

==License==
Coventry University

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

[[es:Guía del moderador]]

Media FAQ

2017-03-07T14:25:57Z

Mudrd8mz: Add info on how to disable the auto-embedded player for a particular link

{{Working with media}}
==Should I put my video into a label or a page?==
While the embedding process is the same, adding a video to a label will mean it displays as soon as the user clicks on that course page. This can be beneficial if the video is, for example, an introduction to the course or an integral part of the whole course. However, if there are several videos in labels, they can slow the loading of the course down, especially if the videos are coming from an external site. Adding a video to a page in Moodle means that the user has to click a text link to reach the video, but it doesn't clutter up the main course page and it is a better choice if the course contains a large number of videos.

==My embedded video is too big/small. How can I change its display size?==
Changing the size of an embedded video depends on whether you're using Moodle's [[Multimedia plugins filter]] or if you're either embedding a video from another source using something like an iframe (for example, embedding a video from YouTube using the embed code they provide).

====If you're using Moodle's Multimedia plugins filter:====
*If you are not using it already, enable the [[Atto editor]] and click the Media icon.
*Click the Video tab and then click Display options. You will be able to change its size there.

====If you're using embed code====
#Click the code/HTML source icon in your text editor
#Locate the <iframe> tag or equivalent.
#Inside that iframe should be "width" and "height" variables, which you can adjust as needed. [[File:Youtuberesize.png]]
#Click "update" in the HTML source editor screen, and save your changes.
#Your video should now be the new size.

==Why won't my swf video play?==
The .swf format carries with it some security issues and so the filter that allows it to display is disabled by default. For you to be able to add .swf videos, your administrator needs to enable the filter in [[Multimedia_plugins|Multimedia plugins]], then to go to ''Site Administration>Security>Site policies'' and check the "enable trusted content" box. They then need to go to ''Site Administration>Users>Permissions>Define roles'' and allow Trust Submitted content ''moodle/site:trustcontent'' for your role. However; swf will still not display in all areas of Moodle, for example forum posts. See this discussion [http://moodle.org/mod/forum/discuss.php?d=183681#p800390| here]

==How can I convert my video file to an .FLV or other format?==
*There are many sites online that allow you to upload a file which will then be converted and sent to you via a link or email. Zamzar [http://www.zamzar.com]or Youconvertit [http://www.youconvertit.com] are just two examples.
*However, if it is a large video file or you want to do the conversion off line, then the free Any Video Converter [http://www.any-video-converter.com/products/for_video_free/] (a downloadable program) will convert most video formats to most others.
*More and more full-featured MTS Video Converter [http://www.mtsconverterfree.com/]software free download a trial, to solve your problem more format conversions.
*The free and open source video player, VLC has the ability to convert to and from many video formats. For more details and downloads [http://www.videolan.org/vlc/ visit their site].
*If you are using Linux as your operating system either ffmpeg or avconv can both convert to FLV.

== I have a .wma/wav file. How can I play it in Moodle's player?==
*There are various free programs available that will convert one type of sound file to another. If you convert your file to an mp3 then you will be able to use Moodle's built-in mp3 player.
*Jodix Free WMA to MP3 converter [http://www.wma-mp3.org/] is just one example

==Videos don't embed even though the filters are enabled==
You might need to change the order of your filters. See [[Filters]] and also the forum discussion [https://moodle.org/mod/forum/discuss.php?d=278993#p1198335 I can't embed YouTube videos]

== How can I disable player embedding for one particular link? ==

If you want to prevent the embedded player and keep just the link to the video, add "nomediaplugin" class to the HTML anchor tag producing the link. For example:

<nowiki><a href="https://link.to/your/video" class="nomediaplugin">Link text</a></nowiki>

[[Category:FAQ]]

[[de:Multimedia FAQ]]
[[es:Medios FAQ]]

admin/tool/pluginskel/index

2016-09-07T07:46:17Z

Mudrd8mz: Mudrd8mz moved page admin/tool/pluginskel/index to Plugin skeleton generator: Human friendly page title

#REDIRECT [[Plugin skeleton generator]]

Plugin skeleton generator

2016-09-07T07:46:17Z

Mudrd8mz: Mudrd8mz moved page admin/tool/pluginskel/index to Plugin skeleton generator: Human friendly page title

{{Infobox plugin
|type = tool
|entry = https://github.com/mudrd8mz/moodle-tool_pluginskel
|tracker = https://github.com/mudrd8mz/moodle-tool_pluginskel
|discussion = https://github.com/mudrd8mz/moodle-tool_pluginskel
|maintainer = [[Alexandru Elisei, David Mudrák]]
|float = right
}}

==Generate plugin skeleton==
The plugin will generate the skeleton files needed for a specific plugin type. The full functionality of the plugin can be accessed either via a web interface or the command line script.

To generate a skeleton plugin via the web interface:
#Proceed to ''Administration > Site administration > Development > Generate plugin skeleton''
#Fill in the various plugin features then click on the "Download plugin skeleton button"
[[Image:tool_pluginskel_first_page_v1.png|thumb|600px|center|Generate plugin skeleton]]

To generate the plugin skeleton by using the comand line interface:
#Create a recipe file in the YAML format, either by writing it from scratch or by editing the template recipe located at cli/example.yaml (recommended)
#Invoke the command line script at cli/generate.php:
php cli/generate.php --recipe=recipe.yaml
This will generate the plugin in the [https://docs.moodle.org/dev/Plugin_types Moodle path directory] corresponding to the plugin type being generated.

==Installation==
This plugin has been tested to work with Moodle 3.1 and newer. There are no guarantess it will work with earlier versions.

General installation procedures are those common for all Moodle plugins: [[Installing_plugins|Installing plugins]].

When downloading the plugin from the git repository [https://github.com/mudrd8mz/moodle-tool_pluginskel tool_pluginskel] there are several options available: cloning the repository, downloading the zip file and extracting it or using the zip file for the plugin install interface accessible at ''Administration > Site administration > Plugins > Install plugins''.

If you choose to clone the repository, then you need to clone it into MOODLE_ROOT_DIRECTORY/admin/tool/pluginskel:

git clone https://github.com/mudrd8mz/moodle-tool_pluginskel MOODLE_ROOT_DIRECTORY/admin/tool/pluginskel

replacing MOODLE_ROOT_DIRECTORY with the actual Moodle installation root directory path. The zip file should be extracted to the same location.

Keep in mind that cloning the repository also creates a hidden .git directory, which you may not want on live servers.

'''Note''': If you decide to use the install plugin interface don't forget to rename the folder inside the archive to ''pluginskel''.

==The web interface==
The web interface is accessible from ''Administration > Site administration > Development > Generate plugin skeleton''. You are given a choice between filling in all the required fields manually, uploading a previously created recipe file or writing the recipe by hand in the text area (presumably by copying and pasting an existing recipe).

The second page of the web interface presents you with all the options needed to generate the complete plugin skeleton. There are help icons associated with each element, as well as links to the relevant Moodle documentation, to guide you through the creation process.
[[Image:tool_pluginskel_second_page_v1.png|thumb|600px|center|Plugin skeleton creation]]

After you have filled the necessary fields, you are given three options:
#You can generate the plugin files and download them by clicking on the ''Download plugin skeleton'' button. The files will be packaged as a zip archive.
#You can choose to generate and save a recipe file in the YAML format from the form input. This is accomplished by clicking on the ''Download recipe'' button.
#You can view and edit the recipe created from the form by clicking the ''Show recipe'' button. You will be taken to the edit recipe web page:
[[Image:tool_pluginskel_show_recipe_v1.png|thumb|600px|center|View and edit the recipe]]
It's worth noting that any changes you make here to the recipe will be reflected on the previous page if you click the ''Back'' button.

==The command line script==
The command line script is located at ''cli/generate.php'' inside the plugin installation directory (that is MOODLE_ROOT_DIRECTORY/admin/tool/pluginskel). The general syntax of the command line script is as follows:
php cli/generate.php --recipe=RECIPE.YAML [--help] [--target-dir=DIR] [--target-moodle=DIR]

The available arguments are:
*'''--help, -h''' - prints a message about how to use the script.
*'''--recipe=RECIPE.YAML''' - the location of the recipe file, as a relative or absolute path to the file. Mandatory.
*'''--loglevel=LOGLEVEL''' - the verbosity of the log message. The default is WARNING. The plugin uses the Monolog logging library, for a full list of the different log levels please examine the file vendor/monolog/monolog/src/Monolog/Logger.php located in the plugin directory.
*'''--target-dir=DIR''' - the path to the directory where the plugin files will be generate (either relative or absolute). Optional. Inside DIR a directory with the component name will be created where all the plugin files will be placed. For example, when creating the plugin mod_newmodule:
php cli/generate.php --recipe=mod_newmodule_recipe.yaml --target-dir=/tmp
the plugin files will be located at /tmp/newmodule/.
*'''target-moodle=DIR''' - this will generate all the plugin files in the [https://docs.moodle.org/dev/Plugin_types Moodle path directory] coresponding to the plugin type being generated, but with DIR considered the Moodle root directory. Optional. For example, to generate the plugin tool_newtool:
php cli/generate.php --recipe=tool_newtool_recipe.yaml --target-moodle=/tmp
the plugin file will be located at /tmp/admin/tool/newtool/.

Note that if not using neither '''--target-dir''', nor '''--target-moodle''' the plugin files will be generated in the [https://docs.moodle.org/dev/Plugin_types Moodle path directory] in the current Moodle installation.

===The recipe format===
The recipe needs to be written in the [http://yaml.org/ YAML] format. It is highly recommended to use the example recipe located at cli/example.yaml as a template for the plugin and edit or remove options as needed.

Conceptually, the recipe is split into three different parts:

#The first part represents the options needed to create the version.php file and the language strings file located at lang/en/<component>.php. These two files are mandatory for all plugins, regardless of the plugin type, and the options are declared at the top level of the recipe. These are: <pre>component, name, release, version, requies, maturiy, copyright, dependencies, lang_strings</pre>

#The second part consists of features that are common to (most) all plugin types. This in turn is split into two sub-parts:
##Options that have a boolean value and they control if a file is to be generated or not. These are defined under the ''features'' section of the recipe. They are: <pre>install, uninstall, settings, readme, license, upgrade, upgradelib</pre>
##Options that needed to be defined as an array (either associative or numerically indexed). They reside at the top level of the recipe and they are: <pre>capabilities, message_providers, cli_scripts, observers_events, mobile_addons, phpunit_tests</pre>

#The last part consists of plugin specific features. All features that correspond to a plugin type will be under the ''<componenttype>_features'' section of the recipe.

Explanation about what the features do as well as links to relevant Moodle documentation for each of the above options can be found on the web interface, by clicking the help icons.

==Adding new features==
The plugin has been designed to be easily expanded by adding new features. But first let's take a look at how the plugin generates the skeleton files from a recipe.

===The generation process===
The generation process is handled by the manager class located at classes/local/util/manager.php. The input for the manager class is the array representation of a recipe. The conversion from the YAML format must be done before invoking the manager.

Invoking the manager class to create a plugin skeleton is done following these steps:
#First, an instance of the class is created by passing a logger class to the static constructor ''manager::instance($logger)''.
#The recipe is parsed and saved by the manager by invoking the public method ''load_recipe($recipe)''. The argument is an array representation of the recipe.
#The file content are created and saved by using the function ''make()''. No files are created on disk at this stage.
#Actually creating the files can be done by invoking the method ''write_files($targetdirectory)''. As an alternative, you can access the files' content by using ''get_files_content()'' (this approach is used when creating the PHPUnit test cases for the plugin).

Note that the manager does no validation (if it exists, if it's writable, etc) on the $targetdirectory.

Each file content is generated from a template using [https://github.com/bobthecow/mustache.php/wiki Mustache]. The Mustache templates are located in the skel/ directory. Responsible for making use of the Mustache engine to generate the files are skeleton classes located at classes/local/skel, and each instance of the skeleton class will generate one file from one template. The template to generate the file from and the recipe data for the template are specified when the skeleton class is instantiated inside the manager function ''prepare_file_skeleton()''.

Now let's take a closer look at what happens when the function ''make()'' is called:
*The function ''prepare_files_skeletons()'' is invoked. This function will create the all the files' content and save it in the ''files'' class attribute. One entry in the ''files'' is composed of the file name and the instance of the skeleton class responsible for generating that file.
*Inside the ''prepare_files_skeletons()'' function, files are queued for generation by invoking the function ''prepare_file_skeleton()'' based on the recipe options. To check if a given file should be generated there are two different functions: ''has_common_feature()'', which deals with the features common to all plugin types, and ''has_component_features()'' which checks whether a component specific feature is present.
*Once all the files have been added to the ''files'' list, the skeleton class method ''render()'' will be invoked for each skeleton class, and that will generate the content of each file.

===Adding new features===
To add a new feature, one must first decide the type feature: if it's a common feature (it applies to all plugins), or if it's a component specific feature (it applies only to a specific plugin type). See [https://docs.moodle.org/38/en/admin/tool/pluginskel/index#The_recipe_format the recipe format] for more details.

After this has been decided, the following steps are necessary:
#Create a Mustache template (or more) for the feature. If the feature is a component feature, then the template should go in the skel/file/<componenttype>/ directory, where ''componenttype'' is the [https://docs.moodle.org/dev/Plugin_types plugin type]. Otherwise, it should be in the skel/file/ directory.
#Choose or create a new skeleton class to render the template. If creating a new skeleton class please extend one of the following three skeleton classes: ''php_internal_file'' (for files that are internal to Moodle and should not be accessible from the web page, they have the expression ''defined('MOODLE_INTERNAL') || die()'' at the beginning of the file), ''php_web_file'' (these are intended to be used from the web interface and include the config.php file), ''php_cli_file'' (these are command line scripts and define the constant 'CLI_SCRIPT' to be true) or ''txt_file'' (which is a common text file, like the LICENSE.md or README.md files).
#Add code to the manager function ''prepare_plugin_skeleton()'' to make sure that the file(s) are queued for generation. Based on the feature type one of the functions ''has_component_feature()'' or ''has_common_feature()'' should return true if the feature is present in the recipe.
#(Optional, but highly recommended)Create [https://docs.moodle.org/dev/PHPUnit PHPUnit] tests for the new feature in the tests/ directory. You can use one of the existing tests as a template.
#To have the new feature present on the web interface:
##The feature should be added to one (and not both) of the static functions: ''manager->get_component_variables($component)'' or ''manager->get_features_variables()''. Based on the code already present it should be self explanatory how that is done.
##Create the language strings for the new feature in the file lang/en/tool_pluginskel.php. At the very least a feature will require two strings: the human readable name for the feature and the help message for that feature. It should be obvious about how to do that from the strings already present there.
#That's all.

===Example===
Here's an example of how to add a feature to the plugin.

First, we decide on the feature type and name. We'll add a new common feature, "myfeature:, which will be located in the ''features'' section of the recipe (meaning it will just toggle the creation of some file). If enabled, the file myfeature.php will generated in the directory mydirectory/.

A simple recipe should look something like this:
<pre>
component: local_test

## Human readable name of the plugin.
name: Example plugin

## Human readable release number.
release: "0.1.0"

## Plugin version number, e.g. 2016062100. Will be set to current date if left empty.
version: 2016121200

## Required Moodle version, e.g. 2015051100 or "2.9".
requires: "2.9"

## Plugin maturity level. Possible options are MATURIY_ALPHA, MATURITY_BETA,
## MATURITY_RC or MATURIY_STABLE.
maturity: MATURITY_BETA

## Copyright holder(s) of the generated files and classes.
copyright: 2016 Alexandru Elisei <alexandru.elisei@gmail.com>, David Mudrák <david@moodle.com>

features:
myfeature:true
</pre>

Next we create the template file at skel/file/myfeature.mustache. We will use the skeleton class ''php_internal_file'' for generating this file, but we are free to use any other base class, or create our own.

Now we modify the manager class to make sure the file is generated properly:
*We make sure that the function ''has_common_feature()'' returns true when the feature is specified in the recipe file. By default, if a feature is set to true and it resides in the ''features'' section of the recipe the function will return true. As this is our case, we don't have to modify ''has_common_feature()''.
*Next we queue the file for generation inside the ''prepare_files_skeletons()'' function:
<code php>
protected function prepare_files_skeletons() {
...
if ($this->has_common_feature('myfeature')) {
$this->prepare_file_skeleton('mydirectory/myfeature.php', 'php_internal_file', 'myfeature');
}
...
}
</code>
*(Optional, but highly recommended) Create the PHPUnit test file tests/myfeature_test.php. You can use one of the existing test files as an example (readme_test.php is one of the simplest).
*Now we have to make sure that we have access to this feature in the web interface. For that we modify the function ''get_features_variables()'':
<code php>
public static function get_features_variables() {

$featuresvars = array();

$featuresvars[] = array('name' => 'myfeature', 'type' => 'boolean');
...
}
</code>
This means that when constructing the recipe from the form data the value for this option will be converted to a boolean.
*The last step is adding the language strings for the new variable. Add the following to the lang/en/tool_pluginskel.php file:
<code php>
// The name of the feature is 'features_myfeature' because in the recipe the feature is under 'features'.
$string['features_myfeature'] = 'The name of the feature on the web form';
$string['features_myfeature_help'] = 'Help message for myfeature';
$string['features_myfeature_link'] = 'Link to additional resources regarding the feature';
</code>
*That's it, we're done.

Administration via command line

2016-07-28T10:09:52Z

Mudrd8mz: Clarify the sudo username a bit

{{Installing Moodle}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins provide their CLI functionality via scripts in their own cli folder. For example, the enrol_db sync script is located in <code>enrol/db/cli/</code>.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:

$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params

Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:

$ sudo -u apache /usr/bin/php admin/cli/install.php --help

{{Note|These scripts are supposed to be run under the identity of the web server user. Examples on this page use the <tt>apache</tt> user for illustration. Particular value depends on your OS distribution and local setup. Typical values may be <tt>apache</tt>, <tt>www-data</tt> or <tt>httpd</tt>.}}

== Upgrading ==

Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)

$ sudo -u apache /usr/bin/php admin/cli/upgrade.php

Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:

$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

== Installation ==

There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.

$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs

If required, the database install may be skipped, with just config.php populated.

$ sudo -u apache /usr/bin/php admin/cli/install.php --skip-database

== Maintenance mode ==

To switch your site into the maintenance mode via CLI, you can use

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable

To turn maintenance mode off, just execute the same script with --disable parameter.

== Offline mode ==

In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.

$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html

You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.

== Custom site defaults ==

During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like

<code php>
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</code>

These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.

== Reset user password ==

If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.

$ sudo -u apache /usr/bin/php admin/cli/reset_password.php

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

==Converting InnoDB tables to Barracuda==

Sites using MySQL with database tables using Antelope as the file format are recommended to convert the tables to the Barracuda file format.

This is because tables using Antelope as the file format cannot handle more than 10 text columns. This file formats only supports ''compact'' and ''redundant'' row formats for backward compatibility reasons. This may cause a problem on larger sites when restoring a course, in which case the following error will be displayed:

Row size too large (>8126). Changing some columns to TEXT or BLOB or using ROW_FORMAT=DYNAMIC or ROW_FORMAT=COMPRESSED may help.

Barracuda is the newest innoDB file format. In addition to supporting ''compact'' and ''redundant'' row formats, Barracuda also supports ''compressed'' and ''dynamic'' row formats.

However, converting tables to Barracuda is only recommended, and not required, since not all MySQL users are affected. (It may only be a problem for larger sites.)

===Tool for converting tables===

A command line tool is included in Moodle for converting tables to Barracuda.

To view tables requiring conversion, use the list option:

$ php admin/cli/mysql_compressed_rows.php --list

Here is an example output:

mdl_data Compact (needs fixing)
mdl_data_fields Compact (needs fixing)
mdl_enrol_paypal Compact (needs fixing)

To proceed with the conversion, run the command using the fix option:

$ php admin/cli/mysql_compressed_rows.php --fix

Successful table conversion will be reported in the output, for example:

mdl_data ... Compressed
mdl_data_fields ... Compressed
mdl_enrol_paypal ... Compressed

Please note that the commands must be executed on your moodle directory. Once tables are fixed, the warning message will no longer be displayed.

For further information on InnoDB file formats see the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_antelope MySQL InnoDB glossary - Antelope] and the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_barracuda MySQL InnoDB glossary - Barracuda].

If you get errors due to having insufficient privileges to run these commands (this is quite likely) then the easiest solution is to generate the required SQL commands using,

$ php admin/cli/mysql_compressed_rows.php --showsql

You can then copy the generated SQL into your mysql client running as the 'root' user.

== Running cron via command line ==

In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.

== Scheduled tasks ==

Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/tool/task/cli/schedule_task.php script.

This script accepts the following arguments:

--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:

<pre>php schedule_task.php --list</pre>

will return something like:

<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>

To run the first task in that list, you would execute

<pre>php schedule_task.php --execute=\\enrol_imsenterprise\\task\\cron_task</pre>

==Database transfer==

A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

==Fix course / module sequences==

In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:

php admin/cli/fix_course_sequence.php -c=* --fix

This will check every course in Moodle and report which ones had errors and were fixed.

==Fix orphaned question categories==

When a quiz is created, a new question category for the quiz is automatically created. In versions of Moodle prior to 2.9.1, if the quiz is deleted, the question category and any questions in the category remain in database. These orphaned question categories may be fixed by running the admin/cli/fix_orphaned_question_categories.php script with the --fix option.

==Search and replace text==

This script can be used to search and replace text throughout the whole database. Use carefully and backup first always. More info in [[Search and replace tool]].

php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost

==See also==

* MDL-35736 - Manage plugins via command line
* MDL-36237 - Resort course list via CLI
* [http://moosh-online.com/ MOOSH] - MOOdle SHell. It is a commandline tool that will allow you to perform most common Moodle tasks.

[[fr:Administration en ligne de commande]]
[[de:Administration über Kommandozeile]]
[[ja:コマンドライン経由の管理]]
[[es:Administración por línea de comando]]