MoodleDocs - User contributions [en]

Using Git to backup moodledata

2015-01-13T23:38:17Z

Aborrow: actually it does not hurt to backup /muc/config.php

{{stub}}

[[GIT]] [https://docs.moodle.org/en/Development:Tracking_Moodle_CVS_with_git] is a distributed source code management system. For the purpose of this document, GIT's basic feature is that it allows to keep the whole history of a directory tree and track all changes. The basic idea of using GIT as a backup tool is that you can clone you moodledata directory on other disk and/or computer.

Create new file called .gitignore in the moodledata with the following content:

cache
lang
localcache
lock
sessions
temp
trashdir

Transform your moodledata into the git repository:

cd /srv/www/moodledata
git init
git add .
git commit -m "Initial commit of moodledata"

Put following commands into the cronjob

cd /srv/www/moodledata
git add .
git commit -a -m "AUTO: committed changes in moodledata"

Create a backup clone on local machine, e.g. on a separate disk

cd /mnt/backup
git clone --no-hardlinks --bare /srv/www/moodledata/.git datamoodle.git

Push changes into a bare clone

cd /srv/www/moodledata
git push /mnt/backup/datamoodle.git

Or, pull changes from the clone (here created on a separate machine)

git --bare fetch ssh://your.moodle.serv.er/backup/datamoodle.git master:master

[[Category:Git]]

Using Git to backup moodledata

2015-01-13T23:35:30Z

Aborrow: adding some other directories that I think are save to ignore

{{stub}}

[[GIT]] [https://docs.moodle.org/en/Development:Tracking_Moodle_CVS_with_git] is a distributed source code management system. For the purpose of this document, GIT's basic feature is that it allows to keep the whole history of a directory tree and track all changes. The basic idea of using GIT as a backup tool is that you can clone you moodledata directory on other disk and/or computer.

Create new file called .gitignore in the moodledata with the following content:

cache
lang
localcache
lock
muc
sessions
temp
trashdir

Transform your moodledata into the git repository:

cd /srv/www/moodledata
git init
git add .
git commit -m "Initial commit of moodledata"

Put following commands into the cronjob

cd /srv/www/moodledata
git add .
git commit -a -m "AUTO: committed changes in moodledata"

Create a backup clone on local machine, e.g. on a separate disk

cd /mnt/backup
git clone --no-hardlinks --bare /srv/www/moodledata/.git datamoodle.git

Push changes into a bare clone

cd /srv/www/moodledata
git push /mnt/backup/datamoodle.git

Or, pull changes from the clone (here created on a separate machine)

git --bare fetch ssh://your.moodle.serv.er/backup/datamoodle.git master:master

[[Category:Git]]

cohort/upload

2014-11-24T08:12:41Z

Aborrow: Replaced content with "#REDIRECT Upload_cohorts"

#REDIRECT [[Upload_cohorts]]

Upload cohorts

2014-11-24T08:11:53Z

Aborrow:

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]]. {{New features}}

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextid</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]
* [[Cohorts#Creating_cohorts_in_bulk|Creating cohorts in bulk]]

Upload cohorts

2014-11-24T08:10:53Z

Aborrow: adding new features

{{Accounts}} {{New features}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextid</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]
* [[Cohorts#Creating_cohorts_in_bulk|Creating cohorts in bulk]]

Cohorts

2014-11-24T08:10:10Z

Aborrow: /* Creating cohorts in bulk */

{{Grouping users}}
Cohorts are site-wide or category-wide groups. Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses. {{New features}}
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==
{{New features}}
#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[Upload_cohorts|Upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email, cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com, year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com, year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').
{{New features}}

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

{{New features}}

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==
Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Cohorts

2014-11-24T08:09:27Z

Aborrow: /* Creating cohorts in bulk */

{{Grouping users}}
Cohorts are site-wide or category-wide groups. Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses. {{New features}}
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==
{{New features}}
#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[Upload_cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email, cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com, year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com, year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').
{{New features}}

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

{{New features}}

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==
Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

admin/setting/userdefaultpreferences

2014-11-24T08:08:10Z

Aborrow: Replaced content with "#REDIRECT User_default_preferences"

#REDIRECT [[User_default_preferences]]

admin/setting/userdefaultpreferences

2014-11-24T07:59:04Z

Aborrow: redirecting to User default preferences page

#REDIRECT [[User_default_preferences]]

{{Accounts}}

User default preferences allow a site administrator to specify the default values for some of the user profile options including:
==Email display==
:<pre>Allow only other course members to see my email address</pre> [default]
:<pre>Hide my email address from everyone</pre>
:<pre>Allow everyone to see my email address</pre>
==Email format==
:<pre>Pretty HTML format</pre> [default]
:<pre>Plain text format</pre>
==Email digest type==
:<pre>No digest (single email per forum post)</pre> [default]
:<pre>Complete (daily email with full posts)</pre>
:<pre>Subjects (daily email with subjects only)</pre>
==Forum auto-subscibe==
:<pre>Yes: when I post, subscibe me to that forum discussion</pre> [default]
:<pre>No: don't automatically subscibe me to forum discussions</pre>
==Forum tracking==
:<pre>No: don't keep track of posts I have seen</pre> [default]
:<pre>Yes: highlight new posts for me</pre>

User default preferences

2014-11-24T07:56:11Z

Aborrow: creating User default preferences page

{{Accounts}}

User default preferences allow a site administrator to specify the default values for some of the user profile options including:
==Email display==
:<pre>Allow only other course members to see my email address</pre> [default]
:<pre>Hide my email address from everyone</pre>
:<pre>Allow everyone to see my email address</pre>
==Email format==
:<pre>Pretty HTML format</pre> [default]
:<pre>Plain text format</pre>
==Email digest type==
:<pre>No digest (single email per forum post)</pre> [default]
:<pre>Complete (daily email with full posts)</pre>
:<pre>Subjects (daily email with subjects only)</pre>
==Forum auto-subscibe==
:<pre>Yes: when I post, subscibe me to that forum discussion</pre> [default]
:<pre>No: don't automatically subscibe me to forum discussions</pre>
==Forum tracking==
:<pre>No: don't keep track of posts I have seen</pre> [default]
:<pre>Yes: highlight new posts for me</pre>

cohort/upload

2014-11-24T07:52:00Z

Aborrow: Redirected page to Upload cohorts

#REDIRECT [[Upload_cohorts]]

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextid</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]
* [[Cohorts#Creating_cohorts_in_bulk|Creating cohorts in bulk]]

Upload cohorts

2014-11-24T07:51:08Z

Aborrow: creating upload cohorts page

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextid</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]
* [[Cohorts#Creating_cohorts_in_bulk|Creating cohorts in bulk]]

Talk:admin/setting/userdefaultpreferences

2014-11-23T23:14:26Z

Aborrow: Created page with "Similarly to the upload cohorts page, I created this using the auto-generate link at the bottom of the page; however, I wonder if it should redirect or be renamed to a page wi..."

Similarly to the upload cohorts page, I created this using the auto-generate link at the bottom of the page; however, I wonder if it should redirect or be renamed to a page with a reader friendlier name like Default user preferences.

Talk:cohort/upload

2014-11-23T23:12:07Z

Aborrow: Created page with "Should this page be renamed to Upload cohorts? I just used the auto-generate URL from within Moodle so that there would be a help page but visually it appears awkward on the A..."

Should this page be renamed to Upload cohorts? I just used the auto-generate URL from within Moodle so that there would be a help page but visually it appears awkward on the Accounts page - https://docs.moodle.org/32/en/Category:Accounts.

Cohorts

2014-11-23T23:07:22Z

Aborrow: reverting adding accounts

{{Grouping users}}
Cohorts are site-wide or category-wide groups. Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses. {{New features}}
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==
{{New features}}
#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[cohort/upload|upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email, cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com, year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com, year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').
{{New features}}

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

{{New features}}

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==
Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Cohorts

2014-11-23T23:04:54Z

Aborrow:

{{Grouping users}} {{Accounts}}
Cohorts are site-wide or category-wide groups. Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses. {{New features}}
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==
{{New features}}
#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[cohort/upload|upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email, cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com, year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com, year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').
{{New features}}

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

{{New features}}

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==
Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

admin/setting/userdefaultpreferences

2014-11-23T23:00:35Z

Aborrow:

admin/setting/userdefaultpreferences

2014-11-23T22:58:25Z

Aborrow:

{{Accounts}}

User default preferences allow a site administrator to specify the default values for some of the user profile options including:
*Email display
:<pre>Allow only other course members to see my email address</pre> [default]
:<pre>Hide my email address from everyone</pre>
:<pre>Allow everyone to see my email address</pre>
*Email format
:<pre>Pretty HTML format</pre> [default]
:<pre>Plain text format</pre>
*Email digest type
:<pre>No digest (single email per forum post)</pre> [default]
:<pre>Complete (daily email with full posts)</pre>
:<pre>Subjects (daily email with subjects only)</pre>
*Forum auto-subscibe
:<pre>Yes: when I post, subscibe me to that forum discussion</pre> [default]
:<pre>No: don't automatically subscibe me to forum discussions</pre>
*Forum tracking
:<pre>No: don't keep track of posts I have seen</pre> [default]
:<pre>Yes: highlight new posts for me</pre>

admin/setting/userdefaultpreferences

2014-11-23T22:53:58Z

Aborrow: Creating admin/setting/userdefaultpreferences

{{Accounts}}

User default preferences allow a site administrator to specify the default values for some of the user profile options including:
*Email display
;Allow only other course members to see my email address [default]
;Hide my email address from everyone
;Allow everyone to see my email address
*Email format
;Pretty HTML format [default]
;Plain text format
*Email digest type
;No digest (single email per forum post) [default]
;Complete (daily email with full posts)
;Subjects (daily email with subjects only)
Forum auto-subscibe
;<pre>Yes: when I post, subscibe me to that forum discussion</pre>
;<pre>No: don't automatically subscibe me to forum discussions</pre>
Forum tracking
;<pre>No: don't keep track of posts I have seen</pre> [default]
;<pre>Yes: highlight new posts for me</pre> [default]

Cohorts

2014-11-23T22:39:25Z

Aborrow: /* See also */ - adding a link to cohort/upload

{{Grouping users}}
Cohorts are site-wide or category-wide groups. Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses. {{New features}}
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==
{{New features}}
#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[cohort/upload|upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email, cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com, year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com, year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').
{{New features}}

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

{{New features}}

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==
Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[[cohort/upload|Upload cohorts]]
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Cohorts

2014-11-23T22:33:52Z

Aborrow: /* Creating cohorts in bulk */

{{Grouping users}}
Cohorts are site-wide or category-wide groups. Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically

==Creating a cohort==

Cohorts can be created by site administrators and other users with appropriate permissions.

* Access ''Administration > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort1.png|thumb|center|400px]]
* Click the Add button
*'''NOTE''' In the dropdown you can choose between making your cohort available throughout the site "system" or in a named category.
*Cohorts are visible to teachers by default but unchecking the 'Visible' link will mean they are not available for teachers to use in their courses. {{New features}}
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:cohortscreen.png|thumb|center|600px]]
* Select potential users from the list then click the Add button.

To synchronise cohort members with course participants, the [[Cohort sync]] enrolment plugin should be enabled in ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Creating cohorts in bulk==
{{New features}}
#Cohorts can be created with a csv file upload to the system or to a named category from ''Site administration>Users>Accounts>Cohorts>Upload cohorts''. More detailed information can be found on the [[cohort/upload|upload cohorts]] page.
#Category managers can upload csv files to create cohorts from the Cohorts link in the Administration block of their category.
#An example file is below. The 'Students 2014-15' cohort will be created in the system and the 'History' cohort will be created in the (already existing) Humanities category:

[[File:cohortupload.png|center|thumb|600px]]

==Adding users to a cohort in bulk==

#Access ''Administration > Site administration > Users > Accounts > Bulk user actions''
#Find users by setting an appropriate filter
#Add users from the available list to the selected list
#Choose 'Add to cohort' with selected users

==Uploading users to a cohort==

An administrator can [[Upload users|upload users]] via CSV file to existing cohorts as follows:
#Access ''Administration > Site administration > Users > Accounts > Upload users''
#Upload a text file with the following format:

username,password,firstname,lastname,email, cohort1
tomjones,Pass1234*,Tom,Jones,tomjones@example.com, year3
marysmith,Pass1234*,Mary,Smith,marysmith@example.com, year4

where year3 and year4 are the '''cohort ids''' of existing cohorts (i.e. ''not their names'').
{{New features}}

''Note: If the users already exist on the system, then you only need their username with the chosen cohort in your csv file.''

It is also possible to create the cohort at the same time as the users are uploaded to the system.
username,password, firstname,lastname,email,cohort1
jackbrown,Pass5678,Jack,Brown,jbrown@example.com,London Contingent
In the above example, the cohort named London Contingent will be created upon upload of the csv file.

==Searching cohorts==
When a site has a large number of cohorts, keywords may be entered into the Search Cohorts box to search for or filter the available
cohorts.

{{New features}}

An All Cohorts screen accessed from ''Site administration>Users>Accounts>Cohorts'' allows an administrator to view and search through system and category cohorts.

[[File:AllCohortsscreen.png|thumb|center|600px]]

==Managing category cohorts==
Cohorts which have been created for a category rather than the system can be located by selecting the appropriate category and then clicking the ''Cohorts'' link in ''Administration>Category (name)>Cohorts''

==Cohort capabilities==

*[[Capabilities/moodle/cohort:assign|Add and remove cohort members]]
*[[Capabilities/moodle/cohort:manage|Create, delete and move cohorts]]
*[[Capabilities/enrol/cohort:config|Configure cohort instances]]
*[[Capabilities/moodle/cohort:view|View site-wide cohorts]]

==See also==

*[[Cohort sync]] enrolment method
*[http://youtu.be/FQ6RjeU3ybQ?list=PLxcO_MFWQBDdJmqW4tD5qXJ6pPXWTP7GL Cohorts 2.8 screencast] from Moodle HQ
*MDL-34189 Make category cohorts visible site-wide for site administrators
*[http://www.somerandomthoughts.com/blog/2011/11/22/using-cohorts-with-moodle-2-2/ Using cohorts with Moodle 2.2] blog entry by Gavin Henrick

[[Category:Site administration]]

[[fr:Cohortes]]
[[de:Globale Gruppen]]
[[es:Cohortes]]
[[ja:コーホート]]

Managing accounts

2014-11-23T22:31:19Z

Aborrow:

{{Managing a Moodle site}}

An administrator can perform various tasks relating to user accounts in ''Administration > Site administration > Users > Accounts''. The links below provide more information:

* [[Browse list of users]] - how to search for, find and edit user accounts
* [[Bulk user actions]] - how to message, confirm, download or perform other actions on a large group of users globally
* [[Add a new user]] - how to create one individual user account
* [[admin/setting/userdefaultpreferences|User default preferences]] - how to set user default preferences
* [[User profile fields]] - how to create customised profile fields
* [[Cohorts]] - how to create cohorts of users
* [[Upload users]] - how to bulk create new user accounts
* [[Upload user pictures]] - how to bulk upload profile pictures for users

* [[Additional name fields]]

==See also==

*[[Accounts FAQ]]

[[Category:Accounts]]

[[de:Nutzerverwaltung]]

cohort/upload

2014-11-23T22:24:41Z

Aborrow: /* Default context */

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextid</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]
* [[Cohorts#Creating_cohorts_in_bulk|Creating cohorts in bulk]]

cohort/upload

2014-11-23T22:22:58Z

Aborrow: /* See also */

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextd</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]
* [[Cohorts#Creating_cohorts_in_bulk|Creating cohorts in bulk]]

cohort/upload

2014-11-23T22:21:25Z

Aborrow: /* File */

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the [[cohort/upload#File_format_for_the_upload_cohorts_file|File format for the upload cohorts file]] section for more detailed information about the cohorts upload file.

====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextd</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]

cohort/upload

2014-11-23T22:19:56Z

Aborrow: /* CSV delimiter */

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the File format for the upload cohorts file section for more detailed information about the cohorts upload file.
====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> - uses the comma character as the field delimiter
; <pre>;</pre> - uses the semicolon character as the field delimiter
; <pre>:</pre> - uses the colon character as the field delimiter
; <pre>\t</pre> - uses \t (tab) as the field delimiter

====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextd</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]

cohort/upload

2014-11-23T22:18:59Z

Aborrow: creating an initial page for cohort/upload

{{Accounts}}
An administrator can upload multiple cohorts from a CSV (comma separated values) formatted text file in ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts''. Cohorts can be created in both the system (site-wide) context or in the [[Course_categories|course category context]].

==Upload cohort process==
Here is an outline of the process:

# Create cohort file for uploading (CSV text file with a 'name' column and the name of each new cohort on a new line)
# Go to ''Administration > Site administration > Users > Accounts > Cohorts > Upload cohorts'
# Add file to upload
# Upload cohort preview - review settings and check for any errors. If errors are reported with the file, correct as needed.
# Upload cohorts - click "Upload cohorts"
# Upload cohorts results - shows how many cohorts were created
# Upload cohorts results - click "Continue"
# Returns to Upload users screen

===Settings===
====File====
The CSV formatted text file containing cohort data to be uploaded. See the File format for the upload cohorts file section for more detailed information about the cohorts upload file.
====CSV delimiter====
The character used as a delimiter between fields in the cohort upload file. The delimiter separates the various fields on a single line. By default, a comma (',') is used as the delimiter; however, other options are available.
; <pre>,</pre> : uses the comma character as the field delimiter
; <pre>;</pre> : uses the semicolon character as the field delimiter
; <pre>:</pre> : uses the colon character as the field delimiter
; <pre>\t</pre> : uses \t (tab) as the field delimiter
====Encoding====
You can specify the character encoding of the upload cohorts file. The default character encoding is UTF-8.
====Default context====
You can specify the default context to use from a list of available contexts. The default context is the System context (i.e. site-wide). A list of course categories will be listed and one of those course categories can be selected as the default context if one is not provided in the upload cohorts file. If the <code>contextid</code> (or one of the available fields to lookup the <code>contextd</code>) is provided, then that value will be used; however, if a contextid is not provided for a particular cohort the default context will be used.

==File format for the upload cohorts file==
The upload cohorts CSV text file has fields separated by a comma (or other delimiter). The first line contains valid field names (preferrably lower case). The rest of the lines (records) contain information about each new cohort.

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload.
'':Tip:'' You can use a spreadsheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can then be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload cohorts file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''name,idnumber,description'''
Class of 2019,2019,Members of the Class of 2019
Class of 2020,2020,Members of the Class of 2020

===Fields that can be included===

*'''Required fields''':
:<code>name</code> - the name of the cohort to be created

*'''Optional fields''': To provide values other than the default include one or more of the following optional fields:
:<code>contextid</code> - used to specify the context id number of the cohorts you are uploading. For example, the context id number of a particular course category.
:<code>idnumber</code> - used to provide an id number for the cohorts you are uploading
:<code>description</code> - used to provide a description for the cohorts you are uploading
:<code>descriptionformat</code> - used to specify the text format of the description. By default, the descriptionformat is set to the recommended value of 1 (FORMAT_HTML); however, values of 0 (FORMAT_MOODLE) and 2 (FORMAT_PLAIN) are also available. These format values are defined in lib/weblib.php.
:<code>visible</code> - used to specify whether the cohorts you are uploading should be visible (1) or not (0).

*'''Additional fields''' : If needed, there are some additional fields that while not normally used can be utilized. Additional fields typically require looking up information in other tables (such as the course categories or context tables). The additional fields provide an alternative way of finding the course category context id. A bit of extra caution is recommended in using these additional fields. The list of additional fields includes:
:<code>context</code> - used to specify the name of the context name for each of the cohorts you are uploading.
:<code>category</code> - used to specify the name of the category name for each of the cohorts you are uploading. For example, the category name of a particular course category.
:<code>category_id</code> - used to specify the course category id (not idnumber) of the category for each of the cohorts you are uploading. For example, the course category id of a particular course category.
:<code>category_idnumber</code> - used to specify the course category idnumber (not id) of the category for each of the cohorts you are uploading. For example, the course category idnumber of a particular course category.
:<code>category_path</code> - used to specify the course category path of the category for each of the cohorts you are uploading. For example, the course category path of a particular course category.

== See also ==
* [[Cohorts]]

Context

2014-11-23T20:42:56Z

Aborrow: /* See also */

{{Main page}}
A context is a space in Moodle where [[Roles_and_capabilities|roles]] can be assigned. For example, a Moodle site is one context and that contains a number of other contexts within it. A category is a context, within a site context, that contains courses and sub-categories that have a context of their own.

A [[Courses|course]] may hold, within its own context, an activity, or a [[Question bank]]'s question category, which are also contexts. A context might contain other contexts and Roles can be assigned to each context.

There is a hierarchy of contexts which helps locate and define a specific space. A course can have many contexts in its space. These might include lesson, assignment, forum and quiz modules and blocks.

Generally speaking, this hierarchy allows a lower context to receive information from a higher context. Thus a student in the context of Course A, will initially be considered a student in a Quiz context that is located in Course A. Or when a theme has been set for the Biology course categories, that is passed on to Biology 101.

==Roles and contexts==
A context is combined with role permissions to define a User's [[Roles and capabilities|capabilities]] on any page in Moodle. Typically contexts have their own organization structure which allow a User's role to be passed along to the context "below" but not to the one above it.[[Image:context.png|right|thumb|150px|Each context can have a different role assigned to a User]]

It is possible to assign a user different permissions based upon a specific context. For example, a user might be given the role of "student" for a course but be given a teacher's role in the context of one specific forum. Or a user can be a teacher of one course and a student in another course.

Many Moodle contexts have a place to grant exceptions to specific roles within that context. Those exceptions are non-transferable from that context. That is, an exception can be applied to the next context downward, but cannot applied sideways nor upward from that context.

== Graphic showing contexts within contexts ==

The image below shows a few contexts and their relationships. The "System" or Moodle site is the overall context. The user is defined initially in this context.
*The System context has 2 contexts under it, with other context under them
**The Front page context has
*** An activity module context and
*** A block context within it
**The Course Category context has
***A Course context within it. The course context has
**** An activity module context and
****A block context within it

[[Image:Moodle-contexts-1.8.png]]

(Source: [[Development:Roles#Context]])

==Another graphic of hierarchy==
[[File:Hierarchycategories.png|thumb|center|Showing the Site > Category > Course contexts but not activities]]

== See also ==

* [[Roles FAQ]]
*[[Course_categories|Course categories context]]

[[es:Contexto]]
[[fr:Contextes]]
[[ja:コンテクスト]]

Context

2014-11-23T20:40:03Z

Aborrow: /* See also */ - adding the course categories context

{{Main page}}
A context is a space in Moodle where [[Roles_and_capabilities|roles]] can be assigned. For example, a Moodle site is one context and that contains a number of other contexts within it. A category is a context, within a site context, that contains courses and sub-categories that have a context of their own.

A [[Courses|course]] may hold, within its own context, an activity, or a [[Question bank]]'s question category, which are also contexts. A context might contain other contexts and Roles can be assigned to each context.

There is a hierarchy of contexts which helps locate and define a specific space. A course can have many contexts in its space. These might include lesson, assignment, forum and quiz modules and blocks.

Generally speaking, this hierarchy allows a lower context to receive information from a higher context. Thus a student in the context of Course A, will initially be considered a student in a Quiz context that is located in Course A. Or when a theme has been set for the Biology course categories, that is passed on to Biology 101.

==Roles and contexts==
A context is combined with role permissions to define a User's [[Roles and capabilities|capabilities]] on any page in Moodle. Typically contexts have their own organization structure which allow a User's role to be passed along to the context "below" but not to the one above it.[[Image:context.png|right|thumb|150px|Each context can have a different role assigned to a User]]

It is possible to assign a user different permissions based upon a specific context. For example, a user might be given the role of "student" for a course but be given a teacher's role in the context of one specific forum. Or a user can be a teacher of one course and a student in another course.

Many Moodle contexts have a place to grant exceptions to specific roles within that context. Those exceptions are non-transferable from that context. That is, an exception can be applied to the next context downward, but cannot applied sideways nor upward from that context.

== Graphic showing contexts within contexts ==

The image below shows a few contexts and their relationships. The "System" or Moodle site is the overall context. The user is defined initially in this context.
*The System context has 2 contexts under it, with other context under them
**The Front page context has
*** An activity module context and
*** A block context within it
**The Course Category context has
***A Course context within it. The course context has
**** An activity module context and
****A block context within it

[[Image:Moodle-contexts-1.8.png]]

(Source: [[Development:Roles#Context]])

==Another graphic of hierarchy==
[[File:Hierarchycategories.png|thumb|center|Showing the Site > Category > Course contexts but not activities]]

== See also ==

* [[Roles FAQ]]
*[[Course_categories]]

[[es:Contexto]]
[[fr:Contextes]]
[[ja:コンテクスト]]

Upload users

2014-11-22T23:01:35Z

Aborrow: updating from 2.7 version of the page

{{Accounts}}
An administrator can upload multiple user accounts via text file in ''Administration > Site administration > Users > Accounts > Upload users''.

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

Rather than uploading the text file, it can simply dragged from the desktop and dropped into the upload area, as demonstrated in the screencast [http://youtu.be/6E-TQXTkZB0 Drag and drop new users into Moodle 2.3] (by Mary Cooch).

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

[[File:uploadusersnew.png|thumb|500px|center|Initial upload users screen]]

==Upload user process==
Here is an outline of the process:

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

==Updating users preview==
There are various settings to better control the desired upload behaviour. These settings are found on the "Upload users preview" page.
[[File:Upload users preview 2.0.JPG|thumb|center|Upload users preview in Moodle 2.x]]

===Settings===

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

====Upload type====
The Upload type specifies how to handle existing accounts.
;Add new only, skip existing users : is the default Moodle upload type. It creates a new user account for each new record in the uploaded file. If an existing <code>username</code> is found (i.e., the <code>username</code> in the uploaded file matches an existing <code>username</code>, that record is '''skipped'''. By skipping the existing user account, the data in the existing record is not touched (in contrast to the "Add new and update existing users" option) and a second new user account is '''not''' created (in contrast to the "Add all, append number to usernames if needed" option).
;Add all, append number to usernames if needed : creates a new user account for each record in the uploaded file. If an existing user account is found, a new account will be created with a number appended to the <code>username</code>. For example, if a user account for <code>username</code> 'jsmith' already exists and a new record in the uploaded file contains a record for <code>username</code> 'jsmith' an additional user account is created with a 1 '''appended''' to the <code>username</code> to produce user 'jsmith1'.
;Add new and update existing users : creates a new user account for each new user in the upload file. If an existing user account with the same <code>username</code> is found, the account information is '''updated''' by the data in the uploaded file.
;Update existing users only : ignores any new users found in the upload file and updates the user account if a matching <code>username</code> record is found in the uploaded file.

====New user password====
When creating a new user account Moodle can create a new password (if one is not provided) or require a password in the uploaded file.
;Create password if needed : creates a default password for the new user account if one is not provided in the uploaded file.
;Field required in file : requires that a password be provided in the uploaded file in order. If a password is not provided, an error is generated and the user account is not created.

====Existing user details====
The Existing user details options are only available when the Upload type allows existing user accounts to be updated. It specifies how Moodle should process user detail information for existing users.
;No changes : ignores user detail data in the uploaded and leaves the existing user account data unchanged.
;Override with file : overwrites data in the existing user account with the data provided in the uploaded file.
;Override with file and defaults : overwrites data in the existing user account with data provided in the uploaded file and fills in the default values for existing user details when no data is provided in the uploaded file.
;Fill in missing from file and defaults : adds data in the existing user account with data provided in the uploaded file if the field is empty (does not already contain data) and fills in the default values for existing user details when no data is provided in the uploaded file.

====Existing user password====
The Existing user password option specifies how to handle password data for existing user accounts when Existing user details is set to overwrite data.
;No changes : ignores password field in the uploaded user file and leaves the existing user account password untouched
;Update : overwrites the existing user account password with the password provided in the uploaded file

====Force password change====
The Force password change option specifies when to tag a user account so that the next login attempt will require the user to change the user's password.
;Users having a weak password : If the user account has a weak password as defined by the stie's [[Password_policy#Password_policy|Password policy]] then the user will be forced to change the password during the next login attempt. This option is not shown if there the site does not have a [[Password_policy#Password_policy|Password policy]], in other words <code>$CFG->passwordpolicy</code> must be set to see this option.
;None : None of the users in the uploaded file will be forced to change the password during the user's next login attempt.
;All : All of the users in the uploaded file will be forced to change the password during the user's next login attempt.

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

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

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

====Prevent email address duplicates====
It is possible, but '''not''' recommended to upload users with duplicate email addresses. By default, uploading users with duplicate email addresses is prevented. See MDL-38104 for some discussion. Further, since MDL-41115 added the ability for users to login with their email address it is even more important that duplicate email addresses be avoided.
;Yes : prevents user accounts from being created from the uploaded if an existing user account already has the same email address as found in the uploaded file's <eode>email</code> column.
;No : allows user accounts to be created if an existing user account already has the same email address found in the uploaded file's <code>email</code> column.

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

For those seeking a more technical explanation, the process for standardising the usernames consists of ensuring the characters are all UTF-8 (fix_utf8) encoded, converting the username to lower case, and then stripping out non-letters/non-number characters (unless <code>$CFG->extendedusernamechars</code> is set to true) with something similar to:

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

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

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

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

===Default values===

You can provide default user values for some fields not included in the uploaded file. Some fields include:
*Email display
*Forum auto-subscribe
*City/town
*ID number
*Insttitution
*Department

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

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

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

'':Tip:'' Avoid special characters in field information like quotes or other commas. Test a file with only one record before a large upload. Remember there are other ways to authenticate users on you site or enroll users in a course.

'':Tip:'' You can use a spread sheet program to create the file with the required columns and fields. Then save the file as "CSV (comma delimited)". These files can be opened with simple text editors for verification.

===Valid upload file for testing===
Here is an example of a simple valid upload file:
(Column headers on the first line of the file are only highlighted in bold in this example to distinguish it from the rest of the of the data/user details)

'''username,password,firstname,lastname,email,course1,group1,cohort1'''
jonest,verysecret,Tom,Jones,jonest@someplace.edu,math102,Section 1,year 3
reznort,somesecret,Trent,Reznor,reznort@someplace.edu,math102,Section 3,year 4

===Fields that can be included===
'':Tip:'' We strongly recommend that you test a file that contains fields you proposed to use with one user before attempting a file upload for the first time. http://demo.moodle.net might be a good place to see if your test file works.

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

*'''Password field''': "password" field is optional if "Create password if needed" setting is chosen (default).
**If included, values should meet the requirements for the site's [[Site_policies#Password_policy|Password policy]]. To force password change for a particular user, set the password field to <code>changeme</code>.
**If omitted, a password will be generated for each user (during the next Cron job) and welcome e-mails sent out.
**Note: the text for the welcome e-mail is in the language settings. Please refer to this [https://moodle.org/mod/forum/discuss.php?d=210359&parent=917138 forum thread]for details.

*'''Optional fields''': To provide values other than the default include one or more of these
:<code>institution,department,city,country,lang,auth,timezone,idnumber,icq,phone1,phone2,address,url,description,mailformat,maildisplay,htmleditor,autosubscribe</code>
*'''[[Additional name fields]]'''
*Country- use a country TWO LETTER CODE
*Some fields have a maximum number of characters that are allowed (notably institution should be '''at most 40 characters''' long). See hints below.
*Maildisplay, htmleditor and autosubscribe can be set from an import screen.

*'''Custom profile field names''': (Optional). xxxxx is the real custom user profile field name (i.e. the unique shortname)
:<code>profile_field_xxxxx</code>
: Create the custom fields BEFORE importing. Use the standard header. The "shortname" for your custom field is xxxxx (NB the shortname must be all lowercase, otherwise won't be recognised). The first record must include "profile_field_xxxxx".

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

: For custom profile fields that are a menu, use the corresponding value (new in Moodle 2.3 onwards).

For custom profile fields that are dates, use the ISO standard format YYYY-MM-DD, eg. 2014-06-19 which will then be properly localized in the interfaced.

:'''Example''': A custom field 'Department' with one of three values 'HR', 'Marketing' or 'Training'. Just insert one of those three words (e.g. 'Training') as the value for that field.

*'''Special fields''': Used for changing of usernames or deleting of users
:<code>oldusername</code>, <code>deleted</code>, <code>suspended</code>

*'''Enrolment fields''': (Optional):
:<code>course1,type1,role1,group1,enrolperiod1,enrolstatus1,course2,type2,role2,group2,enrolperiod2,enrolstatus2</code> etc.

:* Header fields must have a numeric suffix such that <code>type1</code>,<code>role1</code>,<code>group1</code>,<code>enrolperiod1</code> and <code>enrolstatus1</code> all apply to <code>course1</code> for course<code>1</code> to course<code>n</code>.
:*<code>course</code> is the "shortname" of the course, if present the user will be enrolled in that course.
:* <code>type</code> sets the role to be used for the enrolment. A value of <code>1</code> is default course role, <code>2</code> is legacy Teacher role and <code>3</code> is legacy Non-editing Teacher.
:* <code>role</code> may be used to specify roles directly, using either role short name or id (numeric names of roles are not supported).
:* <code>group</code> may be used to assign users to groups in course, using name or id (numeric group names are not supported)
:* <code>enrolperiod</code> may be used to set the enrolment duration, in days, for each course.
:* <code>enrolstatus</code> can suspend users from a course when set to 1 or left blank for enrolled.

*'''Cohort field''': (Optional):
:<code>cohort1</code>

:Internal cohort id numbers or non-numeric Cohort IDs of existing cohorts must be used; names are not allowed.
*'''mnethostid''' (Optional)

Existing [[MNet]]users can be added to courses, groups or cohorts as below:
#enrolling to courses: username+mnethostid+course required
# adding to group: username+mnethostid+course+group required
#adding to cohort: username+mnethostid+cohort required
#suspending/reviving accounts: username+mnethostid+suspended required
All other operations are ignored. You can not add users, delete them or update them (such as change names or email, profile fields, etc.)

Commas within a field must be encoded as &#44 - the script will decode these back to commas.

For Boolean fields, use <code>0</code> for false and <code>1</code> for true.

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

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

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

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

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

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

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

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

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

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

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

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

===Deleting accounts===

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

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

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

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

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

==Hints==

===Spreadsheet===

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

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

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

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

===Country===
The country should be written as a two letter code, in capitals. For example, use BE for Belgium or NL for the Netherlands. Using "be" or "nl" as a country code will result in a database error.
:''Tip:'' If you are having trouble working out the two-letter code for a country, you can consult the list of [http://www.iso.org/iso/country_names_and_code_elements country names and code elements] available on the ISO Website. A common error is to use UK for United Kingdom; it should be GB.

===Field size limits===
Some fields have maximum character lengths. Typically the file will import to the preview list screen but not finish the process. Turn on debug to see the fields that are too long. Common fields to cause problems are "Institution" which is limited to 40 characters, and "City", also limited (20 characters). The error will be "User not added - error".

===Time zones===

The entry is case sensitive so Europe/London will work but europe/london will not.

===All fields listed here===
:All the fields that are valid are listed below, except for any custom fields you may have created.
firstname, lastname, username, email, city, country, lang, timezone, mailformat, maildisplay, maildigest, htmleditor, ajax, autosubscribe ,institution, department, idnumber, skype , msn, aim, yahoo, icq, phone1, phone2, address, url, description, descriptionformat, password, auth, oldusername , deleted, suspended, course1, course2, course3, course4

===Enroll users to Cohorts (system groups)===
You can enroll users to any Cohort (system level group) by using only the "username" and the "Cohort ID".
Here is a sample CSV file:

'''username,cohort1'''
teacher1,system-teachers
teacher2,system-teachers
teacher3,system-teachers

Make sure you set "Upload type" to "Update existing users only" (So you are not asked to add firstname, lastname and email fields too)

== See also ==
* [http://youtu.be/PFGLZnuu_JI Adding users by using a CSV in Moodle] MoodleBites video on YouTube
*[[Flat file]] enrolment
* [[User profile fields]] for details of how to include data about custom user profile fields in the upload users file
* [[Upload courses]]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=36851 Can I auto enroll from Excel?]
*[http://moodle.org/mod/forum/discuss.php?d=97903 Uploading users to custom roles]
*[http://moodle.org/mod/forum/discuss.php?d=181259 User upload option: standardise usernames]
*[http://moodle.org/mod/forum/discuss.php?d=144569 Matriculacion con flat file csv] - discussion in Spanish

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

Venus theme

2013-04-04T04:59:29Z

Aborrow: adding link to tracker

'''Venus Theme'''

{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/view.php?plugin=theme_venus
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/12641
|discussion = https://moodle.org/mod/forum/discuss.php?d=225388
|maintainer = [[User:Gordon McLeod|Gordon McLeod]]
|float = left
}}

Earth theme

2013-04-04T04:58:46Z

Aborrow: adding tracker component url

'''Earth Theme'''

{{Infobox plugin
|type = Theme
|entry = https://moodle.org/plugins/view.php?plugin=theme_earth
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/12642
|discussion = https://moodle.org/mod/forum/discuss.php?d=225388
|maintainer = [[User:Maintainer name|Gordon McLeod]]
|float = left
}}

Count user block

2013-03-29T20:26:36Z

Aborrow: updating name of Github.com repository

This plug-in is the block which counts the number assigned to the roll within a course like moodle1.9.
Only an administrator can use.
When it installs in the front page of moodle, this block considers the load of a server and a total button is not displayed.

github:

https://github.com/h-honda/moodle-block_countuser

Database templates

2012-01-08T02:59:42Z

Aborrow: /* Tag usage */

{{Database}}
{{Update}}
Templates for the [[Database activity module]] allow you to control the visual layout of information when listing, viewing or editing database entries. It is a similar to the technique used to ''mail merge'' letters in word processors such as Open Office Writer or Microsoft Word.

== Tag usage ==

The content of each [[Database fields|field]] you create for your database and some special tags (listed below) can be inserted into the output template by the use of tags.

Fields have the format <code><nowiki>[[fieldname]]</nowiki></code>. All other tags have the format <code>##sometag##</code>.

To use the tags in the box on the left of the page, use the HTML viewer, place your cursor in the text area of your target edit and then click on the tag you want to place. Alternatively, you may simply type the appropriate name within the required symbols like <code>##this##</code> or <code><nowiki>[[this]]</nowiki></code>, respectively.

* <code>##edit##</code> creates a clickable icon link that allows you to edit the current entry (only appears if you have the rights to do this)
* <code>##delete##</code> creates a link that lets you delete the current entry (only appears if you have the rights to do this)
* <code>##approve##</code> create a link that lets you approve the current database entry (only appears if you have the rights to do this)
* <code>##more##</code> creates a link to the single view, which may contain more detailed info
* <code>##moreurl##</code> creates just the URL for the above link, useful for creating your own links. You can click on the link icon and type <code>##moreurl##</code> into URL field or in source view type <pre><a href="##moreurl##">[[fieldname]]</a></pre>
* <code>##comments##</code> creates a link to the view/edit comments page, the link text is the current number of comments (only appears if comments are turned on)
* <code>##user##</code> creates a link to the user page of the user who submitted the entry, link text is their name
* <code>##timeadded##</code>
* <code>##timemodified##</code>

== List template ==

This template allows you to control the fields used and their layout when viewing multiple entries at once (e.g. search results). It is possible that this view may simply provide an overview with more detailed information available by clicking on an entry to access the single view of the entry.

See [http://tracker.moodle.org/secure/attachment/23333/moodle_databse_activity_list_formatting.pdf Designing a list view in Moodle database activity] for instructions on how to create a list template table.

The list template can also be used as a way to [[Database export|export your database]] as a CSV file.

== Single template ==
This is used to display a single entry at a time and so has more space for display and can use, for example, larger versions of images or optionally provide more information than shown in the list view.

[[Image:Databasesingletemplate.png]]

== Advanced search template ==

An advanced search template is for creating the interface form used in the advanced search.

== Add template ==

This template creates the interface form used when adding or editing database entries.

== RSS template ==

Lets you control the content of the [[RSS]] feed for database entries.

== CSS template ==

If any of the [[HTML in Moodle|HTML]] in your other templates requires [[CSS]] to provide visual style you can specify it here.

== Javascript template ==

You can use javascript to manipulate the way elements are displayed in either the List, Single or Add templates. Basically you need to enclose the part you want to manipulate in some named html element. The naming is essential as it allows you to identify the element for manipulation.

Let's say, for example, you have a field in your database that stores a person's name and when you display the names in the List View you want to count the times a name matches some criteria and display the result.

Your database will contain a field which we will call "name". In your List template you will be able to display the contents of that field by using the <nowiki>[[name]]</nowiki> construct at the place where you want that information displayed. For example in the ''Repeated entry'' on the list template you will have

<pre>
<table>
<tr>
<td>Name: [[name]]</td>
</tr>
<table>
</pre>

You now need to modify that entry to ensure that the part you want to manipulate is a named element.

<pre>
<table>
<tr>
<td name="named">Name: [[name]]</td>
</tr>
<table>
</pre>

The footer of your list view can then contain another named element to display the result.

<pre>
<div name="result"></div>
</pre>

Your javascript template can now look as follows

<pre>
var cnt = 0;
var re = /foo|Foo/;

function init(){
var namedElements = document.getElementsByName("named");
for (i=0; i < namedElements.length; i++) {
if(re.test(namedElements[i].innerHTML)) cnt++;
}
var namedResult = document.getElementsByName("result");
namedResult[0].innerHTML = cnt;
}

window.onload = init;
</pre>

This will display a table of names as is usual in the list view. Now at the bottom there will also be the count of the names that matched foo or Foo.

== Reset templates button ==

When you first create a database the templates will be pre-filled with appropriate HTML. If you later add fields then you can press the ''reset templates'' button and it will add HTML for the new fields in a similar fashion. If you have edited any of the templates in the meantime then your changes will be lost. It is recommended that you finalize the database fields before changing the template code.

==See also==
*[[Database presets]]
*[http://video.google.com/videoplay?docid=7026851446099005477 Video demonstrating tag usage]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=55338 Look of the database module]
*[http://moodle.org/mod/forum/discuss.php?d=74243 How can I list database information horizontally instead of vertically?]
*[http://moodle.org/mod/forum/discuss.php?d=61179 For those who want the display of Moodle Site's Modules and plugins]
*[http://moodle.org/mod/forum/discuss.php?d=84050 Can't get columns to line up in list view]
*[http://moodle.org/mod/forum/discuss.php?d=86927 Time stamp for database entries?]

[[de:Datenbank-Vorlagen]]
[[fr:Modèles]]
[[ru:Шаблоны]]
[[ja:データベーステンプレート]]

Birthday block

2011-09-15T13:29:36Z

Aborrow: /* Importing data */

==Birthday Block==

The Birthday Block makes use of a user profile date field to store the date of birth (or anniversary) for each user. The Birthday Block alphabettically displays the user's full name with picture and the ability to click on the send message icon to directly send the user a Moodle message.

The settings page allows the site admin to select which user profile date field to use (currently only one can be used throughout the site). The data stored in the user profile date field is now a unix timestamp (this was not the case in the 1.9 version). Typically institutions auto-populate this field using a CSV upload of the data and then prevent the users from editing the data.

===Installation===

*Copy the files into the \blocks folder.
*Go to the \admin page and allow the block to be installed
*Go to Users, Accounts, User profile fields
*Create a new user profile date field
*Input a Shortname (for example, dob), Name (for example, Birthday), and a Description
*Generally speaking, it is recommended that the field not be required, that it be locked, and visible to user
*Click on the Save Changes button
*In the Site Administration Block, click on Modules, Blocks, and the settings link for the Birthday block
*Select the newly created user profile date field you wish to use to store the birth dates
*Enter the Birth Dates into the created user profile date field (or upload them via a CSV file)
*Add the Birthday block to your page to see a list of those celebrating birthdays

===Languages===

Thanks to the generosity of translators, the Birthday Block is available in many languages:
*English
*Spanish
*French
*Japanese
*German
*Italian
*and many more

If the block is not available in your language feel free to contact me so that we can create one.

===Importing data===

It is possible to mass import the user profile date field data when importing users. More detailed instructions are available on the [https://docs.moodle.org/20/en/Upload_users#Fields_that_can_be_included Upload users] page. In 1.9, the data imported was a text string of a date in either ISO, EUR, or USA format. In 2.0 and beyond, the data imported for the date of birth should be a Unix timestamp.

===Styling===

Styling varies from theme to theme. The following has been setup in the birthday block's styles.php file:

.block_birthday .listentry div.user { float: left; }
.block_birthday .listentry div.message { float: right; }

Some themes allow for the styles.css to be overridden or added to.

===Contributor/Maintainer===
The Birthday Block was contributed and is maintained by [https://docs.moodle.org/20/en/User:Anthony_Borrow Anthony Borrow].

===See also===
[http://moodle.org/mod/data/view.php?d=13&rid=901 Birthday block's Modules and Plugins database entry]

[[Category:Contributed code]]

Birthday block

2011-07-31T03:48:36Z

Aborrow:

==Birthday Block==

The Birthday Block makes use of a user profile date field to store the date of birth (or anniversary) for each user. The Birthday Block alphabettically displays the user's full name with picture and the ability to click on the send message icon to directly send the user a Moodle message.

The settings page allows the site admin to select which user profile date field to use (currently only one can be used throughout the site). The data stored in the user profile date field is now a unix timestamp (this was not the case in the 1.9 version). Typically institutions auto-populate this field using a CSV upload of the data and then prevent the users from editing the data.

===Installation===

*Copy the files into the \blocks folder.
*Go to the \admin page and allow the block to be installed
*Go to Users, Accounts, User profile fields
*Create a new user profile date field
*Input a Shortname (for example, dob), Name (for example, Birthday), and a Description
*Generally speaking, it is recommended that the field not be required, that it be locked, and visible to user
*Click on the Save Changes button
*In the Site Administration Block, click on Modules, Blocks, and the settings link for the Birthday block
*Select the newly created user profile date field you wish to use to store the birth dates
*Enter the Birth Dates into the created user profile date field (or upload them via a CSV file)
*Add the Birthday block to your page to see a list of those celebrating birthdays

===Languages===

Thanks to the generosity of translators, the Birthday Block is available in many languages:
*English
*Spanish
*French
*Japanese
*German
*Italian
*and many more

If the block is not available in your language feel free to contact me so that we can create one.

===Importing data===

It is possible to mass import the user profile date field data when importing users. More detailed instructions are available on the [https://docs.moodle.org/20/en/Upload_users#Fields_that_can_be_included Upload users] page.

===Styling===

Styling varies from theme to theme. The following has been setup in the birthday block's styles.php file:

.block_birthday .listentry div.user { float: left; }
.block_birthday .listentry div.message { float: right; }

Some themes allow for the styles.css to be overridden or added to.

===Contributor/Maintainer===
The Birthday Block was contributed and is maintained by [https://docs.moodle.org/20/en/User:Anthony_Borrow Anthony Borrow].

===See also===
[http://moodle.org/mod/data/view.php?d=13&rid=901 Birthday block's Modules and Plugins database entry]

[[Category:Contributed code]]

Birthday block

2011-07-31T03:47:53Z

Aborrow: /* Contributor/Maintainer */

==Birthday Block==

The Birthday Block makes use of a user profile date field to store the date of birth (or anniversary) for each user. The Birthday Block alphabettically displays the user's full name with picture and the ability to click on the send message icon to directly send the user a Moodle message.

The settings page allows the site admin to select which user profile date field to use (currently only one can be used throughout the site). The data stored in the user profile date field is now a unix timestamp (this was not the case in the 1.9 version). Typically institutions auto-populate this field using a CSV upload of the data and then prevent the users from editing the data.

===Installation===

*Copy the files into the \blocks folder.
*Go to the \admin page and allow the block to be installed
*Go to Users, Accounts, User profile fields
*Create a new user profile date field
*Input a Shortname (for example, dob), Name (for example, Birthday), and a Description
*Generally speaking, it is recommended that the field not be required, that it be locked, and visible to user
*Click on the Save Changes button
*In the Site Administration Block, click on Modules, Blocks, and the settings link for the Birthday block
*Select the newly created user profile date field you wish to use to store the birth dates
*Enter the Birth Dates into the created user profile date field (or upload them via a CSV file)
*Add the Birthday block to your page to see a list of those celebrating birthdays

===Languages===

Thanks to the generosity of translators, the Birthday Block is available in many languages:
*English
*Spanish
*French
*Japanese
*German
*Italian
*and many more

If the block is not available in your language feel free to contact me so that we can create one.

===Advanced Options===

It is possible to mass import the user profile date field data when importing users. More detailed instructions are available on the [https://docs.moodle.org/20/en/Upload_users#Fields_that_can_be_included Upload users] page.

===Styling===

Styling varies from theme to theme. The following has been setup in the birthday block's styles.php file:

.block_birthday .listentry div.user { float: left; }
.block_birthday .listentry div.message { float: right; }

Some themes allow for the styles.css to be overridden or added to.

===Contributor/Maintainer===
The Birthday Block was contributed and is maintained by [https://docs.moodle.org/20/en/User:Anthony_Borrow Anthony Borrow].

===See also===
[http://moodle.org/mod/data/view.php?d=13&rid=901 Birthday block's Modules and Plugins database entry]

[[Category:Contributed code]]

Birthday block

2011-07-31T03:47:29Z

Aborrow: /* Contributor/Maintainer */

==Birthday Block==

The Birthday Block makes use of a user profile date field to store the date of birth (or anniversary) for each user. The Birthday Block alphabettically displays the user's full name with picture and the ability to click on the send message icon to directly send the user a Moodle message.

The settings page allows the site admin to select which user profile date field to use (currently only one can be used throughout the site). The data stored in the user profile date field is now a unix timestamp (this was not the case in the 1.9 version). Typically institutions auto-populate this field using a CSV upload of the data and then prevent the users from editing the data.

===Installation===

*Copy the files into the \blocks folder.
*Go to the \admin page and allow the block to be installed
*Go to Users, Accounts, User profile fields
*Create a new user profile date field
*Input a Shortname (for example, dob), Name (for example, Birthday), and a Description
*Generally speaking, it is recommended that the field not be required, that it be locked, and visible to user
*Click on the Save Changes button
*In the Site Administration Block, click on Modules, Blocks, and the settings link for the Birthday block
*Select the newly created user profile date field you wish to use to store the birth dates
*Enter the Birth Dates into the created user profile date field (or upload them via a CSV file)
*Add the Birthday block to your page to see a list of those celebrating birthdays

===Languages===

Thanks to the generosity of translators, the Birthday Block is available in many languages:
*English
*Spanish
*French
*Japanese
*German
*Italian
*and many more

If the block is not available in your language feel free to contact me so that we can create one.

===Advanced Options===

It is possible to mass import the user profile date field data when importing users. More detailed instructions are available on the [https://docs.moodle.org/20/en/Upload_users#Fields_that_can_be_included Upload users] page.

===Styling===

Styling varies from theme to theme. The following has been setup in the birthday block's styles.php file:

.block_birthday .listentry div.user { float: left; }
.block_birthday .listentry div.message { float: right; }

Some themes allow for the styles.css to be overridden or added to.

===Contributor/Maintainer===
The Birthday Block was contributed and is maintained by [User:Anthony_Borrow Anthony Borrow].

===See also===
[http://moodle.org/mod/data/view.php?d=13&rid=901 Birthday block's Modules and Plugins database entry]

[[Category:Contributed code]]

Birthday block

2011-07-31T03:47:11Z

Aborrow:

==Birthday Block==

The Birthday Block makes use of a user profile date field to store the date of birth (or anniversary) for each user. The Birthday Block alphabettically displays the user's full name with picture and the ability to click on the send message icon to directly send the user a Moodle message.

The settings page allows the site admin to select which user profile date field to use (currently only one can be used throughout the site). The data stored in the user profile date field is now a unix timestamp (this was not the case in the 1.9 version). Typically institutions auto-populate this field using a CSV upload of the data and then prevent the users from editing the data.

===Installation===

*Copy the files into the \blocks folder.
*Go to the \admin page and allow the block to be installed
*Go to Users, Accounts, User profile fields
*Create a new user profile date field
*Input a Shortname (for example, dob), Name (for example, Birthday), and a Description
*Generally speaking, it is recommended that the field not be required, that it be locked, and visible to user
*Click on the Save Changes button
*In the Site Administration Block, click on Modules, Blocks, and the settings link for the Birthday block
*Select the newly created user profile date field you wish to use to store the birth dates
*Enter the Birth Dates into the created user profile date field (or upload them via a CSV file)
*Add the Birthday block to your page to see a list of those celebrating birthdays

===Languages===

Thanks to the generosity of translators, the Birthday Block is available in many languages:
*English
*Spanish
*French
*Japanese
*German
*Italian
*and many more

If the block is not available in your language feel free to contact me so that we can create one.

===Advanced Options===

It is possible to mass import the user profile date field data when importing users. More detailed instructions are available on the [https://docs.moodle.org/20/en/Upload_users#Fields_that_can_be_included Upload users] page.

===Styling===

Styling varies from theme to theme. The following has been setup in the birthday block's styles.php file:

.block_birthday .listentry div.user { float: left; }
.block_birthday .listentry div.message { float: right; }

Some themes allow for the styles.css to be overridden or added to.

===Contributor/Maintainer===
The Birthday Block was contributed and is maintained by [User:Anthony_Borrow|Anthony Borrow].

===See also===
[http://moodle.org/mod/data/view.php?d=13&rid=901 Birthday block's Modules and Plugins database entry]

[[Category:Contributed code]]

Birthday block

2011-07-31T03:46:04Z

Aborrow:

==Birthday Block==

The Birthday Block makes use of a user profile date field to store the date of birth (or anniversary) for each user. The Birthday Block alphabettically displays the user's full name with picture and the ability to click on the send message icon to directly send the user a Moodle message.

The settings page allows the site admin to select which user profile date field to use (currently only one can be used throughout the site). The data stored in the user profile date field is now a unix timestamp (this was not the case in the 1.9 version). Typically institutions auto-populate this field using a CSV upload of the data and then prevent the users from editing the data.

===Installation===

*Copy the files into the \blocks folder.
*Go to the \admin page and allow the block to be installed
*Go to Users, Accounts, User profile fields
*Create a new user profile date field
*Input a Shortname (for example, dob), Name (for example, Birthday), and a Description
*Generally speaking, it is recommended that the field not be required, that it be locked, and visible to user
*Click on the Save Changes button
*In the Site Administration Block, click on Modules, Blocks, and the settings link for the Birthday block
*Select the newly created user profile date field you wish to use to store the birth dates
*Enter the Birth Dates into the created user profile date field (or upload them via a CSV file)
*Add the Birthday block to your page to see a list of those celebrating birthdays

===Languages===

Thanks to the generosity of translators, the Birthday Block is available in many languages:
*English
*Spanish
*French
*Japanese
*German
*Italian
*and many more

If the block is not available in your language feel free to contact me so that we can create one.

===Advanced Options===

It is possible to mass import the user profile date field data when importing users. More detailed instructions are available on the [https://docs.moodle.org/20/en/Upload_users#Fields_that_can_be_included|Upload users] page.

===Styling===

Styling varies from theme to theme. The following has been setup in the birthday block's styles.php file:

.block_birthday .listentry div.user { float: left; }
.block_birthday .listentry div.message { float: right; }

Some themes allow for the styles.css to be overridden or added to.

===Contributor/Maintainer===
The Birthday Block was contributed and is maintained by [User:Anthony_Borrow|Anthony Borrow].

===See also===
[http://moodle.org/mod/data/view.php?d=13&rid=901|Birthday block's Modules and Plugins database entry]

[[Category:Contributed code]]

MNet

2011-07-01T02:36:50Z

Aborrow:

{{Authentication}}
'''Please refer to [[TOC_with_notes#Authentication|these notes]] before editing this page.'''The network feature allows a Moodle administrator to establish a link with another Moodle, and to share some resources with the users of that Moodle. This features was introduced in Moodle 1.8.

==Overview==
The initial release of MNet is bundled with a Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username jody logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.

'''WARNING:''' MNet requires the use of '''xmlrpc'''. Please go to your phpinfo page if you are interested in using this and search for --with-xmlrpc. If your php has not been compiled with xmlrpc then you need to address that first! At present it appears that PEAR xmlrpc will not work.
[[Image:Administration Block Users Authentication MoodleNetwork.jpg|thumb|MNet setting in ''Admin > User > Authentication > Moodle Network]]

'''NOTE:''' An [http://moodle.org/mod/forum/discuss.php?d=175158 initial announcement to end support for MNet in Moodle 2.3] was made in the MNet forums.

==Security==
The MNet feature requires that your server has the '''Curl''' and '''OpenSSL''' extensions installed. When you install or upgrade to Moodle 1.8, your system will generate a new OpenSSL certificate for encrypted communication with other Moodles, and will thereafter rotate encryption keys on a monthly basis (approx).

Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.

References:
*[http://www.w3.org/TR/xmldsig-core/ XML Digital Signatures]
*[http://www.w3.org/TR/xmlenc-core/ XML Encryption]

A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.

==Peer to Peer Network==

This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course.

===Setup===

The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.

Note: If you experience problems, ensure debugging is turned on in ''Site Administration > Server > Debugging''. Extra diagnostic messages may be displayed (particularly from Moodle 1.9.2)

For Moodle 2.0, you need to enable Networking (under the Site Administration > Advanced Features menu). This will add the "Networking" menu to the Site Administration menu.

# Get them to talk to each other
## Ensure ''Admin > Server > Environment'' indicates you have curl installed
## If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out! You can change the cookie prefix via ''Admin > Server > Session Handling''.
## On both, go to ''Admin > Network > Settings'' and turn Networking ON.
## On MoodleA go to ''Admin > Network > Peers'' - put the URL of MoodleB under "Add New Host" and click Add. The URL should include the directory where your Moodle code is located, for example ''www.mymoodle.org/moodle''.
## Do the equivalent on MoodleB.
# Get user roaming going
## (Although discussion exists about removing this setting, it is still required as of 2.0.1) [http://moodle.org/mod/forum/discuss.php?d=141491] ). On both servers:
### For 2.0, go to ''Administration > Plugins > Authentication > Manage authentication''. Enable ''MNet Authentication'' by clicking the 'enable' icon.
### For 1.9, go to ''Administration > Users > Authentication > Manage authentication'' and enable Moodle Network authentication plugin. Click on 'Settings' and enable auto_add_remote_users.''
## On MoodleA go to ''Admin > Networking > (Manage) Peers'', click on 'MoodleB', and click on 'Services'. Enable SSO-IDP(SSO Identity Provider) publish and subscribe, and SSO-SP(SSO Service Provider) publish and subscribe.
## Do the equivalent on MoodleB. (By both publishing and subscribing you allow users to move freely between the two servers. By only publishing or subscribing between servers you create a one way traversal)
## On both, go to ''Admin > Users > Permissions > Define Roles'', only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.
### eg. enabling for ''Authenticated user'' allows any authenticated user to roam between servers.
## On both servers, go to the homepage, and add the 'Network Servers' block.
## To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account.
# Get remote enrolments going -- this is optional. It allows an administrator of MoodleB to enrol users that are "native" to MoodleB in remote courses in MoodleA, and viceversa.
## On both, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable Moodle Network enrolment plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.
## On the server you want to receive enrolments:
### For 2.0, go to ''Site administration > Plugins > Enrolments > Manage enrol plugins''. Enable ''MNet remote enrolments'' by clicking the 'enable' icon. (For ''MNet remote enrolments'' settings info see [[MNet_remote_enrolments|MNet remote enrolments]])
### For 1.9, go to ''Administration > Users > Authentication > Manage authentication'' and enable Moodle Network authentication plugin. Click on 'Settings' and enable auto_add_remote_users.''
## On MoodleA go to ''Admin > Network > Peers'', click on 'MoodleB', and click on 'Services'. Enable Enrolment publish and/or subscribe.
## Do the equivalent on MoodleB.
## On every course you want to allow enrolments into:
### Enter course and go to ''Settings -> Course administration -> Users -> Enrolment methods''
### From ''Add method'' drop-down select ''MNet remote enrolments''
### On the new screen select the ''Remote host'' you want to allow enrolments from, the Role for the enrolled users, and click save. (Note: you can only add a single ''MNet remote enrolments'' method per course.)

===Using it===
# For 1.9: in MoodleA go to ''Admin > Networking > Enrolments''. You will see MoodleB listed. Click on MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Select the course you want, and then enroll the users you want to that course.
# For 2.0: in MoodleA go to ''Admin > Networking > Remote enrolments client''. You will see MoodleB listed. Click on ''Edit enrolments'' button beside MoodleB and you will see a list of courses that MoodleB offers for remote enrolment. Click 'Edit enrolments'', select the users you want to enroll, and then click Add to enroll them in the course.

==Connecting to a Mnet hub==
A Mnet hub (do not confuse it with the [[Community hub]] project of Moodle 2.0) is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Mnet hub, assess the services it has to offer, and enable those services for your users.

===Setup===
# Get talking to the Hub
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed
## Go to ''Admin > Network > Settings'' and turn Networking on
## Go to ''Admin > Network > Peers'' and enter the URL of Mnet Hub under "Add New Host". Click Add
## The host details for the Mnet Hub should appear with the Site Name field already populated. Click Save changes
## The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click Services
##A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to

===Using it===
If the Mnet Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is publishing Moodle Networked Enrolment, then a tick will appear alongside the subscribe checkbox for this service. Note that in order to enable some functionality, prominently single-sign-on, you may have to publish a service, e.g. the Identity Provider service. The Mnet Hub will access this service on your Moodle, asking it to authenticate your users.
# Enable Roaming
## Subscribe to SSO (Service Provider) by checking the box
## Publish SSO (Identity Provider) by checking the box
## Click Save changes
## Go to ''Admin > Users > Permissions > Define Roles'', and grant the capability Roam to a remote Moodle moodle/site:mnetlogintoremote to an appropriate role
## Go to ''Administration > Plugins > Authentication > Manage authentication'' in 2.0 onwards or ''Administration > Users > Authentication > Manage authentication'' in 1.9 and enable the Moodle Network authentication plugin
## Go to your homepage, turn on editing, and add the 'Network Servers' block
## Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to
## Note that the Mnet Hub is listed in the Network Servers block on the homepage. Click on the link to that server
## Some of your user details will be transferred to the Mnet Hub server, and a browsing session will be started for you as if you had logged on there directly
# Enable Networked Enrolment
## Return to the web browser you've been using as the site administrator
## Go to ''Admin > Network > Peers'' and click on the entry for the Mnet Hub.
## Click on the Services tab
## Subscribe to Moodle Networked Enrolment
## Go to ''Site administration > Plugins > Enrolments > Manage enrol plugins'' in 2.0 onwards or ''Administration > Courses > Enrolments'' pre-2.0 and enable the Moodle Network enrolment plugin. Click Save changes
## Click on edit to view the details for networked enrolments.
## Go to ''Admin > Networking > Enrolments'' to see a list of Moodle servers that offer this service to you
## Click on a server name to view a list of courses that the server offers to your users
## Click on a course name, to view a list users that you can enrol in this course
## Enrol users
## Profit!

==Running a Mnet hub==
A Mnet hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.

A Mnet hub is different. As soon as you add an entry for a Mnet hub to your system, the Mnet hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.

This section will guide you to set up a Mnet hub, and select services to offer to all comers.

===Setup===
# Enable Networking
## Ensure that the ''Admin > Server > Environment'' page indicates you have curl and openssl installed
## Go to ''Admin > Network > Settings'' and turn Networking on
## Go to ''Admin > Network > Peers'' and tick the checkbox for Register all hosts. Click on Save Changes
## On the same page, the first entry in your list of hosts should be All hosts. Click this link
## Click on Services and enable any services you want to offer to all comers

==See also==

* [[Moodle Network FAQ]]
* [[Development:Moodle Network|Moodle Network development notes]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6976 MNet forum]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=92749 Examples of how people are using Moodle networks] forum discussion

[[Category:Authentication]]
[[Category:Enrolment]]
[[Category:MNet]]

[[fr:Réseau Moodle]]
[[ja:Moodleネットワーク]]
[[es:Red Moodle]]
[[cs:Síťové služby]]

Database export

2011-06-30T07:48:20Z

Aborrow:

{{Database}}
'''Please refer to [[TOC_with_notes#Database|these notes]] before editing this page.'''

== Choose the format you wish to export to ==

The Database activity module provides an Export tab that allows users to export database entries to either the CSV (comma separated values) or ODS (OpenOffice Calc) formats. Previously, it was possible to export to the XLS (Microsoft Excel) format; however, problems with creating that format have led to it being removed. The workaround is to use either CSV or ODS formats both of which can be opened with the latest version of Microsoft Excel.

When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.

== Choose the fields you wish to export ==

Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.

== Export entries ==

Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.

==See also==

* [[Adding a database entry]] - including import.
* See http://tracker.moodle.org/browse/MDL-19864 - regarding errors related to XLS export

[[de:Datenbank_Export]]
[[ru:Экспорт базы данных]]
[[ja:データベースのエクスポート]]

[[Category:Database_activity_module]]

Database export

2011-06-30T07:45:46Z

Aborrow: /* See also */

{{Database}}
'''Please refer to [[TOC_with_notes#Database|these notes]] before editing this page.'''

== Choose the format you wish to export to ==

The Database activity module provides an Export tab that allows users to export database entries to either the CSV (comma separated values) or ODS (OpenOffice Calc) formats. Previously, it was possible to export to the XLS (Microsoft Excel) format; however, problems with creating that format have led to it being removed. The workaround is to use either CSV or ODS formats both of which can be opened with the latest version of Microsoft Excel.

When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.

== Choose the fields you wish to export ==

Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.

== Export entries ==

Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.

==See also==

* [[Adding a database entry]] - including import.
* See [http://tracker.moodle.org/browse/MDL-19864 MDL-19864] for errors related to XLS export

[[de:Datenbank_Export]]
[[ru:Экспорт базы данных]]
[[ja:データベースのエクスポート]]

[[Category:Database_activity_module]]

Database export

2011-06-30T07:36:02Z

Aborrow:

{{Database}}
'''Please refer to [[TOC_with_notes#Database|these notes]] before editing this page.'''

== Choose the format you wish to export to ==

The Database activity module provides an Export tab that allows users to export database entries to either the CSV (comma separated values) or ODS (OpenOffice Calc) formats. Previously, it was possible to export to the XLS (Microsoft Excel) format; however, problems with creating that format have led to it being removed. The workaround is to use either CSV or ODS formats both of which can be opened with the latest version of Microsoft Excel.

When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.

== Choose the fields you wish to export ==

Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.

== Export entries ==

Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.

==See also==

* [[Adding a database entry]] - including import.
* See [http://tracker.moodle.org/browse/MDL-19864] for errors related to XLS export

[[de:Datenbank_Export]]
[[ru:Экспорт базы данных]]
[[ja:データベースのエクスポート]]

[[Category:Database_activity_module]]

Database export

2011-06-30T07:35:09Z

Aborrow:

{{Database}}
'''Please refer to [[TOC_with_notes#Database|these notes]] before editing this page.'''

== Choose the format you wish to export to ==

The Database activity module provides an Export tab that allows users to export database entries to either the CSV (comma separated values) or ODS (OpenOffice Calc) formats. Previously, it was possible to export to the XLS (Microsoft Excel) format; however, problems with creating that format have led to it being removed. The workaround is to use either CSV or ODS formats both of which can be opened with the latest version of Microsoft Excel.

When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.

== Choose the fields you wish to export ==

Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.

== Export entries ==

Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.

==See also==

* [[Adding a database entry]] - including import.
* See [http://tracker.moodle.org/browse/MDL-19864|MDL-19864] for errors related to XLS export

[[]]
[[de:Datenbank_Export]]
[[ru:Экспорт базы данных]]
[[ja:データベースのエクスポート]]

[[Category:Database_activity_module]]

Category:Contributed code

2011-06-14T08:17:10Z

Aborrow:

An index of documentation pages about contributed code.

Contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution. The standard Moodle distribution, sometimes known as "Core" code is the code stored and developed at [http://git.moodle.org/gw?p=moodle.git;a=summary git.moodle.org].

Contributed code is usually managed by the developer of the plugin or patch; however, as people change jobs or move on for whatever reason others can volunteer to step in to serve as the primary maintainer of a contribution.

The code is hosted on a the version control system (VCS) of the developers choice. Previously, CVS was used for both [http://cvs.moodle.org/moodle/ core Moodle code] and [http://cvs.moodle.org/contrib/ CONTRIB code]. Git is now the preferred VCS for both Moodle core and CONTRIB code. There are various Git repositories; however, the most commonly used Git repository is [http://github.com/ Github.com].

Developers of CONTRIB code can create their own publicly accessible Git repository of the code (for an example see https://github.com/moodlehq/). Plugins typically use the following naming convention: moodle-{type}_{name} so that the book activity module would be named moodle-mod_book. Developers are encouraged to be consistent.

At the moment, all CONTRIB code (and core code) should be indexed in the [http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database]. That said, work is being done to create a new Plugins database that will allow much more flexibility in how CONTRIB code is shared and reviewed. Those interested can follow that work at [http://tracker.moodle.org/browse/MDLSITE-571 MDLSITE-571].

Anthony Borrow, the CONTRIB Coordinator, is happy to answer any questions related to CONTRIB code and will help direct folks to the appropriate developer. Feel free to contact the CONTRIB Coordinator via Moodle message.

==See also==

*[[Installing contributed modules or plugins]]
*[[Contributed code FAQ]]
*[[Development:Guidelines for contributed code]]
*[[Development:contrib]]
*[http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database]

[[Category:Teacher]]
[[Category:Administrator]]
[[Category:Developer]]

[[eu:Kategoria:Kode ezestandarra]]
[[ja:Category:ブロック ( 非標準 )]]

Git

2011-04-29T15:52:32Z

Aborrow:

[http://git-scm.com/ Git] is a free and open source version control system. Git is a more sophisticated replacement for [[CVS]]. You can find the official Git Moodle repository at http://git.moodle.org/ or mirror at https://github.com/moodle/moodle. The particular advantage of Git is its distributed model, making it ideal for managing local customisations to Moodle. It is also suitable for development of contrib plugins for Moodle.

Use the ''Git'' category link at the end of this page to get a list of all Git related pages.

==Books and tutorials==
* [http://progit.org/ Pro Git Book]
* [http://book.git-scm.com/ Git Community Book]
* [http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html Official Git tutorial]
* [http://help.github.com/ GitHub Help]

==Moodle specific guides==
* [[Installing Moodle from Git repository]] - WIP
* [[Maintaining Moodle customisations with Git]] - WIP
* Submitting patches and pull requests - TODO
* [[Git repositories for contrib modules]] - WIP

==Tools==
The most powerful tool you can git is probably command line git. If you prefer clicking you can try one of the following, more information at [http://git-scm.com/tools http://git-scm.com/tools].

'''IDE integrations'''
* [http://www.eclipse.org/egit/ EGit plugin for Eclipse IDE]
* [http://netbeans.org/projects/versioncontrol/pages/Git_main Netbeans] - early access official Git plugin for Netbeans
* [http://www.jetbrains.com/phpstorm/ PHPStorm] - commercial IDE with Git support

'''Frontends'''
* [http://code.google.com/p/tortoisegit/ TortoiseGit] - Windows only UI
* [http://gitx.frim.nl/ GitX] - OS X only UI
* [http://www.syntevo.com/smartgit/index.html SmartGit] - feature rich multiplatform UI (free for non-commercial use)

==Hosting==
* [http://github.com/ GitHub] - probably the best hosting choice for beginners
* [http://gitorious.org/ Gitorious] - free hosting running on open source code

==See also==

* [[Development:Git Migration]]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=162723 Moving from CVS to git in November 2010] forum discussion

[[Category:Git]]
[[Category:Administrator]]

Development:Guidelines for contributed code

2011-01-28T22:20:10Z

Aborrow:

This page describes the various ways to share and work collaboratively on contributed code. In the past, Moodle CONTRIB code was often stored on the Moodle CVS server. As Moodle code transitions to [https://docs.moodle.org/en/Git Git], CONTRIB code will also be transitioning with a goal of having all code maintained via git repositories by August 2011. Don't worry if you have code on CVS and do not know Git as there are many people willing to help you with the transition especially [https://docs.moodle.org/en/User:Anthony_Borrow Anthony Borrow].

For those neither familiar with CVS nor Git, it is recommended that you [https://docs.moodle.org/en/Git#Books_and_tutorials learn Git basics]. The nice thing about using Git is that it will leave control of the code in the hands of contributor.

*'''Sharing code''' - Contributed code will be shared and maintained using a public Git repository (i.e. github.com, gitorious.org, etc.).
*'''Reviewing code''' - If you would like your code to be tested and reviewed, please create an issue in the [http://tracker.moodle.org/ Moodle Tracker] under [http://tracker.moodle.org/browse/CONTRIB CONTRIB].
*'''Documenting code''' - You can maintain helpful documentation of the features and installation instructions in [https://docs.moodle.org Moodle Docs]
*'''Distributing code''' - You can help others find your code by adding an entry to the [http://moodle.org/mod/data/view.php?id=6009 Modules and Plugins database]
*'''Discussing the code''' - You can discuss the functionality and answer questions about how to use your code in the [http://moodle.org/course/view.php?id=5 Using Moodle forums]. Users can ask questions, discuss possible ideas for improvement, etc. Once the discussion matures to a point where you may want to take action, then you can create an issue in the [http://tracker.moodle.org/ Moodle Tracker].
*'''Maintaining code''' - You can further develop your code by fixing issues, adding features, and responding to other issues with the [http://tracker.moodle.org/ Moodle Tracker]. Each plugin or patch can have its own component in the CONTRIB project; however, you will need to request that the component be created in the CONTRIB project. Once created, users can easily create issues related to your contributed code. The primary maintainer of the code will be assigned as the component lead and have their tracker privileges bumped so that they can manage issues related to their contributed code. Those issues will automatically be assigned to the component lead/primary maintainer.

==The CONTRIB Frequently Asked Question (FAQ)==
'''Question:''' I have written a new block, activity, patch or theme to share with the Moodle community. What is the process for contributing the code?

'''Answer:''' First, thank you for your generosity and desire to share your work with the rest of the Moodle community. Code contributions are highly valued and Moodle wants to encourage creativity and generosity in keeping with [https://docs.moodle.org/en/Pedagogy Moodle's social constructionist pedagogy].

As mentioned, there are various tools to help you share and support your contribution. By using a consistent methodology, your Moodle related code will be more easily found, tested, used, maintained, documented, and evaluated by fellow Moodlers and developers. Learning to use the various tools common among Moodle developers will help you to efficiently and effectively develop, share and maintain your contributed code.

==How to submit code==
You have created some code that you would like to contribute to the Moodle community. The first step is to choose which Git code hosting site you want to use. Both [http://github.com/ github.com] and [http://gitorious.org/ gitorious.org] are popular. Follow the instructions for creating a public repository for your code. This will allow others to download your code as well as suggest possible patches. As you become more familiar with collaborating with others you can also control who else you want to be able to push changes into your repository (i.e. write access).

In order to facilitate a common naming convention of Moodle related repositories, it is suggested that you use the following format: moodle-{plugintype}_{pluginname}. For example, the birthday block has a repository name of moodle-block_birthday and is located at https://github.com/arborrow/moodle-block_birthday. Other developers can fork the code and work from their repositories.

==How to request that your code be tested/reviewed==

#If you do not already have an account on the [http://tracker.moodle.org] Moodle Tracker], create one and login.
#Create a new "Task" issue in the "Non-core contributed modules" project. Your issue will be a request that the code be tested and reviewed.
#Provide the link to the repository (i.e. https://github.com/arborrow/moodle-block_birthday)
#Provide a clear description of what the code does and the functionality that it adds to Moodle.
#Provide any other links to supporting documentation

The Contrib Coordinator will then work directly with the code contributor via the Tracker to help evaluate the code, work on resolving any questions/issues found, etc.

*Contributors are encouraged to follow Moodle's coding guidelines [[Development:Coding]].

*Contributors are encouraged to maintain a branch for each major Moodle release (i.e. 1.8, 1.9, etc.). The HEAD branch should be used as the development branch.

*Contributors are encouraged to associate each change made to an issue in the tracker. This practice is done by Moodle core developers and it is a good habit to get into so that you can go back and see why various changes were made to the code. Simple practices like these help to create good documentation of the code as it develops and matures. Commits should begin with the Moodle tracker issue number followed by a brief description of the change.

==How to provide documentation==
Having great code available to the community is wonderful. It is also important to educate users about how to use the code with documentation in [[Main Page|Moodle Docs]]. See [[MoodleDocs:Guidelines for contributors|guidelines for contributors]] for more help.

A documentation page for a contributed module should have some basic elements. A brief introduction of what the code does, a "Features" heading, perhaps a "Installation", "Tips and tricks" and "See also" headings, all with content of course. Sometimes a screenshot is worth 1000 words. In the "See also" put a link to the Modules and Plug database, with a note that this is the place to download versions, and the forum where questions can be answered at moodle.org.

Other information might include: Languages Supported, Known Issues, Supported Versions (for Moodle 1.8, 1.9), and maybe which are being actively supported. The page should be added to the contributed code category by typing <code><nowiki>[[Category:Contributed code]]</nowiki></code> at the bottom of the page.

===Possible format for a contributed code Moodle Docs page===
You can copy and paste the below into your Moodle documentation page. Please add the URL links. '''This is only a suggestion'''.
Start with a 2-4 line introduction. The Plug In Name works with the activity module.
It makes the life of the teacher easier by ...
==Features==
* Add features list or overview description here <nowiki> </nowiki>
<nowiki> [[Image:Sample_screen_shot|thumb|500px|center|Title of screenshot]]</nowiki>
==Installation==
Place install instructions here
==Tips and tricks==
*Optional section, usually added by users later
==See also==
*[Place http_address_for_M&P_entry_here Name of Entry here] is a Modules and plugins database page that has download links and more information.
*Discussions: [Place http_address_for_moodle_forum_or_thread_here Name of forum]

When no thread or forum exists for discussion, put a link to the Contributed Code forum.
*Discussions: Please create or find a discussion topic in the <nowiki>[http://moodle.org/mod/forum/view.php?id=44 Contributed Code forum]</nowiki>

==Share code with modules and plugins database==
Now you have a place for users to get your code, how will they know it exists? Moodle users can easily find information about contributed code in the [http://moodle.org/mod/data/view.php?id=6009 Modules and Plugins database]. When you add an entry to this database, remember that it is searchable by any field. Every field is not required, but providing as much information as possible will help people who would like to find, read about, and then install your contribution. In particular, the name of the module and the description of its function are important. Screen shots are helpful (but please, not larger than 350px wide!). Links to discussion (on Moodle.org or other forum) and documentation (link to your page in the [https://docs.moodle.org Moodle docs] or another location) should be included if possible.

Users may leave comments on your entry, so please check it periodically for questions and bug reports. If you include contact information or a link to a discussion, your users may be able to contact you more directly. The comments are not emailed automatically.

Keep in mind that entries added to the [http://moodle.org/mod/data/view.php?id=6009 Modules and Plugins database] require approval by a moderator before they will be visible to other Moodle users.

==Support code and get feedback with forums==
As users become familiar with the contributed code, discussions about the code are likely to emerge. We strongly urge you to place links to at least one forum at moodle.org in your Modules and Plugins entry as well as in MoodleDocs.

It is important to respond to users who have questions about how to use the code, suggestions for how to make it better, etc. If it looks like there is sufficient need for some contributed code to have its own forum, please create a request via the tracker in the MDL-SITE section. Moodle has included many contributed code projects and ideas into its core.

*[http://moodle.org/mod/forum/view.php?id=44 Contributed code forum] is a generic forum. Maybe create a thread "New Mousetrap module".
*[http://moodle.org/course/view.php?id=5 Using Moodle forums] The English speaking list of forums on many different subjects.
*[http://moodle.org/course/ A list of] other language forums and special areas in Moodle

==Maintain and refine code with Tracker==

In order to facilitate keeping track of feature requests, bugs, and other code issues, the contributor may request that a component be created in the CONTRIB section of the Moodle tracker. (This is the section where you initially made the request to have code included in CVS.moodle.org.)

The contributor can be added to the group of CONTRIB developers in the tracker to manage the issues assigned to them and better coordinate with other developers. Users of the contributed code can then add issues which can be assigned directly to the maintainer. The tracker helps to manage the work flow involved in fixing bugs, working through feature requests, and maintaining the code. When committing changes, maintainers are strongly encouraged to begin the commit comment with a tracker number.

We strongly encourage users to involve themselves in the process of creating a useful issue in tracker. For the developer and code contributor, describing the fix can help clarify the need for the code change. Further, it helps to establish good documentation about how the code developed. Others will be able to identify the issues addressed and understand why a particular decision was made.

==Summary==

It is hoped that following this procedure, will help guide contributors of code in the process of learning the tools and skills used by the Moodle developers. Learning to submit code by using the tracker, work the code with CVS, support the code by providing documentation, share code in Modules and Plugins, maintain the code by using the tracker, and evolve the code by using the Moodle.org forums will assist you in successfully contributing to the Moodle community and working with Moodle's developers.

Throughout this process, the CONTRIB Coordinator is here to encourage and support those contributing code to the Moodle community and fostering the development of tomorrow's Moodle developers.

Eventually, the community may wish for the code to become part of the Moodle core. By following the steps above, the developers will be able to evaluate the merit of the contributed code, understand how users have used the code, see the issues that have emerged and thus have more information to make an informed decision about whether or not to incorporate the contributed code into core.

==Most common recommendations for contributed code==

There are several small issues that the CONTRIB Coordinator will typically check for when reviewing the code prior to committing to the CVS server. These issues help to ensure consistency and quality of code. Any suggestions made by the CONTRIB Coordinator should be considered recommendations aimed to help folks new to the Moodle community collaborate in a way consistent with standard practices within the Moodle community. The suggestions are meant to help avoid potential issues and facilitate the acceptance of your code.

=== Does the file structure conform to Moodle standards? ===
Generally speaking, each file should have an appropriate extension (i.e. php, html, css, txt, etc.). To avoid issues with case sensitivity, folders and files are normally lower case; however, there are exceptions to this. Another common recommendation is to place the lang folder within the block or module rather than asking the user to copy files into the main lang folder. Changes made in the get_string function for Moodle 1.9 and onward make it possible to do this which goes a long way in keeping things modular. Similarly, to respect the modular nature of Moodle if a block requires a library it is usually preferred to keep it as a subdirectory in the block's folder. This can be especially helpful if your code is dependent upon a particular version of an external library.

=== Does the code work without any obvious errors? ===
The CONTRIB Coordinator will try to install the block or module on a fresh Moodle installation and report back any errors. This testing is done with Debugging set to show All PHP notices and errors (not developer mode). The most common notices have to do with attempting to use a variable that has not been initialized or checked for existence.

=== Does the code use the config_plugins table? ===

Contributed blocks and modules are encouraged to make use of the '''config_plugins''' table rather than the config table. Maintainers are encouraged to read the documentation provided for the [http://xref.moodle.org/lib/moodlelib.php.html#get_config get_config()] and [http://xref.moodle.org/lib/moodlelib.php.html#set_config set_config()]] functions in the /lib/moodlelib.php file to help ensure that the footprint for the global $CFG variable does not become bloated.

=== Does the code follow the [[Coding|Coding Guidelines]]? ===
The CONTRIB Coordinator will look at the code for general readability and point out any obvious deviations from the [[Coding|Coding Guidelines]]. While not all code needs to conform with each and every guideline, maintainers are encouraged to follow those guidelines as closely as possible.

==See also==

*[[Development:Migrating contrib code to 2.0]]
*[[Development:contrib]] CONTRIB is an area in the Moodle CVS
*[[Translation]] for information on the translation of contributed code
*[[Development:Overview]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=99037 Best practices for code modification?] forum discussion

[[Category:Developer|Guidelines for contributors]]

Development talk:Process

2011-01-02T18:05:08Z

Aborrow: /* External developers */ new section

I think 'User' should be described as both 'finding issues' and 'suggesting improvements' for Moodle, even if the detail of how things are implemented are left for the Product Owner. Just thinking that a good chunk of the things I add to the Tracker are suggestions for improvement rather than 'issues' as such and that we should promote this idea as a general rule - maybe :)

:I agree with Mark. Bug tracker should be used for actual bugs. Discussion about future roadmaps, enhcnements and improvements is a separate matter, and in actual fact it is hard to engage in this. I don't have an answer at the moment. Maybe a place to discuss, and notification of when discussions have heated up (like specs are being prepared and a new roadmap developed for a component) ie owners manage the discussion, but there is a clear place to go to engage, some indication of timelines etc. --[[User:Derek Chirnside|Derek Chirnside]] 19:39, 25 November 2010 (UTC)

Well, "issues" there was meant to cover "bugs" and "suggestions", as the tracker does both. I'll make it more explicit though. [[User:Martin Dougiamas|Martin Dougiamas]] 10:12, 30 November 2010 (UTC)

OK - I could live with this. But I still prefer this clearer distinction as suggested by Mark:

===User role===

# Uses Moodle
# Finds issues/bugs (report in tracker)
# Suggests improvements (report in tracker)

Question: is there a way in the tracker to keep issues in two lists: bugs and suggestions? Maybe even like Google: you can suggest anything, but at any given time there are a few suggestions up for vote? In Moodle, you can discuss anything, but someone is highlighting at any given time a few topics for focused discussions. On reflection the answer may be No - on this basis I am back to my original suggestion.

A bug is a bug - it is not working as we know it should. A suggestion for an enhancement is partly an invitation to dialogue, vote. Voting for bugs is silly - all bugs need fixing, and priorities are best (IMO) determined centrally. So:

#Uses Moodle
#Finds and reports bugs (use tracker)
#Suggests improvements (use tracker)
#Takes part in dialogue around suggested improvements

[[User:Derek Chirnside|Derek Chirnside]] 06:18, 4 December 2010 (UTC)

:Derek, thanks for your comments. Regarding a way in the tracker to keep issues in two lists: bugs and suggestions, when you create an issue you have a choice of issue types - bug, new feature, task and improvement. Thus, a search for all new features and improvements should generate a list of suggestions. --[[User:Helen Foster|Helen Foster]] 14:31, 4 December 2010 (UTC)

== Backlog naming ==

Regarding the latest change about naming backlog versions with "STABLEBACKLOG/DEVBACKLOG", I'd recommend to use instead something like: "1.9.x backlog/2.0.x backlog/2.1.x backlog" because:

# It saves us to move things when a new major release happens (so it won't be necessary to move all the DEVBACKLOG => STABLEBACKLOG".
# It supports '''multiple''' stable branches, like we have now (1.9.x, 2.0.x...)
# It respects the format used by both the Affected Branches and Fixed Branches custom fields that are really useful for a lot of filters.

Ciao, [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 23:33, 6 December 2010 (UTC) :-)

:Addenda: Finally it has been decided to go to 2 backlogs only (stable/dev). Fair enough so developer (team) will look to the real branches were solution needs to be implemented. [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 10:23, 9 December 2010 (UTC)

==This does not look like scrum to me at all==

I think we need a certified scrum master. This proposal IMHO seems to break nearly all the good Scrum practises described in books.

Ciao, [[User:Petr Škoda (škoďák)|Petr Škoda (škoďák)]] 10:03, 9 December 2010 (UTC)

:Agree! some points (see point 3 especially, both in STABLE/DEV teams, break the thing. It's (scrum, by team) master responsibility to discuss with product owner, not team itself! Isolation is a MUST.

: Ciao, [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 10:12, 9 December 2010 (UTC)

----

== If the issue is a bug in the current stable version requiring database changes, assign "Fix version" to DEVBACKLOG ==

Hmm, maybe this should be governed up by bug severity too? You, sure, aren't going to say that every bug requiring DB update, however severe it is, should be left up to the next major release? --[[User:Oleg Sychev|Oleg Sychev]] 14:51, 9 December 2010 (UTC)

I understand the idea of pulling from the items with the highest priority; however, how are we going to determine that priority. We have issue severity which has traditionally been seen as a priority indicator but we also have the number of votes. I am curious when paper cuts will be taken care of. These smaller issues can impact the user experience. I suspect in an ideal world, all the major issues will be dealt with but occasionally some simple fixes come along with patches in the tracker and it would be good to get those applied. Peace - Anthony

: Well, in practice I expect people will choose items based on a cost/benefit analysis of fixing them - just like they always have in the past.--[[User:Tim Hunt|Tim Hunt]] 18:14, 16 December 2010 (UTC)

== Suggested changes for "External Developers" ==
I had a really good conversation with David (He posted a screenshot that maybe does a better job of explaining what is described below: http://picasaweb.google.com/david.mudrak/Moodle#5551427587739059122), and we discussed one possible suggested workflow external developers can use if they choose to use their own GIT repo. Here's how it would break down:

=== Creating repo ===
==== Branch off MOODLE_20_STABLE (ie: UCLA_TRUNK) ====
$ git --bare fetch git://git.moodle.org/moodle.git MOODLE_20_STABLE:MOODLE_20_STABLE
$ git checkout -b UCLA_TRUNK origin/MOODLE_20_STABLE

==== commit customizations into branch ====
$ ... (hack something, git add, git commit)
$ git push

=== Contributing back ===
==== Create another branch off MOODLE_20_STABLE (ie: COOL_NEW_FEATURE) ====
$ git --bare fetch git://git.moodle.org/moodle.git MOODLE_20_STABLE:MOODLE_20_STABLE
$ git checkout -b COOL_NEW_FEATURE origin/MOODLE_20_STABLE

==== git cherry-pick to selectively pick commits from UCLA_TRUNK to merge into COOL_NEW_FEATURE ====
$ git cherry-pick 7300a6130d9447e18a931e898b64eefedea19544

==== publish branch COOL_NEW_FEATURE ====
??

==== create pull request in tracker ====
http://tracker.moodle.org/browse/PULL-18

If accepted, it becomes part of core moodle

=== Updating to next version of Moodle ===
$ git pull

== Contrib Code - Development process ==

I think this may be a good time to give some thought to coming up with the process we want to implement and enforce for sharing CONTRIB code. What assumptions do we want to make from the beginning? Should shared code be in a git repository somewhere? We have folks that share everything from zip files of plugins, some use Google code, others may use git. My experience has been that many are not initially proficient at using CVS/GIT, etc. although this seems to be improving. In any case, I would love to see a clear diagram about what someone does when they create code that they want to share. It has worked well to initiate conversations in the tracker as I can them work them through the Guidelines for CONTRIB Code (https://docs.moodle.org/en/Development:Guidelines_for_contributed_code) but I think we need to update that now for how we want to handle things in the future. Perhaps the improved M&P database will be the point of first contact. In any case, I would love to see if we could create a page similar to the Development:Process called something like Development:CONTRIB process. Peace - Anthony

== External developers ==

I have a question about the historical integrity of providing patches via links. For external developers, we say "Suggest code via links in comments in Jira". What happens if those links no longer work? Perhaps this is a trivial issue and will in practice hardly ever happen but I was thinking about going back to an older issue that it may be helpful to see an approach that was attempted but rejected. If the external developer removes the branch, then it would seem to me that perhaps their rejected patch would no longer be available to be reviewed later. Am I understanding this properly and if so, might we consider what the approach might be for getting patches in the tracker so that they can stay there? Peace - Anthony

Development talk:Process

2010-12-26T01:20:41Z

Aborrow: /* Contrib Code - Development process */ new section