MoodleDocs - User contributions [en]

Administration via command line

2012-06-17T16:27:41Z

Mits:

If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. All command line tools are located in <code>admin/cli/*</code> directory. To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:

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

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

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

== Installation via command line ==

Since version 2.0, Moodle can be installed from the command line. There are two modes of installation. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.

$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs

== Maintenance mode ==

To switch your site into the maintenance mode via CLI, you can use

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable

To turn the maintenance mode off, just execute the same script with --disable parameter.

== Offline mode ==

In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.

$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html

You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.

== Upgrading via command line ==

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

$ sudo -u apache /usr/bin/php admin/cli/upgrade.php --non-interactive

Upgrading via command line is a very comfortable way of Moodle upgrade if you use [[CVS]] or [[Git|git]] checkout of the Moodle source code. See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:

$ cd /var/www/sites/moodle/htdocs/
$ git fetch
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git merge origin/cvshead
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

===Issues with Upgrading via Command Line===

if your config.php contains information about several moodle instances (distinct moodle websites and databases sharing the same codebase), then this script will silently fail

The solution is to temporarily eliminate from config.php all but the one instance you want to upgrade

If this is a problem for the other instances (production sites), then modify the cli script to point to a copy of config.php (which will be the one edited to contain only one moodle instance at a time)

== Custom site defaults ==

During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like

<code php>
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</code>

These defaults are used during install, upgrade and are also displayed as defaults at the Site administration pages.

== Reset user password ==

If you happen to forget your admin password (or you want to set a password for any other user of your Moodle system), you can use reset_password.php script. The script sets the correctly salted password for the given user.

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

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

== Running cron via command line ==

In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.

[[Category:Installation]]

[[fr:Administration en ligne de commande]]
[[ja:コマンドライン経由の管理]]

Lesson module

2012-06-14T15:43:17Z

Mits: ja link

{{Activities}}

[[Image:Lesson icon.gif]] The lesson module presents a series of HTML pages to the student who is usually asked to make some sort of choice underneath the content area. The choice will send them to a specific page in the Lesson. In a Lesson page's simplest form, the student can select a continue button at the bottom of the page, which will send them to the next page in the Lesson.

[[Image:Lessonexample.png]]

* [[Lesson settings]]
* [[Building Lesson]]
* [[Using Lesson]]
* [[Lesson FAQ]]

There are 2 basic Lesson page types that the student will see: question pages and content pages. There are also several advanced navigational pages which can meet more specialized needs of the Teacher. The Lesson module was designed to be adaptive and to use a student's choices to create a self directed lesson.

The main difference between a Lesson and other activity modules available in Moodle comes from its adaptive ability. With this tool, each choice the students makes can show a different teacher response/comment and send the student to a different page in the lesson. Thus with planning, the Lesson module can customize the presentation of content and questions to each student with no further action required by the teacher.

[[Category:Lesson]]
[[es:Lecciones]]
[[eu:Ikasgaiak]]
[[fr:Leçon]]
[[de:Lektion]]
[[ja:レッスンモジュール]]

Verify Database Schema

2012-06-11T16:28:11Z

Mits: ja link

{{Installing Moodle}}
If you have been upgrading your Moodle site over several versions, it is possible (likely even) that some differences may have crept in between the database table definitions (the "schema") in your database and the version you would get creating a new empty site. This happens because of small errors or oversights in the upgrade scripts. Most of these differences are not harmful, but some may cause strange or unexpected errors. For example, if a default value has been added to a field and this was not reflected in an upgrade script code that assumes the presence of the default may fail to work as expected.

The solution is after doing an upgrade (or, if your problem is that the upgrade fails, before) to compare the database schema of the "production" site to that of a newly created site (where no upgrades have been performed) using '''exactly''' the same code base. There are a number of ways of doing this, but this article outlines a simple way using the Unix command line.

* Complete the upgrade
* Generate the database schema from your recently upgraded site using the following command:
mysqldump -d -u root -p ''myproductiondb'' >production.schema
* Copy the code of your production database to a new (web accessible) location (this is important, it *must* be the same version)
* Create a new, empty database and moodledata area for the new site as per the [[Installation]] instructions
* Edit the config.php file to point at the new database and locations, or delete it and use the install script
* Run the install script to generate the (if applicable) config.php file and the database (admin and site values are not important)
* Generate the database schema from your new site using the following command:
mysqldump -d -u root -p ''mycleandb'' >clean.schema
* Run the following command to detect the differences
diff -u production.schema clean.schema >db.diff

You can now look at ''db.diff'' with your favorite editor to see the differences.

'''NOTE:''' The above obviously applies to MySQL databases. Other databases are likely to have a similar function to dump only the schema. For example PostgreSQL has the '''pg_dump''' command. The remainder of the discussion still applies.

==Interpreting the diff file==

Firstly here's a (real) example:

--
-- Table structure for table `mdl_backup_config`
@@ -129,11 +93,11 @@
DROP TABLE IF EXISTS `mdl_backup_config`;
CREATE TABLE `mdl_backup_config` (
- `id` int(10) unsigned NOT NULL auto_increment,
+ `id` bigint(10) unsigned NOT NULL auto_increment,
`name` varchar(255) NOT NULL default '',
`value` varchar(255) NOT NULL default '',
PRIMARY KEY (`id`),
- UNIQUE KEY `name` (`name`)
+ UNIQUE KEY `mdl_backconf_nam_uix` (`name`)
) ENGINE=MyISAM AUTO_INCREMENT=15 DEFAULT CHARSET=utf8 COMMENT='To store backup configuration variables';

The file may have lots of blocks of changes. The - lines show lines to be taken out and the + lines the ones to replace them (from the production to the clean). So here, the int has been replaced with a bigint and the key name changed. Both of these, technically, should have been changed at some point by upgrade scripts but have been missed. In this case they are unlikely to affect the operation of Moodle.

===Too many changes to track manually?===

You can also use database management programs to synchronize old and new Moodle databases.

For example [http://wb.mysql.com/ MySQL Workbrench] for MySQL databases.

This is very useful, if You have a lot of changes.

If you can work a Unix/Linux command line the Python script [http://schemasync.org/ Schema Sync] provides a quick and simple way to generate all the commands to update your database.

==Should I worry?==

Changes in field types (as long as they are compatible) and key name changes seem to be the common issues but '''should''' not cause problems. Things to look out for would be along the lines of missing fields and changes to default values.

If you are about to upgrade to Moodle 2.0 you should be more concerned. In order for the upgrade to proceed smoothly it is a very good idea to correct these problems.

== See also ==

* The missing indexes report in ''SiteAdmin->Misc->XMLDB editor->Check Indexes''
* [http://moodle.org/mod/forum/view.php?id=45 Moodle Databases Forum]

[[de:Datenbank-Schema prüfen]]
[[fr:Vérification du schéma de la base de données]]
[[ja:データベーススキーマの確認]]

Upgrading to Moodle 2.2

2012-05-15T15:31:55Z

Mits:

{{Installing Moodle}}
You can upgrade to Moodle 2.2 from Moodle 2.1, 2.0 or 1.9. If you are upgrading from 2.0, please also read [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1 Upgrading to Moodle 2.1] . If upgrading from 1.9, please also read that and [https://docs.moodle.org/20/en/Upgrading_to_Moodle_2.0 Upgrading to Moodle 2.0]. After reading this you can upgrade directly to 2.2.

If you are using an earlier version of Moodle, you must upgrade to the latest Moodle 1.9.x first.

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

==System requirements==

* PHP must be '''5.3.2''' or later
** Required PHP extensions: iconv, curl, ctype, zip, simplexml, spl, pcre, dom, xml, json
** Required PHP memory_limit at least 40MB (64MB or more recommended if you have a choice)
* Databases should be one of the following:
** MySQL 5.0.25 or later (InnoDB storage engine highly recommended)
** PostgreSQL 8.3 or later
** Oracle 10.2 or later
** MS SQL 2005 or later
* Any standards-supporting browser from the past few years, for example:
** Firefox 3 or later
** Safari 3 or later
** Google Chrome 4 or later
** Opera 9 or later
** MS Internet Explorer 7 or later

Note: The above system requirements are unchanged from Moodle 2.1.

==Before upgrading please... ==

'''NOTE''': The upgrade process will irreversibly modify the contents of your database '''and''' your moodledata file storage area. If something goes wrong you '''cannot''' go back. It is vital that you take good backups of both moodledata and the database in case you have problems with the upgrade. If you are not sure how see [[Site backup]] or ask in the moodle.org forums (explaining what your operating system is).

* Read the [[:dev:Moodle 2.2 release notes|Moodle 2.2 release notes]] and check the [[:Category:New features|list of new features]]
* Check your site to make sure it meets all system requirements for 2.2 in ''Settings > Site administration > Server > [[Environment]]''
* '''Do a full database backup!'''
* '''Do a full moodledata backup'''
* '''Check your backups carefully'''
* Remember to purge PHP cache if using any PHP accelerator

==Possible issues that may affect you==

* If you have custom reports, there have been changes that may require (simple) changes to be made to their code. See the developer documentation [[:dev:General report plugins]] for details.
* Global search has been removed from core as it was broken. (A new global search is being written for 2.3.)
* Some web service functions have been deprecated. They still work, but check any web service connections you may have to your Moodle for the future.

==Checking database schema - old sites==

If your Moodle site has been upgraded through many prior versions it is possible that there will be some problems with the database schema (compared to a fresh 2.0 installation). This may cause the upgrade to fail. If your site started life prior to Moodle 2.0 it is a very good idea to check and correct the database schema before upgrading. See [[Verify Database Schema]]. You should also run the database integrity checks in the XMLDB editor, see the 'See also' for a link to extra scripts to check for other discrepancies.

==Now upgrade==

Once you have satisfied the requirements for Moodle 2.2, follow the instructions on the [[Upgrading|upgrading]] page.

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

==After upgrade==

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

==See also==

* [[dev:Moodle 2.2 release notes|Moodle 2.2 release notes]]

[[fr:Mise à jour à Moodle 2.2]]
[[ja:Moodle2.2へのアップグレード]]

External database enrolment

2012-04-19T15:26:34Z

Mits:

{{Enrolment}}
Location: External database edit settings link in ''Settings > Site administration > Plugins > Enrolments > Manage enrol plugins''

You may use a external database (of nearly any kind) to control your enrolments. It is assumed your external database contains a field containing a course ID, a field containing a user ID, and optionally a field containing a role. These are compared against fields that you choose in the local course, user tables, and role tables.

The following are the supported data sources, but note that you will need to have to compiled PHP with the appropriate options or through [[ODBC]].

*access
*ado
*mssql
*borland_ibase
*csv
*db2
*fbsql
*firebird
*ibase
*informix72
*informix
*mysql
*mysqlt
*oci805
*oci8
*oci8po
*odbc
*odbc_mssql
*odbc_oracle
*oracle
*postgres64
*postgres7
*postgres
*proxy
*sqlanywhere
*sybase
*vfp

== Enrolment & Unenrolment ==

External database enrolment happens at the moment when a user logs into Moodle. The plugin will attempt to automatically enrol the student in all their courses according to the data in the external database and, optionally, create empty courses where they do not already exist. To check if it is working, you can log in as a student and then check that their list of courses is as you would expect.

The process also unenrols users from courses if they are no longer in the database. User records are marked according to their original enrolment method. Therefore the external database plugin can only unenrol users who were enroled by the plugin in the first place.

== Hidden Courses ==

Courses that are set to "Course is not available to students" can be ignored for enrolment purposes by setting the "enrol_db_ignorehiddencourse" to '''yes'''.

== Enrolment & Roles ==

The "enrol_db_defaultcourseroleid" setting in the plugin settings page specifies the role that the user will take when they are added to the course. The default setting will set them to the course default setting (initially "student"). However, you can specify a field in the external table (specified in the "enrol_db_remoterolefield" setting) that contains the short name for the user's role. This could, for example, be used to enrol both students and teachers into courses using a suitably configured database.

== Creating Courses ==

Optionally courses that do not exist in the Moodle site can be created. Switch the "enrol_db_autocreate" option to "yes" in the plugin settings. You can additionally specify the Category into which the new course will be placed and may also specify a "template" course from which the new course will be copied.

== Synchronization Script ==

A script is provided that can synchronize all your user enrollments at once - both adding and removing user enrolments (and creating courses if specified). The script is called enrol_database_sync.php and is found in the enrol/database folder.

This script is meant to be called from a system cronjob to sync moodle enrolments with enrolments in the external database. You need to make sure all the users present in the external enrolments are already created in moodle. If you are using external authentication plugins (db, ldap, etc.) you can use the scripts provided by those plugins to synchronize your users before running this script.

Example cron entry for Moodle 2.0
# 5 minutes past 4am
5 4 * * * /usr/bin/php -c /path/to/php.ini /path/to/moodle/enrol/database/cli/sync.php

Notes:
* If you have a large number of enrolments, you may want to raise the memory limits by passing -d memory_limit=256M
* For debugging & better logging, you are encouraged to use in the command line: -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
* This only works for users that already exist in your Moodle site (see comment above)

== Setting It Up (How to) ==

You will need to perform (as a minimum) the following steps to enable external database enrolment - only a single table is required in the database which contains a record for every user/course combination. If the table is large it is a good idea to make sure appropriate indexes have been created:

* Use an existing database or create a new one. Use an existing or create a new table with the following minimum fields:
** course identifier (to match unique course identifier in Moodle)
** user identifier (to match unique user identifier in Moodle)
** (optional) role identifier (to match unique role identifier in Moodle)
* Populate the database table. Each user/course combination to have a record in the table
* In Moodle, go to Site Administration => Courses => Enrolments, find External Database in the list and click Settings
* In the top panel, select the database type (make sure you have the necessary configuration in PHP for that type) and then supply the information to connect to the database.
* The middle panel creates the mapping between Moodle and the external database. The first three settings are for the local (Moodle) field names and the last three for the remote (external database) settings. They are in the same order.
** enrol_localcoursefield / enrol_remotecoursefield - in Moodle the name of the field in the course settings the uniquely identifies the course (e.g., idnumber). In the external database the name of the matching field.
** enrol_localuserfield / enrol_remoteuserfield - in Moodle the name of the field in the user profile that uniquely identified the user (e.g., idnumber). In the external database the name of the matching field.
** enrol_db_localrolefield / enrol_db_remoterolefield - (optional) in Moodle the name of the field in the role edit page the uniquely identifies the role (e.g., shortname). In the external database the name of the matching field.
* The Roles panel specifies the role that the user will get in the course if their role is not specified in the external database.
* The final panel enables auto creation of courses.
* Save changes, and then tick the box to enable external database enrolment.

== Database enrolment does not appear in the course enrolment drop down menu. Why? ==

The course enrolment drop down menu only lists [[Enrolment_plugins#Interactive_enrolment|'''interactive''' enrolment plugins]]. External database enrolment is not such a plugin, so it doesn't appear in the list. Similarly, the "Course Enrollable" setting (in the Course Settings) page also only applies to interactive enrolment plugins and has no effect on external database enrollment.

As of this writing, the only interactive enrolment plugins are ''manual'' (also know as ''internal''), ''paypal'' and ''authorize.net''.

== Field Mapping Example: ==
Choose your fields from the Moodle database:

*enrol_localcoursefield: A course identifier from mdl_course, e.g. "idnumber"
*enrol_localuserfield: A user identifier from mdl_user, e.g. "idnumber"
*enrol_localrolefield: (optional) A role identifier from mdl_role, e.g. "shortname"

Create a view in your external database which matches the chosen field values from Moodle:

*enrol_remotecoursefield: A matching course identifier from your external database table, e.g. "course_number"
*enrol_remoteuserfield: A matching user identifier from your external database table, e.g. "userid"
*enrol_remoterolefield: (optional) A matching role identifier from your external database table, e.g. "role_name"

== Potential Gotchas ==

* It almost goes without saying that the integrity of the external database is important. If data is missing from the database then there is a potential for users being unenrolled from some or all of their courses. The unenrollment process will remove them from any group assignments and also poll each module type to give the module the option of removing that user's data if appropriate (for example, however, forum posts are never deleted). It is therefore prudent that you take the utmost care to ensure that the data in the external bass is correct at all times.
* '''Minor Security Issue''' Consider that if the ID field you use to identify your students is editable by the students (in their profile), then there is a potential for them changing this to the id of another valid student and gaining access to resources that they should not. However, they will still appear as themselves, they cannot impersonate the other user or otherwise gain access to their resources.

==Errors and Diagnostics==

The plugin produces a number of diagnostic messages and/or errors which are recorded to the PHP error log (as defined in the php.ini file). In addition messages about courses that are in the database for the user but that do not exist in the Moodle site will only be produced if debugging is set to ALL or DEVELOPER.

==See also==
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=49475 MySQL enrolment plugin doesn't seem to work] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=74133 Someone explain external database enrolment, please??] forum discussion
*Example Setup [https://docs.moodle.org/en/Talk:External_database_enrolment#Example_External_Enrollment] Example Database Enrollment Setup

[[es:Matriculación Base de Datos Externa]]
[[fr:Base de données externe]]
[[de:Einschreibung über externe Datenbank]]
[[ja:外部データベース登録]]

Manual enrolment

2012-03-09T16:09:14Z

Mits: ja link

{{Enrolment}}
The manual enrolments plugin allows users to be enrolled manually via a link in the course administration settings. The plugin has to be enabled by the site administrator (see [[Enrolment plugins]]) and should normally be enabled as certain other enrolment plugins, such as self enrolment, require it.

==Course settings==
===Checking you have manual enrolment in your course===
*In a course, go to ''Settings > Course administration > Uusers > Enrolment methods''
*Make sure Manual enrolments has its "eye" opened:

[[File:Manualenrolments.png]]

===Editing the manual enrolment method===

Managers (and any other users with the capability [[Capabilities/enrol/manual:config|enrol/manual:config]]) can edit the manual enrolment method in the course and set the default enrolment period and default role in ''Settings > Course administration > Users > Enrolment methods''.

[[File:Defaultenrolmentperiod.png]]

==Admin settings==
*Default settings for manual enrolment in courses may be specified in ''Settings>Site administration>plugins>enrolments>Manual enrolments''. These are:
**Add instance to new courses- if this is enabled, then whenever a new course is created, manual enrolments will automatically be enabled
**Enable manual enrolments - this makes this plugin available throughout Moodle and it is advisable to do this.
**Default enrolment period - this sets the default length of enrolment (in seconds) and may be altered by a teacher in a course.
**Default role - this sets the default role, which is normally student but may be altered by a teacher in a course.

==Manual enrolment capabilities==

*[[Capabilities/enrol/manual:config|Configure manual enrol instances]]
*[[Capabilities/enrol/manual:enrol|Enrol users]]
*[[Capabilities/enrol/manual:manage|Manage user enrolments]]
*[[Capabilities/enrol/manual:unenrol|Unenrol users from the course]]
*[[Capabilities/enrol/manual:unenrolself|Unenrol self from the course]]

==See also==

* [[Enrolled users]] including option to manually enrol a user in the course

[[de:Manuelle Einschreibung]]
[[ja:手動登録]]

Capabilities/enrol/manual:config

2012-03-06T15:13:44Z

Mits: ja link

{{Capabilities}}
*This allows a user to edit the [[Manual enrolment]] method and set the default enrolment period and default role in ''Settings > Course administration > Users > Enrolment methods
*This capability is allowed for the default role of manager only

[[File:Defaultenrolmentperiod.png]]

[[Category:Capabilities|Enrol]]
[[Category:Enrolment]]

[[ja:ケイパビリティ/enrol/manual:config]]

Category enrolments

2012-02-24T17:56:48Z

Mits: ja link

{{Enrolment}}

The category enrolments plugin allows users to be enrolled in a category as opposed to individual courses. The plugin has to be enabled by the site administrator (see [[Enrolment plugins]]).

Note: It is recommended that [[Cohort sync]] is used in preference to category enrolments.

==Settings for category enrolment==

*Go to the category into which you wish to enrol users. '''Note:''' You need to have category rights (manager or administrator)

*In the ''Settings'' box,click ''Assign roles''. The list of possible roles you can assign will appear:
[[File:Categoryassign.png]]

== Admin settings for category enrolment==

The category enrolment plugin may be enabled or disabled throughout the site in ''Settings > Site administration > Plugins > Enrolments> Manage enrol plugins.''

===Assigning teachers or students to a category===

*By default, only managers and course creators can be assigned category-wide. If you want to add teachers or students then the site administrator needs to tick the "category" box in their role in ''Settings > Site administration > Users > Permissions > Define roles''.
*To ensure they will be automatically assigned as teachers/students in any new courses you make, the administrator needs to set to "allow" the capability ''enrol/category:synchronised'' for the role in question in ''Settings > Site Administration > Users > Permissions > Define roles''

[[File:Enrolcategorysync.png]]

[[ja:カテゴリ登録]]

Cohort sync

2012-02-15T15:30:11Z

Mits: ja link

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

==Enrolling a cohort in a course==

In order to actually enrol users from a Cohort into courses the ''Cohort-Sync'' Enrollment plugin needs to be added to the enrollment methods for the course. The Administrator will first need to enable the ''Cohort-Sync'' enrolment plugin site wide (''Settings > Site administration > Plugins > Enrolments'') and then add it to the required Course: (''Settings > Course administration > Users > Enrolment Methods'').

[[File:Cohortsync.png]]

At this stage the ''Cohort-Sync'' instance for the course is edited and the appropriate Cohort selected. The role to which the Cohort users are assigned is also selected at this point (typically Student).

Visiting the ''Settings > Course administration > Users > Enrolled Users'' page will show users enrolled via the ''Cohort-Sync'' plugin.

Note that, by default, a teacher cannot add this plugin to their course. It needs to be configured by an Administrator or a user with the Manager role.

The required capabilities for setting up a cohort sync are:
* moodle/course:enrolconfig in the course context
* moodle/cohort:config in the course context
* moodle/cohort:view in the same context as category

The required capabilities for manually enrolling cohort members are:
* the same as cohort sync (note: this is a bug MDL-28431)
* enrol/manual:enrol in course context
* moodle/course:enrolreview in course context

==See also==

* [[Cohorts]] for information on how to create a cohort

[[de:Einschreibung über globale Gruppen]]
[[ja:コーホート同期]]

Cohorts

2012-02-14T15:20:08Z

Mits: ja link

{{Grouping users}}
Cohorts, or site-wide groups, 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 ''Settings > Site administration > Users > Accounts > Cohorts''
[[File:Createcohort.png]]
* 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.
*Complete the details and save the changes.
* Follow the assign link opposite the cohort name in the list of available cohorts.
[[File:Assigncohort.png]]
* 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 ''Settings > Site administration > Plugins > Enrolments > Manage enrol plugins''.

==Adding users to a cohort in bulk==

{{New features}}#Access ''Settings > 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==

{{New features}}An administrator can upload users via CSV file to existing cohorts as follows:
#Access ''Settings > 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'')

==See also==
*[http://www.youtube.com/watch?v=FMWZW_n0eVI A three minute Cohort in Moodle 2.0 video]
*[http://www.youtube.com/watch?v=dMqaeOGXuHQ Cohorts in Moodle 2.0 video]
*[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]]
[[ja:コーホート]]

HTTP

2012-01-23T16:09:44Z

Mits: ja link

{{Server settings}}
An administrator can change the following settings in ''Settings > Site administration > Server > HTTP''.

==Use slash arguments==

You will need to change this setting only if you are having trouble viewing files or images. Most of the time, Moodle will display files and pictures with no problem using the slash arguments. If you get errors when you try to view pictures or files from within Moodle, your PHP server doesn't allow the slash argument method and you will need to disable this setting.

==Proxyhost and proxyport==

Your Moodle server may need to access the Internet through a proxy server, depending on your network configuration. If you're not sure about whether you need a proxy server, contact your network administrator or ISP.

[[ja:HTTP]]

Cleanup

2012-01-19T15:56:30Z

Mits: ja link

{{Server settings}}
An administrator can limit the size of certain tables in the database by setting appropriate options in ''Settings > Site administration > Server > Cleanup''.

==Delete unconfirmed users after==

If you're using [[Email-based self-registration]] users must confirm their account within a certain time-frame. Once the time set here has passed, any account that hasn't been confirmed will be deleted. 7 days is a good setting.

==Delete incomplete users after==

The period after which old not-fully-set-up accounts are deleted may be set (from 1 day to never).

(What is the definition of a "not-fully-set-up account"? What criteria needs to be met for an account to be fully-set-up?)

==Keep logs for==

Moodle keeps extensive logs of user activity. Eventually, however, the logs will become so large that they begin to clog your server. Limiting the length of time logs are kept for will reduce database table size. Generally, a year is enough time to keep logs for.

==Disable grade history==

History tracking of changes in grades-related tables may be disabled by checking the ''disablegradehistory'' box.

==Grade history lifetime==

The length of time that the history of changes in grade-related tables is kept may be set (from 30 days to never).

==Unsubscribe users from courses after==

Note for users who have upgraded to Moodle 2.0 from 1.9: The setting 'Unsubscribe users from courses after' in Cleanup has been replaced by 'Unenrol inactive after' in [[Self enrolment]].

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=87795 How do I prune mdl_log table?] forum discussion

[[eu:Garbiketa]]
[[fr:Nettoyage]]
[[ja:クリーンアップ]]

Session handling

2012-01-13T16:03:37Z

Mits: ja link

{{Server settings}}
An administrator can change the following settings in ''Settings > Site administration > Server > Session Handling''.

==Timeout==

Once someone logs in to your Moodle server, the server starts a session. The session data allows the server to track users as they access different pages. If users don't load a new page during the amount of time set here, Moodle will end their session and log them out.

Be sure this time frame is long enough to cover the longest test your teachers may offer. If a student is logged out while they are taking a test, their responses to the test questions may be lost.

==Cookie prefix==

Most of the time, you can leave this blank, unless you are running more than one Moodle site on the same server. In this case, you will want to customize the name of the cookie each Moodle site uses to track the session. This enables you to be logged into more than one Moodle site at the same time.

Note: If you change "Cookie prefix" or "Cookie path" you will need to login again as the changes take effect immediately.

==See also==

*[[Sessions FAQ]]

[[cs:admin/setting/sessionhandling]]
[[ja:セッションハンドリング]]

System paths

2012-01-07T15:29:59Z

Mits: ja link

{{Server settings}}
An administrator can set the following system paths in ''Settings > Site administration > Server > System Paths''.

==GD version==

GD is a graphics library that manipulates graphics. It's used to create thumbnail images from uploaded files and other graphics on the fly. If you don't know what version is installed, leave this on the original setting.

'''Note''': When setting the system paths on Windows systems, use of the 8.3 notation for the path and filename is preferred. So instead of entering ''c:\program files\path to aspell\aspell.exe'', enter ''c:\progra~1\path~1\aspell.exe''. Check the exact 8.3 path using the ''dir /x'' command at the prompt.

==Path to aspell==

If PSpellSpell is selected as the spell engine for TinyMCE in ''Settings > Site administration > Plugins > Text editors > TinyMCE HTML editor'' then you must specify the correct path to access the aspell binary.

In addition, you MUST have aspell 0.50 or later installed on your server. On Unix/Linux systems use the which program to determine the path:

[root@moodle ~]# which aspell
/usr/bin/aspell

In this example the path to enter is ''/usr/bin/aspell''.

On a Windows system, download and install [http://aspell.net/win32 GNU aspell] together with at least one dictionary and then use the search facility in Explorer to find the aspell.exe file. The path should look like:

c:\program files\aspell\bin\aspell.exe

It can be best to install aspell in c:\aspell or use the 8.3 notation if you are installing in ''c:\program files'' so that the path looks like

c:\progra~1\aspell\bin\aspell.exe

==Path to dot==

Path to dot is for enabling image generation in profiling. The generated graphs are really useful to see what each request does. To have profiling visible (and working), the xhprof extension must be installed in PHP.

==External links==

*[http://aspell.sourceforge.net/ GNU Aspell]
*[http://aspell.net/win32/ GNU Aspell (Win32 version)]

==See also==

* [http://moodle.org/mod/forum/discuss.php?d=125912 HowTo: Installing aspell in Ubuntu (with dictionary)] forum discussion

[[cs:admin/setting/systempaths]]
[[hu:Rendszerútvonalak]]
[[ja:システムパス]]

Book module

2011-10-22T15:12:30Z

Mits: ja link

{{Book}}

The '''Book module''' makes it easy to create multi-page resources with a book-like format. It is contributed by [http://moodle.org/user/view.php?id=12863&course=5 Petr Škoda]. This module can be used to build complete book-like websites inside of your Moodle course.

Previously created websites can be imported directly into the Book module. Books can be printed entirely or by chapter.

The book module allows you to have main chapters and sub chapters, but it goes no deeper. In other words, sub chapters cannot have their own sub chapters. This was an intentional decision by the creator of the book module. He intended this to be a simple resource for teachers and students.

The book module is not interactive. You can, however, link to [[Choice module|choices]], [[Forum module|forums]] etc., from within a book. And you can include multimedia objects like [[Flash]] movies in your book.

==Books and Moodle 2.0==
The latest code is here: https://github.com/skodak/moodle-mod_book

===Can I duplicate a book within a course?===
Use the Sharing Cart. See [http://moodle.org/mod/forum/discuss.php?d=167624 Discussion:Duplicating a book within a course]

===Can I shift Books from one Moodle 2 server to another Moodle 2 server?===
Not using the backup and restore. This is not written yet. (as of 19th February 2011)

It is possible to export as an IMS package and make a couple of tweaks and then import. https://docs.moodle.org/en/IMS_content_package

==Installation==
* Select the correct version of the "book.zip" module for your Moodle installation
* Unpack the zip file into the mod folder of your Moodle site
* Login to the Moodle site as administrator and
* In site administration block click on notifications
* Moodle will install the Book module.
* [[Creating_a_book|Add a book as an activity]]

==See also==
*[http://moodle.org/mod/data/view.php?d=13&rid=319 Book Module] is a Modules and plugins database page for downloads and more information.
*Discussions: please create or find a discussion topic in the [http://moodle.org/mod/forum/view.php?id=2633 Book module forum]
*Examples: The manuals at [http://moodle.tokem.fi tokem.fi] are a series of book modules. Each book is designed for a different level of Moodle user.
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=76092 Using a Lesson to simulate a Book] forum discussion
* [http://tracker.moodle.org/secure/attachment/23370/Moodle+Procedure+Set+up+a+Moodle+Book+and+copy+it.pdf Procedure for setting up a Book] pdf from Frances Hill

[[Category:Contributed code]]

[[es:Book]]
[[eu:Liburua]]
[[ja:ブックモジュール]]

Course files

2011-10-19T16:26:25Z

Mits: ja link

{{Working with files and folders}}
This page explains the legacy "Course files" area in Moodle 2, and related topics.

It's useful for any teacher who wants to know how to add files to a Moodle 2.0 course (especially if you previously used Moodle 1.9 or earlier).

==Files in Moodle 1.9==

In versions of Moodle before 2.0 all the files uploaded into Moodle were stored in a physical directory on disk known as the "Course files" area.

This is where a teacher might upload files to be part of the course content, but this area also included everything students uploaded, such as assignments and forum attachments. These "activity files" were stored in a special folder called ''moddata'' in a certain structure that helped modules keep track of their own files.

===Typical Moodle 1.x workflows===

The course files area was accessed in two ways through the Moodle interface by teachers.

# Through the "Files" link in the Course Administration block, or
# When a file was required in other places, such as a resource, or attachment.

When publishing a file as a resource, say a PDF file, a teacher might:

# Upload it to their course files area along with all the other files they intend to use in the course
# Add a resource to the course
# Select the PDF from the course files

Students did not have direct access to read the course files area. All they could do was upload files from their desktop computer straight into activities.

===A less typical workflow===

# Use [[wikipedia:FTP|FTP]] to push files straight into the course files area
# Add resources to the course by selecting these files
# Update the resources later by updating the files directly via FTP

This meant expert users could update course content with files or HTML mini-sites without having to change anything in Moodle.

===Problems with the Moodle 1.x model===

* If the original file was deleted from course files area, or renamed, it would result in broken links everywhere where it was previously used
* Storing files on disk meant file names were restricted (eg file names in Japanese would break on some operating systems)
* All course files had to be readable by students (if they knew the URL) because Moodle had no way of telling what context you were viewing a file in (eg the same file might be in a HTML text in a forum and also in a resource). This meant that files stored in the course files area were not as secret as teachers thought they were.
* Files could not be reused in several courses - that had to be uploaded to each course files area
* Backups had to include ALL course files, just in case they were required, even if the backup only contained one activity
* Images and other media might look fine for teachers, but others would not see it (eg in course descriptions)
* When importing activities from one course to another, ALL course files were imported, as it was impossible to tell which files were needed

==Files in Moodle 2.0==

In Moodle 2.0 the files work a lot more like Web 2.0 systems, such as Facebook and Google Docs.

Each activity and each text has its own file area, and files are associated directly with the place it is used. For example, a file attached to a forum post is stored "with" the forum post, and becomes subject to exactly the same access restrictions.

The Files system is intimately connected with the Repository system, and a file picker which makes it easy to browse external and internal repositories for files, and then copy them into Moodle. Certain repositories also allow you to link directly to their media files. Repositories in general are the way of the future for content - most Web 2.0 systems are really repositories of data with various management interfaces.

A private files area is provided for each user to store a collection of files for their own use. This is useful for students as well as teachers, and makes it easy to re-use media across the Moodle site. Only you can access your own private files.

The course files area in Moodle 2.0 is [[wikipedia:Deprecation|deprecated]] and is not available by default due to the problems described above. When a site is upgraded from 1.9, all course files are migrated into new file areas and the old course files area is hidden from view.

Internally, files are stored in a "file pool" of blobs on disk with numbers for names. All the actual names and metadata are stored in a database.

===Typical Moodle 2.0 workflow===

# Edit a text or activity
# Use the filepicker to easily select the file from any local or remote repository

The file is then copied to Moodle and stored securely with the text or activity.

===More advanced Moodle 2.0 workflow===

# Edit a text or url resource
# Use the filepicker to easily select the file from any local or remote repository and select "link"

The file URL is then embedded into the text and when viewed, the media comes directly from the open repository.

===Why is it better?===

====Integrity====

If a forum post with attached files (eg images) is imported into another course, then the files move with it. Anyone in the new course will also see the files. This makes activities more portable and re-usable.

If two activities use the same file and one is deleted, then the other one is not affected.

There should be less problems with everything looking fine for teachers and not appearing for students.

====Security====

Access to files is governed the same way as the items that they attached to, which is what people expect. All files are now controlled by the settings in the Moodle interface, including roles and permissions.

====Re-usability====

It is now fast and easy to re-use files across Moodle. Using the file picker, a recently-used file may easily be chosen, or a file from any course a user has access to.

====Backups====

Backups of activities are small and accurate, because Moodle knows exactly what files to include. This is important for things like [[Community hubs]], where sharing of courses and parts of courses will become more common, and sharing every file in a course may be unacceptable.

====Internationalization====

There are no restrictions on file names - even files with names in Japanese may be used.

====Repositories====

The world is turning towards better management of files and less "dumping" of files into disks. There are many repository solutions out there that focus on better management of files, with versioning, workflow, metadata and other features.

===How to duplicate Moodle 1.x functionality in 2.0===

If you really want to mimic older workflows in 2.0 then there are some solutions, although none of them are exactly the same.

====FTP files into Moodle====

# One way to do this is via the [[admin/repository/filesystem|File system repository]]. This allows you to turn a directory on the server into a repository of files within the Moodle file picker. You can then use any server technology to access that directory from a desktop, such as FTP, [[wikipedia:Samba (software)|Samba]], [[wikipedia:AppleShare|Appleshare]] or [[wikipedia:WebDAV|WebDAV]].
# See the direct WebDAV plans below.

====Change a file once, have it update in many places====

# If you use an external repository that supports linking (such as Alfresco) then you get this behaviour for free. Files in the repository can not have exactly the same access control as Moodle, but they can implement their own access control, especially if you use some sort of single sign-on.
# If you enable the [[Legacy course files]] feature in Moodle 2.0 then you can also link directly to files there using the Course files repository in the file picker. Even HTML mini-sites work. The caveat is that it only works in places where you can '''link''' to files. So, for example, it won't work for a forum attachment or the 'resource' module. But it will work for the url module (new in 2.0) and any media embedded in HTML via the editor.

==Roadmap for future improvements==

Based on recent feedback, there are plans to improve the model in 2.0 with new features.

===File synchronization===

Instead of having to choose between linking to a course file or copying it to the current file area, we could add the option to 'Always use the latest version' of the file. This would re-copy the file to the destination whenever the source file changed. Initially this would be implemented just for the internal repositories but could also be used later for some external repositories as well (those not requiring the Moodle site to authenticate as the user).

This feature has the potential to maintain all the benefits of the 1.0 model without compromising the 2.0 model.

However this feature is complex to implement because:

* We need to cope with changing permissions in source and destination.
* We need to cope with cases like Assignment submissions (students shouldn't be able to update files after the due date, for example)
* We need some GUI solution to synchronize whole folders at once, such as a HTML mini-site.
* We need some in-GUI solution to report what the source file is for any given destination file.

===Linking ability to File system repository===

The File system repository currently does not allow linking to files. This is because the files are in a directory inside moodledata and are not exposed by any direct URL from the web.

To serve them to the web we'd have to have some script like ''/repository/filesystem/file.php'' to serve them as links, which would allow relative links like HTML mini-sites to work.

The problem with this is that we are back to the same issues as 1.9 course files (or even worse), with no access control on the files at all. Some people may not care about this, but the solution needs to make this very clear to users.

===WebDAV support for course files and user files===

This would effectively replace direct FTP access to the file system with WebDAV access to the "virtual" file system inside these file areas in Moodle. It would allow people to update files without going near the web GUI.

==See also==

* MDL-23306 META: Improve usability of new files structure
* [http://moodle.org/mod/forum/discuss.php?d=167471 Where is the Moodle 2.0 Course Backup Filearea] Using Moodle forum dicussion
* [[Legacy course files]]

[[fr:Fichiers de cours]]
[[ja:コースファイル]]

Git for Administrators

2011-10-09T16:52:22Z

Mits: ja link

An alternative way to maintaining your Moodle server via [[CVS for Administrators|CVS]] is using Git. This page describes how to maintain a copy of Moodle on your production server which can easily be upgraded using Git. If you have customisations of Moodle core code, you are advised to follow the instructions in the [[Development:Quick Git start guide for Moodle development|Quick Git start guide for Moodle development]].

== Obtaining the code from Git ==

You can find the official Moodle git repository at git://git.moodle.org/moodle.git (with an official clone at git://github.com/moodle/moodle.git). To initialize your local checkout, use

git clone git://git.moodle.org/moodle.git (1)
cd moodle
git branch -a (2)
git branch --track local_19_STABLE origin/MOODLE_19_STABLE (3)
git checkout local_19_STABLE (4)

The command (1) initializes the new local repository as a clone of the upstream moodle.git repository. By default, this upstream repository will be known as 'origin' remote repository. The command (2) lists all available branches. Use the command (3) to create a new local branch called local_19_STABLE and set it to track the branch MOODLE_19_STABLE from the upstream repository. The command (4) actually switches to the newly created local branch. Note that the last two lines can be replaced with

git checkout -b local_19_STABLE origin/MOODLE_19_STABLE (3 + 4)

that creates a new local tracking branches and switches to it immediately.

== Updating your installation ==

The Moodle development team performs integration and testing of fixed bugs every Monday and Tuesday. On Wednesday you can install all patches by updating your code. Check the [http://git.moodle.org/gw?p=moodle.git;a=summary shortlog] to see if the official repository has been already updated or not.

cd /path/to/your/moodle/checkout
git fetch (1)
git status (2)
git merge (3)

The command (1) downloads new updates from the remote repository without touching your local checkout. The command (2) displays the information about the eventual drift between you local version and the upstream one. The command (3) actually modifies your local files with the updates. The git-fetch + git-merge couple can be replaced with a single command

git pull (1 + 3)

== Installing a contributed extension from its Git repository ==

For example, let us say we want to install the [[Book module]] form its Git repository into our Moodle 2.0.

cd /path/to/your/moodle/checkout
cd mod (1)
git clone git://github.com/skodak/moodle-mod_book.git book (2)
cd book
git checkout -b MOODLE_20_STABLE origin/MOODLE_20_STABLE (3)
git branch -d master (4)

The command (1) changes the current directory into the ''mod'' folder of your local Moodle clone. The command (2) creates a new subdirectory ''book'' and makes a local clone of Petr Škoda's vanilla Book repository. The command (3) creates a new local branch that will track the remote branch with a Book version for Moodle 2.0. The command (4) deletes the ''master'' that was created automatically by git-clone in (2) as we do not want it in this production checkout.

Now it is wise to put the new directory mod/book/ to the list of ignored files of the main Moodle clone.

cd /path/to/your/moodle/checkout
echo /mod/book/ >> .git/info/exclude

To update your Moodle installation now, you must visit both Git repositories and pull changes from upstream.

cd /path/to/your/moodle/checkout
git pull
cd /path/to/your/moodle/checkout/mod/book
git pull

Writing a shell script with these lines in the root of Moodle installation is a very good idea. Otherwise it is easy to forget what Git repositories are there within the main Moodle repository.

== See also ==

; Moodle Docs
* [[CVS for Administrators]]
* [[Moodle versions]]
* For some screenshots see [[User:Frank_Ralf/Git]] (still work in progress)

; Moodle forum discussions
* [http://moodle.org/mod/forum/discuss.php?d=168094 GIT help needed]
* [http://moodle.org/mod/forum/discuss.php?d=165236 Best way to manage CONTRIB code with GIT]
* [http://moodle.org/mod/forum/discuss.php?d=167063 Handy Git tip for tracking 3rd-party modules and plugins]
* [http://moodle.org/mod/forum/discuss.php?d=167730 Moodle Git repositories]
* [http://moodle.org/mod/forum/discuss.php?d=183693 Git and CVS]

; External resources
* [http://www.kernel.org/pub/software/scm/git/docs/everyday.html Everyday GIT With 20 Commands Or So]
* [http://gitref.org/ Git Reference]
* [http://progit.org/book/ Pro Git book]

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

[[ja:管理者用Git]]

Upgrading

2011-09-09T02:18:27Z

Mits: ja link

Moodle is designed to upgrade itself from one version to the next. The procedure is
# [[Site backup|Back up everything]].
# Replace the old version of the code with the new one.
# Visit the [[Site_administration_block#Notifications|administrator notifications]] link, which triggers Moodle to self-update.
These steps are explained in more detail below.

Sometimes there are specific considerations when upgrading to a particular version. See the [[dev:Releases|Releases page]] for more information on this. You also have to be more careful if you have installed additional plug-ins or customised the code.

See this tutorial if you are [http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf upgrading Moodle on cpanel]. It is a bit rough around the edges and is a little dated, but you should get the idea.

There is also a separate page about [[Ubuntu_Debian_Upgrades|upgrading Moodle if you installed it using the Ubuntu/Kubuntu/Debian package manager]].

__TOC__

When upgrading a Moodle installation you should follow these steps:

==Before you upgrade your site for real==

You are strongly advised to make a copy of your entire Moodle site onto another computer (see [[Moodle migration]]) and run the upgrade there to verify it will work.

==Check the requirements==
Spend some time re-reading the [[Installing Moodle | installation documentation]] and documentation for the new version. Check the system requirements for the target version you want to upgrade-to in ''Administration > Server > [[Environment]]''.
==Put your Site into Maintenance Mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | Maintenance Mode]] to stop any non-admin users from logging in.

== Backup important data ==
See [[Site backup]] for more specific information.

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

Experienced site administrators know that it is a best practice (a very good idea) to make a backup of any production system before a major upgrade. In fact, it is a good idea to automate your server to backup your Moodle installation daily. Most upgrades on sites that have used the standard Moodle packages (no contributed code and no little tweaks to the php files), will not have any major issues with the upgrade process.

:''TIP:'' One more time, "do not risk what you can not afford to lose": do regular backups, make sure it is really backed up and know how to restore a backup!

== Install the new Moodle software ==
Upgrading can be a simple process or a more complicated process. Sites that have not used contributed code and are migrating from say Moodle 1.x.1 to 1.x.3 '''should''' not have a problem. However, we still recommend that with any production server that you have made a successful backup of the MySQL database, the moodledata directory and the moodle program folders and files.

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new installations. Review the backup section above.

=== Standard install package ===
Having read the cautions about backups, download a copy of the standard install package. Here is a set of simple instructions for an average site.
*It is probably a good idea to use the [[Site administration block]]>Server>Maintenance mode to prevent user activity as the site upgrades.
*Having moved your old Moodle software program files to another location, unzip or unpack the upgrade file so that all new the Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and [[Moodledata directory|moodledata]] if it needs to in the upgrade.
*Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
*If you had added any custom plugins or themes into your Moodle you can add them to the new code. It is important to check that you get the correct version for your new version of Moodle. You should check in the optional plugins database. Be particularly careful that you do not overwrite any code in the new version of Moodle. If you are upgrading to Moodle 2.0 or newer, note that all optional plugins and themes required a significant rewrite and most do not have 2.0 versions (yet).
*Use the notification link in the site administration to start the upgrade process. You will see a series of lines or screens indicating progress.
*After a successful upgrade, turn off the maintenance mode, so your users can get into the site.

=== Using a downloaded archive ===
In some installs, the site administrator may overwrite the Moodle code with a backup copy. Or create a new clean install copy of Moodle, then restore an archive (via a compressed file or parts of a saved set of Moodle code files and folders).

*Do not overwrite an old installation unless you know what you are doing ... sometimes old files can cause problems in new or "cleaned" installations. The best way is to rename the current Moodle code directory (for example rename "moodle" to "moodleold"), then unpack the new Moodle archive into the old location (for example, a new directory called "moodle").

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

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

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

Don't forget to

sudo chown www-data moodle/config.php

if necessary.

where www-data is whatever user the Apache user is on your system. This is often 'apache' or 'www'.
You can find out by doing 'ls -l' in your /var/www/moodle folder (or wherever your moodle site is)
and then looking at the owner and group.

so you may see something like

ls -l
...lots of lines...
-rw-r--r-- 1 apache system 784 Jun 28 2007 config.php
...lots more lines...

so the owner is apache and the group is system.

To replicate this on your new system you can do 'chown apache:system config.php'

or to do a whole group do

chown apache:system ./*

and recursively

chown -R apache:system ./*

=== Using CVS ===

You can use CVS for updating or upgrading your Moodle.
First you need to do a CVS checkout in your (empty) Moodle root directory.

You can use any of our [[CVS_for_Administrators#CVS_Servers|CVS Mirror servers]]. Just replace '''SERVER.cvs.moodle.org''' in the instructions below with the name of the mirror server you chose!.

====For Linux servers====

To do a CVS checkout of Moodle, you first have to logon to the Moodle CVS server.

<nowiki>cvs -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle login</nowiki>
No password for anonymous, so just hit the Enter button.

Go to the directory where you want the Moodle root to come and type

<nowiki>cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co -r MOODLE_18_STABLE moodle</nowiki>
(where MOODLE_18_STABLE is the desired version)

To update, just go into the Moodle root directory and update to the new files:

cvs update -dP
To update to a new version type in the following and change 18 to whatever newest version upgrade number is
cvs -Q update -dP -r MOODLE_18_STABLE

Make sure you use the "d" parameter to create new directories if necessary, and the "P" parameter to prune empty directories.

====For Windows servers====

You can use Tortoise CVS to do the initial checkout and the updates.

If you have been editing Moodle files, watch the messages very closely for possible conflicts. All your customised themes and non-standard plugins will be untouched.

Do not forget to trigger the install process in the site administration block (see below).

=== Using Git ===

You can use [[Git]] for updating or upgrading your Moodle.
First you need to do a Git checkout in your (empty) Moodle root directory.

See [[Git for Administrators]] for further details.

== Finishing the upgrade ==

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

To do this just visit the [[Site administration block]] admin page (or ''<nowiki>http://example.com/moodle/admin</nowiki>'') and the "Notifications" link.

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

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

:''TIP:'' Use the site administration block>Server>Maintenance mode to prevent users from changing data during the upgrade.
:''TIP:'' If you are running a large scale Moodle site (e.g. have more tha 10,000+ courses and 40,000+ users), make sure that you do your own performance profiling testing. Post a thread or check the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum] and check [[Tracker]] for potential issues.

== Verify the upgrade (optional) ==

If you wish to confirm that the database definitions in the upgraded database match the definitions of a new, clean install (which they should) you might like to look at [[Verify Database Schema]].

==Upgrading more than one version==

In general, it is recommended to upgrade via the newest of each major version of Moodle, for example 1.7 -> 1.9. An exception to this is when upgrading from 1.5 or 1.6, when it is recommended that 1.7 and 1.8 are skipped, in other words upgrade 1.5 -> 1.6 -> 1.9. (The main reason for this recommendation is that the default roles settings obtained when upgrading to 1.7 are not ideal for 1.8 onwards, 1.8 has problems with groups, etc.)

==See also==

*[[Installing Moodle]]
*[[Installation FAQ]]
*[[Upgrading to Moodle 1.6]]
*[[Upgrading to Moodle 1.8]]
*[[Upgrading to Moodle 1.9]]
*[[Upgrading to Moodle 2.0]]
*[[Environment]]
*[[Git]] Version control and upgrading
*Moodle.org [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
*[http://ic.eflclasses.org/tutorials/howtoupgrademoodlewithcpanel.swf How to upgrade Moodle with cpanel tutorial] - screencasts of older Moodle/Cpanel install but useful (also, a very large file that will take some time to load).

Using Moodle.org forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=26731&parent=125858 Using cvs]
*[http://moodle.org/mod/forum/discuss.php?d=56915 Upgrading from 1.5.2 to 1.7]
*[http://moodle.org/mod/forum/discuss.php?d=56991 Upgrade nightmares.... any help appreciated]
*[http://moodle.org/mod/forum/discuss.php?d=62463 After upgrading i get "Your site may not be secure." msg]
*[http://moodle.org/mod/forum/discuss.php?d=104887 Best practices for QA]
*[[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration]]

[[Category:Installation]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[nl:Upgraden]]
[[zh:升级]]
[[pl:Aktualizacja]]
[[de:Aktualisierung von Moodle]]
[[ru:Обновление]]

Dropbox repository

2011-09-07T02:40:03Z

Mits: ja link

{{Repositories}}
A Dropbox repository can be enabled by a site administrator in ''Settings > Site administration > Modules > Repositories > Manage repositories''.

==Sign up app keys at dropbox==

# Go to https://www.dropbox.com/developers/apps
# Create an app, you must change app status to Production. This feature is only availble for new API developers, but not for Moodle repository users. See MDL-26949
# Copy the app keys (scroll if necessary)

NOTE: The only way to get App stats for Production approved is to use an acceptable App name. The App name should be something like "Moodle With Dropbox" - with dropbox is the key part of the name (can't just use dropbox). Otherwise, you'll receive an email that says "Your app name does not follow Dropbox branding guidelines (found here: https://www.dropbox.com/developers/branding ). Please choose a new name and submit a request to change your app name to api-program@dropbox.com."

==Configuration==
Once enabled by the administrator a Dropbox API Key and Secret will need to be added to the Dropbox settings in order for it to work. This will be ''the'' Dropbox available to all users throughout the site (and each will need the correct Dropbox login credentials to access it from their courses). To gather the Dropbox API Key and Secret click the "Dropbox Developers" link on the Dropbox repository settings page. On the next page you'll be prompted to login with your Dropbox username and password and to create a Dropbox app.

Once the App has been created at Dropbox.com you'll have the API Secret and Key available at the bottom of the App page. Entering those on the Dropbox settings page (and clicking Save) back in Moodle will finish the configuration. Dropbox is now available to the entire site.

To access it editing teachers need only "Add..." a new file while editing or creating a resource to see Dropbox as a new option.

==See also==

* [http://www.youtube.com/watch?v=V221JLCywWs Import files from Dropbox into Moodle 2.0 video]
* MDL-19168
* MDL-26949 - Can't change the Dropbox API key and secret to production status

[[Category:Site administration]]
[[de:Dropbox]]
[[ja:Dropbox]]

Legacy course files

2011-08-30T00:31:00Z

Mits:

<p class="note">Note: This page only applies to sites which have been upgraded from Moodle 1.9.</p>
{{Working with files and folders}}

In Moodle 2.0 onwards, files are stored in separate areas, rather than together in the course files area. See [[Course files]] for a detailed explanation. When a site is upgraded from 1.9, the course files area is renamed 'Legacy course files'. By default, this area is not available in new courses.

''It is recommended that teachers make use of the new [[Repositories|repositories]] in Moodle 2.0 for storing course files, rather than saving them in the legacy course files area''.

==Enabling legacy course files areas==

To enable a legacy course files area in a new course

# Enable the legacy course files repository plugin in ''Settings > Site administration > Plugins > Repositories > [[Manage repositories]]''.
# Check the legacyfilesinnewcourses box in the Manage repositories common settings then click the 'Save changes' button.
# Set 'Legacy course files' to Yes in the course settings.

A legacy course files link will then appear in the ''Settings > Course administration'' area.

[[Category:Repositories]]
[[Category:Site administration]]

[[ja: レガシーコースファイル]]

Legacy course files

2011-08-30T00:30:48Z

Mits: ja link

Private files

2011-08-21T20:40:20Z

Mits: ja link

{{Working with files and folders}}
{{Repositories}}
<p class="note">'''Please refer to [[Page_notes#Private files|these notes]] before editing this page.'''</p>

In Moodle 2.0 onwards, each user has a private files area for uploading and managing a set of files.

The private files area is accessible via ''Navigation > My home > My profile > My private files'' or the [[My private files block]]. It is available as a source within the filepicker when selecting files to use in a course.

==Private files management==

To add a file to your private files area
# On the Navigation menu, click My profile > My private files
# Click "Manage my private files" button
# The standard file picker Add-Create folder popup will appear.
# If desired, create or move to a folder,
#Click on the Add button
#Browse for and select a file
# Click the 'Save changes' button

[[Image:Files_standard_added_files_1.png|center|frame|Standard file add- create directory, showing 2 files]]
*Uploaded files may be downloaded, renamed, moved or deleted by clicking the icon next to the file. After making any changes, '''remember to click the 'Save changes' button'''.

[[Category:Repositories]]
[[Category:Moodle 2.0]][[Category:Files]]

[[eu:Fitxategi_pribatuak]]
[[fr:Fichiers personnels]]
[[ja:プライベートファイル]]

Category:Files

2011-08-17T16:33:59Z

Mits:

An index of pages about the [[Files | files]] option of the [[Course administration block | administration block]]

[[Category:Course]]

[[eu:Kategoria:Fitxategiak]]
[[fr:Catégorie:Fichiers]]
[[ja:Category:ファイル]]

Category:Files

2011-08-17T16:33:10Z

Mits: ja link

My private files block

2011-08-16T16:37:34Z

Mits: ja link

{{Moodle 2.0}}The My private files block, in Moodle 2.0 onwards, enables access to a user's [[Private files|private files]] area.

[[Category:Block]]

[[eu:Nire_fitxategi_pribatuak_blokea]]
[[de:Eigene Dateien (Block)]]
[[ja:プライベートファイルブロック]]

Import a community course

2011-08-15T16:01:41Z

Mits: ja link

{{Moodle 2.0}}
# in your [[Community block]], select''' 'Search'''' operation
# select a hub (Mooch being Moodle.org hub)
# set search settings to''' 'courses I can download'''' and select ''''Search'''' operation
# look at the result and click on Download. The course backup will be downloaded in your private files (see [https://docs.moodle.org/en/My_private_files_block private files block]) under a ''''Downloaded backup'''' folder.
# you have the choice to restore the course straight forward. Select''' 'Restore'''' operation.
# follow the common restore procedure, the you should be redirected to a newly created course (if you selected this option).
==See also==
* [https://docs.moodle.org/en/Community_hub Community hub]
* [[Community block]]

[[Category:Hub]]

[[ja: コミュニティコースをインポートする]]

Context

2011-07-22T16:07:22Z

Mits: ja link

{{Moodle site - basic structure}}
<p class="note">'''Please refer to [[TOC_with_notes#Moodle site - basic structure|these notes]] before editing this page.'''</p>
A context is a "space" in Moodle. Together, they define the navigational structure of a Moodle site. A course can be a context, so can an activity, resource or block.

A course can have many contexts in its space. These might include lesson, assignment, forum and quiz modules and blocks. Or for example, [[Question bank]]'s question categories are contexts.

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

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.

== 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 iniially 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 Cateory 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]])

== See also ==

Moodle Docs
* [[Beginning_Administration_FAQ | Beginning Administration FAQ]]
* [[Roles FAQ]]
* [[Development:Roles#Context]]
* [[Development:Roles and modules#Context]]
* [[Roles and capabilities]]
* [[Role permissions]]

Forum discussions
* [http://moodle.org/mod/forum/discuss.php?d=60125 "Roles and contexts in Moodle 1.7"]

[[Category:Roles]]

[[ja:コンテクスト]]

Publishing a course

2011-06-28T16:02:31Z

Mits: ja link

{{Moodle 2.0}}In Moodle 2.0 onwards, users with the capability [[Capabilities/moodle/course:publish|moodle/course:publish]] can publish courses to a hub.

==Why publish a course?==
[[Image:Publication.png|thumb|Publish course page]]
Possible reasons for publishing a course include:

* To share it with the world
* To sell your course design/methodology
* To attract more participants (students, teachers...)

== Advertising a course for people to join==
You can display a link to your course on any hub your site is registered on. The hub will redirect users on your course. T

# Click the button 'Advertise this course for people to join'.
# Select the hub where you want to advertise your course.
# Enter information about the course.
# Click the 'Advertise this course' button.

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

The advert for the course may be updated or removed at any time by clicking an appropriate button in the actions column.

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

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

# Click the button 'Share this course for people to download'.
# Select the hub where you want to share your course.
# Enter information about the course.
# Click the 'Upload this course' button.
# Select the data to be included in the backup.
# Create the course backup.

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

The course may be removed at any time by clicking the button in the actions column. To update the course, firstly remove it from the hub, then re-share it. You may also share different versions of the same course.

== Hub listing ==

To check whether a course is included in the hub listing, click the 'Check it now' link. Your Moodle site will contact the hub and will update the status of all courses published on the hub.

==See also==
* [[Community hub]]

[[Category:Hub]]

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

Site registration

2011-06-19T01:01:04Z

Mits: ja link

{{Moodle 2.0}}Location: ''Site Administration > Registration''

[[Image:Registration.png|thumb|Registration]]In Moodle 2.0 onwards, an administrator can register their site with the moodle.org open community hub, [http://hub.moodle.org/ MOOCH], and other community hubs.

==Moodle.org registration==

When you register your site with moodle.org, you are added to a low-volume mailing list for important notifications such as security alerts and new releases of Moodle. Statistics about your site, such as the number of users and number of courses will be added to the statistics of the worldwide Moodle community http://moodle.org/stats/.

If you wish, you can choose for your site to be listed in http://moodle.org/sites/.

In addition, users with the capability [[Capabilities/moodle/course:publish|moodle/course:publish]] can publish courses on MOOCH.

To register your site with moodle.org

# Click the 'Register with moodle.org now' button
# Review the registration information, amending as necessary
# Click the 'Update registration on moodle.org' button at the bottom of the page

After registering, MOOCH will appear in the list of hubs you have registered with on the registration page.

You may change the registration information at any time by updating your registration.

Updated site statistics are sent to moodle.org automatically every 7 days.

==Specific hub registration==

You may register your site with a specific hub by selecting the hub from a list or by entering a private hub URL and password.

== Unregistering from a hub==

You may unregister from a hub at any time by clicking the unregister button. You will then be given the option to remove all courses currently being advertised on the hub and remove all courses that were uploaded to the hub.

==See also==
* [[Community hub]]

[[Category:Hub]]

[[ja: サイト登録]]

Capabilities/moodle/course:publish

2011-06-14T17:25:10Z

Mits: ja link

*This allows a user to [[Publish a course|publish a course]] on a hub.
*This capability is available in Moodle 2.0 onwards. It is allowed for the default role of manager only.

[[Category:Capabilities|Course]]
[[Category:Hub]]

[[ja:ケイパビリティ/moodle/course:publish]]

Web services

2011-06-13T16:02:48Z

Mits: ja link

<p class="note">'''Please refer to [[Page_notes#Web services|these notes]] before editing this page.'''</p>
Web services enable other systems to login to Moodle and perform operations.

== Documentation for administrators ==
* [[How to enable web services for ordinary users]]
* [[How to enable web services for an external system]]

== User documentation ==
* [[How to get a security key]]

== Developer documentation==
* [[Development:Creating a web service and a web service function]]
* [[Development:Creating a web service client]]

==See also==

Specification / core development:
* [[Development:Web services]]
* [[Development:External services security]]
* [[Development:External services description]]

Other implementations:
* [[Web Services:OK Tech Web Services]]

[[Category:Web Services]]

[[eu:Web-zerbitzuak]]
[[ja:ウェブサービス]]

Hub administration

2011-06-09T17:02:55Z

Mits: ja link

{{Moodle 2.0}}
==Deciding to run a Hub==

Running a hub server is not something you should undertake lightly.

As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:
* verify all the course content is clean (of porn or malicious javascript)
* manage registered sites and their status
* maintain the quality of the listings through editing

==How the hub software works==

The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.

Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).

Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.

==How to set up a Moodle Hub server==

# Install Moodle 2.0 or later somewhere on a web server with a nice URL.
# Download the latest hub plugin from http://download.moodle.org/download.php/plugins/local/hub.zip
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.
# Enable web services for the hub ('''Site Administration > Advanced features''')
# Enable the XML-RPC protocol ('''Site Administration > Plugins > Web services > Manage protocols''')
# Set up the SMTP ('''Site Administration > Server > Email''')
#Set up the recaptcha ('''Site Administration > Plugins > Authentication > Manage authentication''')
# Set up your hub ('''Site Administration > Hub > Settings''')

Congratulations! You now have a working hub with no content!

==Site registration==

Only sites that are registered with the hub are allowed to publish content there.

Sites register on the hub via '''Site Administration > Registration'''

==Hub registration==

You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.

==Managing sites==
In '''Administration > Hub > Manage sites''', you can:
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.
* Trust a site: when a site is trusted, any published course is immediatly available
* Delete a site: delete a site from the database. A message will be sent to the site administrator.
* Settings: you can change some information as the name, the description, the language...
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)

==Managing courses==
In '''Administration > Hub > Manage course''', you can:
* Delete a course: delete a course from the database.
* Settings: you can change some information as the name, the description, the language...
* Make a course visible: decide if the course is displayed on search result

== Important things about roles, users and web services ==
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.

=== Roles ===
The hub server creates on the fly some roles that you should '''never delete/modify''':
* one role for the hub directory
* one role for registered sites
* one role for public sites

=== Users ===
The hub server creates on the fly some users that you should '''never delete/modify''':
* one user for the hub directory
* one user for public access
* as many users as registered sites

=== Services ===
The hub creates during installation some web services that you should '''never delete/modify''':
* one service for Hub directory
* one service for Registered sites
* one service for Public sites

It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.

[[Category:Hub]]

[[ja:ハブ管理]]

Student FAQ

2011-02-08T17:30:26Z

Mits: ja link

This article is intended to prepare teachers for the kinds of questions their [[Students|students]] may ask about their Moodle courses. The article could also be given to students (either printed, copied electronically or simply linked to) but the contents may need to be modified depending upon the age / ability of the students concerned.

==Access and Navigation==

===Why can't I log in?===
There could be many reasons but the most probable is you have simply forgotton your password, are trying the wrong one or are entering it incorrectly. Some other things to think about include:
* Does your username or password contain a mixture of upper and lower case letters? It should be entered exactly
* Are cookies enabled on your browser

===How do I gain access to a course?===
Locate or search for the desired course (you can click 'All courses...' in the 'My courses' block) and click on the course name. If your teacher has given you an enrollment key, enter it when prompted, and click '''Enroll me in this course'''. Once you are enrolled in a course, it will appear under "My courses" any time that your are logged into that Moodle site.

===How do I jump between my courses?===

* 'My Courses' block if it has been added to the page you are on
* Go back to the homepage (see below) and then use the main course block (if it has been added!)

===How do I get back to the homepage?===

Use the [[Navigation bar|navigation bar]] at the top left of the page or the button at the very bottom of the course

===How do I find course X?===
If you are not already enrolled in a course you can search for it by name and description.

==Course content==
===Where have all of the weeks / topics gone?===
You have probably clicked on the [[Image:One.gif]] icon. To reveal all of the other weeks / topics you need to click on the [[Image:All.gif]] icon which you will see in the right margin of the week / topic.
You can also use the dropdown box underneath the displayed week / topic to jump to a hidden section

==Emails and forums==

===Why am I not getting any e-mails and others are?===
Chances are your email address in your profile is either wrong or disabled. It could also be that you are not subscribed to the forums that are generating emails. AOL users may also not receive e-mails if the administrator has banned the use of AOL email addresses.

===How can I stop all of these e-mails?===
E-mails are an essential part of the way Moodle works. They are used to keep you up to date with what is going on. If you wish to reduce the amount of emails you get you could:
* Edit your profile and change your e-mail settings to digest
* Unsubscribe from non-essential forums (although they are there for a reason!)
* Disable your e-mail address in your profile although this is not recommended and may go against in house rules.

==Assignments and grades==

===Why is there no upload box?===
This is either because:
* The assignment has now closed
* The assignment is not yet open
* You already uploaded something and the settings prevent resubmissions

===How can I see my recent assignment feedback?===
There are many ways you can access their feedback.
The most common method is by simply going to the same place where you uploaded the work.
Another common method is to follow the link in the recent activity block (if the teacher has included it on the course).
Another method would be to access the grade book and then follow the link for the required assignment.
Depending upon how the assignment was set up, you may receive an email when it has been marked with a direct link to the feedback.

===Why is my course average so low?===
Don't panic! The Moodle gradebook takes into account unmarked and unsubmitted work. In other words, you start with zero and as you progress through the course and complete graded activities the percentage will steadily rise

==Quizzes==

===Which button do I press when I have finished a quiz?===
That depends upon what you want to do ....

===Why am I getting zero grade on my quiz?===

You might exceed the quiz time limit.

This should never happen, because the count-down timer should submit the quiz automatically when time expires, and then the Moodle server should process you submission promptly. However, if the server is overloaded and running slowly, your responses may not be processed until after to 'too late' cut-off time, and so you will not receive marks for those questions.

==See also==
*[[Student documentation]]
*[[Student documentation examples]]
*[http://moodle.org/mod/forum/discuss.php?d=43084 AOL - no friend of education!] forum discussion

[[Category:Teacher]]
[[Category:Student]]
[[Category:FAQ]]

[[es:FAQ Estudiante]]
[[fr:FAQ d'étudiant]]
[[de:Teilnehmer FAQ]]
[[ja:学生FAQ]]

Using 'Weighted mean of grades'

2011-01-12T21:02:19Z

Mits: ja link

The first feature of the new grade book that some may want to be able to master is the ability to 'clump' assignments into categories and then have each category be assigned a different weight in the overall final grade. (Note - The non-technical term 'clump' is being used to avoid the term aggregate in the hopes of preventing confusion given the terminology used in the new grade book)

Example (how some courses could be evaluated using categories)

Attendance & Participation 40%,
Quizzes 20%,
Tests (Mid-term & Final) 20%,
Final Projects 20%,

First, create the categories to be used. This can be done after assignments have been created but we found it easier to create the categories first. For this short doc two categories were utilized (Reading and Writing).

In order to be able to weight categories, select "Weighted Mean of Grades" as the Aggregation method. You can also select the weight the category will be given here. In this case Reading is being weighted at 10% and Writing at 90%. These figures can be adjusted after creating the categories by selecting Categories and Items from the pulldown window from within the Grader.

Here are the details of the two categories created.

[[Image:Reading_10Percent.jpg]]
[[Image:Writing_90Percent.jpg]]

For this short doc four Assignments (offline activities) were created. Assign each a category at the bottom of the page when creating the assignment. (they can be assigned later as well from the grade book but since the categories have already been created it is just as easy to assign the category when creating the assignment)

[[Image:Giving_Assignment_A_Category.jpg]]

(Note - We noticed some irregular behavior with the ID Number when leaving it blank and letting Moodle generate it automatically so we decided it is better to assign an ID number here. 1234 was used for simplicity in this example.)

So after creating the 4 assignments this is what it should look like (roughly) from the front page of your course.

[[Image:Four_assignments.jpg]]

After grading the assignments you should be able to view the grade book and see that the categories are being weighted as desired in the overall Aggregation Course Total.

[[Image:WeightedMeanGradeReport2.jpg]]

Explanation for the student at the top of the list - Reading is 10% thus the 100% score in the reading category results in a 10% contribution to the overall Aggregation Course Total and Writing is set at 90% thus the 10% score results in a 9% contribution to the overall Aggregation Course Total.

[[Category:Grades]]

[[ja:評点の加重値を使用する]]

Grader report

2011-01-09T15:25:46Z

Mits: ja link

{{Grades}}The grader report page is the main teacher view of the new gradebook in Moodle 1.9. For versions prior to 1.9, look [[Grades_pre-1.9 | here]].

The report can be seen in [[Course administration block|Course administration]]>Grades.

=Basics=
The gradebook collects [[Grade_items|items]] that have been graded from the various parts of Moodle that are assessed, and allows you to view and change them as well as sort them out into [[Grade_categories|categories]] and calculate totals in various ways. When you add an assessed item in a Moodle course, the gradebook automatically creates space for the grades it will produce and also adds the grades themselves as they are generated, either by the system or by you.

The [[Grades|grades]] displayed are initially displayed as the raw marks from the assessments themselves, so will depend on how you set those up e.g. an essay out of 36 will appear as however many raw marks that student got, not a percentage (although this can be changed later, see below).

Note that various default options for the gradebook are set at system level by the administrator and can be marked as being overridable by you, or fixed. This means that the options will not always be set up the same way for every user when they see the grader report for the first time.

=Display=
==Layout==
The layout has changed with different versions of 1.9.
[[Image:Grades grader report unsorted 1.png|center|thumb|600px|Grader report in 1.9.9, new course, no categories and unsorted]]

[[Image:Grades grader report with categories 1.png|center|thumb|600px|Grader report in 1.9.9, new course, with categories and sorted]]

Along the top of the grader report are several rows: first the course, then the category, then the columns for each graded activity (for example: Assignment, Quiz, Lesson). Any activities settings which were left "uncategorised" will appear in the general category which is named after the course by default (any category name can be changed).

You can add a row showing the range of possible scores by going to [[Grade_preferences|My report preferences]] and selecting '''Show ranges'''.
[[Image:gradebook_normal_mode.png|right|thumb|center|Grader report in 1.9.5, with students]]

There are three ways that the categories can be displayed (

* Grades only - without the category totals column
* Collapsed - Category total column only
* Full view - grades and the aggregates (the totals column for the category)

Each section has a small icon immediately to the right of its name. Clicking this will cycle through these display modes for that category. + goes to grades only view, o goes to full view and - goes to collapsed view.

===Other layout options===
The defaults for these options can be set at site level by going to Administration->Grades->[[Gradebook_report_settings|Report settings]]->Grader report.

*You can add a row showing the range of possible scores by going to [[Grade_preferences|My report preferences]] and selecting '''Show ranges'''.

==Highlighting rows and columns==
When your gradebook starts to grow, it can be hard to keep track of which student and which assignment a cell refers to. Highlighting solves that.
* Clicking on empty space in the cell that contains the students name will toggle the highlighting of that entire row
* Clicking on empty space in the cell at the top of each column will toggle highlighting of the entire column
(Note: this requires Javascript to be enabled in your browser.)

==Sorting by columns==

You can sort by any column. Click the [[Image:Move.gif]] symbol near the top of a column to sort by that column. This will change the symbol to a single downarrow. Clicking again will sort lowest-to-highest, changing the symbol to an uparrow. The arrows will toggle between these two states until you click on a different column.

The student name columns do not have the [[Image:Move.gif]] symbol. Clicking on either the first or last name will cause the report to sort.

*Examples

{| style="width:75%; border="0" align="center"
|[[Image:Grade Report unsorted column1.png|frame|center|Unsorted]]
||[[Image:Grade Report sorted column2.png|frame|center|Sorted]]
||[[Image:Grade Report unsorted name1.png|frame|center|Unsorted]]
||[[Image:Grade Report sorted lastname3.png|frame|center|Sorted ]]
|-
|}

==Sorting columns==
*See below, [[Grader_report#Changing_the_order_of_graded_activities|Changing order of graded activities]].

==Highlighting scores that are either adequate or unacceptable in red and green==

Turn editing on and click on the edit icon in the controls cell at the top of the column. You can then (maybe need to click 'show advanced') see the option to enter a 'grade to pass'. Once set, any grades falling above this will be highlighted in green and any below will be highlighted in red.

Note that the highlighting will not show if the Grader report is viewed in the editing mode.

==Categorising the grades==
The 'Choose an action...' drop down on the upper left will let you switch to other views
* '''Edit categories and items''' will allow you to set up your assessments in different categories e.g. 'classwork', 'homework' etc.

Each category will then have its own '''Category total''' column.

==Horizontal scrollbar==
[[Image:Gradebook horizontal scrollbar.png|thumb|Grader report with horizontal scrollbar]]
In Moodle 1.9.5 onwards, administrators may enable a static students column (in ''Administration > Grades > Report settings > [[Gradebook report settings|Grader report]]'') for teachers to scroll grades in the grader report using a horizontal scrollbar. (Note that this feature is not available for IE6 users or for users who have have the screenreader setting in their profile set to Yes.)

==Mouse-over tooltips==

In Moodle 1.9.5 onwards, each grade cell in the table has a tooltip indicating the user and grade item to which the grade belongs.

=Editing=
[[Image:gradebook_edit_mode.png|right|thumb|Pre 1.9.5 Grader report in editing mode]]
Note: Editing anything in the gradebook refers to editing the grades '''only''' and none of the available operations bear any relationship to editing the main course page i.e. the appearance of your course page cannot be influenced by anything you do in the gradebook. The "Turn editing on" button functions separately from the main course one, so editing can be on in the gradebook, but simultaneously off when you switch back to course view. This is because editing grades and editing the course page are separate capabilities. Roles such as 'non-editing teacher' may only have one or the other.

==Altering the grades==
You can click "Turn editing on" at the top right to show an edit icon next to each grade. Clicking on the icon will bring up the editing screen for that grade which will allow you to set the grade, its written feedback and a number of other attributes.

Alternatively, you can click on "[[Grade_preferences|My report preferences]]"' and choose "Quick grading" and "Quick feedback" to make the report appear with editable boxes containing each grade, so you can change many at once. This capability can be a real time saver, but make sure to save at reasonable intervals lest a pageful of changes be lost. You can lose unsaved changes by bringing up a new page in the browser, such as a Moodle manual page. If you want a manual page or the like, be sure to bring it up in a new tab.

Quick feedback is switched off by default, but you can easily switch it on or off using the "Show Quick Feedback" link above the grader report, when editing is on. Alternatively you can switch it on and off in the page "[[Grade_preferences|My report preferences]]".

==The significance of altering the grades in this screen==
If you make changes here, they're highlighted in this screen going forward. The orange highlight represents a grade altered outside of its native assignment page.

==Calculating totals==
Rather than a simple average or sum, Moodle can perform very complex calculations to produce the totals for each category and for the whole course. e.g. you want to take an average of 3 items from one category, double it, then add it to the average of another category.

You can do this using calculations. Either turn on editing, then click '''Show calculations''', or go to '''[[Grade_preferences|My report preferences]]''', choose '''show calculations''', then save and turn editing on. You will then see a small calculator icon next to each total column which, when you click on it, will take you to the page [[Edit grade calculation]] where there are instructions.

To choose how the grades are aggregated for the totals within categories, you can turn editing on and click on the little editing icon for the category. You can then choose to have means, medians, modes etc. You can also leave out empty grades and choose other settings.

==Hiding columns or individual grades==
Turning on editing then clicking the "Show show/hide icons" link will give you the familiar show/hide eye icon next to each grade and at the top of each column. For more information, read about [[Grade_hiding|grade hiding]].

==Recalculating==
If you change any part of an assessment e.g. alter the maximum grade for one of the questions in a quiz, you may find that the columns do not yet reflect the change you have made. Click '''Turn editing on''' twice to force the gradebook to re-check.

==Changing the order of graded activities==
In 1.9.9, using the "Choose an action" pull down, the "Categories and items" links are the places to arrange graded activities that appear on reports. By default all graded items are placed in the "Uncategorized" group. There is a move icon ([[Image:Move.gif]]) next to each item to move that item. By creating categories, it is also possible to move groups of graded items from "Uncategorized" to a new category. Then if you wish, you may move items within that category.
*Note: in earlier versions many actions were put on tabs, instead of the "Choose an action" pulldown menu. Functionality is similar.

===Move an individual grade item===
On the ""categories and items" action view there is a series of icons under the 'Actions' column one of which is a up/down arrow called 'move'. Click on the [[Image:Move.gif]] and then click on one of the empty boxes to where you want to move the item to.

[[Image:Grades categories-items move 1.png|center|thumb|150px|1.9.9, selected individual activity "Lesson 1" to move]]

Next click on the box where you want the item to be positioned. In the above example, the teacher has not created any categories in the course. However any time the move icon appears, it is possible to move a single item across categories.

===Move a number of grade items simultaneously===
[[Image:Grades categories-items move 2.png|right|thumb|200px|Preparing to move Quizzes to "Exam" category in 1.9.9]] By selecting items and using the pull down menu, many graded activities can be moved at once into a category.

Categories allow the teacher to visually organize grade activities in many ways.
:For example, the teacher could create a category for each week or by type of activity. In the screen shot, the teacher created a category called Exams. The teacher selected the items to move by using the check boxes, then used the "Move selected items to" pull down menu to select the category Exams. After the move of one or more selected items to a category, each item can be repositioned at any time.

==See also==
*[[Edit grade calculation]]
*[[Grade preferences]]
*[http://www.youtube.com/watch?v=EB58W3KePBc Video showing the basic gradebook setup and use]
*[http://www.youtube.com/watch?v=jWPUEqdhI4A Video showing how to change the display of grades in the gradebook]
*[http://www.youtube.com/watch?v=5hrLNbifiGQ Video explaining the different gradebook reports]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=87844 What happens in the 1.9 gradebook when students are unenrolled from a course]
*[http://moodle.org/mod/forum/discuss.php?d=125266 How to make the grader report narrower]

[[ca:grade/report/grader/index]]
[[cs:Celkový přehled]]
[[es:Informe_calificador]]
[[eu:Kalifikatzailearen_txostena]]
[[fr:Rapport de l'évaluateur]]
[[ja:評定者レポート]]

Grades FAQ

2010-12-04T16:49:32Z

Mits: ja link

{{Grades}}
== General ==

===How can I change how grades are displayed?===

Grades may be displayed as as actual grades, as percentages (in reference to the minimum and maximum grades) or as letters.

The default grade display type for the site is set by an administrator in ''Administration > Grades > [[Grade item settings]]''. However, this may be changed at course level.

To change how grades are displayed for particular [[Grade items|grade items]], or category and course summaries (called aggregations):

# Follow the grades link in the course administration block.
# Select "Categories and items" from the gradebook dropdown menu.
# Click the edit icon for the grade item, category total or course total.
# From the Grade display type menu, select real (for actual grades), percentage or letter.
# Click the "Save changes" button at the bottom of the page.

Alternatively, to change how grades are displayed for the whole course:

# Follow the grades link in the course administration block.
# Select "Course settings" from the gradebook dropdown menu.
# From the Grade display type menu, select real (for actual grades), percentage or letter.
# Click the "Save changes" button.

===How can I hide entered grades until a specified date?===

To set a "Hidden until" date:

#Access the course gradebook via the grades link in the course administration block.
#Select "Categories and items" from the gradebook dropdown menu.
#Click on the edit icon opposite the activity for which a "Hidden until" date is to be set.
#On the edit grade item page, ensure that advanced settings are displayed. (Click the "Show advanced" button if not.)
#Enable the "Hidden until" setting by unchecking the disable checkbox, then set a date.
#Click the "Save changes" button.

=== Is it possible to show the teachers/administrators' grades in the grader report? ===
Yes, at the site level you can define which roles will appear in the grader report. This can be found in [[General_grade_settings#Graded_Roles|Administration > Grades > General settings]]. Also read [http://moodle.org/mod/forum/discuss.php?d=92612 this discussion] for some more ideas.

===Why can't I change a grade within an assignment after changing it in the gradebook?===

When you edit a grade directly in the gradebook, an "overridden" flag is set, meaning that the grade can no longer be changed from within the assignment.

However, the flag can be removed by turning editing on in the [[Grader report|grader report]], then clicking the [[Grade editing|edit grade]] icon, unchecking the overridden box and saving the changes.

===How do I get groups to show up in the grader report?===

For groups to show up in the grader report, group mode should be set to visible or separate groups in the [[Course settings|course settings]]. This will result in a groups dropdown menu being displayed, enabling a teacher to view the grades of all participants, or only the grades for a selected group.

===The quiz grades keep disappearing from the student view, even after I un-hide them!===

Check your quiz settings. Under the '''Review options''' heading, in the '''Later, while the quiz is still open''' and/or the '''After the quiz is closed''' columns, you probably have Scores un-checked. Each time a student completes a quiz, these settings are consulted and the scores will be hidden from ''all'' students. If your students don't all take the quiz at the same time, it can look like quiz scores reset themselves to 'hidden' randomly, even after you un-hide them.

===How can I make the gradebook simpler for teachers?===

See [[Simplifying the gradebook by changing permissions]].

== Reports ==
=== How do I create my own custom gradebook reports? ===
Here is a [[Development:Gradebook_Report_Tutorial|tutorial]] explaining all the main steps involved.
===How can I sort or change the order of column headings?===
Go to Grades link, then select one of the "Category & items" actions from the pulldown on the top left. Use the move icon to change the position of the graded item. And/or you could create categories for the items and move them into a category so they will be grouped that way first.

== Aggregation ==
=== I can't find where to change the aggregation type for my gradebook categories! ===
Each category has an aggregation type, which can be changed through that category's "edit" page. To access that page, you must use one of 2 ways:

1. In the grader report, turn "Editing" on, then click the little "hand" icon next to the category whose aggregation you want to change
2. In the "Edit categories and Items" page (accessible through the "choose an action" menu, top left), you see a tree view of the categories and items in your gradebook. The top category is the course category. Each category also has a "hand" icon, which leads to the category edit page

=== How can I grade some of my activities without the results affecting my students' course total? ===
#Create two [[Grade categories]], one for your "activities still being graded," and one for your "released" activities.
#Ensure that "Aggregate including subcategories" (an advanced option) is unchecked for your top level course grade category.
##Where is this? In gradebook (grader report), in the upper right corner, click the "Turn Editing On" button.
##Click the edit icon next to the "course category" (usually your course name, just above the quiz names and below all the clickable links that were revealed when you turned editing on)
##Then make sure you have the "Show Advanced" option turned on.
#Edit the "activities still being graded" category's "course total" item. (This is one of the categories you created above.)
##Where is this? Look for the edit icon under "category total" that is below this category's name
#Set the "grade type" to "none".
#Tick the "Hidden" checkbox.
#Save your changes.
#Move all your activities being graded in the "activities still being graded" category.
#Move all your activities already graded in the "released" category.

Note: I rewrote this a bit, to help people find where things are. However, this method didn't seem to work for me on Moodle 1.9.

=== My student completed only one activity out of 5, but his course total shows 100%. How do I show a more "progressive" course total? ===

==== Step-by-Step Explanation ====
# From the view menu in the gradeboook, select "Categories and items" [[image: https://docs.moodle.org/en/images_en/6/65/Gradebook_Tutorial_Categories_and_items_menu.gif]]
# At the top line there is a folder icon and an edit icon on the right, click the edit icon
# You'll then see the title "Grade category," the 3rd item is "Aggregate only non-empty grades."
# Uncheck this.
# Save.

==== Another Explanation ====
By default, only non-empty grades are aggregated, the others are ignored. However, you can change this setting as well as others that affect the course total, by turning "Editing" on in the grader report, and clicking the "Edit" icon next to the course category (the very top row of the grader report).

You can untick the box "Aggregate only non-empty grades" if you want to show a more "progressive" score for each student. Their empty grades will count as a 0 and will be counted in the course mean/total.

If you prefer to show a sum of points, rather than a percentage, you can change the course category's aggregation method to "Sum of grades".

=== How can I display the average grade for my course categories (not grade categories)? ===
In Moodle 1.9 there is no way to aggregate course totals within each category. The gradebook is course-centered, and there is currently no User Interface for showing grades within an entire course category at once.

=== How can I setup weighted assignments? ===
See [[Using "Weighted Mean of Grades" to weight categories containing assignments]].

== Categories ==
=== How many depths of categories/subcategories can I create? ===
There is no programmatic limit, but there are practical limits. Very deeply nested structures are difficult to manage. 3 levels of categories should be sufficient for most situations. Note that there is always at least one level of categories, since the Course category always encompasses all other categories and grade items, can cannot be deleted.

=== I can't find setting X in the grade category edit page! Where is it? ===
If a setting documented on the [[Grade categories]] page does not appear on your edit page, it may mean that it is set globally in your site. See [[Grade_category_settings#Forcing_settings|Forcing settings]] for more information.

== Outcomes ==
=== I have just upgraded to Moodle 1.9, and I want to set up an outcome item for my course. What are the steps required? ===
# Administration > Grades > General settings > [[General_grade_settings#Enable_outcomes|Enable outcomes]]
#[[Scales#Creating_a_new_scale|Create a scale]]
#Create a course outcome (read the [[Outcomes| outcomes documentation]] for instructions). Assign to it the scale you just created.
#Assign the outcome to your course
#Enter the "Grades" section of your course, from the course administration block
#In the Actions menu (top left), select Edit -> Categories and Items
#Click "Add outcome item"
#Follow the instructions of the [[Outcome items|outcome items documentation]] to create the outcome item

You can now give your students a rating on the outcome dimension you just created. If you created a standard outcome, you will be able to use it in other courses and follow your students' performance across these courses.

===How can I remove an outcome from an activity?===

An outcome can be removed from an activity by deleting it on the gradebook edit categories and items page. This results in the outcomes being deselected on the update activity page.

== Modules ==
=== The activity module (Module name) doesn't support grading. How can I give my students a grade anyway? ===
You can create a [[Grade_items#Manual_grade_items|grade item]] manually in the gradebook. You will have to grade your students through the [[Grader report]] interface (in editing mode).

=== I just graded some of my students using the (Module name) interface, but the results aren't showing up in the grader report. What's going on? ===
Here are some of the possible reasons:

#The corresponding [[Grade items|grade item]] is [[Grade_locking#In_grade_items|locked]], or its parent [[Grade categories|category]] is [[Grade_locking#In_grade_categories|locked]].
#The module code is not using the [[Development:Grades#API_for_communication_with_modules.2Fblocks|gradebook API]] correctly

=== I just created a new assignment with the "Grade" setting set to "No grade", but it still appears in the gradebook ===
The reason is that the gradebook is now the place where both numerical and textual types of feedback are recorded for all activity modules. The word "Grading" in assignment relates only to numerical grades, but the ability to give text feedback remains, and must be recorded in the gradebook. This is why a grade item is created for it. You can hide the grade item if you do not want it to appear in the user reports.

==Weights and extra credits==

===How do weighted grades influence the category or course total?===
A weight (also called coefficient) only has meaning in reference to other weights. If you only have one grade item, changing its weight will not have any effect. However, if you have two grade items, each with a different weight, the "heavier" item will have more influence on the total grade than the "lighter" one.

You can set the weights to any positive numerical value you choose. Usually, at least one of the weights will be 1 and serve as the baseline for other weights. If another item has a weight of 2, its grades will be multiplied by 2 compared with the grades of the first grade item, before being averaged. The denominator used for averaging is the sum of all the weights.

An example follows:
item 1 weight: 1
item 2 weight: 3
item 3 weight: 0.5

item 1 grade: 40/100
item 2 grade: 60/100
item 3 grade: 20/100

Calculation:
total = ((40 * 1) + (60 * 3) + (20 * 0.5)) / (1 + 3 + 0.5)
= (40 + 180 + 10) / (4.5)
= 230 / 4.5
= 51.11

The total for this category will then be 51.11 out of 100

===Do I have to put a value in each "weight" input box?===
No. If you do not put a value, it will default to 1. If all items are set to 1 then they all have equal weight. If you set a weight to 0, the item's grades will not count at all in the category or course average.

===Do all the weights have to add up to 100 or some similar value?===
No, the numbers you put as weights are completely arbitrary. They must be positive numbers, and can add up to anything you want. Note however that the following four sets of weights are identical in value:

(1 1.75 3)
(4 7 12)
(8 14 24)
(400 700 1200)

===What is the difference between Weight and Extra Credit?===
Weight is only available with "Weighted mean of grades". For the "Simple weighted mean of grades", the weight is taken from the grade item's maximum grade. A weight is used to give a grade item more or less importance in the computation of the category total or average, compared with the other items of the same category.

Extra credit replaces grade item weight if the aggregation method is "Mean of grades (with extra credits)" or "Sum of grades". The effect of extra credit is different for both methods, hence some confusion:

*Mean of grades (with extra credits): A value of 0 does nothing. Any other value is used to multiply the grade and add it to the total after the computation of the mean. This grade is not used in the computation of the mean, however, only added afterwards. Additionally, this cannot bring the category total over its maximum grade unless grades over 100% are enabled by the site administrator (since 1.9.5). This grade item is not counted either in the denominator used to compute the category mean.

*Sum of grades: Extra credit is a checkbox, not a number. Normally, with Sum of Grades, the category's maximum grade is the sum of the maximum grades of all its grade items. If one of them is set as "Extra Credit", however, its maximum grade is not added to the category's maximum grade, but its grades will be. This way it is possible to achieve maximum grade (or grades over maximum if enabled by the site administrator) in the category without getting the maximum grade in all the grade items.

===How do I create an assignment for which students can receive a grade higher than the maximum?===

In Moodle 1.9.5 onwards, a new unlimited grades setting in ''Administration > Grades > General settings'' enables administrators to allow teachers to enter grades over 100% directly in the gradebook.

In earlier versions of 1.9, it is possible for a student to get less than the maximum grade in some grade items, while still getting the maximum grade in the category or course total. The Extra Credit feature is used for this purpose, as described above.

==Formulas==

===How do I give a fixed score for a successful quiz attempt===

Suppose you want to give 5 points for a passing grade (say, 70) in a certain quiz. Possible scenario ([http://moodle.org/mod/forum/discuss.php?d=148576]): extra credit points to every student that gets a "passing grade" in a "practice test" at the end of each chapter covered in the course, to encourage them to practice after the homework quizzes and to get familiar with a "test type" situation before the actual test.

The following formula should do the trick:

=round((||quiz||/70)-0.49,0)*5

The formula may be added to a designated grade item or category.

Sample calculations:
Score 70:
=round((70/70)-0.49,0)*5
=round(1-0.49,0)*5
=round(0.51,0)*5
=1*5
=5

Score 69:
=round((69/70)-0.49,0)*5
=round(0.98-0.49,0)*5
=round(0.49,0)*5
=0*5
=0

==See also==
*[[Gradebook 1.9 Tutorial]]
*Gradebook Scenarios/Use Cases [https://docs.moodle.org/en/experimental:_gb_tutoring]
*Using Moodle [http://moodle.org/mod/forum/view.php?id=2122 Gradebook forum]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=102609 Can I aggregate only non hidden items?]
*[http://moodle.org/mod/forum/discuss.php?d=123907 1.8.5 to 1.9.5 - gradebook faqs]
*[http://moodle.org/mod/forum/discuss.php?d=123143 Excluding practice quizzes from gradebook]

[[Category:FAQ]]

[[ca:PMF de les qualificacions]]
[[fr:FAQ des notes]]
[[ja:評定FAQ]]

Gradebook report settings

2010-11-27T02:27:44Z

Mits: ja link

{{Grades}}The gradebook report settings determine the appearance of gradebook reports in each course site-wide. Report settings appear as default values prefixed with "Report default" in a teacher's [[Grade preferences|"My report preferences"]] tab and "Default" in the [[Gradebook course settings|course settings]].

==Grader report settings==
[[Image:Grader report settings.png|thumb|Grader report settings]]Location: ''Administration > Grades > Report settings > Grader report''

Grader report settings include whether to show calculations, show/hide icons, column averages etc. Individual teachers may override certain settings for their own grader report view via their [[Grade preferences|"My report preferences"]] tab.

===Quick grading and quick feedback===

*Quick grading adds a text input element in each grade cell on the grader report, allowing you to edit the feedback for many grades at once. You can then click the Update button to perform all these changes at once, instead of one at a time.
*Quick feedback adds a text input element in each grade cell on the grader report, allowing you to edit many grades at once. You can then click the Update button to perform all these changes at once, instead of one at a time.
*By default, both quick grading and quick feedback are enabled. They can be disabled by de-selecting the appropriate checkbox(es).
[[Image:Gradebook horizontal scrollbar.png|thumb|Grader report with horizontal scrollbar]]
===Static students column===

In Moodle 1.9.5 onwards, a static students column may be enabled so that teachers can scroll grades in the [[Grader report|grader report]] using a horizontal scrollbar. (Note that this feature is not available for IE6 users or for users who have have the screenreader setting in their profile set to Yes.)

==Overview report settings==
Location: ''Administration > Grades > Report settings > Overview report''

The overview report setting may be overridden for all overview reports in a course by a teacher in the [[Gradebook course settings|course settings]].

===Show rank===

If the show rank checkbox is ticked, the position of a grade item in relation to the rest of the class will be shown.

==User report settings==
Location: ''Administration > Grades > Report settings > User report''

The user report settings may be overridden for all user reports in a course by a teacher in the [[Gradebook course settings|course settings]].

===Show rank===

If the show rank checkbox is ticked, the position of a grade item in relation to the rest of the class will be shown.

===Show percentage===

If the show percentage checkbox (in Moodle 1.9.3 onwards) is ticked, the percentage value of each grade item will be shown.

==See also==

*[[Grade preferences]] - for teachers to set their personal preferences for how the grader report is displayed
*[[Gradebook course settings]]

[[Category:Grades]]

[[de:Einstellungen_für_die_Bewertungsübersicht]]
[[eu:Kalifikazio-liburuaren_txostenen_ezarpenak]]
[[fr:Réglages du rapport de l'évaluateur]]
[[ja:評定表レポート設定]]

Development:Gradebook Report Tutorial

2010-11-11T16:59:20Z

Mits: ja link

== Introduction ==
One of the great features of the new gradebook implementation in Moodle 1.9 is the support for plug-in reports. A few reports are already included in the release, but it is fast and easy to create new reports of any kind.

This page is a small tutorial on how to create a new report for the Moodle gradebook. The first section highlights the basic setup steps, the bare minimum to get your plug-in detected and usable. The second section gives an example of a possible implementation, although you are free to develop outside of these suggestions.

The simplest example report to look at while following this guide is '''grade/report/overview'''.

== Bare minimum ==

These steps all involve creating new files, but in all cases they can be copy-pasted from existing reports, to make your life easier.

1. Create a new folder under grade/report
grade/report/[newreport]
2. Create a /db sub-folder under the new report folder
grade/report/[newreport]/db
3. Create an access.php file in the db folder with the following content. You should change the capabilities as needed.
grade/report/[newreport]/db/access.php

<?php
$gradereport_[newreport]_capabilities = array(
'gradereport/[newreport]:view' => array(
'riskbitmask' => RISK_PERSONAL,
'captype' => 'read',
'contextlevel' => CONTEXT_COURSE,
'legacy' => array(
'student' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
),
);
?>
4. Create a version.php file with the current dates:
grade/report/[newreport]/version.php
<?php
$plugin->version = 2007081000;
$plugin->requires = 2007081000;
?>
5.Create an index.php
grade/report/[newreport]/index.php
6.Create a language file for your report. Include at least the modulename, and optionally the strings for different capabilities.
grade/report/[newreport]/lang/en_utf8/gradereport_[newreport].php

Example from user report here:

$string['modulename'] = 'User report';
$string['user:view'] = 'View your own grade report';

You do not need to create a new link to your report, it will be automatically detected and added to the gradebook plugin drop-down menu, if you've followed all these steps!

This is all you need to do to create a new report! Now, of course, you'll want the code to actually DO something, usually fetch and display some data. The next section discusses one easy approach using flexitable.

== Possible step 7 ==

I also needed to include the '''settings.php''' file in my new ''grade\report\[directory name]'' directory. If the file was not present, i received this error '''"Section Error!"'''. Once i added the file to the grade\report\[directory name] directory, it corrected. The settings.php file is empty. I am using Moodle 1.9.

== Possible step 8 ==

If the report is made available to multiple users you may need to update the tables by going to the admin section of your Moodle installation, just like when you are upgrading. Then go the the define roles and make sure that your permissions are set correct. I'm using Moodle 1.9

== Extending the grade_report class ==

You are free to develop that class any way you want, but by using the existing methods set up in grade_report, you can avoid tedious repetition of code. We use flexitable for simple reports, as you can see in the user report (grade_report_user class). The rest of this tutorial will follow the path of flexitable.

=== New file ===
#Create a lib.php file (or copy it from other report).
grade/report/[newreport]/lib.php

#The lib.php contains an extension of the grade_report class, and should be named
grade_report_[newreport]

=== Grade_report class variables ===
The grade_report class makes the following variables available to your new class, if you use its constructor in your child class' constructor:

; courseid : Required by constructor
; gpr : Grade plugin return tracking object, required by constructor
; context : Required by constructor
; gtree : The grade_tree must be instantiated in child classes: not all reports need the whole tree
; prefs : Array of user preferences related to this report. Methods are given to get and set these easily
; gradebookroles : The roles for this report, pulled out of $CFG->gradebookroles
; baseurl : Base url for sorting by first/last name (not needed by all reports)
; pbarurl : Base url for paging
; page : Current page (for paging). Must be given to constructor if paging is required.
; lang_strings : Array of cached language strings (using get_string() all the time takes a long time!). A method is provided to replace get_string() and use this cache
; currentgroup : The current group being displayed.
; group_selector : A HTML select element used to select the current group.
; groupsql : An SQL fragment used to add linking information to the group tables.
; groupwheresql : An SQL constraint to append to the queries used by this object to build the report.

=== Grade_report class methods ===

The grade_report class has the following methods which you can use, provided the right steps have been taken to initialise the object first:
; get_pref() : Given the name of a user preference (without grade_report_ prefix), locally saves then returns the value of that preference. If the preference has already been fetched before, the saved value is returned. If the preference is not set at the User level, the $CFG equivalent is given (site default).
; set_pref() : Uses set_user_preferences() to update the value of a user preference. If 'default' is given as the value, the preference will be removed in favour of a higher-level preference ($CFG->$pref_name usually)
; process_data() : Abstract method, needs to be implemented by child classes if they want to handle user form submissions on the report they want to handle user actions on the report
; process_action() : Abstract method, needs to be implemented by child classes if they want to handle user actions on the report
; get_grade_clean() : format grade using lang specific decimal point and thousand separator the result is suitable for printing on html page
; format_grade() : Given a user input grade, format it to standard format i.e. no thousand separator, and . as decimal point
; get_lang_string() : First checks the cached language strings, then returns match if found, or uses get_string(). Use this for any lang_strings in the grades.php file.
; grade_to_percentage() : Computes then returns the percentage value of the grade value within the given range.
; get_grade_letters() : Fetches and returns an array of grade letters indexed by their grade boundaries, as stored in preferences.
; get_numusers() : Fetches and returns a count of all the users that will be shown on this page.
; setup_groups() : Sets up this object's group variables, mainly to restrict the selection of users to display.
; get_sort_arrow() : Returns an arrow icon inside an <a> tag, for the purpose of sorting a column.
; get_module_link() : Builds and returns a HTML link to the grade or view page of the module given. If no itemmodule is given, only the name of the category/item is returned, no link.

=== Report child class ===

Assuming you are using flexitable, your child class needs the following variable and methods:
$table : The flexitable that will hold the data

*grade_report_[newreport]() : Constructor. You can set up anything here, but you must call the parent constructor with the 3 required params:
parent::grade_report($COURSE->id, $gpr, $context);
The $gpr and $context variables are normally set up in grade/report/[newreport]/index.php

*setup_table() : Prepares the headers and attributes of the flexitable. Example used for the very simple overview report:
// setting up table headers
$tablecolumns = array('coursename', 'grade', 'rank');
$tableheaders = array($this->get_lang_string('coursename', 'grades'),
$this->get_lang_string('grade'),
$this->get_lang_string('rank', 'grades'));

$this->table = new flexible_table('grade-report-overview-'.$this->user->id);

$this->table->define_columns($tablecolumns);
$this->table->define_headers($tableheaders);
$this->table->define_baseurl($this->baseurl);

$this->table->set_attribute('cellspacing', '0');
$this->table->set_attribute('id', 'overview-grade');
$this->table->set_attribute('class', 'boxaligncenter generaltable');

$this->table->setup();

*fill_table() : After setup_table(), gathers and enters the data in the table. Again, from the overview report:
global $CFG;
$numusers = $this->get_numusers();

if ($courses = get_courses('all', null, 'c.id, c.shortname')) {
foreach ($courses as $course) {
// Get course grade_item
$grade_item_id = get_field('grade_items', 'id', 'itemtype',
'course', 'courseid', $course->id);

// Get the grade
$finalgrade = get_field('grade_grades', 'finalgrade', 'itemid',
$grade_item_id, 'userid', $this->user->id);

/// prints rank
if ($finalgrade) {
/// find the number of users with a higher grade
$sql = "SELECT COUNT(DISTINCT(userid))
FROM {$CFG->prefix}grade_grades
WHERE finalgrade > $finalgrade
AND itemid = $grade_item_id";
$rank = count_records_sql($sql) + 1;

$rankdata = "$rank/$numusers";
} else {
// no grade, no rank
$rankdata = "-";
}

$this->table->add_data(array($course->shortname, $finalgrade, $rankdata));
}

return true;
} else {
notify(get_string('nocourses', 'grades'));
return false;
}
*print_table() : Just does what its name says...
ob_start();
$this->table->print_html();
$html = ob_get_clean();
if ($return) {
return $html;
} else {
echo $html;
}

*process_data() and process_action() : You can implement these two methods if you need to handle data and actions.

=== Set up the index.php file ===
Here is the simple example from the overview report (grade/report/overview).

require_once '../../../config.php';
require_once $CFG->libdir.'/gradelib.php';
require_once $CFG->dirroot.'/grade/lib.php';
require_once $CFG->dirroot.'/grade/report/overview/lib.php';

$courseid = optional_param('id', $COURSE->id, PARAM_INT);
$userid = optional_param('userid', $USER->id, PARAM_INT);

/// basic access checks
if (!$course = get_record('course', 'id', $courseid)) {
print_error('nocourseid');
}
require_login($course);

if (!$user = get_complete_user_data('id', $userid)) {
error("Incorrect userid");
}

$context = get_context_instance(CONTEXT_COURSE, $course->id);
$usercontext = get_context_instance(CONTEXT_USER, $user->id);
require_capability('gradereport/overview:view', $context);

$access = true;
if (has_capability('moodle/grade:viewall', $context)) {
//ok - can view all course grades

} else if ($user->id == $USER->id and has_capability('moodle/grade:view', $context) and $course->showgrades) {
//ok - can view own grades

} else if (has_capability('moodle/grade:viewall', $usercontext) and $course->showgrades) {
// ok - can view grades of this user- parent most probably

} else {
$acces = false;
}

/// return tracking object
$gpr = new grade_plugin_return(array('type'=>'report', 'plugin'=>'overview', 'courseid'=>$course->id, 'userid'=>$userid));

/// last selected report session tracking
if (!isset($USER->grade_last_report)) {
$USER->grade_last_report = array();
}
$USER->grade_last_report[$course->id] = 'overview';

/// Build navigation
$strgrades = get_string('grades');
$reportname = get_string('modulename', 'gradereport_overview');

$navigation = grade_build_nav(__FILE__, $reportname, $course->id);

/// Print header
print_header_simple($strgrades.': '.$reportname, ': '.$strgrades, $navigation,
'', '', true, '', navmenu($course));

/// Print the plugin selector at the top
print_grade_plugin_selector($course->id, 'report', 'overview');

if ($access) {

//first make sure we have proper final grades - this must be done before constructing of the grade tree
grade_regrade_final_grades($course->id);

// Create a report instance
$report = new grade_report_overview($userid, $gpr, $context);

$gradetotal = 0;
$gradesum = 0;

// print the page
print_heading(get_string('modulename', 'gradereport_overview'). ' - '.fullname($report->user));

if ($report->fill_table()) {
echo $report->print_table(true);
}

} else {
// no access to grades!
echo "Can not view grades."; //TODO: localize
}
print_footer($course);

== Conclusion ==
This short tutorial doesn't explain how to actually create a ''useful'' report. That part is essentially up to you, and there are no hard rules about how to do it. Instead, this tutorial explains how to setup a "stub" report, a basic framework with a set of tools and variables you can use to create a fully functional and essential report for your Moodle needs. Please share your report-building experiences and tribulations with the Moodle community through the forum.

== See also ==

* [http://moodle.org/mod/forum/discuss.php?d=69223&mode=3 Gradebook Development ideas] forum discussion
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=51107 New gradebook for Moodle] forum discussion
* [[Development:Grades]]

[[Category:Developer|Grades]]
[[Category:Grades]]

[[ja:開発:評定表レポートチュートリアル]]

Outcome items

2010-10-23T19:44:25Z

Mits: ja link

{{Grades}}
== Overview ==
An outcome item IS NOT an [[Outcomes|outcome]].

An outcome item is in most respects the same thing as a [[Grade items|grade item]].

The main difference between the two is that the purpose of a outcome item is to rate students on a particular outcome/competency/goal, whereas grade items are used for grading students, usually with the intention of aggregating the results as a measure of the student's performance in the course activities.

An outcome item is always linked with an outcome, which itself is linked to a [[Scales|scale]]. The scale may represent a quantitative measure, its values being arranged from lowest to highest; or it may represent a qualitative measure, in which the order of the scale values is irrelevant. The first type can be aggregated, but the second type shouldn't (we wouldn't want to fail a student because her favourite colour is "blue"!).

An outcome item may optionally be linked to an activity. This activity may or may not appear in the gradebook (for example, a wiki is usually not graded, so does not appear). Linking an outcome item with an activity creates a grade item with the icon of the linked activity, but there is no other way to see which activity it is linked with. For this reason, it is a good idea to include the activity name in the name of the outcome item (e.g. Wiki 1: Participation).

== Settings ==
=== Item name ===
Usually named after the linked outcome. If linked to an activity, it is a good idea to include that activity's name in the item name (see explanation above)

=== Outcome ===
The site or course outcome this item represents in the gradebook.

=== Linked activity ===
An optional course activity with which this outcome item can be linked. See notes above regarding the naming of activity-linked outcome items.

=== Hidden ===
See [[Grade_hiding]] for info.

=== Locked ===
See [[Grade_locking]] for info.

== Advanced settings ==

=== Item info ===
A space for entering information about the item. Text entered does not appear anywhere else.

=== ID number ===
Setting an ID number provides a way of identifying the outcome item for grade calculation purposes. If the outcome item is not included in any grade calculation, or if a calculation is not applicable (i.e. qualitative scales), then the ID number field can be left blank.

[[ja:アウトカム項目]]

Grade calculations

2010-09-20T16:04:03Z

Mits: ja link

{{Grades}}A grade calculation is a formula used to determine grades, based (optionally) on other grade items. Note that this is not the same as [[Calculated_question_type|Calculated question types]].

Calculations for the gradebook follow the pattern of formulas/functions in popular spreadsheet programs. They start with an equal (=) sign, and use common mathematical operators and functions to produce a single numerical output. This output is then used as the computed value for the grade item you are editing.

==Setting a grade calculation==
[[Image:Calc_icon.JPG|thumb|Calculator symbol]]
[[Image:Final_calc.JPG|thumb|Example calculation]]
To set a grade calculation:
# Login as teacher or other user with permission to edit grades
# Click on Grades in the course administration block
# Click the 'Categories and items' tab (or select it from the gradebook dropdown menu)
# Click the 'calculator symbol' (in the 'Actions' column) opposite the grade category you wish to set a calculation for
# Start with an equal sign (=)
# Choose a function; Example: =sum()
# Plug in your ID numbers enclosed in double square brackets, for example <nowiki>=sum([[item1]][[item2]][[item3]])</nowiki>
# Separate each ID number with a comma, for example <nowiki>=sum([[item1]],[[item2]],[[item3]])</nowiki>
# Click the "Save Changes" button

==Assigning ID numbers==

You can include the values of other grade items by using their ID number as references in your formulas. The ID number is surrounded by double square brackets, for example if you have a grade item with Quiz.3 as ID number, you will refer to this item as <nowiki>[[Quiz.3]]</nowiki> in your calculation.

Below the calculation field is a list of your course with its grade categories and grade items. Next to each item or category's total is displayed the ID number you can use in your calculation (already surrounded with double square brackets). However, since the ID number is optional, some items may not yet have one. These items without an ID number have instead a form field which lets you enter an ID number directly.

As soon as you have assigned the ID numbers you need, you can click the "Add ID numbers" button, and the page will reload and show you the same list with the ID numbers you have just assigned.

==Calculation functions==

Every calculation must start with an equal sign (=). Following is a list of the functions supported by the calculation. The comma (,) character is used to separate arguments within function brackets. The comma can also be used to separate different functions. (The separator character could be a semicolon (;) in other languages, see below).

* average<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the average of a sample
* max<nowiki>([[item1]], [[item2]]...)</nowiki>: Returns the maximum value in a list of arguments
* min<nowiki>([[item1]], [[item2]]...):</nowiki> Returns the minimum value in a list of arguments
* mod(dividend, divisor): Calculates the remainder of a division
* pi(): Returns the value of the number Pi
* power(base, power): Raises a number to the power of another
* round(number, count): Rounds a number to a predefined accuracy
* sum(<nowiki>[[item1]], [[item2]]...)</nowiki>: Returns the sum of all arguments
* an asterisk (*) gives the product of two items: <nowiki>[[item1]]*[[item2]]</nowiki>

A number of mathematical functions is also supported:

* sin
* sinh
* arcsin
* asin
* arcsinh
* asinh
* cos
* cosh
* arccos
* acos
* arccosh
* acosh
* tan
* tanh
* arctan
* atan
* arctanh
* atanh
* sqrt
* abs
* ln
* log
* exp

==Example calculations==

* <nowiki>=average([[Quiz.1]], [[Quiz.4]], [[Assignment.1]])</nowiki>
* <nowiki>=average(max([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]), min([[Quiz.1]], [[Quiz.4]], [[Assignment.1]]))</nowiki>
* Weighted grade calculations where item 1 is weighted 30%, item 2 is weighted at 60% and item 3 is weighted at 200%: <nowiki>=sum([[1]]*0.3,[[2]]*0.6,[[3]]*2)</nowiki>

==Calculations when user language is not English==

Calculation formulas use decimal and list separators as defined in each language pack.

The decimal separator (a symbol used to mark the boundary between the integral and the fractional parts of a decimal number) is a point (.) in English. In other languages it may be a comma (,).

The list separator (a symbol used to separate a list of ID numbers in square brackets) is a comma (,) in English. In other languages it may be a semicolon (;).

==See also==
*[http://www.youtube.com/watch?v=WKUGyzAXcyA Video on how to set up calculations in the gradebook (basic)]
*[http://www.youtube.com/watch?v=VBEj8mmu8lM Video on how to set up calculations in the gradebook (advanced)]

[[ca:grade/edit/tree/calculation]]
[[fr:Calcul de notes]]
[[ru:Формулы и вычисления оценок]]
[[ja:評定計算]]

Grade item settings

2010-09-15T16:20:10Z

Mits: ja link

{{Grades}}Location: ''Administration > Grades > Grade item settings''
[[Image:Grade item settings.png|thumb|Grade item settings screen]]

Grade item settings are the various settings that the administrator is able to edit for all [[Gradebook|gradebooks]] used by teachers. These settings will change what items are displayed for each grade. As administrator, you would turn on or off various settings and the teacher would input the actual data.

==Grade display type==

This is the type of grade that is to be shown for each individual grade. Different school districts use different grading systems so this can be changed to suit your district.

* Real - Grade from minimum to maximum range indicating total points received. Default from 0-100 but may be arbitrary.
* Percentage - Grade from 0 - 100% indicating the total points received divided by maximum possible amount times 100.
* [[Grade letters|Letter]]- Grade in the form of a letter representing a range of percentages.

==Overall decimal points==

This setting is for display purposes only. Grade calculations are made with an accuracy of 5 decimal places and grade letters, if used, are assigned accordingly.

If rounding of grades in [[Grade calculations|grade calculations]] is required, the round(number, count) function may be used.

==Advanced grade item options==

This contains a list of various fields that can be toggled on or off to appear on the default grade item screen or hidden. By selecting a field, it is put into the "Advanced" items menu and a field that is not selected will appear on the main grade item menu by default. Note that all of these options will always be available to teachers with a click of the button "Show Advanced".

[[Image:Advanced grade item options.png|frame|center|Top left: Advanced grade item options with some selected. Top right: Default grade item menu screen with non-selected fields. Bottom Right: Advanced grade item menu with green asterisks denoting selected fields. Hidden until clicked "Show Advanced".]]

To highlight more than one field, use ctrl+click and both will be highlighted. To highlight from one field to another, use shift+click the range between two will be highlighted. Shift+ctrl+right click will combine a range of selections to those already highlighted. To de-highlight a field just do the same steps but click on already highlighted fields.

* Item info
* ID Number
* Grade Type
* Scale
* Minimum Grade
* Maximum Grade
* Grade to pass
* Offset
* Multiplicator
* Grade display type
* Overall decimal places
* Hidden
* Hidden until
* Locked
* Locked after
* Aggregation coefficient
* Parent category

==See also==
*[[Grade items]] - for teachers
*[http://www.moodletutorials.org/view_video.php?viewkey=d7fbdea1afc51c7c6ad2 Video tutorial on Grade Item Setting and Grade Letters]

[[de:Einstellungen_für_Bewertungsaspekte]]
[[fr:Réglages des éléments d'évaluation]]
[[ja:評定項目設定]]

Grade category settings

2010-09-07T17:17:00Z

Mits: ja link

{{Grades}}Location: ''Administration > Grades > Grade Category Settings''

Grade category settings enable administrators to choose which options appear for teachers when [[Grade categories|adding/editing a grade category]] in their course gradebook, and their default values. Settings are applied site-wide.

[[Image:Grade category settings.png|thumb|Grade category settings]]
==Forcing settings==
Force checkboxes are for forcing certain items to apply. This results in switches and drop-down elements being disabled in all course gradebooks. For example, if the Aggregation Type setting is forced as "Mean", teachers will no longer have the option to change the aggregation type of each grade category separately, the option will not be there in the category edit form.

Selecting "Do not force" after a forced setting has been applied will simply restore each category's setting to its previous state, prior to the application of the forced global setting. Administrators can thus experiment with these settings without fear of losing any specific category settings.

==Advanced settings==
Advanced checkboxes are for selecting items which are only displayed when a teacher clicks the "Show advanced" button in the category edit form.

==Available aggregation types==
[[Image:Available agg types.png|thumb|Available aggregation types setting]]
In Moodle 1.9.5 onwards, administrators may reduce the number of aggregation types available for teachers to use.

By default, all existing aggregation types are available (Mean of grades, Weighted mean of grades, Simple weighted mean of grades, Mean of grades (with extra credits), Median of grades, Lowest grade, Highest grade, Mode of grades, Sum of grades). This list may be reduced to only a few types, with additional types being enabled as/when teachers request them.

Note that reducing the number of aggregation types simply results in disabled aggregation types not appearing in the aggregation type dropdown menu. All existing grade category calculations remain the same, regardless of whether the aggregation type is later disabled by an administrator.

==See also==
*[[Grade categories]] - for teachers
*[http://www.youtube.com/watch?v=p6zWwJGb9TA Video demonstrating how to use gradebook site settings and defaults]
*[http://www.youtube.com/watch?v=sUslTuZPu6A Video showing the effects of the grade category settings]

[[Category:Grades]]

[[de:Einstellungen_für_Bewertungskategorien]]
[[fr:Réglages des catégories d'évaluation]]
[[ja:評定カテゴリ設定]]

Grade letters

2010-09-04T17:00:06Z

Mits: ja link

{{Grades}}[[Image:Grade letters.png|thumb|Default grade letters]]Grade letters, also called letter grades, are symbols used to represent a range of grades. For example "A" could be used to represent grades of 80% and above, "B" to represent grades between 70 and 80%, "C" to represent grades between 50 and 70%, and so on. Alternatively, you could have "Pass" for grades above 50% and "Fail" for grades below 50%.

==Displaying letter grades==
To change particular [[Grade items|grade items]], category and course summaries (called aggregations) in the [[Grader report|grader report]] and [[User report|user reports]] to display letter grades:

# Follow the grades link in the course administration block.
# Select "Categories and items" from the gradebook dropdown menu.
# Click the edit icon for Category total or Course total.
# From the Grade display type menu, select letter.
# Click the "Save changes" button at the bottom of the page.

Repeat this for any other totals that you want displayed as letters.

Alternatively, to display ALL grades as letter grades:

# Follow the grades link in the course administration block.
# Select "Course settings" from the gradebook dropdown menu.
# From the Grade display type menu, select letter.
# Click the "Save changes" button.

==Editing course-level grade letters==

[[Image:Editing grade letters.png|thumb|Editing grade letters]]
Grade letters are set initially at site level. To use different grade letters in a particular course:

# Follow the grades link in the course administration block.
# Select Letters from the from the gradebook dropdown menu.
# Click the edit tab in the middle of the page.
# Check the override site defaults box.
# Change grade letters and/or boundaries as required. (You may wish to use words, for example Below Pass, Pass, Merit, Distinction, rather than letters.)
# Scroll to the bottom of the page and click the "Save changes" button.
[[Image:Pass fail grade letters.png|thumb|Pass/fail grade letters]]

==Setting grade letter site-level defaults==

To set grade letter site defaults:
# Login as an administrator.
# Access ''Site administration > Grades > Letters''.
# Change grade letters and/or boundaries as required.
# Scroll to the bottom of the page and click the "Save changes" button.

==Forcing grade letter site-level defaults==

To force grade letter site-level defaults in all courses i.e. remove the ability for teachers to override site defaults and edit grade letters in their courses:
# Login as an administrator.
# Access ''Administration > Users > Permissions > Define roles''
# Edit the role of teacher and change the capability [[Capabilities/moodle/grade:manageletters|moodle/grade:manageletters]] from Allow to Not set.
# Scroll to the bottom of the page and click the "Save changes" button.

==Accuracy of grade calculations==

Grade calculations are made with an accuracy of 5 decimal places and grade letters assigned accordingly. The overall decimal points setting (in the system [[Grade item settings|grade item settings]] and for individual [[Grade items|grade items]]) is for display purposes only and is not used when assigning grade letters.

==See also==
*[http://www.youtube.com/watch?v=p6zWwJGb9TA Video demonstrating how to use gradebook site settings and defaults]
*[http://www.moodletutorials.org/Moodle-Tutorial-on-Grade-Item-Settings-and-Grade-Letters.html Tutorial on Grade Item Setting and Grade Letters]

[[ca:grade/edit/letter/index]]
[[es:Calificaciones con Letras]]
[[eu:Kalifikazio-letrak]]
[[fr:Notes lettres]]
[[ja:評定文字]]

Gradebook course settings

2010-08-28T22:22:56Z

Mits: ja link

{{Grades}}Course settings determine how the gradebook appears for all participants in the course.

To change the course settings:

#Choose "Course settings" from the gradebook dropdown menu.
#Change the settings as required.
#Click the "Save changes" button.

Note: Individual teachers may override the aggregation position setting for their own grader report view via their [[Grade preferences|"My report preferences"]] tab.

===Show rank===

The show rank setting determines whether the position of a grade item in relation to the rest of the class is shown.

===Show percentage===

The show percentage setting (in Moodle 1.9.3 onwards) determines whether the percentage value of each grade item is shown.

==Default course settings==
[[Image:Gradebook course settings.png|thumb|left|Gradebook course settings]]
The default course settings are set by an administrator in the following locations:
* Grade display type and overall decimal points - ''Administration > Grades > [[Grade item settings]]''
* Default aggregation position - ''Administration > Grades > [[General grade settings|General settings]]''
* Overview report setting - ''Administration > Grades > [[Gradebook report settings|Report settings]] > Overview report''
* User report settings - ''Administration > Grades > [[Gradebook report settings|Report settings]] > User report''

[[Category:Course]]

[[ca:grade/edit/settings/index]]
[[cs:Nastavení hodnocení v kurzu]]
[[ja:評定表コース設定]]

Grade items

2010-08-26T15:30:29Z

Mits: ja link

{{Grades}}

== Introduction ==
The three building blocks of the Gradebook in Moodle 1.9 are

#The [[Grade_categories|grade category]]
#The grade item
#The [[Grades|grade]]

A grade item is a unit of measurement by which participants in a course are graded (i.e. 'marked'). As such, a grade item is a container for grades and a set of settings applied to these grades. The settings affect the calculation and display of the grades in the gradebook reports and [[Grade_export|exports]].

Grade items are represented by columns in the [[Grader_report | grader report]].

Grade items may refer to course activities (e.g. a quiz, an assignment etc.), [[Outcomes]] or even manual grades. Following is an overview of each type.

Within a category, a [[Grades|grade]] summary is also a grade item itself. Summary grade items for a category can show up in reports, and can be used in the calculation of the grade for the parent category.

== Activity-based grade items ==
[[Image:Edit grade item.png|right|thumb|Editing a grade item]]
Modules that include a form of grading use the [[Development:Grades#API_for_communication_with_modules.2Fblocks|Gradebook API]] to generate a matching grade item, and to communicate their grades to the gradebook. The generated grade item can later be edited from within the gradebook interface (Course -> Grades -> Edit Categories and items -> Edit (hand icon) grade item), as seen in the screenshot to the right, but several of its settings will be 'frozen', only changeable from the activity module's interface. These are listed and explained below in the manual grade items section.

Here is a list of the settings that can be edited for an activity-based grade item:

*'''Item info''': General information about the grade item. Optional.
*'''Grade to pass''': Specify the minimum grade a student must achieve to be considered to have passed this item. This must be in real grades, not a percentage. Once this is done, grades will be highlighted in red for fail and green for pass in the gradebook. It doesn't work for scales, as it is yet to be fully implemented in Moodle 1.9. It is planned for use in [[Development:Course completion|course completion]] in Moodle 2.0.
*'''Grade display type''': See the [[Grade_item_settings#Grade_display_type | Grade display type doc]]
*'''Overall decimal points''': This specifies the number of decimal points to display for each grade. It has no effect on grade calculations, which are made with an accuracy of 5 decimal places.
*'''Multiplicator''': Factor by which all grades for this grade item will be multiplied, with a maximum value of the maximum grade. For example, if the multiplicator is 2 and the maximum grade is 100, then all grades less than 50 are doubled, and all grades 50 and above are changed to 100.
*'''Offset''': Number that will be added to every grade for this grade item, after the Multiplicator is applied. (Can be a negative number.)
*'''Hidden''': Whether this grade item should be hidden from students.
*'''Hidden until''': An optional date after which the grade item will no longer be hidden (i.e. a grades release date)
*'''Locked''': Whether or not to lock this grade item. A locked grade item doesn't accept changes to its settings or grades from its related module.
*'''Locked after''': A date after which the locking will be effective, usually after the grades release date.

== Grade outcome items ==
[[Image:grade_outcome_item.png|right|thumb|Editing a grade outcome item]]
These can either be generated by the creation of a new activity module (by selecting [[Outcomes]] in the module creation form), or manually created like manual grade items. A grade outcome item uses a course outcome as its grading type, so such an outcome must be made available at the course level before a grade outcome item can be manually created.

Grade outcome items can optionally be linked with an activity module. This is done automatically when a grade outcome item is generated by the creation of an activity module in which outcomes were selected. In this scenario, a grade category is also created and named after the activity module, and the grade item and grade outcome items are created as children of that category.

The settings of the grade outcome item edit form are identical to those of manual grade items, with the addition of two settings:

*'''Outcome''': The course outcome represented by this item
*'''Linked activity''': The optional activity module to which this item will be linked

== Manual grade items ==
[[Image:manual_item.png|right|thumb|Editing a manual grade item]]
These grade items are created manually through the "Edit Categories and Items" page. The "Add grade item" button is clicked, and the form appears. Several options are available here which are normally automatically filled out by the activity module creating an activity-based grade item:

*'''Item name''': The display name of your grade item
*'''ID Number''': An arbitrary string of characters used to refer to this grade item in Formulas. If set, it must be unique.
*'''Grade type''': The type of grade: None (no grading possible), Value (a numerical value), Scale (an item in a list) or Text (arbitrary text).
*'''Scale''': Which scale to use for grading: available only when the Scale grade type is selected.
*'''Maximum grade''': The maximum grade that can be given (for scales: the number of items in the scale - 1)
*'''Minimum grade''': The minimum grade that can be given (for scales: 0)

Conversely, two of the settings found in the form for activity-based grade items are absent from this form:
*Multiplicator
*Offset

==See also==
*[[Grade item settings]] - for administrators

[[ca:grade/edit/tree/item]]
[[cs:Položky hodnocení]]
[[fr:Eléments d'évaluation]]
[[ja:評定項目]]

User report

2010-08-21T21:26:47Z

Mits: ja link

{{Grades}}The user report shows the currently logged in user's grades in the current course. It includes:

#A breakdown of the grades for each assessment (grade item) in the course.
#The optional teacher-given feedback for each grade.
#The overall grade for the course (called course total). This total is the same as that shown on the [[Overview report|overview report]].

The user report may also include:

#The position of each grade item in relation to the rest of the class (rank).
#A percentage value relative to the minimum-maximum grade for each assessment.

[[Image:User report.png|thumb|left|User report in Moodle 1.9.5]]
Teachers can choose whether to show or hide rank and percentages (in Moodle 1.9.3 onwards) in the [[Gradebook course settings]].

Teachers and administrators may use the "Select all or one user" dropdown menu at the top right of the page to view individual user reports. When all users are selected, the report can be printed, and only one student should appear on each page (browser-dependent behaviour).

In Moodle 1.9.5 onwards, category nesting is shown with contrasting colours, which makes it a lot clearer, especially when lots of categories are in use. A range column has also been added.

==See also==

*[http://www.youtube.com/watch?v=5hrLNbifiGQ Video explaining the different gradebook reports]

[[ca:grade/report/user/index]]
[[cs:Známky uživatele]]
[[eu:Erabiltzailearen_txostena]]
[[fr:Rapport de l'utilisateur]]
[[ja:ユーザレポート]]

Overview report

2010-08-16T15:45:18Z

Mits: ja link

{{Grades}}The overview report lists all the courses a student is enrolled in together with the total grade for each course.

Students can access their overview report from within any course by following the grades link in the course administration block, then selecting "Overview report" from the "Choose an action" dropdown menu at the top left of the page.

The overview report is not relevant for teachers or non-editing teachers. For new Moodle 1.9.5 installs the [[Capabilities/gradereport/overview:view|view overview report]] capability is not set for the default teacher and non-editing teacher roles. For administrators upgrading to Moodle 1.9.5, [[Simplifying the gradebook by changing permissions]] provides details of how to make this change for teachers and non-editing teachers.

[[ca:grade/report/overview/index]]
[[cs:Výsledné známky ze všech kurzů]]
[[eu:Txosten_orokorra]]
[[fr:Rapport d'ensemble]]
[[ja:概要レポート]]

Grade categories

2010-08-13T16:38:06Z

Mits: ja link

{{Grades}}
[[Image:Edit grade category.png|thumb|Editing a grade category]]Grades can be organised into grade categories.
A grade category has its own aggregated grade which is calculated from its grade items. There is no limit to the level of nesting of categories (a category may belong to another category). However, each grade item may belong to only one category. Also, all grade items and categories belong to at least one, permanent category: [[Edit_categories_and_items#Top_category|the course category]].

==Adding a grade category==
To add a grade category:
# Select "Categories and items" from the gradebook dropdown menu.
# Click the "Add category" button near the bottom of the page.
# Give the grade category a meaningful name.
# Select grade category settings as appropriate. Advanced settings may be made available by clicking the "Show advanced" button.
# Click the "Save changes" button.

==Editing a grade category==
To edit a grade category:
# Select "Categories and items" from the gradebook dropdown menu.
# Click the edit icon opposite the grade category you wish to edit.
# After editing the grade category, click the "Save changes" button.

==Settings==
If any of the following do not appear in your page, it may mean that they are set globally in your site. See [[Grade_category_settings#Forcing_settings|Forcing settings]] for more information.

=== Aggregation ===
See [[Category aggregation]] for a detailed explanation.

=== Aggregate only non-empty grades ===
Non-existent grades are either treated as minimal grades or not included in the aggregation. For example, an assignment graded between 0 and 100 for which only half the students have been graded will either count the non-graded submissions as 0 (option switched off) or will ignore them (option switched on).

Important: An empty grade is simply a missing gradebook entry, and could mean different things. For example, it could be a participant who hasn't yet submitted an assignment, an assignment submission not yet graded by the teacher, or a grade that has been manually deleted by the gradebook administrator. Caution in interpreting these "empty grades" is thus advised.

=== Aggregate including sub-categories ===
The aggregation is usually done only with immediate children, it is also possible to aggregate grades in all subcategories excluding other aggregated grades.

=== Include outcomes in aggregation ===
Including outcomes in aggregation may not lead to the desired overall grade, so you have the option to include or leave them out.

=== Drop the lowest ===
If set, this option will drop the X lowest grades, X being the selected value for this option.

Note: You can only make use of either this option or the option below `Keep Highest`. If you have both set then only `Drop the lowest` will be usable under course categories

=== Keep the highest ===
If set, this option will only retain the X highest grades, X being the selected value for this option.

Note: If you have `Drop the lowest` set to anything other than null then this option will have no effect

=== Parent Category - Item Weight ===

If your course is set to use weighted mean of grades, you can assign a weight that the grade for this category will have inside the parent category. Within all of the subcategories of the parent category, the weight values do not need to add up to 100.

=== Aggregation view ===
Each category can be displayed in three ways: Full mode (aggregated column and grade item columns), the aggregated column only, or the grade items alone.

==See also==

*[[Grade items]]
*[[Edit categories and items]]
*[[Grade category settings]] - for administrators
*[http://www.youtube.com/watch?v=sUslTuZPu6A Video showing the effects of the grade category settings]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=91632 Grade categories and weights 1.8 to 1.9?] forum discussion

[[ca:grade/edit/tree/category]]
[[fr:Catégories d'évaluation]]
[[cs:Kategorie známek]]
[[ru:Категории оценок]]
[[ja:評定カテゴリ]]

Grade import

2010-08-13T16:28:52Z

Mits: ja link

{{Grades}}Grades may be imported as a CSV or XML file.

The import file format is the same as the corresponding export format.

Note: Grade import is equivalent to manual grading in the [[Grader report|grader report]]. Thus, if grades for a particular Moodle activity such as an assignment are imported, they can no longer be edited via the assignment submission page.

==Importing grades==
[[Image:Csv grade import.png|thumb|CSV grade import]]
To import grades into the gradebook:

# Decide on an import format - CSV or XML file (see below) - then [[Grade export|export some grades]] using the corresponding export format.
# Edit the export file as appropriate and save it.
# Tip: If you opened your exported file in Excel, don't add columns there because Moodle will reject the import if there are new columns that didn't exist in the exported file. If you need to add columns, do that in Moodle BEFORE you export your gradebook.
# Select your chosen import format from the gradebook dropdown menu.
# Browse and upload your previously saved file.
# Set options as required.
# Click the "Upload grades" button.
# CSV import only: Preview the grade import and choose the column mapping then click the "Upload grades" button to complete the grade import.
## Tip: By default "Map from" is set to First Name, and "Map to" to userid. Change both dropdowns to: "Email Address" to "useremail", or to "Id Number" to "useridnumber" (assuming that your users have ID number fields filled in in their profiles)

You need two permissions to import grades: (1) general permission to import grades and (2) permission to import grades in a particular format. For example, to import CSV grades you need

moodle/grade:import ("Import grades") = Allow
gradeimport/csv:view ("Import grades from CSV") = Allow

==XML import==

XML import requires the numerical grade, activity idnumber and user idnumber.

===Remote file URL===

The remote file URL field is for fetching data from a remote server, such as a student information system.

==CSV import==

CSV import is more flexible than XML import, as you may choose the column mapping.

===Encoding===

If you are unsure of the encoding of your CSV file, try selecting the second option in the encoding dropdown menu. If you've used Excel to produce the CSV file the second option WINDOWS-xxx encoding is probably the correct one. The grade import preview will tell you if you guessed the encoding correctly.

===Verbose scales===

Scales can be either specified as a raw id - eg. 0, 1, 2, 3, etc. or as a string, eg. "good", "bad", "not very bad". The later format is called "verbose".

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=85944 Gradebook confusion]
*[http://moodle.org/mod/forum/discuss.php?d=92081 Can external software insert data into the gradebook?]

[[ca:grade/import/csv/index]]
[[ja:評定のインポート]]

Grade export

2010-08-11T15:41:59Z

Mits: ja link

{{Grades}}Grades can be exported to Excel spreadsheet, OpenDocument spreadsheet, plain text file or XML file.

''Grade export is NOT intended for students.''

==How to export grades==
[[Image:Grade export.png|thumb|left|Grade export]]To export grades from the gradebook:
# Choose an export format from the gradebook dropdown menu.
# Set options as required.
# If the course uses groups, select whether to export grades for all participants or for a particular group.
# Select the grade items to be included. Note that ID numbers are required for all activities for XML file export. An ID number field can be found in the common module settings for each activity.
# Click the submit button.
# After previewing the data on the following page, click the download button.

==XML file export==

To export grades to XML file, you need to ensure that:
* Users have ID numbers (an optional field in the user profile)
* Activities have ID numbers (an optional field in the common module settings)

==Default grade export settings==

The grade export display type and grade export decimal points site-wide defaults may be set by an administrator in ''Administration > Grades > [[General grade settings|Grade settings]]''.

==Grade publishing==
[[Image:Grade publishing settings.png|thumb|left|Grade publishing settings]]
Grade publishing is a way of importing and exporting grades via a URL without being logged in to Moodle. Grade publishing is intended for administrators only, due to the security implications.

Grade publishing is disabled by default. It can be enabled by an administrator by checking the gradepublishing box in ''Administration > Grades > [[General grade settings|Grade settings]]''. Users with grade publishing capabilities (normally administrators only) are then provided with grade export publishing settings.

==Tips and tricks==
*Export grades in a spreadsheet format. Then copy and paste that information into another file that has worksheet ("raw grades"). Create other worksheets which are custom reports which take their data from "raw grades". This works if graded activities are '''not''' moved around to different positions in the course. This allows you to create a standard printed report(s). For example a compact landscape report of all students and all grades for each activity, a report of just quizes, another of lessons, another of assignments. A pivot table of students by scores, generated from a report worksheet, which gets its data from the raw data.
*Mailmerge exported grades into custom documents. For example, a document that is given to a department to file as a proof of training, with scores for every subject quiz.

==See also==

*[http://www.youtube.com/watch?v=yZcbN_7p2zI Video showing how to export grades in Moodle 1.9]

[[ca:grade/export/xml/index]]
[[es:Exportar_calificaciones]]
[[fr:Exportation des notes]]
[[ja:評定のエクスポート]]