https://docs.moodle.org/37/en/api.php?action=feedcontributions&feedformat=atom&user=DanstowellMoodleDocs - User contributions [en]2026-04-23T10:55:47ZUser contributionsMediaWiki 1.43.5https://docs.moodle.org/37/en/index.php?title=User:Dan_Stowell&diff=23237User:Dan Stowell2007-05-12T17:38:05Z<p>Danstowell: </p>
<hr />
<div>[http://www.elec.qmul.ac.uk/department/staff/research/dans.htm Dan Stowell]<br />
<br />
I've been developing bits and bobs for Moodle for a while - for example:<br />
<br />
* '''In Moodle core:'''<br />
** [[IMS Enterprise]] enrolment module<br />
** [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] for database activity<br />
* '''Optional add-ins:'''<br />
** [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] voice messaging tool<br />
** [[Jmol filter]]<br />
** [[Jmol resource type]]<br />
** [http://moodle.org/mod/data/view.php?d=13&rid=296 Java Molecular Editor question type]<br />
** [[WebCT migration]] scripts<br />
<br />
If you want to know more about me you might like to look at [http://www.mcld.co.uk/cv/quick/ my CV]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Coding&diff=21107Development:Coding2007-03-05T22:23:24Z<p>Danstowell: /* General rules */</p>
<hr />
<div>Any collaborative project needs consistency and stability to stay strong.<br />
<br />
These '''coding guidelines''' are to provide a goal for all Moodle code to strive to. It's true that some of the older existing code falls short in a few areas, but it will all be fixed eventually. All new code definitely must adhere to these standards as closely as possible.<br />
<br />
==General rules==<br />
<br />
# All code files should use the .php extension.<br />
# All template files should use the .html extension.<br />
# All text files should use Unix-style text format (most text editors have this as an option).<br />
# All php tags must be 'full' tags like <?php ?> ... not 'short' tags like <? ?>.<br />
# All existing copyright notices must be retained. You can add your own if necessary.<br />
# Each file should include the main config.php file.<br />
# Each file should check that the user is authenticated correctly, using require_login() and isadmin(), isteacher(), iscreator() or isstudent().<br />
# All access to databases should use the functions in ''lib/dmllib.php'' whenever possible - this allows compatibility across a wide range of databases. You should find that almost anything is possible using these functions. If you must write SQL code then make sure it is: cross-platform; restricted to specific functions within your code (usually a lib.php file); and clearly marked.<br />
# Don't create or use global variables except for the standard $CFG, $SESSION, $THEME, $SITE, $COURSE and $USER.<br />
# All variables should be initialised or at least tested for existence using isset() or empty() before they are used.<br />
# All strings should be translatable - create new texts in the "lang/en_utf8" files with concise English lowercase names and retrieve them from your code using get_string() or print_string(). Never delete strings to ensure backwards compatibility of the language packs is maintained.<br />
# All errors should be printed using print_error() to maximise translation and help for users (it automatically links to the docs wiki).<br />
# All help files should be translatable - create new texts in the "lang/en_utf8/help" directory and call them using helpbutton(). If you need to update a help file:<br />
#* with a minor change, where an old translation of the file would still make sense, then it's OK to make the change but you should notify translation AT moodle DOT org.<br />
#* for a major change you should create a new file by adding an incrementing number (eg filename2.html) so that translators can easily see it's a new version of the file. Obviously the new code and the help index files should also be modified to point to the newest versions.<br />
# Incoming data from the browser (sent via GET or POST) automatically has magic_quotes applied (regardless of the PHP settings) so that you can safely insert it straight into the database. All other raw data (from files, or from databases) must be escaped with addslashes() before inserting it into the database. Because this is so often done incorrectly, there is more explanation on this issue of adding and stripping slashes on a [[Developer:Slashes|separate page]].<br />
# VERY IMPORTANT: All texts within Moodle, especially those that have come from users, should be printed using the format_text() function. This ensures that text is filtered and cleaned correctly. More information can be found on the page about [[Development:Output_functions|output functions]].<br />
# User actions should be logged using the [[Development:Logs|add_to_log()]] function. These logs are used for [[Settings#Show_activity_reports|activity reports]] and [[Logs]].<br />
# When generating a HTML link, always make it relative to the full site root, i.e. link to ''$CFG->wwwroot/mod/blonk/view.php?id=99'' rather than just ''view.php?id=99''. This means that your code will work if called by a script in another folder, among other things.<br />
<br />
==Coding style==<br />
<br />
I know it can be a little annoying to change your style if you're used to something else, but balance that annoyance against the annoyance of all the people trying later on to make sense of Moodle code with mixed styles. There are obviously many good points for and against any style that people use, but the current style just is, so please stick to it.<br />
<br />
1. Indenting should be consistently 4 spaces. Don't use tabs AT ALL.<br />
<br />
2. Variable names should always be easy-to-read, meaningful lowercase English words. If you really need more than one word then run them together, but keep them short as possible. Use plural names for arrays of objects.<br />
<br />
GOOD: $quiz<br />
GOOD: $errorstring<br />
GOOD: $assignments (for an array of objects)<br />
GOOD: $i (but only in little loops)<br />
<br />
BAD: $Quiz<br />
BAD: $aReallyLongVariableNameWithoutAGoodReason<br />
BAD: $error_string<br />
<br />
3. Constants should always be in upper case, and always start with the name of the module. They should have words separated by underscores.<br />
<br />
define("FORUM_MODE_FLATOLDEST", 1);<br />
4. Function names should be simple English lowercase words, and start with the name of the module to avoid conflicts between modules. Words should be separated by underscores. Parameters should always have sensible defaults if possible. Note there is no space between the function name and the following (brackets).<br />
<br />
function forum_set_display_mode($mode=0) {<br />
global $USER, $CFG;<br />
<br />
if ($mode) {<br />
$USER->mode = $mode;<br />
} else if (empty($USER->mode)) {<br />
$USER->mode = $CFG->forum_displaymode;<br />
}<br />
}<br />
<br />
5. Blocks must always be enclosed in curly braces (even if there is only one line). Moodle uses this style:<br />
<br />
if ($quiz->attempts) {<br />
if ($numattempts > $quiz->attempts) {<br />
error($strtoomanyattempts, "view.php?id=$cm->id");<br />
}<br />
}<br />
<br />
6. Strings should be defined using single quotes where possible, for increased speed.<br />
<br />
$var = 'some text without any variables';<br />
$var = "with special characters like a new line \n";<br />
$var = 'a very, very long string with a '.$single.' variable in it';<br />
$var = "some $text with $many variables $within it";<br />
<br />
7. Comments should be added as much as is practical, to explain the code flow and the purpose of functions and variables.<br />
<br />
* Every function (and class) should use the popular [http://www.phpdoc.org/ phpDoc format]. This allows code documentation to be generated automatically.<br />
* Inline comments should use the // style, laid out neatly so that it fits among the code and lines up with it.<br />
<br />
/**<br />
* The description should be first, with asterisks laid out exactly<br />
* like this example. If you want to refer to a another function,<br />
* do it like this: {@link clean_param()}. Then, add descriptions<br />
* for each parameter as follows.<br />
*<br />
* @param int $postid The PHP type is followed by the variable name<br />
* @param array $scale The PHP type is followed by the variable name<br />
* @param array $ratings The PHP type is followed by the variable name<br />
* @return mixed<br />
*/<br />
function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {<br />
if (!$ratings) {<br />
$ratings = array(); // Initialize the empty array<br />
if ($rates = get_records("forum_ratings", "post", $postid)) {<br />
// Process each rating in turn<br />
foreach ($rates as $rate) {<br />
....etc<br />
<br />
8. Space should be used liberally - don't be afraid to spread things out a little to gain some clarity. Generally, there should be one space between brackets and normal statements, but no space between brackets and variables or functions:<br />
<br />
foreach ($objects as $key => $thing) {<br />
process($thing);<br />
}<br />
<br />
if ($x == $y) {<br />
$a = $b;<br />
} else if ($x == $z) {<br />
$a = $c;<br />
} else {<br />
$a = $d;<br />
}<br />
<br />
9. When making a COPY of an object, always use the php5 clone() function (otherwise you may end up with just a reference to the first object). Moodle will make sure this works consistently on php4 too.<br />
<br />
BAD: $b = $a;<br />
GOOD: $b = clone($a);<br />
<br />
If the thing you want to copy is not an object, but may contain objects (eg an array of objects) then use fullclone() instead.<br />
<br />
==Database structures==<br />
<br />
# Every table must have an auto-incrementing id field (INT10) as primary index. (see [[IdColumnReasons]])<br />
# The main table containing instances of each module must have the same name as the module (eg widget) and contain the following minimum fields:<br />
#* id - as described above<br />
#* course - the id of the course that each instance belongs to<br />
#* name - the full name of each instance of the module<br />
# Other tables associated with a module that contain information about 'things' should be named widget_things (note the plural).<br />
# Table and column names should avoid using [[Database reserved words|reserved words in any database]]. Please check them before creation.<br />
# Column names should be always lowercase, simple and short, following the same rules as for variable names.<br />
# Where possible, columns that contain a reference to the id field of another table (eg widget) should be called widgetid. (Note that this convention is newish and not followed in some older tables)<br />
# Boolean fields should be implemented as small integer fields (eg INT4) containing 0 or 1, to allow for later expansion of values if necessary.<br />
# Most tables should have a timemodified field (INT10) which is updated with a current timestamp obtained with the PHP time() function.<br />
# Always define a default value for each field (and make it sensible)<br />
# Each table name should start with the database prefix ($CFG->prefix). In a lot of cases, this is taken care of for you automatically. Also, under Postgres, the name of every index must start with the prefix too.<br />
# In order to guarantee [[Development:XMLDB problems#Table and column aliases - the AS keyword|cross-db compatibility]] follow these simple rules about the use of the '''AS''' keyword (only if you need table/colum aliases, of course):<br />
#* '''Don't use''' the '''AS''' keyword for '''table aliases'''.<br />
#* '''Do use''' the '''AS''' keyword for '''column aliases'''.<br />
# '''Never''' create UNIQUE KEYs (constraints) at all. Instead use UNIQUE INDEXes. In the future, if we decide to add referential integrity to Moodle and we need UNIQUE KEYs they will be used, but not now. Please note that the XMLDB editor allows you to specify both XMLDB-only UNIQUE and FOREIGN constraints (and that's good, in order to have the XML well defined) but only underlying INDEXes will be generated. <br />
# Those XMLDB-only UNIQUE KEYs (read previous point) only must be defined if such field/fields '''are going to be the target''' for some (XMLDB-only too) FOREIGN KEY. Else, create them as simple UNIQUE INDEXes.<br />
# Tables associated '''with one block''' must follow this convention with their names: '''$CFG->prefix + "block_" + name_of_the_block + anything_else'''. For example, assuming that $CFG->prefix is 'mdl_', all the tables for the block "rss_client" must start by 'mdl_block_rss_client' (being possible to add more words at the end, i.e. 'mdl_block_rss_client_anothertable'...). This rule will be 100% enforced with Moodle 2.0, giving time to developers until then. See [http://tracker.moodle.org/browse/MDL-6786 Task 6786] for more info about this.<br />
# '''Never''' make database changes in the STABLE branches. If we did, then users upgrading from one stable version to the next would have duplicate changes occurring, which may cause serious errors.<br />
<br />
==Security issues (and handling form and URL data)==<br />
<br />
# Do not rely on 'register_globals'. Every variable must be properly initialised in every code file. It must be obvious where the variable came from.<br />
# Initialise all arrays and objects, even if empty. $a = array() or $obj = new stdClass();.<br />
# Do not use the optional_variable() function (this function is now deprecated). Use the optional_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.<br />
# Do not use the require_variable() function (this function is now deprecated). Use the required_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.<br />
# Use data_submitted(), with care. Data must still be cleaned before use.<br />
# Do not use $_GET, $_POST or $_REQUEST. Use the appropriate required_param() or optional_param() appropriate to your need.<br />
# Do not check for an action using something like if (isset($_GET['something'])). Use, e.g., $something = optional_param( 'something',-1,PARAM_INT ) and then perform proper test for it being in its expected range of values e.g., if ($something>=0) {....<br />
# Wherever possible group all your required_param(), optional_param() and other variables initialisation at the beginning of each file to make them easy to find.<br />
# Use 'sesskey' mechanism to protect form handling routines from attack. Basic example of use: when form is generated, include <input type="hidden" name="sesskey" value="<?php echo sesskey(); ?>" />. When you process the form check with if (!confirm_sesskey()) {error('Bad Session Key');}.<br />
# All filenames must be 'cleaned' using the clean_filename() function, if this has not been done already by appropriate use of required_param() or optional_param()<br />
# Any data read from the database must have [[Developer:Slashes|addslashes()]] applied to it before it can be written back. A whole object of data can be hit at once with addslashes_object().<br />
# Wherever possible, data to be stored in the database must come from POST data (from a form with method="POST") as opposed to GET data (ie, data from the URL line).<br />
# Do not use data from $_SERVER if you can avoid it. This has portability issues.<br />
# If it hasn't been done somewhere else, make sure all data written to the database has been through the clean_param() function using the appropriate PARAM_XXXX for the datatype.<br />
# If you write custom SQL code, make very sure it is correct. In particular watch out for missing quotes around values. Possible SQL 'injection' exploit.<br />
# Check all data (particularly that written to the database) in every file it is used. Do not expect or rely on it being done somewhere else.<br />
# Blocks of code to be included should contain a definite PHP structure (e.g, a class declaration, function definition(s) etc.) - straight blocks of code promote uninitialised variable usage.<br />
<br />
[[Category:Developer]]<br />
<br />
[[es:Manual de Estilo de Código]]<br />
[[zh:代码指南]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Coding&diff=21106Development:Coding2007-03-05T22:22:41Z<p>Danstowell: /* General rules */</p>
<hr />
<div>Any collaborative project needs consistency and stability to stay strong.<br />
<br />
These '''coding guidelines''' are to provide a goal for all Moodle code to strive to. It's true that some of the older existing code falls short in a few areas, but it will all be fixed eventually. All new code definitely must adhere to these standards as closely as possible.<br />
<br />
==General rules==<br />
<br />
# All code files should use the .php extension.<br />
# All template files should use the .html extension.<br />
# All text files should use Unix-style text format (most text editors have this as an option).<br />
# All php tags must be 'full' tags like <?php ?> ... not 'short' tags like <? ?>.<br />
# All existing copyright notices must be retained. You can add your own if necessary.<br />
# Each file should include the main config.php file.<br />
# Each file should check that the user is authenticated correctly, using require_login() and isadmin(), isteacher(), iscreator() or isstudent().<br />
# All access to databases should use the functions in ''lib/dmllib.php'' whenever possible - this allows compatibility across a wide range of databases. You should find that almost anything is possible using these functions. If you must write SQL code then make sure it is: cross-platform; restricted to specific functions within your code (usually a lib.php file); and clearly marked.<br />
# Don't create or use global variables except for the standard $CFG, $SESSION, $THEME, $SITE, $COURSE and $USER.<br />
# All variables should be initialised or at least tested for existence using isset() or empty() before they are used.<br />
# All strings should be translatable - create new texts in the "lang/en_utf8" files with concise English lowercase names and retrieve them from your code using get_string() or print_string(). Never delete strings to ensure backwards compatibility of the language packs is maintained.<br />
# All errors should be printed using print_error() to maximise translation and help for users (it automatically links to the docs wiki).<br />
# All help files should be translatable - create new texts in the "lang/en_utf8/help" directory and call them using helpbutton(). If you need to update a help file:<br />
#* with a minor change, where an old translation of the file would still make sense, then it's OK to make the change but you should notify translation AT moodle DOT org.<br />
#* for a major change you should create a new file by adding an incrementing number (eg filename2.html) so that translators can easily see it's a new version of the file. Obviously the new code and the help index files should also be modified to point to the newest versions.<br />
# Incoming data from the browser (sent via GET or POST) automatically has magic_quotes applied (regardless of the PHP settings) so that you can safely insert it straight into the database. All other raw data (from files, or from databases) must be escaped with addslashes() before inserting it into the database. Because this is so often done incorrectly, there is more explanation on this issue of adding and stripping slashes on a [[Developer:Slashes|separate page]].<br />
# VERY IMPORTANT: All texts within Moodle, especially those that have come from users, should be printed using the format_text() function. This ensures that text is filtered and cleaned correctly. More information can be found on the page about [[Development:Output_functions|output functions]].<br />
# User actions should be logged using the [[Development:Logs|add_to_log()]] function. These logs are used for [[Settings#Show_activity_reports|activity reports]] and [[Logs]].<br />
# When generating a HTML link, always make it relative to the full site root, i.e. link to '''$CFG->wwwroot/mod/blonk/view.php?id=99''' rather than just '''view.php?id=99'''. This means that your code will work if called by a script in another folder, among other things.<br />
<br />
==Coding style==<br />
<br />
I know it can be a little annoying to change your style if you're used to something else, but balance that annoyance against the annoyance of all the people trying later on to make sense of Moodle code with mixed styles. There are obviously many good points for and against any style that people use, but the current style just is, so please stick to it.<br />
<br />
1. Indenting should be consistently 4 spaces. Don't use tabs AT ALL.<br />
<br />
2. Variable names should always be easy-to-read, meaningful lowercase English words. If you really need more than one word then run them together, but keep them short as possible. Use plural names for arrays of objects.<br />
<br />
GOOD: $quiz<br />
GOOD: $errorstring<br />
GOOD: $assignments (for an array of objects)<br />
GOOD: $i (but only in little loops)<br />
<br />
BAD: $Quiz<br />
BAD: $aReallyLongVariableNameWithoutAGoodReason<br />
BAD: $error_string<br />
<br />
3. Constants should always be in upper case, and always start with the name of the module. They should have words separated by underscores.<br />
<br />
define("FORUM_MODE_FLATOLDEST", 1);<br />
4. Function names should be simple English lowercase words, and start with the name of the module to avoid conflicts between modules. Words should be separated by underscores. Parameters should always have sensible defaults if possible. Note there is no space between the function name and the following (brackets).<br />
<br />
function forum_set_display_mode($mode=0) {<br />
global $USER, $CFG;<br />
<br />
if ($mode) {<br />
$USER->mode = $mode;<br />
} else if (empty($USER->mode)) {<br />
$USER->mode = $CFG->forum_displaymode;<br />
}<br />
}<br />
<br />
5. Blocks must always be enclosed in curly braces (even if there is only one line). Moodle uses this style:<br />
<br />
if ($quiz->attempts) {<br />
if ($numattempts > $quiz->attempts) {<br />
error($strtoomanyattempts, "view.php?id=$cm->id");<br />
}<br />
}<br />
<br />
6. Strings should be defined using single quotes where possible, for increased speed.<br />
<br />
$var = 'some text without any variables';<br />
$var = "with special characters like a new line \n";<br />
$var = 'a very, very long string with a '.$single.' variable in it';<br />
$var = "some $text with $many variables $within it";<br />
<br />
7. Comments should be added as much as is practical, to explain the code flow and the purpose of functions and variables.<br />
<br />
* Every function (and class) should use the popular [http://www.phpdoc.org/ phpDoc format]. This allows code documentation to be generated automatically.<br />
* Inline comments should use the // style, laid out neatly so that it fits among the code and lines up with it.<br />
<br />
/**<br />
* The description should be first, with asterisks laid out exactly<br />
* like this example. If you want to refer to a another function,<br />
* do it like this: {@link clean_param()}. Then, add descriptions<br />
* for each parameter as follows.<br />
*<br />
* @param int $postid The PHP type is followed by the variable name<br />
* @param array $scale The PHP type is followed by the variable name<br />
* @param array $ratings The PHP type is followed by the variable name<br />
* @return mixed<br />
*/<br />
function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {<br />
if (!$ratings) {<br />
$ratings = array(); // Initialize the empty array<br />
if ($rates = get_records("forum_ratings", "post", $postid)) {<br />
// Process each rating in turn<br />
foreach ($rates as $rate) {<br />
....etc<br />
<br />
8. Space should be used liberally - don't be afraid to spread things out a little to gain some clarity. Generally, there should be one space between brackets and normal statements, but no space between brackets and variables or functions:<br />
<br />
foreach ($objects as $key => $thing) {<br />
process($thing);<br />
}<br />
<br />
if ($x == $y) {<br />
$a = $b;<br />
} else if ($x == $z) {<br />
$a = $c;<br />
} else {<br />
$a = $d;<br />
}<br />
<br />
9. When making a COPY of an object, always use the php5 clone() function (otherwise you may end up with just a reference to the first object). Moodle will make sure this works consistently on php4 too.<br />
<br />
BAD: $b = $a;<br />
GOOD: $b = clone($a);<br />
<br />
If the thing you want to copy is not an object, but may contain objects (eg an array of objects) then use fullclone() instead.<br />
<br />
==Database structures==<br />
<br />
# Every table must have an auto-incrementing id field (INT10) as primary index. (see [[IdColumnReasons]])<br />
# The main table containing instances of each module must have the same name as the module (eg widget) and contain the following minimum fields:<br />
#* id - as described above<br />
#* course - the id of the course that each instance belongs to<br />
#* name - the full name of each instance of the module<br />
# Other tables associated with a module that contain information about 'things' should be named widget_things (note the plural).<br />
# Table and column names should avoid using [[Database reserved words|reserved words in any database]]. Please check them before creation.<br />
# Column names should be always lowercase, simple and short, following the same rules as for variable names.<br />
# Where possible, columns that contain a reference to the id field of another table (eg widget) should be called widgetid. (Note that this convention is newish and not followed in some older tables)<br />
# Boolean fields should be implemented as small integer fields (eg INT4) containing 0 or 1, to allow for later expansion of values if necessary.<br />
# Most tables should have a timemodified field (INT10) which is updated with a current timestamp obtained with the PHP time() function.<br />
# Always define a default value for each field (and make it sensible)<br />
# Each table name should start with the database prefix ($CFG->prefix). In a lot of cases, this is taken care of for you automatically. Also, under Postgres, the name of every index must start with the prefix too.<br />
# In order to guarantee [[Development:XMLDB problems#Table and column aliases - the AS keyword|cross-db compatibility]] follow these simple rules about the use of the '''AS''' keyword (only if you need table/colum aliases, of course):<br />
#* '''Don't use''' the '''AS''' keyword for '''table aliases'''.<br />
#* '''Do use''' the '''AS''' keyword for '''column aliases'''.<br />
# '''Never''' create UNIQUE KEYs (constraints) at all. Instead use UNIQUE INDEXes. In the future, if we decide to add referential integrity to Moodle and we need UNIQUE KEYs they will be used, but not now. Please note that the XMLDB editor allows you to specify both XMLDB-only UNIQUE and FOREIGN constraints (and that's good, in order to have the XML well defined) but only underlying INDEXes will be generated. <br />
# Those XMLDB-only UNIQUE KEYs (read previous point) only must be defined if such field/fields '''are going to be the target''' for some (XMLDB-only too) FOREIGN KEY. Else, create them as simple UNIQUE INDEXes.<br />
# Tables associated '''with one block''' must follow this convention with their names: '''$CFG->prefix + "block_" + name_of_the_block + anything_else'''. For example, assuming that $CFG->prefix is 'mdl_', all the tables for the block "rss_client" must start by 'mdl_block_rss_client' (being possible to add more words at the end, i.e. 'mdl_block_rss_client_anothertable'...). This rule will be 100% enforced with Moodle 2.0, giving time to developers until then. See [http://tracker.moodle.org/browse/MDL-6786 Task 6786] for more info about this.<br />
# '''Never''' make database changes in the STABLE branches. If we did, then users upgrading from one stable version to the next would have duplicate changes occurring, which may cause serious errors.<br />
<br />
==Security issues (and handling form and URL data)==<br />
<br />
# Do not rely on 'register_globals'. Every variable must be properly initialised in every code file. It must be obvious where the variable came from.<br />
# Initialise all arrays and objects, even if empty. $a = array() or $obj = new stdClass();.<br />
# Do not use the optional_variable() function (this function is now deprecated). Use the optional_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.<br />
# Do not use the require_variable() function (this function is now deprecated). Use the required_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.<br />
# Use data_submitted(), with care. Data must still be cleaned before use.<br />
# Do not use $_GET, $_POST or $_REQUEST. Use the appropriate required_param() or optional_param() appropriate to your need.<br />
# Do not check for an action using something like if (isset($_GET['something'])). Use, e.g., $something = optional_param( 'something',-1,PARAM_INT ) and then perform proper test for it being in its expected range of values e.g., if ($something>=0) {....<br />
# Wherever possible group all your required_param(), optional_param() and other variables initialisation at the beginning of each file to make them easy to find.<br />
# Use 'sesskey' mechanism to protect form handling routines from attack. Basic example of use: when form is generated, include <input type="hidden" name="sesskey" value="<?php echo sesskey(); ?>" />. When you process the form check with if (!confirm_sesskey()) {error('Bad Session Key');}.<br />
# All filenames must be 'cleaned' using the clean_filename() function, if this has not been done already by appropriate use of required_param() or optional_param()<br />
# Any data read from the database must have [[Developer:Slashes|addslashes()]] applied to it before it can be written back. A whole object of data can be hit at once with addslashes_object().<br />
# Wherever possible, data to be stored in the database must come from POST data (from a form with method="POST") as opposed to GET data (ie, data from the URL line).<br />
# Do not use data from $_SERVER if you can avoid it. This has portability issues.<br />
# If it hasn't been done somewhere else, make sure all data written to the database has been through the clean_param() function using the appropriate PARAM_XXXX for the datatype.<br />
# If you write custom SQL code, make very sure it is correct. In particular watch out for missing quotes around values. Possible SQL 'injection' exploit.<br />
# Check all data (particularly that written to the database) in every file it is used. Do not expect or rely on it being done somewhere else.<br />
# Blocks of code to be included should contain a definite PHP structure (e.g, a class declaration, function definition(s) etc.) - straight blocks of code promote uninitialised variable usage.<br />
<br />
[[Category:Developer]]<br />
<br />
[[es:Manual de Estilo de Código]]<br />
[[zh:代码指南]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Coding&diff=21105Development:Coding2007-03-05T22:21:51Z<p>Danstowell: /* General rules */ Note about creating links with $CFG->wwwroot</p>
<hr />
<div>Any collaborative project needs consistency and stability to stay strong.<br />
<br />
These '''coding guidelines''' are to provide a goal for all Moodle code to strive to. It's true that some of the older existing code falls short in a few areas, but it will all be fixed eventually. All new code definitely must adhere to these standards as closely as possible.<br />
<br />
==General rules==<br />
<br />
# All code files should use the .php extension.<br />
# All template files should use the .html extension.<br />
# All text files should use Unix-style text format (most text editors have this as an option).<br />
# All php tags must be 'full' tags like <?php ?> ... not 'short' tags like <? ?>.<br />
# All existing copyright notices must be retained. You can add your own if necessary.<br />
# Each file should include the main config.php file.<br />
# Each file should check that the user is authenticated correctly, using require_login() and isadmin(), isteacher(), iscreator() or isstudent().<br />
# All access to databases should use the functions in ''lib/dmllib.php'' whenever possible - this allows compatibility across a wide range of databases. You should find that almost anything is possible using these functions. If you must write SQL code then make sure it is: cross-platform; restricted to specific functions within your code (usually a lib.php file); and clearly marked.<br />
# Don't create or use global variables except for the standard $CFG, $SESSION, $THEME, $SITE, $COURSE and $USER.<br />
# All variables should be initialised or at least tested for existence using isset() or empty() before they are used.<br />
# All strings should be translatable - create new texts in the "lang/en_utf8" files with concise English lowercase names and retrieve them from your code using get_string() or print_string(). Never delete strings to ensure backwards compatibility of the language packs is maintained.<br />
# All errors should be printed using print_error() to maximise translation and help for users (it automatically links to the docs wiki).<br />
# All help files should be translatable - create new texts in the "lang/en_utf8/help" directory and call them using helpbutton(). If you need to update a help file:<br />
#* with a minor change, where an old translation of the file would still make sense, then it's OK to make the change but you should notify translation AT moodle DOT org.<br />
#* for a major change you should create a new file by adding an incrementing number (eg filename2.html) so that translators can easily see it's a new version of the file. Obviously the new code and the help index files should also be modified to point to the newest versions.<br />
# Incoming data from the browser (sent via GET or POST) automatically has magic_quotes applied (regardless of the PHP settings) so that you can safely insert it straight into the database. All other raw data (from files, or from databases) must be escaped with addslashes() before inserting it into the database. Because this is so often done incorrectly, there is more explanation on this issue of adding and stripping slashes on a [[Developer:Slashes|separate page]].<br />
# VERY IMPORTANT: All texts within Moodle, especially those that have come from users, should be printed using the format_text() function. This ensures that text is filtered and cleaned correctly. More information can be found on the page about [[Development:Output_functions|output functions]].<br />
# User actions should be logged using the [[Development:Logs|add_to_log()]] function. These logs are used for [[Settings#Show_activity_reports|activity reports]] and [[Logs]].<br />
# When generating a HTML link, always make it relative to the full site root, i.e. use $CFG->wwwroot/mod/blonk/view.php?id=99 rather than just view.php?id=99. This means your code will work if called by a script in another folder, among other things.<br />
<br />
==Coding style==<br />
<br />
I know it can be a little annoying to change your style if you're used to something else, but balance that annoyance against the annoyance of all the people trying later on to make sense of Moodle code with mixed styles. There are obviously many good points for and against any style that people use, but the current style just is, so please stick to it.<br />
<br />
1. Indenting should be consistently 4 spaces. Don't use tabs AT ALL.<br />
<br />
2. Variable names should always be easy-to-read, meaningful lowercase English words. If you really need more than one word then run them together, but keep them short as possible. Use plural names for arrays of objects.<br />
<br />
GOOD: $quiz<br />
GOOD: $errorstring<br />
GOOD: $assignments (for an array of objects)<br />
GOOD: $i (but only in little loops)<br />
<br />
BAD: $Quiz<br />
BAD: $aReallyLongVariableNameWithoutAGoodReason<br />
BAD: $error_string<br />
<br />
3. Constants should always be in upper case, and always start with the name of the module. They should have words separated by underscores.<br />
<br />
define("FORUM_MODE_FLATOLDEST", 1);<br />
4. Function names should be simple English lowercase words, and start with the name of the module to avoid conflicts between modules. Words should be separated by underscores. Parameters should always have sensible defaults if possible. Note there is no space between the function name and the following (brackets).<br />
<br />
function forum_set_display_mode($mode=0) {<br />
global $USER, $CFG;<br />
<br />
if ($mode) {<br />
$USER->mode = $mode;<br />
} else if (empty($USER->mode)) {<br />
$USER->mode = $CFG->forum_displaymode;<br />
}<br />
}<br />
<br />
5. Blocks must always be enclosed in curly braces (even if there is only one line). Moodle uses this style:<br />
<br />
if ($quiz->attempts) {<br />
if ($numattempts > $quiz->attempts) {<br />
error($strtoomanyattempts, "view.php?id=$cm->id");<br />
}<br />
}<br />
<br />
6. Strings should be defined using single quotes where possible, for increased speed.<br />
<br />
$var = 'some text without any variables';<br />
$var = "with special characters like a new line \n";<br />
$var = 'a very, very long string with a '.$single.' variable in it';<br />
$var = "some $text with $many variables $within it";<br />
<br />
7. Comments should be added as much as is practical, to explain the code flow and the purpose of functions and variables.<br />
<br />
* Every function (and class) should use the popular [http://www.phpdoc.org/ phpDoc format]. This allows code documentation to be generated automatically.<br />
* Inline comments should use the // style, laid out neatly so that it fits among the code and lines up with it.<br />
<br />
/**<br />
* The description should be first, with asterisks laid out exactly<br />
* like this example. If you want to refer to a another function,<br />
* do it like this: {@link clean_param()}. Then, add descriptions<br />
* for each parameter as follows.<br />
*<br />
* @param int $postid The PHP type is followed by the variable name<br />
* @param array $scale The PHP type is followed by the variable name<br />
* @param array $ratings The PHP type is followed by the variable name<br />
* @return mixed<br />
*/<br />
function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {<br />
if (!$ratings) {<br />
$ratings = array(); // Initialize the empty array<br />
if ($rates = get_records("forum_ratings", "post", $postid)) {<br />
// Process each rating in turn<br />
foreach ($rates as $rate) {<br />
....etc<br />
<br />
8. Space should be used liberally - don't be afraid to spread things out a little to gain some clarity. Generally, there should be one space between brackets and normal statements, but no space between brackets and variables or functions:<br />
<br />
foreach ($objects as $key => $thing) {<br />
process($thing);<br />
}<br />
<br />
if ($x == $y) {<br />
$a = $b;<br />
} else if ($x == $z) {<br />
$a = $c;<br />
} else {<br />
$a = $d;<br />
}<br />
<br />
9. When making a COPY of an object, always use the php5 clone() function (otherwise you may end up with just a reference to the first object). Moodle will make sure this works consistently on php4 too.<br />
<br />
BAD: $b = $a;<br />
GOOD: $b = clone($a);<br />
<br />
If the thing you want to copy is not an object, but may contain objects (eg an array of objects) then use fullclone() instead.<br />
<br />
==Database structures==<br />
<br />
# Every table must have an auto-incrementing id field (INT10) as primary index. (see [[IdColumnReasons]])<br />
# The main table containing instances of each module must have the same name as the module (eg widget) and contain the following minimum fields:<br />
#* id - as described above<br />
#* course - the id of the course that each instance belongs to<br />
#* name - the full name of each instance of the module<br />
# Other tables associated with a module that contain information about 'things' should be named widget_things (note the plural).<br />
# Table and column names should avoid using [[Database reserved words|reserved words in any database]]. Please check them before creation.<br />
# Column names should be always lowercase, simple and short, following the same rules as for variable names.<br />
# Where possible, columns that contain a reference to the id field of another table (eg widget) should be called widgetid. (Note that this convention is newish and not followed in some older tables)<br />
# Boolean fields should be implemented as small integer fields (eg INT4) containing 0 or 1, to allow for later expansion of values if necessary.<br />
# Most tables should have a timemodified field (INT10) which is updated with a current timestamp obtained with the PHP time() function.<br />
# Always define a default value for each field (and make it sensible)<br />
# Each table name should start with the database prefix ($CFG->prefix). In a lot of cases, this is taken care of for you automatically. Also, under Postgres, the name of every index must start with the prefix too.<br />
# In order to guarantee [[Development:XMLDB problems#Table and column aliases - the AS keyword|cross-db compatibility]] follow these simple rules about the use of the '''AS''' keyword (only if you need table/colum aliases, of course):<br />
#* '''Don't use''' the '''AS''' keyword for '''table aliases'''.<br />
#* '''Do use''' the '''AS''' keyword for '''column aliases'''.<br />
# '''Never''' create UNIQUE KEYs (constraints) at all. Instead use UNIQUE INDEXes. In the future, if we decide to add referential integrity to Moodle and we need UNIQUE KEYs they will be used, but not now. Please note that the XMLDB editor allows you to specify both XMLDB-only UNIQUE and FOREIGN constraints (and that's good, in order to have the XML well defined) but only underlying INDEXes will be generated. <br />
# Those XMLDB-only UNIQUE KEYs (read previous point) only must be defined if such field/fields '''are going to be the target''' for some (XMLDB-only too) FOREIGN KEY. Else, create them as simple UNIQUE INDEXes.<br />
# Tables associated '''with one block''' must follow this convention with their names: '''$CFG->prefix + "block_" + name_of_the_block + anything_else'''. For example, assuming that $CFG->prefix is 'mdl_', all the tables for the block "rss_client" must start by 'mdl_block_rss_client' (being possible to add more words at the end, i.e. 'mdl_block_rss_client_anothertable'...). This rule will be 100% enforced with Moodle 2.0, giving time to developers until then. See [http://tracker.moodle.org/browse/MDL-6786 Task 6786] for more info about this.<br />
# '''Never''' make database changes in the STABLE branches. If we did, then users upgrading from one stable version to the next would have duplicate changes occurring, which may cause serious errors.<br />
<br />
==Security issues (and handling form and URL data)==<br />
<br />
# Do not rely on 'register_globals'. Every variable must be properly initialised in every code file. It must be obvious where the variable came from.<br />
# Initialise all arrays and objects, even if empty. $a = array() or $obj = new stdClass();.<br />
# Do not use the optional_variable() function (this function is now deprecated). Use the optional_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.<br />
# Do not use the require_variable() function (this function is now deprecated). Use the required_param() function instead. Pick the correct PARAM_XXXX value for the data type you expect.<br />
# Use data_submitted(), with care. Data must still be cleaned before use.<br />
# Do not use $_GET, $_POST or $_REQUEST. Use the appropriate required_param() or optional_param() appropriate to your need.<br />
# Do not check for an action using something like if (isset($_GET['something'])). Use, e.g., $something = optional_param( 'something',-1,PARAM_INT ) and then perform proper test for it being in its expected range of values e.g., if ($something>=0) {....<br />
# Wherever possible group all your required_param(), optional_param() and other variables initialisation at the beginning of each file to make them easy to find.<br />
# Use 'sesskey' mechanism to protect form handling routines from attack. Basic example of use: when form is generated, include <input type="hidden" name="sesskey" value="<?php echo sesskey(); ?>" />. When you process the form check with if (!confirm_sesskey()) {error('Bad Session Key');}.<br />
# All filenames must be 'cleaned' using the clean_filename() function, if this has not been done already by appropriate use of required_param() or optional_param()<br />
# Any data read from the database must have [[Developer:Slashes|addslashes()]] applied to it before it can be written back. A whole object of data can be hit at once with addslashes_object().<br />
# Wherever possible, data to be stored in the database must come from POST data (from a form with method="POST") as opposed to GET data (ie, data from the URL line).<br />
# Do not use data from $_SERVER if you can avoid it. This has portability issues.<br />
# If it hasn't been done somewhere else, make sure all data written to the database has been through the clean_param() function using the appropriate PARAM_XXXX for the datatype.<br />
# If you write custom SQL code, make very sure it is correct. In particular watch out for missing quotes around values. Possible SQL 'injection' exploit.<br />
# Check all data (particularly that written to the database) in every file it is used. Do not expect or rely on it being done somewhere else.<br />
# Blocks of code to be included should contain a definite PHP structure (e.g, a class declaration, function definition(s) etc.) - straight blocks of code promote uninitialised variable usage.<br />
<br />
[[Category:Developer]]<br />
<br />
[[es:Manual de Estilo de Código]]<br />
[[zh:代码指南]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Latest_release_notes&diff=16910Latest release notes2006-10-10T11:17:52Z<p>Danstowell: /* Other improvements */</p>
<hr />
<div>{{About Moodle}}<br />
<br />
<br />
==Moodle 1.7==<br />
<br />
Under final test phase, release expected soon. Moodle 1.7 Beta is now available from CVS or the [http://download.moodle.org Moodle download page]. This version is not recommended for production sites yet.<br />
<br />
[http://tracker.moodle.org/secure/ReleaseNote.jspa?version=10120&styleName=Html&projectId=10011&Create=Create This page shows details about issues resolved in this version]<br />
<br />
===Headline features===<br />
<br />
* [[Roles]]<br />
:: Permissions based on fine-grained capabilities allow all kinds of roles to be created and assigned in all contexts around Moodle. This creates a great deal more flexibility in the permissions that you can grant to people.<br />
* [[XML database schema]]<br />
:: added support for MS-SQL and Oracle with more databases to come. Developers now have just one XML file to edit when changing the database structure, and there is even a very funky editor for this file built-in to Moodle<br />
* New Admin interface<br />
:: Completely new admin interface, with accessible design and cool features to make access to settings fast and easy.<br />
* AJAX Course editing<br />
:: The Topics and Weekly course formats now feature AJAX editing which means you can drag drop blocks, activities and sections (weeks/topics) and it all happens instantly. No more page reloading!<br />
* [[Unit tests|Unit testing framework]]<br />
:: Making it easier for developers to write test code, which should ultimately lead to a more reliable Moodle.<br />
<br />
<br />
===Other improvements===<br />
<br />
* Improvements to the [[Database module]]<br />
**Template/Field settings can now be saved as Presets and shared across a site.<br />
**Presets are just zip files, and can also be shared between sites.<br />
**Moodle 1.7 comes with one sample preset (an Image Gallery) with more to come.<br />
**New latitude/longitude data type<br />
<br />
* Improvements to the [[Lesson module]]<br />
**Now has a more unified view of lesson screens.<br />
**Teacher editing:<br />
***Collapsed view has a nicer format, displays more information regarding each page and allows the creation of new pages.<br />
***Editing is now speedier by replacing 3 second redirect delays with a notification system.<br />
**New feature: display default feedback.<br />
***Default is '''On''' so previous lessons behave as before.<br />
***Description: if no ''response'' is entered for a question answer and this setting is turned '''Off''', then the user skips the feedback page.<br />
**Graceful degrade of JavaScript.<br />
**Several bug fixes.<br />
<br />
* Improvements to the [[Quiz module]]<br />
:* The teacher can configure comments that are displayed to the student at the end of their attempt, with the comment displayed depending on the student's score.<br />
<br />
* Improvements to some core question types<br />
:* All question types can now have some general feedback. This is displayed to all students after they have finished the question (depending on the quiz settings) and does not depend on what response the student gave. Use this to tell the student what the question was about, or link them to more information about the topic it covers.<br />
:* [[Matching question type|Matching]] questions can have extra wrong answers, and work when two questions have the same answer.<br />
:* [[Multiple Choice question type|Multiple Choice]] questions can have feedback for the whole question, as well as specific answers. This is particularly useful for multiple-response questions.<br />
:* [[Numerical question type|Numerical]] questions can have different answers with different precisions and scores. (Previously this was only supported via GIFT import. Now you can edit questions like this.)<br />
<br />
==Moodle 1.6.3==<br />
10th October, 2006<br />
<br />
[http://tracker.moodle.org/secure/ReleaseNote.jspa?version=10140&styleName=Text&projectId=10011 Full details of these issues can be found in the tracker]<br />
<br />
===Security Bugfix===<br />
* A vulnerability was discovered that could allow SQL injections if a parameter was improperly used. Full details of this particular issue are on the [http://security.moodle.org/ Moodle Security site]. All registered Moodle admins were notified by direct email on Saturday September 30th.<br />
<br />
===General Bugs Fixed===<br />
* [MDL-3048] - Release note should note not to use some PHP versions<br />
* [MDL-3805] - mod.html in NEWMODULE.zip is not XHTML1.0 Transitional compliant<br />
* [MDL-5378] - shorten_text doesn't work for oriental languages<br />
* [MDL-5601] - cloze question restore error problem<br />
* [MDL-5884] - Turn Student View On<br />
* [MDL-5893] - Blackboard export/backup course does not restore to Moodle correctly<br />
* [MDL-6084] - Restore to new course failure notice if logged in as course creator<br />
* [MDL-6128] - 1.6, special chars and messaging system.<br />
* [MDL-6193] - problem with login/index.php file<br />
* [MDL-6205] - slashes not stripped when re-editing profile<br />
* [MDL-6224] - Syntax error creating tables on install<br />
* [MDL-6247] - Error checking for missing themes<br />
* [MDL-6271] - breadcrumb problem<br />
* [MDL-6272] - DB Enrolment not recording enrolment end date<br />
* [MDL-6334] - Unnecessary group menu in Feedback popup window<br />
* [MDL-6336] - After utf8-migration unserializing of old essay fails<br />
* [MDL-6341] - "Student view" locks out designers/administrators from courses not available to students<br />
* [MDL-6342] - cannot move forum post to other forum when the subject includes an apostrophe<br />
* [MDL-6363] - typo in mod/forum/restorelib.php prevents grouped discussions from being accessible to group after a restore.<br />
* [MDL-6375] - Uploaded assignments are not available from the student submission page once graded<br />
* [MDL-6480] - Import of multichoice questions in Moodle XML format doesn't use shuffle option. Fix included<br />
* [MDL-6517] - Adding or editing post produces "ERROR: invalid input syntax for integer: "Object id #XXX"<br />
* [MDL-6518] - How to make new themes link no longer required<br />
* [MDL-6521] - Single discussion forums can be splitted and it hasn't too much sense....<br />
* [MDL-6537] - past students receive email from forum<br />
* [MDL-6538] - Bug in hotpot upgrade script 1.6.1 -> 1.6.2 with MetaColumns() method<br />
* [MDL-6615] - Highlighting search terms in forum search text posts fails<br />
* [MDL-6632] - scorm_grade_user function in locallib.php file has errors<br />
* [MDL-6649] - HTML Editor in Quiz Essay Question unreliable<br />
* [MDL-6686] - Streamed Chat Locks Send Message Field<br />
* [MDL-6750] - change_password.php produces JS error.<br />
* [MDL-6754] - moodle.php in de_utf8 langpack has wrong locale<br />
* [MDL-6757] - Insert a Chinese charachter string to label resource result error.<br />
* [MDL-6770] - Student cannot see handed-in assignment<br />
* [MDL-6791] - Streamed Chat JS bug Prevents Use<br />
* [MDL-6824] - redundant style declaration in theme<br />
* [MDL-6837] - Make a language file entry for the wording of popup blocker checker<br />
* [MDL-6841] - Student View button fails when course is hidden to students<br />
* [MDL-6842] - Resource frameset error in IE6<br />
* [MDL-6866] - A required parameter (backup_unique_code) was missing" error<br />
* [MDL-6876] - Grades computed incorrectly if assignment name appears more than twice in a course<br />
<br />
===Improvement===<br />
* [MDL-6280] - Backup files should not be included in new backups<br />
* [MDL-6572] - Allow students to access their uploaded documents after grading.<br />
* [MDL-6662] - why footer with margin-top: 100px<br />
* [MDL-6878] - Scalable Vector Graphics (SVG) files in Moodle are not correctly displayed in many Browsers<br />
<br />
===New Feature===<br />
* [MDL-5653] - add blacklisted level into environment XML<br />
<br />
==Moodle 1.6.2==<br />
12th September, 2006<br />
<br />
===Security===<br />
* Fixed handling of uploaded files in Database module<br />
* Module instance id is now properly validated when creating course module object; developers should use get_coursemodule_from_id() to get valid $cm<br />
* Default error reporting level was lowered to 5, E_WARNINGs are no longer displayed on production sites with debug off.<br />
* Multiple problems leading to information leakage fixed in help.php file<br />
* Fixed information leakage from scheduled backups<br />
* Added basic detection of dataroot accessible from Internet, web installer now better suggests dataroot location outside of web file area<br />
* Swf is now disabled by default in Mediaplugin<br />
* forgot_password.php does not allow remote email or username enumeration by default, the old behavior can be enabled by setting protectusernames to No in site configuration<br />
* Undisclosed SQL injections fixed by automatic data conversions in adodb layer<br />
* Theoretical XSS problems fixed in doc/index.php and files/index.php scripts<br />
* Access to tex and algebra files is blocked when filters are disabled<br />
* Request for redirection in jumpto.php protected with sesskey<br />
<br />
===Bug Fixes===<br />
<br />
* Fixed error when upgrading forum read tracking<br />
* Locales from language packs should finally work - please check your configuration variables and empty the locale field<br />
* Added missing link for course request<br />
* Fixed several glossary problems with non-ascii characters<br />
* Fixed bug where you could not regrade a quiz question where the teacher had added a comment with a ' character.<br />
* Quiz import of BlackBoard V6 files now much more reliable<br />
* Fixed scheduled backups - they were broken in 1.6 and 1.6.1<br />
* Fixed missing guest icons from course listing<br />
* Database sessions respect sessiontimeout setting<br />
* Fixed redirect problems during upgrade resulting in "Table xxx already exists"<br />
* Lesson module: the "(Continue)" no longer displays for 3 seconds after branch tables.<br />
* Lesson module: now properly checks import formats for support.<br />
* Lesson module: feedback is set properly during the import process.<br />
* and many other smaller fixes<br />
<br />
===New Features===<br />
<br />
* Authorize.net Payment Gateway: Autoconfigures credit card types if the merchant does not accept some types of credit cards<br />
<br />
===Known Problems===<br />
* Broken images in published question categories<br />
<br />
==Moodle 1.6.1==<br />
20th July, 2006<br />
<br />
===Bug Fixes===<br />
<br />
* Fixed regression in Turkish locale handling<br />
* Authorize and Paypal enrolment plugin cleanup<br />
* Fixed serious problem with failing Database restore<br />
* Fixed restore of HotPot module containing attempts<br />
* Minor Database module fixes<br />
* National characters in graphs now work for most languages out of the box<br />
* Reviewed and fixed all *nix locale codes in language packs<br />
* Fixed problems when using Resources with Blocks on the frontpage<br />
* Fixed missing events on the first day of month in calendar<br />
* Fixed several problems in Lesson - scores, branch tables, HTML editor issues<br />
* Fixed broken intermodule relinking of absolute paths - please do not use course backups from original 1.6<br />
* PDF byteserving problems caused by incorrect partial content length solved<br />
* Fixed several regressions in handling of multiple groups<br />
* Fixed alphabet problems in Glossary<br />
* Chameleon theme fixes and enhancements<br />
* Fixed all hard coded admin paths<br />
* Fixed moving of course sections<br />
* Fixed grading of Essays in Quiz<br />
* Several Quiz regrading problems solved<br />
* Questions are now exported into backupdata directory<br />
* Added workaround for problems when editting two quizes in one browser<br />
* Lots of other Quiz related bugs fixed - thanks Tim!<br />
<br />
* Fixed IE unsecure items warning on sites with https login<br />
* Improved cookie test on the login page<br />
* Potential security issue with unzipping maliciously-crafted zip files fixed<br />
* Satinized input parameters in help.php<br />
* Calendar view.php now respects forcelogin setting<br />
<br />
* And lots of other minor fixes worth upgrading<br />
<br />
===New Features===<br />
<br />
* Enhanced frontpage settings - frontpage can now be different for logged in users, changed category list display<br />
* Improved administration page layout<br />
* Possibility to change graph font for all locales - moodledata/lang/default.ttf takes precedence over lib/default.ttf<br />
* Local language packs may also contain default.ttf<br />
* Backported improved lang.php from HEAD<br />
* New config.php option $CFG->allowvisiblecoursesinhiddencategories<br />
<br />
===Known Problems===<br />
<br />
* Broken images in published question categories<br />
* Small number of sites reports problems with Quiz upgrade - please always do a full database backup before any upgrade!<br />
<br />
===Related===<br />
<br />
* Third party modules should be already updated for 1.6.x - you must install new versions before UTF-8 migration!<br />
* New integration of phpMyAdmin available - fixes upstream security problems and compatiblility with PHP 5<br />
<br />
==Moodle 1.6==<br />
19th June, 2006<br />
<br />
NOTE: Moodle 1.6 requires PHP 4.3.0 (or PHP 5.1.0) and MySQL 4.1.16 (4.1.12 if you use latin languages only). Here is more info on [[Upgrading to Moodle 1.6]].<br />
<br />
===New features===<br />
<br />
* [[UTF-8 migration|Unicode]]<br />
::Moodle is now 100% Unicode, which means any language can be mixed together and an end to a number of problems that different character sets caused us.<br />
* [[MoodleDocs development|Documentation]]<br />
::A new one-stop wiki site for ALL Moodle documentation, including links from Moodle itself<br />
* [[Database module]]<br />
::A new activity module that allows collaborative collection of structured data, useful for many things!<br />
* [[LAMS]]<br />
::Integrated via a course format and an activity module<br />
* [[Blogs]]<br />
::Allows reflection on an ongoing basis. Entries are marked and can be viewed by user, course, group, site etc. Contains first new support for [[Tags]]. <br />
* [[Reports]]<br />
::All reports are now centralised under Course reports and Admin reports. New reports can be written as plugins and dropped in very easily. One big new report is the new course-based statistics system from Catalyst.<br />
* [[Questions]]<br />
::A centralized bank of questions with the potential to be (re-)used in a variety of modules.<br />
* [[My Moodle]]<br />
::A dashboard interface that allows an overview for each user of all their courses etc.<br />
* [[Hive integration]]<br />
::This initial integration with Hive allows teachers to upload, browse, search and select [[Resources|resources]] within the external repository.<br />
* [[Multiple groups]]<br />
::Users can be part of multiple groups within a course<br />
* [[IMS content package]] resource type<br />
::Supports the loading of any content package as a resource, with an optional repository for sharing packages between courses.<br />
* [[Course backup|Granularised backup]]<br />
* [[Chameleon|Chameleon theme]]<br />
:: An interactive Moodle theme<br />
* [[Enrolment plugins|Multi enrolment]]<br />
::Moodle's enrolment plugins can be used simultaneously on the same site. Also new [[IMS Enterprise]] enrolment plugin.<br />
*[[Authorize.net Payment Gateway]] enrolment plugin <br />
::New feature called 'Order Review'. Admins and teachers may accept or deny payments before processing the credit card and they can also refund payments after processing the credit card in 'Payment Management' page. Students may view their order details. Address Verification System (AVS) and Scheduled-Capture support added. For 'Manual-Capture' admins are notified 5 days prior to pending orders expiring.<br />
===See also===<br />
*[[:Category:Moodle 1.6|Moodle 1.6 features]]<br />
<br />
==Moodle 1.5.4==<br />
21st May, 2006<br />
<br />
(Because this release contains important security fixes, we highly advise that sites using any previous version of Moodle upgrade to this version as soon as possible.)<br />
<br />
===Various fixes===<br />
<br />
'''Security'''<br />
* Improved kses cleaning of html SC#204<br />
* Prevent unwanted password change here SC#225<br />
* Fix for Secunia Advisory SA18267, plus some logging of suspicious activity.<br />
* AdoDB tests cleanup after Secunia Advisory SA18267<br />
* Fixed $cfg->forceloginforprofiles logic SC#207. Backported from HEAD<br />
<br />
'''General'''<br />
* Various updates/improvements in the the Environmental Check allowing to check if your server suits future Moodle requirements.<br />
* Bug 4619. Fixed one DB query not following coding rules.<br />
* Bug 4607. Avoid duplication of course shortname on restore.<br />
* Fixed one problem with auto-link filters and frames.<br />
* Important fixes to muti-byte text handling routines.<br />
* Small changes to the installer.<br />
* Bug 3853. Some important improvements in the restore of log actions.<br />
* Bug 4328. Prevent some warnings in the blocks system.<br />
* Bug 4341. Extending multi-lang support to the "jumpto" menu (showed in collapsed mode).<br />
* Added rss_get_url() to 1.5 to help support data module<br />
* Added support for having a linked tab even if it is currently selected.<br />
* RSS Client block: Removed secondary cache. [http://moodle.org/bugs/bug.php?op=show&bugid=4625 Bug 4625]<br />
* Email confirmation now includes lastname. [http://moodle.org/bugs/bug.php?op=show&bugid=4869 Bug 4869]<br />
* Database connection errors can now be reported to an admin. See $CFG->emailconnectionerrors in config-dist.php.<br />
* Metacourses: Fixed a problem with self enrolment in child courses.<br />
* Several MySQL v5 compatibility fixes<br />
* Avoid listing more than 200 courses in my courses block, and course listing pages.<br />
* SCORM: Fixed lesson status skin support<br />
* Skype: Added webstatus icon<br />
* File uploads: Only create a directory if needed, [http://moodle.org/bugs/bug.php?op=show&bugid=4659 bug 4659]<br />
* Admin Block. Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4627 bug 4627]: Hide "change password" link in admin block if the user is restricted. Credits for report & patch go to Joseph Rezeau.<br />
* HTMLArea: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4562 bug 4562]. Fix posted by sgarcia.<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4626 bug 4626] - weblib.php: $course object conversion error in &quot;print_footer &quot; function<br />
* Messaging: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4621 bug 4621] errors in MySQL v3.23 with message backup.<br />
* Introducing Admin->Environment to help users assess installed software prior to the 1.6 upgrade<br />
* Course Restore: Now we avoid duplicates. [http://moodle.org/bugs/bug.php?op=show&bugid=4607 Bug 4607]<br />
* Assignment: Guests can no longer submit an online assignment. [http://moodle.org/bugs/bug.php?op=show&bugid=4604 Bug 4604]<br />
* File Downloads: Fixed problems for slow (dial up) clients, and avoid hogging memory when PHP's output compression is on.<br />
* Wiki: Supports initial load of contents from course file area. [http://moodle.org/bugs/bug.php?op=show&bugid=3830 Bug 3830]<br />
* Lesson: Now when a teacher edits a page with the "Edit page contents" button and then saves or cancels, s/he gets redirected back to the lesson navigation. This will help to streamline the editing.<br />
* Activity Modules Block - [http://moodle.org/bugs/bug.php?op=show&bugid=4586 bug 4586]<br />
* Metacourse: Fixes unenrolling [http://moodle.org/bugs/bug.php?op=show&bugid=4541 bug 4541]<br />
* File uploads: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4533 bug 4533] - Max upload size at course level ignored.<br />
* Enrol/Authorize.net: Added Address Verification System (AVS) support.<br />
* Online Users Block: Limit the number of students displayed.<br />
* Unicode Support: Typo3 Library updated to newest version.<br />
* Course Categories: Fixed courses and subcategories in an invisible category being visible. [http://moodle.org/bugs/bug.php?op=show&bugid=4074 Bug 4074]<br />
* Wiki: Fixed a fatal error updating wiki pages.<br />
* Added autocomplete=off in form tag to avoid browser autocomplete [http://moodle.org/bugs/bug.php?op=show&bugid=4423 bug:4423]<br />
* Password change: Primary administrator password can only be changed by the administraror him/herself.<br />
* Enrol/Authorize.net: Some changes:- allow_internal is not need anymore. Shows two option if enrolment key of course is set.- login_https is required for payment pages. My credit card is important. If you haven't a certificate forgot this module. (security)- Expiry date of credit card is more friendly :).<br />
* User profile: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4400 bug 4400]<br />
* Removed old THEME variable.<br />
* Added some more CSS hooks for the correctness feedback<br />
* Fix [http://moodle.org/bugs/bug.php?op=show&bugid=4366 bug 4366]<br />
* Makes autologinguest possible at site level<br />
* Micro-increment version number to 2.0.10<br />
* Corrected adjustment of relative URLs in <EMBED> tag<br />
* Merging from HEAD:Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4371 bug 4371] (also SC#199):Now manually created users with admin privileges and force change passwordcannot change their username with impunity.<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4067 bug 4067] - allow user to update assignment when not yet marked<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4314 bug 4314]<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4206 bug 4206]<br />
* Delayed merge from HEAD - If tablelib is going to do fullname voodoo, allow default sort field to be firstname/lastname<br />
* Log actions must be strored to DB without &amp;print_log() takes care of it! [http://moodle.org/bugs/bug.php?op=show&bugid=3853 Bug 3853]<br />
* Fixes [http://moodle.org/bugs/bug.php?op=show&bugid=4354 bug 4354]<br />
* shorten_text() AFTER format properly. See [http://moodle.org/bugs/bug.php?op=show&bugid=4355 bug 4355]<br />
* Prevent a warning when params is empty. [http://moodle.org/bugs/bug.php?op=show&bugid=4328 Bug 4328]<br />
* Now the section "jumpto" menu (showed in collapse mode), supportsthe multilang filter. [http://moodle.org/bugs/bug.php?op=show&bugid=4341 Bug 4341]<br />
* Print performance info if exists and $CFG->perfdebug is enabled.<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4351 bug 4351]. New parasmeter for get_record_sql to disableauto-added LIMIT (in case we are using our own)<br />
* Solved bug found when trying to backup all users! http://moodle.org/mod/forum/discuss.php?d=27105<br />
* Fixing [http://moodle.org/bugs/bug.php?op=show&bugid=4345 bug 4345]: merging problem when fixing [http://moodle.org/bugs/bug.php?op=show&bugid=4303 bug 4303]<br />
* Mimic changes from "Ought to mention the improved assignment grading!"Merged from HEAD<br />
* Ought to mention the improved assignment grading!<br />
* Fixes [http://moodle.org/bugs/bug.php?op=show&bugid=4086 bug 4086] spelling mistake<br />
* Commenting out gz_handler since it seem to cause problemsmore on http://moodle.org/mod/forum/discuss.php?d=34376<br />
<br />
'''Assignment'''<br />
* Fixed bug in "Prevent late submissions", thanks to Samuli, [http://moodle.org/bugs/bug.php?op=show&bugid=4780 bug 4780]<br />
<br />
'''Enrolment'''<br />
* Enrolment: Better explanation of flat file enrolment format. Re-formatted the imporved flat file enorlment description<br />
* Auth/LDAP: Better support for ActiveDirectory<br />
* Enrol/Authorize.net: PostgreSQL support and some indexes for speed.<br />
* Authorize.net: Address Verification System (AVS) support added.<br />
* Authorize.net: $CGF->login_https must be ON for payment pages.<br />
* Authorize.net: Shows two forms if the enrolment key of the course is set (internal and authorize forms).<br />
* Authorize.net: IIS https fix. It doesn't recognize empty($_SERVER['HTTPS']) but accepts HTTPS=off.<br />
<br />
'''Forum Module'''<br />
<br />
* Bug 4355. Solved one visualisation problem in the page showing the list of forums.<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4360 bug 4360]<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4431 bug 4431], affecting site course, added function forum_user_can_view_post in lib.php<br />
<br />
'''Glossary Module'''<br />
* Bug 4543, 4713. Fixed some problems with entries and categories containing more than one word in their title.<br />
* Bug 4858. Fixed one problem with formats, not being detected properly.<br />
* Bug 4915. Entrylist format now displays the "Send Ratings" button.<br />
<br />
'''Hotpot Module'''<br />
* Add support for HP5 quizzes (including JBC and old JQuiz)<br />
* Removed weighting from questiontext in JCloze import<br />
* Fixed import of JCloze into quiz module as a MULTIANSWER question<br />
* Fixed bug in restoring attempts from backup<br />
<br />
'''Lesson Module<br />
* Lesson: $navigation and $grade_value were undefined when lesson was added to site main page<br />
* Lesson: Lesson Essay Question Can't be Graded when attempt not finished. [http://moodle.org/bugs/bug.php?op=show&bugid=4174 Bug 4174]<br />
* Lesson: Added cancel button. [http://moodle.org/bugs/bug.php?op=show&bugid=4216 Bug 4216] - cancel button<br />
* Lesson: Fixed [http://moodle.org/mod/forum/discuss.php?d=37537 problem with storing the answerid for numerical questions].<br />
* Lesson: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=1187 bug 1187]<br />
<br />
'''Quiz Module'''<br />
<br />
* Fixed bug 4250: Added missing percentages to the grade selector<br />
* Fixed bug 4495: Don't apply lateness check when teacher previews<br />
* Fixed bug 4544: Incorrect path to exported files in some language packs<br />
* Fixed bug 4780: Bug in "Prevent late submissions" setting fixed<br />
* Fixed bug 5070: Students can't see quizzes when they are closed<br />
* Turned off regrading of quizzes that have the attemptonlast option set<br />
* A number of other minor interface fixes<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4319 bug 4319]. Thanks to Jaroslav<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4217 bug 4217]<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4829 bug 4829]<br />
* Now we avoid checking for lateness when teacher previews. [http://moodle.org/bugs/bug.php?op=show&bugid=4495 Bug 4495]<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4688 bug 4688]<br />
* [http://moodle.org/mod/forum/discuss.php?d=39548 Rounding errors could lead to "Partially correct" for correct answers]<br />
* Added missing percentages to the grade selector, [http://moodle.org/bugs/bug.php?op=show&bugid=4250 bug 4250]<br />
* Avoid error messages in case $quiz->sumgrades is zero, [http://moodle.org/bugs/bug.php?op=show&bugid=4454 bug 4454]<br />
* [http://moodle.org/mod/forum/discuss.php?d=27730#181773 get_actual_response() method for cloze question type] contributed by Jean-Michel<br />
* Better PostgreSQL support<br />
* Now With Nicer Presentation of Questions<br />
* Summary text shouldn't be cleaned as only entered by teacher.<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4345 bug 4345]. Report performance improvements caused regression with MySQLv3<br />
* Now we turn off browser-based autocomplete. Fixes [http://moodle.org/bugs/bug.php?op=show&bugid=4423 bug 4423] - Short Answer Quiz Q's Saving Form Entries<br />
<br />
'''Resource Module'''<br />
<br />
* Solved one problem on restore that was causing some links to become corrupted.<br />
* Slightly changes to the delete_instance() function in resources to allow future improvements.<br />
* Resource restore: Solved bug when [http://moodle.org/mod/forum/discuss.php?d=38801 decoding encoded links for resource]<br />
<br />
'''Wiki Module'''<br />
<br />
* Solved one problem sending double-slashed info to DB.<br />
* Bug 3830. Load of initial content from course file area is now allowed.<br />
<br />
==Moodle 1.5.3==<br />
<br />
11th November, 2005<br />
<br />
(Because this release contains important security fixes, we highly advise that sites using any previous version of Moodle upgrade to this version as soon as possible.)<br />
<br />
===A few new things===<br />
<br />
* We now have SCORM 1.3 (SCORM 2004) support!<br />
* Much improved Assignment grading interface, including "quick grading" options<br />
* A new Single-Sign-On API is available<br />
<br />
===Various fixes===<br />
<br />
'''General'''<br />
<br />
* Contains warnings when Moodle is used on an PHP configuration known to be insecure<br />
* Contains fixes for some recently reported security problems (see [http://security.moodle.org/ security.moodle.org])<br />
* Backups now runs a lot faster medium/large installs. Many issues fixed in this area<br />
* Listing of directory sizes can be made much faster on Linux/Unix servers, thanks to a performance fix you can enable from Admin->Variables: "path_to_du"<br />
* We now log more meaningful IP addresses when the server or the clients are working behind a proxy<br />
* Fixed some issues with PHP accelerators<br />
* Upgrade scripts have been refined and work much better for PostgreSQL installations<br />
* General PostgreSQL port code cleanup<br />
* Upgrading to 1.5.3 will fix any legacy Journal to Online Assignment upgrade issues<br />
* RSS libraries now support RSS 2.0 categories, see bug 3654<br />
* Better accesibilty in file uploads, see bug 3662<br />
* Better support for site-wide HTTPS, see bug 3848<br />
* We now send away bots (like Googlebot) from that try mangled URLs, see bug 3958<br />
* Better DST support for non-logged-in users<br />
* Better DST support for repeat events in Calendar<br />
* Small fixes to the lesson, choice and grade modules<br />
* Minor CSS improvements to formal_white and orangewhite themes<br />
* Better pagination in course listing and loglive pages<br />
* Fixed an IE-only bug related to HTMLArea content where user-edited tables could float and hide part of the UI.<br />
<br />
'''Authentication'''<br />
<br />
* Fixes to change password/forgotten password with external auth<br />
* Data fetched from external DB or LDAP is now truncated correctly<br />
* Fixed bug 4305 -- better login block behaviour when using secureforms<br />
* Better support for utf-8 user data from external auth<br />
* LDAP: General fixes covering sync_users script and logging of errors<br />
* LDAP: Fixed bug 3141 - Can't update external data with LDAP authentication<br />
* LDAP: Fixed bug 3992 - LDAP password including a quote does not work - credits go to Kita<br />
* LDAP: Better support for ActiveDirectory.<br />
* LDAP: Fixed bug #3594<br />
* LDAP: Better handling of multi-source field mapping<br />
* LDAP: Fix for using DN as idnumber - thanks fo Jeff Graham - http://moodle.org/mod/forum/discuss.php?d=28840<br />
<br />
'''Enrolment and metacourses'''<br />
<br />
* Metacourses: Prevent normal users to gain access to meta courses via manual enrolment<br />
* Metacourses: better support for MySQL v3.23.x<br />
* DB: Enrolment lookups now work reliably with Moodle on MySQL and Postgres<br />
* DB: Non-MySQL databases work again as external enrolment databases<br />
* LDAP: Fixed a wrong call to add_teacher in LDAP plugin.<br />
* LDAP: Servers being down or unavailable no longer prevent logins<br />
* LDAP: Course auto-creation works again<br />
* LDAP: Fixed several bugs reported by Jeff Graham and Barron Koralesky -- including bugs 3912 and 3974<br />
* LDAP: We can now bind non-anonymously to LDAP<br />
* Authorize.net: several fixes<br />
<br />
'''Resources'''<br />
<br />
* Bugfix: Avoid linking to empty or unlinkable activity names<br />
<br />
'''Forums'''<br />
<br />
* Big and small optimizations to tracking of read/unread messages, specially for PostgreSQL<br />
* Fixed some PostgreSQL bugs<br />
* Some more actions are now supported by backup/restore when processing log records, see bug 3582<br />
* Now message forum RSS feeds are including category data -- useful under some RSS agregators able to group messages, see bug 3654<br />
* Fixed paging on forum search<br />
<br />
'''Blocks'''<br />
<br />
* Several performance improvements<br />
* Fixes to the upgrade process, including PostgreSQL syntax and lower memory usage<br />
* Brought in several bugfixes from 1.6dev<br />
* Fixed bug 3478: Cannot add RSS feed as course creator<br />
* Fixed bug 3793: Prevent warning message when configuring a glossary_random block in a course which has no glossaries<br />
<br />
'''Quiz'''<br />
<br />
* Some CSS style fixes<br />
* Better compatibility with themes that contain forms in the headers<br />
* Highlighting of correct answers can now be turned off<br />
* Fixed bug 3986: Too many random questions. (mindforge)<br />
* Fixed missing action icons<br />
* Fixed bug 3899 and removed some 'missing course object' messages<br />
* Fixed bug 3950: Ee-attempt button inconsistency for multi-attempt quizzes<br />
* Fixed bug 3953: Quiz/report.php pagesize can be set to 0, credits to Jean-Michel<br />
* Fixed potential data data corruption bug 3915<br />
* Fixed bug 3884: Quiz correct highlights missing for 2 of 3 options.<br />
* Fix for the Student review highlight doesn't seem to work bug<br />
* Fixed bug 3804: Differences in question types between 1.5 and 1.6<br />
* Fixed bug 3822: don't count previews as attempts<br />
* Fixed bug 3807: Question numbering issue<br />
* Fixes for the item analysis plug-in, assembled by Jean-Michel<br />
* Now we reset the timeout counter to avoid timeouts<br />
* Several improvements contributed by Jean-Michel Vedrine. You can now change the number of attempts per page displayed on screen, and download results to Excel/text file, including detailed grades<br />
* Fixed export bug with non-English languages<br />
<br />
'''SCORM'''<br />
<br />
* We now support SCORM 1.3 (SCORM 2004)!<br />
* Fixed a bug with next and prev SCO search<br />
* Fixed bugs related to masteryscore<br />
* Fixed a problem in AICC course tracking<br />
<br />
'''Wiki'''<br />
<br />
* Now paging of older versions is showed and working properly, see bug 3750<br />
<br />
'''Filters'''<br />
<br />
* Mediaplugin filter now finds multi-line links in HTML code<br />
* Censor filter: Added original word as title to the blacked-out version. The filter can obscure actual important words by mistake (eg Dickens) and there needs to be some way to recover the meaning<br />
<br />
==Moodle 1.5.2==<br />
<br />
16th July, 2005<br />
<br />
=== Various fixes ===<br />
<br />
* Journal -> Assignment upgrade now works properly :-/<br />
* Assignment submodules now upgrade as expected<br />
* Various other bugs with new Assignments fixed<br />
* Journal module is now disabled by default on new installations<br />
* Login page is now 100% HTTPS if required<br />
* Various small standard theme tweaks<br />
* Fix for recent matching questions display bug in Quiz<br />
* Language editor no longer creates empty files when not necessary (caused country list bug)<br />
* Fixed some manifest parsing problems in SCORM module<br />
* Multilang filter now deals with pack names that contain numbers<br />
* Files are now force-downloaded (fixes IE problems and some security issues)<br />
* Relinking debugging output is escaped<br />
* Large MP3 player now displays ID3 tags properly again<br />
* Some chat daemon improvements<br />
<br />
=== Some new things ===<br />
<br />
* Orangewhite theme optimised for use on PDA<br />
* Forum user posts page can be called without userid<br />
* Altavista BabelFish now allowed in as guest when Google is<br />
<br />
==Moodle 1.5.1==<br />
<br />
8th July, 2005<br />
<br />
===Various fixes===<br />
<br />
* Several potential security problems solved<br />
* Allowobjectembed setting now works correctly<br />
* Speed problem on IE, caused by tab hover fixed.<br />
* Cut and paste in editor on Firefox has a more helpful warning message<br />
* Fixed a session problem when logged on as admin during upgrade from very old Moodle version<br />
* Fixed editing problem in Main menu of site<br />
* Minor CSS display problems in a few areas were fixed<br />
* Fixed the adding of a single discussion forum<br />
* Fixed Lesson problems with calculating grades, and dates<br />
* Fixed Lesson problems with entering a cluster after a page<br />
* Censor filter was fixed to make it work better with old themes<br />
<br />
===Some new things===<br />
<br />
* New theme: Wood<br />
* Metal theme updated for 1.5<br />
* Many language updates for most languages, including a new language: Khmer<br />
* Block classes can now run custom code when an instance is created/deleted (this is useful for blocks that need to set up non-trivial data structures)<br />
* Wizard for Calculated Questions in Quiz was rewritten<br />
* Backup/Restore module selection is now improved and much easier<br />
* Backup/Restore module has much improved relinking support, it's now faster and easier to implement in new modules<br />
<br />
==Moodle 1.5==<br />
<br />
5th June, 2005<br />
<br />
Here you can find the release notes of the current stable version of Moodle. '''If you experience any bugs in this release, please report them at [http://moodle.org/bugs moodle.org/bugs] so we can fix them in the next release.'''<br />
<br />
=== Headline features ===<br />
<br />
* Web pages are compliant with XHTML Transitional 1.0<br />
* Improved '''Accessibility''', aiming for compliance with WAI (W3C), SENDA (UK) and Section 508 (US) criteria.<br />
* Very strong '''new Themes system''', allowing cascading themes, user themes, course themes, with very fine control of every page in Moodle via CSS.<br />
* Integrated '''Messaging''' feature for direct communication between all users in the site, featuring realtime popup windows, notification, email copies, blocking, history, WYSIWYG editor, etc<br />
* Forum read/unread tracking with highlights allows you to see new postings at a glance and to control how these are displayed (per forum, per user or per site).<br />
* New '''Blocks''' system, allowing multiple copies of blocks and better block configuration<br />
* Full support for '''Daylight Savings Time''' in every locality around the globe, so everyone always see the correct local time for all events.<br />
* New '''extended gradebook''' allowing custom weighting of different activities, setting extra grades (or taking out others) and improved display and sorting options<br />
* Users can be required to agree to a '''Site Policy<br />
'''<br />
<br />
=== Other major system-wide improvements ===<br />
<br />
'''Admin'''<br />
<br />
* New "maintenance mode" allows the admin to temporarily disable a site (during upgrades, for example).<br />
* Moodle can automatically download a new list of timezones from moodle.org or elsewhere and install it to the database (Olson files are supported too)<br />
* New version of Moodle MySQL Admin module (available separately)<br />
* New calendar options page provides user interface to configure the behavior of the calendar<br />
<br />
'''Authentication'''<br />
<br />
* New Shibboleth Support<br />
* New CAS Support<br />
* New PAM Support<br />
* Improved LDAP integration, so that LDAP can now control course creation, group assignments. Increased performance and scalability performing user synchronisation.<br />
* Certain user fields can be locked by the admin when using external authentication<br />
* Improved session handling now detects "crossover" sessions that we have found in some buggy PHP installations and prevents them<br />
* Sessions can now be stored in the database (good for clustered installations!)<br />
* Users can be forced to change their password<br />
<br />
'''Files'''<br />
<br />
* Standardised file browsing in all areas<br />
* Improved uploading, with support for automated Virus scanning of new documents using ClamAV.<br />
* Slasharguments now work also on IIS (upgrade to PHP 4.3.11 needed for ISAPI)<br />
<br />
'''Filters'''<br />
<br />
* Standardised filter library makes it trivial to write new filters that require searching and highlighting of text.<br />
* Huge efficiency improvements for complex filters like the Glossary filter<br />
* New Tidy filter uses the W3C Tidy program to (optionally) clean all user-entered texts throughout the site and convert it to valid XHTML code<br />
* Improved censorship filter, now "blacks out" words using styles and uses a word list from the language packs.<br />
* Improved Flash MP3 player, now shows progress bar while downloading and playing<br />
* Improved Multi-language filter is faster, more forgiving of syntax errors, and uses new editor-friendly syntax: <span lang="en"></span><br />
* Auto-linking filters (glossary, activities) can work to link all the occurrences (old behaviour), once for each text block or only once for the whole page ($CFG->filtermatchonepertext, $CFG->filtermatchoneperpage).<br />
* More text can now be filtered in Moodle, including activity names, headings and other such small texts. This makes it possible to design completely multi-lingual sites in Moodle that fully appears in the user's chosen language.<br />
<br />
'''Themes'''<br />
<br />
* Modules can provide standard styles<br />
* Themes can override required styles of other themes<br />
* Users and courses can choose their own themes if the admin allows it<br />
* Implementation of tabs interface on many pages<br />
* Modules, Blocks and Languages can define their own standard styles<br />
<br />
'''HTML Editor'''<br />
<br />
* The toolbuttons offered in the editor toolbar are now configurable by the admin<br />
* Search and Replace text within the editor text area (with optional use of regular expressions)<br />
<br />
'''Course management'''<br />
<br />
* Transparent Blackboard 5.5 course importing (partial 6.0 support)<br />
* The new meta-courses allow to get users automatically enroled in a general course (the metacourse) when enroled in any of the metacourse-linked courses<br />
* New tool to copy content from a course to other.<br />
<br />
'''New blocks'''<br />
<br />
* HTML block: allowing to place arbitrary content (text, images links) in any course mainpage<br />
* Remote RSS feed: allows to display external news channels inside a Moodle course<br />
* Glossary Selection: to choose and display content from a Moodle glossary in course mainpage<br />
<br />
'''Calendar'''<br />
<br />
* Major speed improvements for sites with a large number of courses using groups<br />
* Repeating events can now be modified or deleted all at the same time or separately as before<br />
* New "remember filter settings" preference that allows calendar filters to remember their status between logins<br />
<br />
=== Activity module improvements ===<br />
<br />
'''Assignment'''<br />
<br />
* Completely refactored into a new class-based design, allowing new plugin-assignment types<br />
* New Online Text assignment type that doesn't require files and allows inline comments when grading - this new type effectively replaces the old Journal module<br />
* Vastly improved grading interface for handling large classes<br />
* New configuration options to disable late submission and to e-mail alerts to teachers when students submit new work<br />
<br />
'''Chat'''<br />
<br />
* Streamlined interface looks smoother, works faster, even without using the optional server daemon<br />
* Blocks can now be added to chat pages (e.g. for additional information)<br />
<br />
'''Choice'''<br />
<br />
* Rewritten to allow any number of choices<br />
* The number of users per choice can be limited, which allows it to be used as tool for "signing up" to an array of options.<br />
* You can now download the results of the choice to XLS or a TXT file<br />
<br />
'''Forum'''<br />
<br />
* Powerful new Google-like forum searching tools<br />
* Forum read/unread tracking - unread messages are highlighted on the course page, forum page, discussion listing and the discussion view<br />
* The tracking system may be disabled by teachers/users<br />
* User profiles show all posts by a user, as well as all discussions<br />
* When admins edit user messages, a notice is attached<br />
* Discussion listing shows the last user who posted to each discussion and when it was, with a direct link to that post<br />
* In group-enabled forums the discussion listing shows the group the thread applies to, with a link to the group description page.<br />
<br />
'''Glossary'''<br />
<br />
* New setting to enable/disable the print view of each glossary.<br />
* New search system looks for words everywhere (instead of doing exact phrase match).<br />
* More information is sent to logs to be able to track activity better.<br />
<br />
'''Journal'''<br />
<br />
* The Journal module has not changed since 1.4, and is now deprecated. The upgrade procedure will convert all your Journal activities into Online Assignments, and hide all the old Journal activities. If you don't want this to happen, then define this in your config.php: $CFG->noconvertjournals = true;<br />
<br />
'''Lesson'''<br />
<br />
* Now supports timed Lessons<br />
* Can create practice Lessons (grades are not stored)<br />
* Option for students to view points earned while taking the Lesson<br />
* Allow students to review their answers before submitting the Lesson<br />
* New Slide Show Mode (only branch tables are displayed as slides)<br />
* New Left Menu (for enabled branch tables only)<br />
* Lessons can now be Password Protected<br />
* A Tree View can be used for the Lesson creation screen<br />
* Students can post their high scores<br />
* New option to save a Lesson's settings as defaults for new lessons in the same course<br />
* Can delete a student's attempts<br />
* New page Jumps:<br />
** Previous Page<br />
** Unseen question within a branch<br />
** Random question within a branch<br />
** Unseen question within a cluster<br />
* Added functionality to view Lesson statistics<br />
* New question type: Essay. Teachers can view each essay and write comments, assign a grade, and then email it all to the student<br />
* New question creation interface<br />
<br />
'''Quiz'''<br />
<br />
* Can handle adaptive questions, i.e., questions that allow the student to interact with them repeatedly within the same quiz attempt and that can change in response to student answers.<br />
* Student can be allowed to try a question again immediately within the same quiz attempt until they get the answer right.<br />
* There is a penalty mechanism that deducts a specified fraction of the mark for each wrong attempt at a question.<br />
* Allows questions rendered and scored externally (e.g., by mathematical assessment engines) to be integrated seamlessly into Moodle quizzes via the RQP web services protocol.<br />
* Is prepared for the handling of IMS QTI questions once web services for these become available.<br />
* New tabbed teacher interface for previewing, editing, and reviewing quizzes.<br />
* New "improved security" mode shows quiz in a separate full-screen window, with many browser features disabled<br />
* Quizzes can be presented to students in several pages. The number of questions per page is selectable by the teacher.<br />
* Blocks can now be added to quiz pages (to show results table, or additional information etc)<br />
* Better and cleaner interface for question selection and management in the database. Selected questions can be added to quiz, moved to other categories or deleted en mass.<br />
* Random questions are now added to the quiz question list with a dedicated button, leaving a cleaner interface at questions database without phantom placeholders<br />
* Final grade can be a fractional number, with teacher-defined decimal figures<br />
* Improved results page with user-selectable display of columns, cleaner sorting and new mark display options<br />
* Questions can be edited with one click from the improved quiz preview and question preview screens.<br />
* Questions can be copied with one click, to allow question variations to be created with ease.<br />
* Revamped question categories structures and editing interface.<br />
* Categories now can contain nested subcategories and can be re-ordered.<br />
* It is possible to select whether questions from categories, and or their subcategories are displayed on the question edit page.<br />
* It is now possible to select whether to add random questions from a parent category alone, or from a parent category and its sub-categories.<br />
* Quiz creators are prevented from changing the question set of quizes that have had student responses.<br />
* Recognition, and rejection, of overlapping/redundant questions has been improved.<br />
* The display of questions in longer quiz categories on the quiz editing page is now paginated.<br />
* New export types - IMS QTI (2.0) and xhtml. Improvements & fixes to others.<br />
* New import type - Hot Potato. Improvements & fixes to others.<br />
<br />
'''Scorm'''<br />
<br />
* The module is now fully conformant with the SCORM 1.2 standard.<br />
* User result data storage and reporting was improved.<br />
* AICC packages can now be imported.<br />
<br />
'''Survey'''<br />
<br />
* Graph formatting has been improved (labels are more readable)<br />
<br />
'''Wiki'''<br />
<br />
* Changes to wiki pages are now monitored and displayed in Recent Activity block<br />
* Several under the hood improvements to backup/restore and other routines that enhance the reliability of wikis<br />
<br />
== See also ==<br />
<br />
*[[Old releases|1.4.5 release notes]]<br />
<br />
[[Category:Core]]<br />
[[Category:Administrator]]<br />
<br />
[[pt:Versões do Moodle]]<br />
[[es:Notas de versiones]]<br />
[[fr:Notes de mise à jour]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Latest_release_notes&diff=16906Latest release notes2006-10-10T09:39:37Z<p>Danstowell: /* Moodle 1.6.3 */ Changed subheadings to make it clear to non-techies that the bugs are fixed ;)</p>
<hr />
<div>{{About Moodle}}<br />
<br />
<br />
==Moodle 1.7==<br />
<br />
Under final test phase, release expected soon. Moodle 1.7 Beta is now available from CVS or the [http://download.moodle.org Moodle download page]. This version is not recommended for production sites yet.<br />
<br />
[http://tracker.moodle.org/secure/ReleaseNote.jspa?version=10120&styleName=Html&projectId=10011&Create=Create This page shows details about issues resolved in this version]<br />
<br />
===Headline features===<br />
<br />
* [[Roles]]<br />
:: Permissions based on fine-grained capabilities allow all kinds of roles to be created and assigned in all contexts around Moodle. This creates a great deal more flexibility in the permissions that you can grant to people.<br />
* [[XML database schema]]<br />
:: added support for MS-SQL and Oracle with more databases to come. Developers now have just one XML file to edit when changing the database structure, and there is even a very funky editor for this file built-in to Moodle<br />
* New Admin interface<br />
:: Completely new admin interface, with accessible design and cool features to make access to settings fast and easy.<br />
* AJAX Course editing<br />
:: The Topics and Weekly course formats now feature AJAX editing which means you can drag drop blocks, activities and sections (weeks/topics) and it all happens instantly. No more page reloading!<br />
* [[Unit tests|Unit testing framework]]<br />
:: Making it easier for developers to write test code, which should ultimately lead to a more reliable Moodle.<br />
<br />
<br />
===Other improvements===<br />
<br />
* Improvements to the [[Database module]]<br />
**Template/Field settings can now be saved as Presets and shared across a site.<br />
**Presets are just zip files, and can also be shared between sites.<br />
**Moodle 1.7 comes with one sample preset (an Image Gallery) with more to come.<br />
<br />
* Improvements to the [[Lesson module]]<br />
**Now has a more unified view of lesson screens.<br />
**Teacher editing:<br />
***Collapsed view has a nicer format, displays more information regarding each page and allows the creation of new pages.<br />
***Editing is now speedier by replacing 3 second redirect delays with a notification system.<br />
**New feature: display default feedback.<br />
***Default is '''On''' so previous lessons behave as before.<br />
***Description: if no ''response'' is entered for a question answer and this setting is turned '''Off''', then the user skips the feedback page.<br />
**Graceful degrade of JavaScript.<br />
**Several bug fixes.<br />
<br />
* Improvements to the [[Quiz module]]<br />
:* The teacher can configure comments that are displayed to the student at the end of their attempt, with the comment displayed depending on the student's score.<br />
<br />
* Improvements to some core question types<br />
:* All question types can now have some general feedback. This is displayed to all students after they have finished the question (depending on the quiz settings) and does not depend on what response the student gave. Use this to tell the student what the question was about, or link them to more information about the topic it covers.<br />
:* [[Matching question type|Matching]] questions can have extra wrong answers, and work when two questions have the same answer.<br />
:* [[Multiple Choice question type|Multiple Choice]] questions can have feedback for the whole question, as well as specific answers. This is particularly useful for multiple-response questions.<br />
:* [[Numerical question type|Numerical]] questions can have different answers with different precisions and scores. (Previously this was only supported via GIFT import. Now you can edit questions like this.)<br />
<br />
==Moodle 1.6.3==<br />
10th October, 2006<br />
<br />
[http://tracker.moodle.org/secure/ReleaseNote.jspa?version=10140&styleName=Text&projectId=10011 Full details of these issues can be found in the tracker]<br />
<br />
===Security Bugfix===<br />
* A vulnerability was discovered that could allow SQL injections if a parameter was improperly used. Full details of this particular issue are on the [http://security.moodle.org/ Moodle Security site]. All registered Moodle admins were notified by direct email on Saturday September 30th.<br />
<br />
===General Bugs Fixed===<br />
* [MDL-3048] - Release note should note not to use some PHP versions<br />
* [MDL-3805] - mod.html in NEWMODULE.zip is not XHTML1.0 Transitional compliant<br />
* [MDL-5378] - shorten_text doesn't work for oriental languages<br />
* [MDL-5601] - cloze question restore error problem<br />
* [MDL-5884] - Turn Student View On<br />
* [MDL-5893] - Blackboard export/backup course does not restore to Moodle correctly<br />
* [MDL-6084] - Restore to new course failure notice if logged in as course creator<br />
* [MDL-6128] - 1.6, special chars and messaging system.<br />
* [MDL-6193] - problem with login/index.php file<br />
* [MDL-6205] - slashes not stripped when re-editing profile<br />
* [MDL-6224] - Syntax error creating tables on install<br />
* [MDL-6247] - Error checking for missing themes<br />
* [MDL-6271] - breadcrumb problem<br />
* [MDL-6272] - DB Enrolment not recording enrolment end date<br />
* [MDL-6334] - Unnecessary group menu in Feedback popup window<br />
* [MDL-6336] - After utf8-migration unserializing of old essay fails<br />
* [MDL-6341] - "Student view" locks out designers/administrators from courses not available to students<br />
* [MDL-6342] - cannot move forum post to other forum when the subject includes an apostrophe<br />
* [MDL-6363] - typo in mod/forum/restorelib.php prevents grouped discussions from being accessible to group after a restore.<br />
* [MDL-6375] - Uploaded assignments are not available from the student submission page once graded<br />
* [MDL-6480] - Import of multichoice questions in Moodle XML format doesn't use shuffle option. Fix included<br />
* [MDL-6517] - Adding or editing post produces "ERROR: invalid input syntax for integer: "Object id #XXX"<br />
* [MDL-6518] - How to make new themes link no longer required<br />
* [MDL-6521] - Single discussion forums can be splitted and it hasn't too much sense....<br />
* [MDL-6537] - past students receive email from forum<br />
* [MDL-6538] - Bug in hotpot upgrade script 1.6.1 -> 1.6.2 with MetaColumns() method<br />
* [MDL-6615] - Highlighting search terms in forum search text posts fails<br />
* [MDL-6632] - scorm_grade_user function in locallib.php file has errors<br />
* [MDL-6649] - HTML Editor in Quiz Essay Question unreliable<br />
* [MDL-6686] - Streamed Chat Locks Send Message Field<br />
* [MDL-6750] - change_password.php produces JS error.<br />
* [MDL-6754] - moodle.php in de_utf8 langpack has wrong locale<br />
* [MDL-6757] - Insert a Chinese charachter string to label resource result error.<br />
* [MDL-6770] - Student cannot see handed-in assignment<br />
* [MDL-6791] - Streamed Chat JS bug Prevents Use<br />
* [MDL-6824] - redundant style declaration in theme<br />
* [MDL-6837] - Make a language file entry for the wording of popup blocker checker<br />
* [MDL-6841] - Student View button fails when course is hidden to students<br />
* [MDL-6842] - Resource frameset error in IE6<br />
* [MDL-6866] - A required parameter (backup_unique_code) was missing" error<br />
* [MDL-6876] - Grades computed incorrectly if assignment name appears more than twice in a course<br />
<br />
===Improvement===<br />
* [MDL-6280] - Backup files should not be included in new backups<br />
* [MDL-6572] - Allow students to access their uploaded documents after grading.<br />
* [MDL-6662] - why footer with margin-top: 100px<br />
* [MDL-6878] - Scalable Vector Graphics (SVG) files in Moodle are not correctly displayed in many Browsers<br />
<br />
===New Feature===<br />
* [MDL-5653] - add blacklisted level into environment XML<br />
<br />
==Moodle 1.6.2==<br />
12th September, 2006<br />
<br />
===Security===<br />
* Fixed handling of uploaded files in Database module<br />
* Module instance id is now properly validated when creating course module object; developers should use get_coursemodule_from_id() to get valid $cm<br />
* Default error reporting level was lowered to 5, E_WARNINGs are no longer displayed on production sites with debug off.<br />
* Multiple problems leading to information leakage fixed in help.php file<br />
* Fixed information leakage from scheduled backups<br />
* Added basic detection of dataroot accessible from Internet, web installer now better suggests dataroot location outside of web file area<br />
* Swf is now disabled by default in Mediaplugin<br />
* forgot_password.php does not allow remote email or username enumeration by default, the old behavior can be enabled by setting protectusernames to No in site configuration<br />
* Undisclosed SQL injections fixed by automatic data conversions in adodb layer<br />
* Theoretical XSS problems fixed in doc/index.php and files/index.php scripts<br />
* Access to tex and algebra files is blocked when filters are disabled<br />
* Request for redirection in jumpto.php protected with sesskey<br />
<br />
===Bug Fixes===<br />
<br />
* Fixed error when upgrading forum read tracking<br />
* Locales from language packs should finally work - please check your configuration variables and empty the locale field<br />
* Added missing link for course request<br />
* Fixed several glossary problems with non-ascii characters<br />
* Fixed bug where you could not regrade a quiz question where the teacher had added a comment with a ' character.<br />
* Quiz import of BlackBoard V6 files now much more reliable<br />
* Fixed scheduled backups - they were broken in 1.6 and 1.6.1<br />
* Fixed missing guest icons from course listing<br />
* Database sessions respect sessiontimeout setting<br />
* Fixed redirect problems during upgrade resulting in "Table xxx already exists"<br />
* Lesson module: the "(Continue)" no longer displays for 3 seconds after branch tables.<br />
* Lesson module: now properly checks import formats for support.<br />
* Lesson module: feedback is set properly during the import process.<br />
* and many other smaller fixes<br />
<br />
===New Features===<br />
<br />
* Authorize.net Payment Gateway: Autoconfigures credit card types if the merchant does not accept some types of credit cards<br />
<br />
===Known Problems===<br />
* Broken images in published question categories<br />
<br />
==Moodle 1.6.1==<br />
20th July, 2006<br />
<br />
===Bug Fixes===<br />
<br />
* Fixed regression in Turkish locale handling<br />
* Authorize and Paypal enrolment plugin cleanup<br />
* Fixed serious problem with failing Database restore<br />
* Fixed restore of HotPot module containing attempts<br />
* Minor Database module fixes<br />
* National characters in graphs now work for most languages out of the box<br />
* Reviewed and fixed all *nix locale codes in language packs<br />
* Fixed problems when using Resources with Blocks on the frontpage<br />
* Fixed missing events on the first day of month in calendar<br />
* Fixed several problems in Lesson - scores, branch tables, HTML editor issues<br />
* Fixed broken intermodule relinking of absolute paths - please do not use course backups from original 1.6<br />
* PDF byteserving problems caused by incorrect partial content length solved<br />
* Fixed several regressions in handling of multiple groups<br />
* Fixed alphabet problems in Glossary<br />
* Chameleon theme fixes and enhancements<br />
* Fixed all hard coded admin paths<br />
* Fixed moving of course sections<br />
* Fixed grading of Essays in Quiz<br />
* Several Quiz regrading problems solved<br />
* Questions are now exported into backupdata directory<br />
* Added workaround for problems when editting two quizes in one browser<br />
* Lots of other Quiz related bugs fixed - thanks Tim!<br />
<br />
* Fixed IE unsecure items warning on sites with https login<br />
* Improved cookie test on the login page<br />
* Potential security issue with unzipping maliciously-crafted zip files fixed<br />
* Satinized input parameters in help.php<br />
* Calendar view.php now respects forcelogin setting<br />
<br />
* And lots of other minor fixes worth upgrading<br />
<br />
===New Features===<br />
<br />
* Enhanced frontpage settings - frontpage can now be different for logged in users, changed category list display<br />
* Improved administration page layout<br />
* Possibility to change graph font for all locales - moodledata/lang/default.ttf takes precedence over lib/default.ttf<br />
* Local language packs may also contain default.ttf<br />
* Backported improved lang.php from HEAD<br />
* New config.php option $CFG->allowvisiblecoursesinhiddencategories<br />
<br />
===Known Problems===<br />
<br />
* Broken images in published question categories<br />
* Small number of sites reports problems with Quiz upgrade - please always do a full database backup before any upgrade!<br />
<br />
===Related===<br />
<br />
* Third party modules should be already updated for 1.6.x - you must install new versions before UTF-8 migration!<br />
* New integration of phpMyAdmin available - fixes upstream security problems and compatiblility with PHP 5<br />
<br />
==Moodle 1.6==<br />
19th June, 2006<br />
<br />
NOTE: Moodle 1.6 requires PHP 4.3.0 (or PHP 5.1.0) and MySQL 4.1.16 (4.1.12 if you use latin languages only). Here is more info on [[Upgrading to Moodle 1.6]].<br />
<br />
===New features===<br />
<br />
* [[UTF-8 migration|Unicode]]<br />
::Moodle is now 100% Unicode, which means any language can be mixed together and an end to a number of problems that different character sets caused us.<br />
* [[MoodleDocs development|Documentation]]<br />
::A new one-stop wiki site for ALL Moodle documentation, including links from Moodle itself<br />
* [[Database module]]<br />
::A new activity module that allows collaborative collection of structured data, useful for many things!<br />
* [[LAMS]]<br />
::Integrated via a course format and an activity module<br />
* [[Blogs]]<br />
::Allows reflection on an ongoing basis. Entries are marked and can be viewed by user, course, group, site etc. Contains first new support for [[Tags]]. <br />
* [[Reports]]<br />
::All reports are now centralised under Course reports and Admin reports. New reports can be written as plugins and dropped in very easily. One big new report is the new course-based statistics system from Catalyst.<br />
* [[Questions]]<br />
::A centralized bank of questions with the potential to be (re-)used in a variety of modules.<br />
* [[My Moodle]]<br />
::A dashboard interface that allows an overview for each user of all their courses etc.<br />
* [[Hive integration]]<br />
::This initial integration with Hive allows teachers to upload, browse, search and select [[Resources|resources]] within the external repository.<br />
* [[Multiple groups]]<br />
::Users can be part of multiple groups within a course<br />
* [[IMS content package]] resource type<br />
::Supports the loading of any content package as a resource, with an optional repository for sharing packages between courses.<br />
* [[Course backup|Granularised backup]]<br />
* [[Chameleon|Chameleon theme]]<br />
:: An interactive Moodle theme<br />
* [[Enrolment plugins|Multi enrolment]]<br />
::Moodle's enrolment plugins can be used simultaneously on the same site. Also new [[IMS Enterprise]] enrolment plugin.<br />
*[[Authorize.net Payment Gateway]] enrolment plugin <br />
::New feature called 'Order Review'. Admins and teachers may accept or deny payments before processing the credit card and they can also refund payments after processing the credit card in 'Payment Management' page. Students may view their order details. Address Verification System (AVS) and Scheduled-Capture support added. For 'Manual-Capture' admins are notified 5 days prior to pending orders expiring.<br />
===See also===<br />
*[[:Category:Moodle 1.6|Moodle 1.6 features]]<br />
<br />
==Moodle 1.5.4==<br />
21st May, 2006<br />
<br />
(Because this release contains important security fixes, we highly advise that sites using any previous version of Moodle upgrade to this version as soon as possible.)<br />
<br />
===Various fixes===<br />
<br />
'''Security'''<br />
* Improved kses cleaning of html SC#204<br />
* Prevent unwanted password change here SC#225<br />
* Fix for Secunia Advisory SA18267, plus some logging of suspicious activity.<br />
* AdoDB tests cleanup after Secunia Advisory SA18267<br />
* Fixed $cfg->forceloginforprofiles logic SC#207. Backported from HEAD<br />
<br />
'''General'''<br />
* Various updates/improvements in the the Environmental Check allowing to check if your server suits future Moodle requirements.<br />
* Bug 4619. Fixed one DB query not following coding rules.<br />
* Bug 4607. Avoid duplication of course shortname on restore.<br />
* Fixed one problem with auto-link filters and frames.<br />
* Important fixes to muti-byte text handling routines.<br />
* Small changes to the installer.<br />
* Bug 3853. Some important improvements in the restore of log actions.<br />
* Bug 4328. Prevent some warnings in the blocks system.<br />
* Bug 4341. Extending multi-lang support to the "jumpto" menu (showed in collapsed mode).<br />
* Added rss_get_url() to 1.5 to help support data module<br />
* Added support for having a linked tab even if it is currently selected.<br />
* RSS Client block: Removed secondary cache. [http://moodle.org/bugs/bug.php?op=show&bugid=4625 Bug 4625]<br />
* Email confirmation now includes lastname. [http://moodle.org/bugs/bug.php?op=show&bugid=4869 Bug 4869]<br />
* Database connection errors can now be reported to an admin. See $CFG->emailconnectionerrors in config-dist.php.<br />
* Metacourses: Fixed a problem with self enrolment in child courses.<br />
* Several MySQL v5 compatibility fixes<br />
* Avoid listing more than 200 courses in my courses block, and course listing pages.<br />
* SCORM: Fixed lesson status skin support<br />
* Skype: Added webstatus icon<br />
* File uploads: Only create a directory if needed, [http://moodle.org/bugs/bug.php?op=show&bugid=4659 bug 4659]<br />
* Admin Block. Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4627 bug 4627]: Hide "change password" link in admin block if the user is restricted. Credits for report & patch go to Joseph Rezeau.<br />
* HTMLArea: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4562 bug 4562]. Fix posted by sgarcia.<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4626 bug 4626] - weblib.php: $course object conversion error in &quot;print_footer &quot; function<br />
* Messaging: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4621 bug 4621] errors in MySQL v3.23 with message backup.<br />
* Introducing Admin->Environment to help users assess installed software prior to the 1.6 upgrade<br />
* Course Restore: Now we avoid duplicates. [http://moodle.org/bugs/bug.php?op=show&bugid=4607 Bug 4607]<br />
* Assignment: Guests can no longer submit an online assignment. [http://moodle.org/bugs/bug.php?op=show&bugid=4604 Bug 4604]<br />
* File Downloads: Fixed problems for slow (dial up) clients, and avoid hogging memory when PHP's output compression is on.<br />
* Wiki: Supports initial load of contents from course file area. [http://moodle.org/bugs/bug.php?op=show&bugid=3830 Bug 3830]<br />
* Lesson: Now when a teacher edits a page with the "Edit page contents" button and then saves or cancels, s/he gets redirected back to the lesson navigation. This will help to streamline the editing.<br />
* Activity Modules Block - [http://moodle.org/bugs/bug.php?op=show&bugid=4586 bug 4586]<br />
* Metacourse: Fixes unenrolling [http://moodle.org/bugs/bug.php?op=show&bugid=4541 bug 4541]<br />
* File uploads: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4533 bug 4533] - Max upload size at course level ignored.<br />
* Enrol/Authorize.net: Added Address Verification System (AVS) support.<br />
* Online Users Block: Limit the number of students displayed.<br />
* Unicode Support: Typo3 Library updated to newest version.<br />
* Course Categories: Fixed courses and subcategories in an invisible category being visible. [http://moodle.org/bugs/bug.php?op=show&bugid=4074 Bug 4074]<br />
* Wiki: Fixed a fatal error updating wiki pages.<br />
* Added autocomplete=off in form tag to avoid browser autocomplete [http://moodle.org/bugs/bug.php?op=show&bugid=4423 bug:4423]<br />
* Password change: Primary administrator password can only be changed by the administraror him/herself.<br />
* Enrol/Authorize.net: Some changes:- allow_internal is not need anymore. Shows two option if enrolment key of course is set.- login_https is required for payment pages. My credit card is important. If you haven't a certificate forgot this module. (security)- Expiry date of credit card is more friendly :).<br />
* User profile: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4400 bug 4400]<br />
* Removed old THEME variable.<br />
* Added some more CSS hooks for the correctness feedback<br />
* Fix [http://moodle.org/bugs/bug.php?op=show&bugid=4366 bug 4366]<br />
* Makes autologinguest possible at site level<br />
* Micro-increment version number to 2.0.10<br />
* Corrected adjustment of relative URLs in <EMBED> tag<br />
* Merging from HEAD:Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4371 bug 4371] (also SC#199):Now manually created users with admin privileges and force change passwordcannot change their username with impunity.<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4067 bug 4067] - allow user to update assignment when not yet marked<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4314 bug 4314]<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4206 bug 4206]<br />
* Delayed merge from HEAD - If tablelib is going to do fullname voodoo, allow default sort field to be firstname/lastname<br />
* Log actions must be strored to DB without &amp;print_log() takes care of it! [http://moodle.org/bugs/bug.php?op=show&bugid=3853 Bug 3853]<br />
* Fixes [http://moodle.org/bugs/bug.php?op=show&bugid=4354 bug 4354]<br />
* shorten_text() AFTER format properly. See [http://moodle.org/bugs/bug.php?op=show&bugid=4355 bug 4355]<br />
* Prevent a warning when params is empty. [http://moodle.org/bugs/bug.php?op=show&bugid=4328 Bug 4328]<br />
* Now the section "jumpto" menu (showed in collapse mode), supportsthe multilang filter. [http://moodle.org/bugs/bug.php?op=show&bugid=4341 Bug 4341]<br />
* Print performance info if exists and $CFG->perfdebug is enabled.<br />
* Fix for [http://moodle.org/bugs/bug.php?op=show&bugid=4351 bug 4351]. New parasmeter for get_record_sql to disableauto-added LIMIT (in case we are using our own)<br />
* Solved bug found when trying to backup all users! http://moodle.org/mod/forum/discuss.php?d=27105<br />
* Fixing [http://moodle.org/bugs/bug.php?op=show&bugid=4345 bug 4345]: merging problem when fixing [http://moodle.org/bugs/bug.php?op=show&bugid=4303 bug 4303]<br />
* Mimic changes from "Ought to mention the improved assignment grading!"Merged from HEAD<br />
* Ought to mention the improved assignment grading!<br />
* Fixes [http://moodle.org/bugs/bug.php?op=show&bugid=4086 bug 4086] spelling mistake<br />
* Commenting out gz_handler since it seem to cause problemsmore on http://moodle.org/mod/forum/discuss.php?d=34376<br />
<br />
'''Assignment'''<br />
* Fixed bug in "Prevent late submissions", thanks to Samuli, [http://moodle.org/bugs/bug.php?op=show&bugid=4780 bug 4780]<br />
<br />
'''Enrolment'''<br />
* Enrolment: Better explanation of flat file enrolment format. Re-formatted the imporved flat file enorlment description<br />
* Auth/LDAP: Better support for ActiveDirectory<br />
* Enrol/Authorize.net: PostgreSQL support and some indexes for speed.<br />
* Authorize.net: Address Verification System (AVS) support added.<br />
* Authorize.net: $CGF->login_https must be ON for payment pages.<br />
* Authorize.net: Shows two forms if the enrolment key of the course is set (internal and authorize forms).<br />
* Authorize.net: IIS https fix. It doesn't recognize empty($_SERVER['HTTPS']) but accepts HTTPS=off.<br />
<br />
'''Forum Module'''<br />
<br />
* Bug 4355. Solved one visualisation problem in the page showing the list of forums.<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4360 bug 4360]<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4431 bug 4431], affecting site course, added function forum_user_can_view_post in lib.php<br />
<br />
'''Glossary Module'''<br />
* Bug 4543, 4713. Fixed some problems with entries and categories containing more than one word in their title.<br />
* Bug 4858. Fixed one problem with formats, not being detected properly.<br />
* Bug 4915. Entrylist format now displays the "Send Ratings" button.<br />
<br />
'''Hotpot Module'''<br />
* Add support for HP5 quizzes (including JBC and old JQuiz)<br />
* Removed weighting from questiontext in JCloze import<br />
* Fixed import of JCloze into quiz module as a MULTIANSWER question<br />
* Fixed bug in restoring attempts from backup<br />
<br />
'''Lesson Module<br />
* Lesson: $navigation and $grade_value were undefined when lesson was added to site main page<br />
* Lesson: Lesson Essay Question Can't be Graded when attempt not finished. [http://moodle.org/bugs/bug.php?op=show&bugid=4174 Bug 4174]<br />
* Lesson: Added cancel button. [http://moodle.org/bugs/bug.php?op=show&bugid=4216 Bug 4216] - cancel button<br />
* Lesson: Fixed [http://moodle.org/mod/forum/discuss.php?d=37537 problem with storing the answerid for numerical questions].<br />
* Lesson: Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=1187 bug 1187]<br />
<br />
'''Quiz Module'''<br />
<br />
* Fixed bug 4250: Added missing percentages to the grade selector<br />
* Fixed bug 4495: Don't apply lateness check when teacher previews<br />
* Fixed bug 4544: Incorrect path to exported files in some language packs<br />
* Fixed bug 4780: Bug in "Prevent late submissions" setting fixed<br />
* Fixed bug 5070: Students can't see quizzes when they are closed<br />
* Turned off regrading of quizzes that have the attemptonlast option set<br />
* A number of other minor interface fixes<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4319 bug 4319]. Thanks to Jaroslav<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4217 bug 4217]<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4829 bug 4829]<br />
* Now we avoid checking for lateness when teacher previews. [http://moodle.org/bugs/bug.php?op=show&bugid=4495 Bug 4495]<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4688 bug 4688]<br />
* [http://moodle.org/mod/forum/discuss.php?d=39548 Rounding errors could lead to "Partially correct" for correct answers]<br />
* Added missing percentages to the grade selector, [http://moodle.org/bugs/bug.php?op=show&bugid=4250 bug 4250]<br />
* Avoid error messages in case $quiz->sumgrades is zero, [http://moodle.org/bugs/bug.php?op=show&bugid=4454 bug 4454]<br />
* [http://moodle.org/mod/forum/discuss.php?d=27730#181773 get_actual_response() method for cloze question type] contributed by Jean-Michel<br />
* Better PostgreSQL support<br />
* Now With Nicer Presentation of Questions<br />
* Summary text shouldn't be cleaned as only entered by teacher.<br />
* Fixed [http://moodle.org/bugs/bug.php?op=show&bugid=4345 bug 4345]. Report performance improvements caused regression with MySQLv3<br />
* Now we turn off browser-based autocomplete. Fixes [http://moodle.org/bugs/bug.php?op=show&bugid=4423 bug 4423] - Short Answer Quiz Q's Saving Form Entries<br />
<br />
'''Resource Module'''<br />
<br />
* Solved one problem on restore that was causing some links to become corrupted.<br />
* Slightly changes to the delete_instance() function in resources to allow future improvements.<br />
* Resource restore: Solved bug when [http://moodle.org/mod/forum/discuss.php?d=38801 decoding encoded links for resource]<br />
<br />
'''Wiki Module'''<br />
<br />
* Solved one problem sending double-slashed info to DB.<br />
* Bug 3830. Load of initial content from course file area is now allowed.<br />
<br />
==Moodle 1.5.3==<br />
<br />
11th November, 2005<br />
<br />
(Because this release contains important security fixes, we highly advise that sites using any previous version of Moodle upgrade to this version as soon as possible.)<br />
<br />
===A few new things===<br />
<br />
* We now have SCORM 1.3 (SCORM 2004) support!<br />
* Much improved Assignment grading interface, including "quick grading" options<br />
* A new Single-Sign-On API is available<br />
<br />
===Various fixes===<br />
<br />
'''General'''<br />
<br />
* Contains warnings when Moodle is used on an PHP configuration known to be insecure<br />
* Contains fixes for some recently reported security problems (see [http://security.moodle.org/ security.moodle.org])<br />
* Backups now runs a lot faster medium/large installs. Many issues fixed in this area<br />
* Listing of directory sizes can be made much faster on Linux/Unix servers, thanks to a performance fix you can enable from Admin->Variables: "path_to_du"<br />
* We now log more meaningful IP addresses when the server or the clients are working behind a proxy<br />
* Fixed some issues with PHP accelerators<br />
* Upgrade scripts have been refined and work much better for PostgreSQL installations<br />
* General PostgreSQL port code cleanup<br />
* Upgrading to 1.5.3 will fix any legacy Journal to Online Assignment upgrade issues<br />
* RSS libraries now support RSS 2.0 categories, see bug 3654<br />
* Better accesibilty in file uploads, see bug 3662<br />
* Better support for site-wide HTTPS, see bug 3848<br />
* We now send away bots (like Googlebot) from that try mangled URLs, see bug 3958<br />
* Better DST support for non-logged-in users<br />
* Better DST support for repeat events in Calendar<br />
* Small fixes to the lesson, choice and grade modules<br />
* Minor CSS improvements to formal_white and orangewhite themes<br />
* Better pagination in course listing and loglive pages<br />
* Fixed an IE-only bug related to HTMLArea content where user-edited tables could float and hide part of the UI.<br />
<br />
'''Authentication'''<br />
<br />
* Fixes to change password/forgotten password with external auth<br />
* Data fetched from external DB or LDAP is now truncated correctly<br />
* Fixed bug 4305 -- better login block behaviour when using secureforms<br />
* Better support for utf-8 user data from external auth<br />
* LDAP: General fixes covering sync_users script and logging of errors<br />
* LDAP: Fixed bug 3141 - Can't update external data with LDAP authentication<br />
* LDAP: Fixed bug 3992 - LDAP password including a quote does not work - credits go to Kita<br />
* LDAP: Better support for ActiveDirectory.<br />
* LDAP: Fixed bug #3594<br />
* LDAP: Better handling of multi-source field mapping<br />
* LDAP: Fix for using DN as idnumber - thanks fo Jeff Graham - http://moodle.org/mod/forum/discuss.php?d=28840<br />
<br />
'''Enrolment and metacourses'''<br />
<br />
* Metacourses: Prevent normal users to gain access to meta courses via manual enrolment<br />
* Metacourses: better support for MySQL v3.23.x<br />
* DB: Enrolment lookups now work reliably with Moodle on MySQL and Postgres<br />
* DB: Non-MySQL databases work again as external enrolment databases<br />
* LDAP: Fixed a wrong call to add_teacher in LDAP plugin.<br />
* LDAP: Servers being down or unavailable no longer prevent logins<br />
* LDAP: Course auto-creation works again<br />
* LDAP: Fixed several bugs reported by Jeff Graham and Barron Koralesky -- including bugs 3912 and 3974<br />
* LDAP: We can now bind non-anonymously to LDAP<br />
* Authorize.net: several fixes<br />
<br />
'''Resources'''<br />
<br />
* Bugfix: Avoid linking to empty or unlinkable activity names<br />
<br />
'''Forums'''<br />
<br />
* Big and small optimizations to tracking of read/unread messages, specially for PostgreSQL<br />
* Fixed some PostgreSQL bugs<br />
* Some more actions are now supported by backup/restore when processing log records, see bug 3582<br />
* Now message forum RSS feeds are including category data -- useful under some RSS agregators able to group messages, see bug 3654<br />
* Fixed paging on forum search<br />
<br />
'''Blocks'''<br />
<br />
* Several performance improvements<br />
* Fixes to the upgrade process, including PostgreSQL syntax and lower memory usage<br />
* Brought in several bugfixes from 1.6dev<br />
* Fixed bug 3478: Cannot add RSS feed as course creator<br />
* Fixed bug 3793: Prevent warning message when configuring a glossary_random block in a course which has no glossaries<br />
<br />
'''Quiz'''<br />
<br />
* Some CSS style fixes<br />
* Better compatibility with themes that contain forms in the headers<br />
* Highlighting of correct answers can now be turned off<br />
* Fixed bug 3986: Too many random questions. (mindforge)<br />
* Fixed missing action icons<br />
* Fixed bug 3899 and removed some 'missing course object' messages<br />
* Fixed bug 3950: Ee-attempt button inconsistency for multi-attempt quizzes<br />
* Fixed bug 3953: Quiz/report.php pagesize can be set to 0, credits to Jean-Michel<br />
* Fixed potential data data corruption bug 3915<br />
* Fixed bug 3884: Quiz correct highlights missing for 2 of 3 options.<br />
* Fix for the Student review highlight doesn't seem to work bug<br />
* Fixed bug 3804: Differences in question types between 1.5 and 1.6<br />
* Fixed bug 3822: don't count previews as attempts<br />
* Fixed bug 3807: Question numbering issue<br />
* Fixes for the item analysis plug-in, assembled by Jean-Michel<br />
* Now we reset the timeout counter to avoid timeouts<br />
* Several improvements contributed by Jean-Michel Vedrine. You can now change the number of attempts per page displayed on screen, and download results to Excel/text file, including detailed grades<br />
* Fixed export bug with non-English languages<br />
<br />
'''SCORM'''<br />
<br />
* We now support SCORM 1.3 (SCORM 2004)!<br />
* Fixed a bug with next and prev SCO search<br />
* Fixed bugs related to masteryscore<br />
* Fixed a problem in AICC course tracking<br />
<br />
'''Wiki'''<br />
<br />
* Now paging of older versions is showed and working properly, see bug 3750<br />
<br />
'''Filters'''<br />
<br />
* Mediaplugin filter now finds multi-line links in HTML code<br />
* Censor filter: Added original word as title to the blacked-out version. The filter can obscure actual important words by mistake (eg Dickens) and there needs to be some way to recover the meaning<br />
<br />
==Moodle 1.5.2==<br />
<br />
16th July, 2005<br />
<br />
=== Various fixes ===<br />
<br />
* Journal -> Assignment upgrade now works properly :-/<br />
* Assignment submodules now upgrade as expected<br />
* Various other bugs with new Assignments fixed<br />
* Journal module is now disabled by default on new installations<br />
* Login page is now 100% HTTPS if required<br />
* Various small standard theme tweaks<br />
* Fix for recent matching questions display bug in Quiz<br />
* Language editor no longer creates empty files when not necessary (caused country list bug)<br />
* Fixed some manifest parsing problems in SCORM module<br />
* Multilang filter now deals with pack names that contain numbers<br />
* Files are now force-downloaded (fixes IE problems and some security issues)<br />
* Relinking debugging output is escaped<br />
* Large MP3 player now displays ID3 tags properly again<br />
* Some chat daemon improvements<br />
<br />
=== Some new things ===<br />
<br />
* Orangewhite theme optimised for use on PDA<br />
* Forum user posts page can be called without userid<br />
* Altavista BabelFish now allowed in as guest when Google is<br />
<br />
==Moodle 1.5.1==<br />
<br />
8th July, 2005<br />
<br />
===Various fixes===<br />
<br />
* Several potential security problems solved<br />
* Allowobjectembed setting now works correctly<br />
* Speed problem on IE, caused by tab hover fixed.<br />
* Cut and paste in editor on Firefox has a more helpful warning message<br />
* Fixed a session problem when logged on as admin during upgrade from very old Moodle version<br />
* Fixed editing problem in Main menu of site<br />
* Minor CSS display problems in a few areas were fixed<br />
* Fixed the adding of a single discussion forum<br />
* Fixed Lesson problems with calculating grades, and dates<br />
* Fixed Lesson problems with entering a cluster after a page<br />
* Censor filter was fixed to make it work better with old themes<br />
<br />
===Some new things===<br />
<br />
* New theme: Wood<br />
* Metal theme updated for 1.5<br />
* Many language updates for most languages, including a new language: Khmer<br />
* Block classes can now run custom code when an instance is created/deleted (this is useful for blocks that need to set up non-trivial data structures)<br />
* Wizard for Calculated Questions in Quiz was rewritten<br />
* Backup/Restore module selection is now improved and much easier<br />
* Backup/Restore module has much improved relinking support, it's now faster and easier to implement in new modules<br />
<br />
==Moodle 1.5==<br />
<br />
5th June, 2005<br />
<br />
Here you can find the release notes of the current stable version of Moodle. '''If you experience any bugs in this release, please report them at [http://moodle.org/bugs moodle.org/bugs] so we can fix them in the next release.'''<br />
<br />
=== Headline features ===<br />
<br />
* Web pages are compliant with XHTML Transitional 1.0<br />
* Improved '''Accessibility''', aiming for compliance with WAI (W3C), SENDA (UK) and Section 508 (US) criteria.<br />
* Very strong '''new Themes system''', allowing cascading themes, user themes, course themes, with very fine control of every page in Moodle via CSS.<br />
* Integrated '''Messaging''' feature for direct communication between all users in the site, featuring realtime popup windows, notification, email copies, blocking, history, WYSIWYG editor, etc<br />
* Forum read/unread tracking with highlights allows you to see new postings at a glance and to control how these are displayed (per forum, per user or per site).<br />
* New '''Blocks''' system, allowing multiple copies of blocks and better block configuration<br />
* Full support for '''Daylight Savings Time''' in every locality around the globe, so everyone always see the correct local time for all events.<br />
* New '''extended gradebook''' allowing custom weighting of different activities, setting extra grades (or taking out others) and improved display and sorting options<br />
* Users can be required to agree to a '''Site Policy<br />
'''<br />
<br />
=== Other major system-wide improvements ===<br />
<br />
'''Admin'''<br />
<br />
* New "maintenance mode" allows the admin to temporarily disable a site (during upgrades, for example).<br />
* Moodle can automatically download a new list of timezones from moodle.org or elsewhere and install it to the database (Olson files are supported too)<br />
* New version of Moodle MySQL Admin module (available separately)<br />
* New calendar options page provides user interface to configure the behavior of the calendar<br />
<br />
'''Authentication'''<br />
<br />
* New Shibboleth Support<br />
* New CAS Support<br />
* New PAM Support<br />
* Improved LDAP integration, so that LDAP can now control course creation, group assignments. Increased performance and scalability performing user synchronisation.<br />
* Certain user fields can be locked by the admin when using external authentication<br />
* Improved session handling now detects "crossover" sessions that we have found in some buggy PHP installations and prevents them<br />
* Sessions can now be stored in the database (good for clustered installations!)<br />
* Users can be forced to change their password<br />
<br />
'''Files'''<br />
<br />
* Standardised file browsing in all areas<br />
* Improved uploading, with support for automated Virus scanning of new documents using ClamAV.<br />
* Slasharguments now work also on IIS (upgrade to PHP 4.3.11 needed for ISAPI)<br />
<br />
'''Filters'''<br />
<br />
* Standardised filter library makes it trivial to write new filters that require searching and highlighting of text.<br />
* Huge efficiency improvements for complex filters like the Glossary filter<br />
* New Tidy filter uses the W3C Tidy program to (optionally) clean all user-entered texts throughout the site and convert it to valid XHTML code<br />
* Improved censorship filter, now "blacks out" words using styles and uses a word list from the language packs.<br />
* Improved Flash MP3 player, now shows progress bar while downloading and playing<br />
* Improved Multi-language filter is faster, more forgiving of syntax errors, and uses new editor-friendly syntax: <span lang="en"></span><br />
* Auto-linking filters (glossary, activities) can work to link all the occurrences (old behaviour), once for each text block or only once for the whole page ($CFG->filtermatchonepertext, $CFG->filtermatchoneperpage).<br />
* More text can now be filtered in Moodle, including activity names, headings and other such small texts. This makes it possible to design completely multi-lingual sites in Moodle that fully appears in the user's chosen language.<br />
<br />
'''Themes'''<br />
<br />
* Modules can provide standard styles<br />
* Themes can override required styles of other themes<br />
* Users and courses can choose their own themes if the admin allows it<br />
* Implementation of tabs interface on many pages<br />
* Modules, Blocks and Languages can define their own standard styles<br />
<br />
'''HTML Editor'''<br />
<br />
* The toolbuttons offered in the editor toolbar are now configurable by the admin<br />
* Search and Replace text within the editor text area (with optional use of regular expressions)<br />
<br />
'''Course management'''<br />
<br />
* Transparent Blackboard 5.5 course importing (partial 6.0 support)<br />
* The new meta-courses allow to get users automatically enroled in a general course (the metacourse) when enroled in any of the metacourse-linked courses<br />
* New tool to copy content from a course to other.<br />
<br />
'''New blocks'''<br />
<br />
* HTML block: allowing to place arbitrary content (text, images links) in any course mainpage<br />
* Remote RSS feed: allows to display external news channels inside a Moodle course<br />
* Glossary Selection: to choose and display content from a Moodle glossary in course mainpage<br />
<br />
'''Calendar'''<br />
<br />
* Major speed improvements for sites with a large number of courses using groups<br />
* Repeating events can now be modified or deleted all at the same time or separately as before<br />
* New "remember filter settings" preference that allows calendar filters to remember their status between logins<br />
<br />
=== Activity module improvements ===<br />
<br />
'''Assignment'''<br />
<br />
* Completely refactored into a new class-based design, allowing new plugin-assignment types<br />
* New Online Text assignment type that doesn't require files and allows inline comments when grading - this new type effectively replaces the old Journal module<br />
* Vastly improved grading interface for handling large classes<br />
* New configuration options to disable late submission and to e-mail alerts to teachers when students submit new work<br />
<br />
'''Chat'''<br />
<br />
* Streamlined interface looks smoother, works faster, even without using the optional server daemon<br />
* Blocks can now be added to chat pages (e.g. for additional information)<br />
<br />
'''Choice'''<br />
<br />
* Rewritten to allow any number of choices<br />
* The number of users per choice can be limited, which allows it to be used as tool for "signing up" to an array of options.<br />
* You can now download the results of the choice to XLS or a TXT file<br />
<br />
'''Forum'''<br />
<br />
* Powerful new Google-like forum searching tools<br />
* Forum read/unread tracking - unread messages are highlighted on the course page, forum page, discussion listing and the discussion view<br />
* The tracking system may be disabled by teachers/users<br />
* User profiles show all posts by a user, as well as all discussions<br />
* When admins edit user messages, a notice is attached<br />
* Discussion listing shows the last user who posted to each discussion and when it was, with a direct link to that post<br />
* In group-enabled forums the discussion listing shows the group the thread applies to, with a link to the group description page.<br />
<br />
'''Glossary'''<br />
<br />
* New setting to enable/disable the print view of each glossary.<br />
* New search system looks for words everywhere (instead of doing exact phrase match).<br />
* More information is sent to logs to be able to track activity better.<br />
<br />
'''Journal'''<br />
<br />
* The Journal module has not changed since 1.4, and is now deprecated. The upgrade procedure will convert all your Journal activities into Online Assignments, and hide all the old Journal activities. If you don't want this to happen, then define this in your config.php: $CFG->noconvertjournals = true;<br />
<br />
'''Lesson'''<br />
<br />
* Now supports timed Lessons<br />
* Can create practice Lessons (grades are not stored)<br />
* Option for students to view points earned while taking the Lesson<br />
* Allow students to review their answers before submitting the Lesson<br />
* New Slide Show Mode (only branch tables are displayed as slides)<br />
* New Left Menu (for enabled branch tables only)<br />
* Lessons can now be Password Protected<br />
* A Tree View can be used for the Lesson creation screen<br />
* Students can post their high scores<br />
* New option to save a Lesson's settings as defaults for new lessons in the same course<br />
* Can delete a student's attempts<br />
* New page Jumps:<br />
** Previous Page<br />
** Unseen question within a branch<br />
** Random question within a branch<br />
** Unseen question within a cluster<br />
* Added functionality to view Lesson statistics<br />
* New question type: Essay. Teachers can view each essay and write comments, assign a grade, and then email it all to the student<br />
* New question creation interface<br />
<br />
'''Quiz'''<br />
<br />
* Can handle adaptive questions, i.e., questions that allow the student to interact with them repeatedly within the same quiz attempt and that can change in response to student answers.<br />
* Student can be allowed to try a question again immediately within the same quiz attempt until they get the answer right.<br />
* There is a penalty mechanism that deducts a specified fraction of the mark for each wrong attempt at a question.<br />
* Allows questions rendered and scored externally (e.g., by mathematical assessment engines) to be integrated seamlessly into Moodle quizzes via the RQP web services protocol.<br />
* Is prepared for the handling of IMS QTI questions once web services for these become available.<br />
* New tabbed teacher interface for previewing, editing, and reviewing quizzes.<br />
* New "improved security" mode shows quiz in a separate full-screen window, with many browser features disabled<br />
* Quizzes can be presented to students in several pages. The number of questions per page is selectable by the teacher.<br />
* Blocks can now be added to quiz pages (to show results table, or additional information etc)<br />
* Better and cleaner interface for question selection and management in the database. Selected questions can be added to quiz, moved to other categories or deleted en mass.<br />
* Random questions are now added to the quiz question list with a dedicated button, leaving a cleaner interface at questions database without phantom placeholders<br />
* Final grade can be a fractional number, with teacher-defined decimal figures<br />
* Improved results page with user-selectable display of columns, cleaner sorting and new mark display options<br />
* Questions can be edited with one click from the improved quiz preview and question preview screens.<br />
* Questions can be copied with one click, to allow question variations to be created with ease.<br />
* Revamped question categories structures and editing interface.<br />
* Categories now can contain nested subcategories and can be re-ordered.<br />
* It is possible to select whether questions from categories, and or their subcategories are displayed on the question edit page.<br />
* It is now possible to select whether to add random questions from a parent category alone, or from a parent category and its sub-categories.<br />
* Quiz creators are prevented from changing the question set of quizes that have had student responses.<br />
* Recognition, and rejection, of overlapping/redundant questions has been improved.<br />
* The display of questions in longer quiz categories on the quiz editing page is now paginated.<br />
* New export types - IMS QTI (2.0) and xhtml. Improvements & fixes to others.<br />
* New import type - Hot Potato. Improvements & fixes to others.<br />
<br />
'''Scorm'''<br />
<br />
* The module is now fully conformant with the SCORM 1.2 standard.<br />
* User result data storage and reporting was improved.<br />
* AICC packages can now be imported.<br />
<br />
'''Survey'''<br />
<br />
* Graph formatting has been improved (labels are more readable)<br />
<br />
'''Wiki'''<br />
<br />
* Changes to wiki pages are now monitored and displayed in Recent Activity block<br />
* Several under the hood improvements to backup/restore and other routines that enhance the reliability of wikis<br />
<br />
== See also ==<br />
<br />
*[[Old releases|1.4.5 release notes]]<br />
<br />
[[Category:Core]]<br />
[[Category:Administrator]]<br />
<br />
[[pt:Versões do Moodle]]<br />
[[es:Notas de versiones]]<br />
[[fr:Notes de mise à jour]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=IMS&diff=16307IMS2006-09-25T19:20:19Z<p>Danstowell: </p>
<hr />
<div>IMS is a standards body. IMS standards implemented in Moodle include:<br />
<br />
* [[IMS Enterprise]] enrolment data plugin<br />
** Also IMS Enterprise Web Services, to be developed as an early application of Moodle's [[Web Services API]]<br />
* [[IMS content package|IMS content packaging]]<br />
* IMS Learning Design - Moodle 2.0 is [[Roadmap|planned]] to conform to this standard<br />
* IMS QTI - for exchanging questions and tests between systems<br />
<br />
==See also==<br />
<br />
* [http://imsglobal.org/ IMS official website]<br />
<br />
<br />
{{disambig}}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=IMS&diff=16306IMS2006-09-25T19:18:52Z<p>Danstowell: </p>
<hr />
<div>IMS is a standards body. IMS standards implemented in Moodle include:<br />
<br />
* [[IMS Enterprise]] enrolment data plugin<br />
** Also IMS Enterprise Web Services, to be developed as an early application of Moodle's [[Web Services API]]<br />
* [[IMS content package|IMS content packaging]]<br />
* IMS Learning Design - Moodle 2.0 is planned to conform to this standard<br />
* IMS QTI - for exchanging questions and tests between systems<br />
<br />
==See also==<br />
<br />
* [http://imsglobal.org/ IMS official website]<br />
<br />
<br />
{{disambig}}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=IMS&diff=16305IMS2006-09-25T19:18:18Z<p>Danstowell: Created disambiguation page in case people type "IMS" in search box</p>
<hr />
<div>IMS is a standards body. IMS standards implemented in Moodle include:<br />
<br />
* [[IMS Enterprise]] enrolment data plugin<br />
** Also IMS Enterprise Web Services, to be developed as an early application of Moodle's [[Web Services API]]<br />
* [[IMS content package|IMS content packaging]]<br />
* IMS Learning Design - Moodle 2.0 is planned to conform to this standard<br />
* IMS QTI - for exchanging questions and tests between systems<br />
<br />
{{disambig}}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Performance_recommendations&diff=15889Performance recommendations2006-09-15T13:53:50Z<p>Danstowell: /* Web server performance */</p>
<hr />
<div>Moodle can be made to perform very well, at small usage levels or scaling up to many thousands of users. The factors involved in performance are basically the same as for any PHP-based database-driven system, and Moodle's design (with clear separation of application layers) allows for strongly scalable setups. (Please check the list of [[Large installations|large Moodle installations]].)<br />
<br />
Large sites usually separate the web server and database onto separate servers, although for smaller installations this is typically not necessary.<br />
<br />
It is possible to load-balance a Moodle installation, for example by using more than one webserver. The separate webservers should query the same database and refer to the same filestore area, but otherwise the separation of the application layers is complete enough to make this kind of clustering feasible. Similarly, the database could be a cluster of servers (e.g. a MySQL cluster).<br />
<br />
:::The above comment makes it sound easy to run a database cluster. It is not. It is easy to run the webservers in cluster with LVM and other solutions. The only "easy" cluster database is MySQL Cluster and there are several issues with it. --[[User:Martin Langhoff|Martin Langhoff]] 18:53, 31 August 2006 (CDT)<br />
<br />
==Web server performance==<br />
<br />
* The amount of '''RAM''' on your web server is the strongest factor in performance - get as much as possible (eg 4GB).<br />
* Linux or Unix is the recommended '''operating system''' for the server. They perform much better than Mac OSX or Windows servers at high loads.<br />
* You are strongly recommended to use a '''PHP accelerator''' to ease CPU load, such as Turck MMCache, PHPA or eAccelerator. (Take care to choose a PHP accelerator that is known to work well with your version of PHP etc.)<br />
* Performance of PHP is better when installed as an Apache module (rather than a CGI).<br />
* On a Unix/Linux system, performance can be greatly improved by allowing the webserver to use the system '''zip/unzip''' commands (rather than PHP-based zip libraries) - visit Admin/Configure/Variables and enter the path to the relevant executables. (Similarly, filling in the path to '''du''' will improve Moodle's speed at listing directory contents.)<br />
* Note that using '''secure web connections''' ('''https''' rather than '''http''') carries a higher processing burden, both for the webserver and the client - particularly because cacheing cannot be used as effectively, so the number of file requests is likely to increase dramatically. For this reason using https for all Moodle pages is not recommended. You can enable https just for the login screen, simply from Moodle's config page.<br />
* You can increase performance by using the light-weight webserver [http://www.lighttpd.org/ lighttpd] in combination with PHP in fastCGI-mode instead of Apache, due to much lower memory consumption. One single apache process requires more RAM than the whole lighttpd with all of its fastCGI-processes together. Note that this may not be a good solution if you can afford lots of hardware power, because administration takes a little more time.<br />
* Consider lowering MaxRequestsPerChild in httpd.conf to as low as 20-30 (if you set it any lower the overhead of forking begins to outweigh the benefits). Also check the memory_limit in php.ini, reduce it to at least 16M. ([http://moodle.org/mod/forum/discuss.php?d=39656 Suggested by Rory Allford])<br />
<br />
==Database performance==<br />
<br />
* [[Arguments in favour of PostgreSQL]]<br />
* [[Increasing the database connection lifetime]]<br />
* [http://dev.mysql.com/doc/refman/5.0/en/server-parameters.html Tuning MySQL parameters] (advice from the MySQL manual)<br />
<br />
==Performance of different Moodle modules==<br />
<br />
Moodle's activity modules, filters, and other plugins can be activated/deactivated. If necessary, you may wish to deactivate some features (such as chat) if not required - but this isn't necessary. Some notes on the performance of certain modules:<br />
<br />
* The '''Chat''' module is [http://moodle.org/mod/forum/discuss.php?d=37979&parent=175079 said] to be a hog in terms of frequent HTTP requests to the main server. This can be reduced by setting the module to use ''Streamed'' updates, or, if you're using a Unix-based webserver, by running the chat in daemon mode.<br />
* [http://moodle.org/mod/forum/discuss.php?d=25616&parent=120770 Brief report on performance for 55 students simultaneously using '''Quiz''']<br />
* The Moodle '''cron''' task is triggered by calling the script ''cron.php''. If this is called over HTTP (e.g. using wget or curl) it can take a large amount of memory on large installations. If it is called by directly invoking the php command (e.g. ''php -f /path/to/moodle/directory/admin/cron.php'') efficiency can be much improved.<br />
* Having too many filters active can have serious effects on server load, especially on lower-end systems. The number of active filters has a direct effect on the perceived latency of your site; that is the time taken for each page impression. For best performance, leave the text cache enabled and do not "Filter all strings" unless you have a specific need. If in doubt [[Performance profiling|profile the performance]], and see how your changes affect the processing time.<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/view.php?f=94 Servers and Performance] forum<br />
<br />
[[Category:Administrator]]<br />
[[Category:Performance]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Performance_recommendations&diff=15888Performance recommendations2006-09-15T13:53:29Z<p>Danstowell: /* Web server performance */</p>
<hr />
<div>Moodle can be made to perform very well, at small usage levels or scaling up to many thousands of users. The factors involved in performance are basically the same as for any PHP-based database-driven system, and Moodle's design (with clear separation of application layers) allows for strongly scalable setups. (Please check the list of [[Large installations|large Moodle installations]].)<br />
<br />
Large sites usually separate the web server and database onto separate servers, although for smaller installations this is typically not necessary.<br />
<br />
It is possible to load-balance a Moodle installation, for example by using more than one webserver. The separate webservers should query the same database and refer to the same filestore area, but otherwise the separation of the application layers is complete enough to make this kind of clustering feasible. Similarly, the database could be a cluster of servers (e.g. a MySQL cluster).<br />
<br />
:::The above comment makes it sound easy to run a database cluster. It is not. It is easy to run the webservers in cluster with LVM and other solutions. The only "easy" cluster database is MySQL Cluster and there are several issues with it. --[[User:Martin Langhoff|Martin Langhoff]] 18:53, 31 August 2006 (CDT)<br />
<br />
==Web server performance==<br />
<br />
* The amount of '''RAM''' on your web server is the strongest factor in performance - get as much as possible (eg 4GB).<br />
* Linux or Unix is the recommended '''operating system''' for the server. They perform much better than Mac OSX or Windows servers at high loads.<br />
* You are strongly recommended to use a '''PHP accelerator''' to ease CPU load, such as [http://turck-mmcache.sourceforge.net/ Turck MMCache] or PHPA or eAccelerator. (Take care to choose a PHP accelerator that is known to work well with your version of PHP etc.)<br />
* Performance of PHP is better when installed as an Apache module (rather than a CGI).<br />
* On a Unix/Linux system, performance can be greatly improved by allowing the webserver to use the system '''zip/unzip''' commands (rather than PHP-based zip libraries) - visit Admin/Configure/Variables and enter the path to the relevant executables. (Similarly, filling in the path to '''du''' will improve Moodle's speed at listing directory contents.)<br />
* Note that using '''secure web connections''' ('''https''' rather than '''http''') carries a higher processing burden, both for the webserver and the client - particularly because cacheing cannot be used as effectively, so the number of file requests is likely to increase dramatically. For this reason using https for all Moodle pages is not recommended. You can enable https just for the login screen, simply from Moodle's config page.<br />
* You can increase performance by using the light-weight webserver [http://www.lighttpd.org/ lighttpd] in combination with PHP in fastCGI-mode instead of Apache, due to much lower memory consumption. One single apache process requires more RAM than the whole lighttpd with all of its fastCGI-processes together. Note that this may not be a good solution if you can afford lots of hardware power, because administration takes a little more time.<br />
* Consider lowering MaxRequestsPerChild in httpd.conf to as low as 20-30 (if you set it any lower the overhead of forking begins to outweigh the benefits). Also check the memory_limit in php.ini, reduce it to at least 16M. ([http://moodle.org/mod/forum/discuss.php?d=39656 Suggested by Rory Allford])<br />
<br />
==Database performance==<br />
<br />
* [[Arguments in favour of PostgreSQL]]<br />
* [[Increasing the database connection lifetime]]<br />
* [http://dev.mysql.com/doc/refman/5.0/en/server-parameters.html Tuning MySQL parameters] (advice from the MySQL manual)<br />
<br />
==Performance of different Moodle modules==<br />
<br />
Moodle's activity modules, filters, and other plugins can be activated/deactivated. If necessary, you may wish to deactivate some features (such as chat) if not required - but this isn't necessary. Some notes on the performance of certain modules:<br />
<br />
* The '''Chat''' module is [http://moodle.org/mod/forum/discuss.php?d=37979&parent=175079 said] to be a hog in terms of frequent HTTP requests to the main server. This can be reduced by setting the module to use ''Streamed'' updates, or, if you're using a Unix-based webserver, by running the chat in daemon mode.<br />
* [http://moodle.org/mod/forum/discuss.php?d=25616&parent=120770 Brief report on performance for 55 students simultaneously using '''Quiz''']<br />
* The Moodle '''cron''' task is triggered by calling the script ''cron.php''. If this is called over HTTP (e.g. using wget or curl) it can take a large amount of memory on large installations. If it is called by directly invoking the php command (e.g. ''php -f /path/to/moodle/directory/admin/cron.php'') efficiency can be much improved.<br />
* Having too many filters active can have serious effects on server load, especially on lower-end systems. The number of active filters has a direct effect on the perceived latency of your site; that is the time taken for each page impression. For best performance, leave the text cache enabled and do not "Filter all strings" unless you have a specific need. If in doubt [[Performance profiling|profile the performance]], and see how your changes affect the processing time.<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/view.php?f=94 Servers and Performance] forum<br />
<br />
[[Category:Administrator]]<br />
[[Category:Performance]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Template:Large_Installations&diff=15885Template:Large Installations2006-09-15T11:11:04Z<p>Danstowell: Removed the "these lists are new" message</p>
<hr />
<div>{| width=85% align=center style="background: #F8EABA; border: 1px solid #aaa; margin: 0 auto 10px auto; text-align: center;" <br />
| style="font-size: 90%; padding-right: 4px; padding-left: 4px;"|<br />
::[[Installations 1000 plus]] - [[Installations 5000 plus]] - [[Installations 10000 plus]]<br />
|}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=User:Dan_Stowell&diff=15353User:Dan Stowell2006-09-04T10:27:32Z<p>Danstowell: </p>
<hr />
<div>I've been developing bits and bobs for Moodle for a while - for example:<br />
<br />
* '''In Moodle core:'''<br />
** [[IMS Enterprise]] enrolment module<br />
** [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] for database activity<br />
* '''Optional add-ins:'''<br />
** [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] voice messaging tool<br />
** [[Jmol filter]]<br />
** [[Jmol resource type]]<br />
** [http://moodle.org/mod/data/view.php?d=13&rid=296 Java Molecular Editor question type]<br />
** [[WebCT migration]] scripts<br />
<br />
If you want to know more about me you might like to look at [http://www.mcld.co.uk/cv/quick/ my CV]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=User:Dan_Stowell&diff=15351User:Dan Stowell2006-09-04T10:24:37Z<p>Danstowell: </p>
<hr />
<div>I've been developing bits and bobs for Moodle for a while - for example:<br />
<br />
* '''In Moodle core:'''<br />
** [[IMS Enterprise]] enrolment module<br />
** [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] for database activity<br />
* '''Optional add-ins:'''<br />
** [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] voice messaging tool<br />
** [[Jmol filter]]<br />
** [[Jmol resource type]]<br />
** [[WebCT migration]] scripts<br />
<br />
If you want to know more about me you might like to look at [http://www.mcld.co.uk/cv/quick/ my CV]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=User:Dan_Stowell&diff=15350User:Dan Stowell2006-09-04T10:23:44Z<p>Danstowell: </p>
<hr />
<div>I've been developing bits and bobs for Moodle for a while - for example:<br />
<br />
* In Moodle core:<br />
** [[IMS Enterprise]] enrolment module<br />
** [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] for database activity<br />
* Optional add-ins<br />
** [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] voice messaging tool<br />
** [[Jmol filter]]<br />
** [[Jmol resource type]]<br />
** [[WebCT migration]] scripts<br />
<br />
If you want to know more about me you might like to look at [http://www.mcld.co.uk/cv/quick/ my CV]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=User:Dan_Stowell&diff=15349User:Dan Stowell2006-09-04T10:22:51Z<p>Danstowell: </p>
<hr />
<div>I've been developing bits and bobs for Moodle for a while - for example:<br />
<br />
* [[IMS Enterprise]] enrolment module<br />
* [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] voice messaging tool<br />
* [[Jmol filter]]<br />
* [[Jmol resource type]]<br />
* [[WebCT migration]] scripts<br />
* [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] for database activity<br />
<br />
If you want to know more about me you might like to look at [http://www.mcld.co.uk/cv/quick/ my CV]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=User:Dan_Stowell&diff=15348User:Dan Stowell2006-09-04T10:18:15Z<p>Danstowell: </p>
<hr />
<div>I've been developing bits and bobs for Moodle for a while - for example:<br />
<br />
* [[IMS Enterprise]] enrolment module<br />
* [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] voice messaging tool<br />
* [[Jmol filter]]<br />
* [[Jmol resource type]]<br />
* [[WebCT migration]] scripts<br />
<br />
If you want to know more about me you might like to look at [http://www.mcld.co.uk/cv/quick/ my CV]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Roadmap&diff=15052Roadmap2006-08-29T11:08:39Z<p>Danstowell: /* Version 2.0 - Expected early 2007 */</p>
<hr />
<div>This roadmap collects the best information about upcoming features in Moodle. It is not 100% certain - features may change according to available funding and developers.<br />
<br />
== Version 1.7 - Expected September 2006 ==<br />
<br />
* [[Roles]] - Moodle.com<br />
::This new system will allow the creation of custom roles at site, course and activity level<br />
* [[XML Database Schema]] - Moodle.com <br />
::Conversion to full database independence using new XML schema for ADOdb. This will give us support for MS SQL, Oracle etc.<br />
* New admin interface with admin plugins<br />
* New AJAX course format (drag and drop!)<br />
* Database module can now save and load presets (fields and templates in a package).<br />
* [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] - Dan Stowell<br />
::A new field type for database activities, storing geographic locations, with integrated links with [http://earth.google.com Google Earth], [http://www.openstreetmap.org/ OpenStreetMap], and more.<br />
* Assorted quiz and question type improvements, as listed in the [[Release Notes|release notes]].<br />
<br />
== Version 1.8 - Expected December 2006 ==<br />
<br />
* [[Accessibility]] - Moodle.com <br />
::Full compliance with all major accessibility standards<br />
* [[Repository API]] - Open University<br />
::Abstract all file operations to an API that allows plugins for different external repositories<br />
* [[Gradebook]] - Arab Open University<br />
::The gradebook system will be revamped for performance, switching from our older "pull" model to a "push" model where all modules will now publish grades as necessary into a central table.<br />
* [[Multi Authentication]] - Iñaki Arenaza?<br />
* [[Learning Design export]] - Moodle.com and Open University of The Netherlands<br />
::We plan to have a very simple export for any Moodle course into IMS LD format, as a proof of concept and to help the community start learning about IMS LD.<br />
<br />
<br />
== Version 2.0 - Expected early 2007 ==<br />
<br />
* [[IMS Learning Design]] - Moodle.com<br />
::Support for importing/exporting LD, converting Moodle activities and sequences of activities into a standard format for sharing, and importing standard sequences into Moodle courses<br />
* [[Conditional activities]] - Moodle.com<br />
::Allowing dependencies and forced paths through the content<br />
* [[Metadata]] - Moodle.com<br />
::Build on the keywords in 1.6 to provide metadata for all activities and courses, linkable to standard lists of metadata such as State-based learning outomes and curricula<br />
* [[Web Services API]]<br />
::Providing remote control and access of Moodle services by other systems, as well as sharing of information between Moodle sites with trust relationships.<br />
* [[Student Information API]]<br />
::API for integrating external systems for managing student information<br />
* [[Community hub]] - Moodle.com <br />
::Leverage above improvements into a system to network Moodles together<br />
<br />
''Note: Moodle 2.0 will require PHP 5.1 as a minimum, because of certain improvements not available in PHP 4.''<br />
<br />
== Version 2.1 ==<br />
<br />
* [[Site groups|Groups]] <br />
::Groups can also be defined at the site level, and activities can be assigned to course groups<br />
* [[Portfolio API]]<br />
::Interface Moodle activities and repositories to help produce portfolios for internal assessment AND external publication<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
[[es:Planificación]]<br />
[[fr:Planification]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Roadmap&diff=15051Roadmap2006-08-29T11:06:55Z<p>Danstowell: /* Version 2.0 - Expected early 2007 */ Added note re PHP 5</p>
<hr />
<div>This roadmap collects the best information about upcoming features in Moodle. It is not 100% certain - features may change according to available funding and developers.<br />
<br />
== Version 1.7 - Expected September 2006 ==<br />
<br />
* [[Roles]] - Moodle.com<br />
::This new system will allow the creation of custom roles at site, course and activity level<br />
* [[XML Database Schema]] - Moodle.com <br />
::Conversion to full database independence using new XML schema for ADOdb. This will give us support for MS SQL, Oracle etc.<br />
* New admin interface with admin plugins<br />
* New AJAX course format (drag and drop!)<br />
* Database module can now save and load presets (fields and templates in a package).<br />
* [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] - Dan Stowell<br />
::A new field type for database activities, storing geographic locations, with integrated links with [http://earth.google.com Google Earth], [http://www.openstreetmap.org/ OpenStreetMap], and more.<br />
* Assorted quiz and question type improvements, as listed in the [[Release Notes|release notes]].<br />
<br />
== Version 1.8 - Expected December 2006 ==<br />
<br />
* [[Accessibility]] - Moodle.com <br />
::Full compliance with all major accessibility standards<br />
* [[Repository API]] - Open University<br />
::Abstract all file operations to an API that allows plugins for different external repositories<br />
* [[Gradebook]] - Arab Open University<br />
::The gradebook system will be revamped for performance, switching from our older "pull" model to a "push" model where all modules will now publish grades as necessary into a central table.<br />
* [[Multi Authentication]] - Iñaki Arenaza?<br />
* [[Learning Design export]] - Moodle.com and Open University of The Netherlands<br />
::We plan to have a very simple export for any Moodle course into IMS LD format, as a proof of concept and to help the community start learning about IMS LD.<br />
<br />
<br />
== Version 2.0 - Expected early 2007 ==<br />
<br />
* [[IMS Learning Design]] - Moodle.com<br />
::Support for importing/exporting LD, converting Moodle activities and sequences of activities into a standard format for sharing, and importing standard sequences into Moodle courses<br />
* [[Conditional activities]] - Moodle.com<br />
::Allowing dependencies and forced paths through the content<br />
* [[Metadata]] - Moodle.com<br />
::Build on the keywords in 1.6 to provide metadata for all activities and courses, linkable to standard lists of metadata such as State-based learning outomes and curricula<br />
* [[Web Services API]]<br />
::Providing remote control and access of Moodle services by other systems, as well as sharing of information between Moodle sites with trust relationships.<br />
* [[Student Information API]]<br />
::API for integrating external systems for managing student information<br />
* [[Community hub]] - Moodle.com <br />
::Leverage above improvements into a system to network Moodles together<br />
<br />
''Note:'' Moodle 2.0 will require PHP 5.1 as a minimum, because of certain improvements not available in PHP 4.<br />
<br />
== Version 2.1 ==<br />
<br />
* [[Site groups|Groups]] <br />
::Groups can also be defined at the site level, and activities can be assigned to course groups<br />
* [[Portfolio API]]<br />
::Interface Moodle activities and repositories to help produce portfolios for internal assessment AND external publication<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
[[es:Planificación]]<br />
[[fr:Planification]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Assign_roles&diff=15021Assign roles2006-08-28T09:45:31Z<p>Danstowell: </p>
<hr />
<div>To assign a role to another user, first choose the type of role you wish to assign. For example, if we wanted to assign a Course Creator role to Ali, we'd choose "Course Creator" from the drop-down list. ("Course Creator" is one of the default role types that comes with Moodle - your installation may have a modified set of roles.)<br />
<br />
Once you have selected a role, two lists appear: the list of users who currently have that role, and the list of users who don't. We can locate Ali in the second list, and use the left-facing arrow button to add Ali's account to the list of Course Creators.<br />
<br />
{{Moodle 1.7}}<br />
{{stub}}<br />
<br />
[[Category:Administrator]]<br />
[[Category:Roles]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Database_fields&diff=14759Development:Database fields2006-08-23T12:38:47Z<p>Danstowell: </p>
<hr />
<div>Moodle's [[Database module]] has some predefined [[Fields|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:<br />
<br />
; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.<br />
; Institution-specific field types : e.g. "library reference number" - people can enter a number into the field, and this is automatically turned into a direct link to your library webpages<br />
; Module-specific field types : e.g. "wiki page" - people see a drop-down list containing the names of pages in your wiki, and can choose which page this particular entry refers to<br />
<br />
==Basic concepts==<br />
<br />
To create a new field type in Moodle we need to create a new folder in /moodle/mod/data/field. Inside this folder will be PHP code telling Moodle:<br />
<br />
# What HTML to output when people are looking at a record in the database<br />
# What form fields to output when people are adding/editing a record in the database<br />
# What to do (what info to store) when someone submits the record-add/edit form<br />
# What form fields to output when the teacher is adding/editing an instance of the field<br />
# What to do (what info to store) when the teacher submits the field-add/edit form<br />
<br />
==The files==<br />
<br />
The best way to get an understanding of the plugin architecture is to look at an existing field type - I recommend you look at '''the URL field type''', stored in /moodle/mod/data/field/url. There are three files:<br />
<br />
* '''field.class.php''' - the most important file, this defines a PHP class which defines the majority of the data field's behaviour. See below for more detail on this.<br />
* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.<br />
* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field.<br />
<br />
<br />
==The PHP class==<br />
<br />
If you look at the file "field.class.php" for the URL field type you'll see that the class is named "data_field_url" and it is a subclass of "data_field_base". This is very important - the class "data_field_base" (defined in /moodle/mod/data/lib.php, by the way) defines some of the core behaviours without which your field will not work.<br />
<br />
Your class's name should match the subfolder you have created. For example, if we're creating a new data type called "Tastiness", we want to create our plugin in a folder "tastiness" and the PHP class should be data_field_tastiness. The class should also define a class variable $type, which again should use the same name - in our example, we'd give it the value 'tastiness'. So the top of our field.class.php would look like this:<br />
<br />
<br />
<?php <br />
class data_field_tastiness extends data_field_base {<br />
var $type = 'tastiness';<br />
<br />
<br />
If you want to take an existing field type, duplicate it, and rename it to a new type (which you can modify later), this is all you need to do. You might like to try this (again, the URL field is a good one to start with) and see how it works.<br />
<br />
The base class defines some simple behaviours which you can override in your subclass, to make the plugin do exactly what you want. For example:<br />
<br />
function display_add_field($recordid=0) // Return some HTML for use when a user is adding/editing a record<br />
function display_browse_field($recordid, $template) // Return some HTML for displaying a record<br />
function update_content($recordid, $value, $name='') // Used when a user stores data for a record<br />
function get_sort_sql($fieldname) // Specify SQL for how this field should be sorted<br />
<br />
If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen. <br />
<br />
<br />
''To be continued...''<br />
<br />
{{stub}}<br />
<br />
[[Category:Developer]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Database_fields&diff=14758Development:Database fields2006-08-23T12:38:27Z<p>Danstowell: </p>
<hr />
<div>Moodle's [[Database module]] has some predefined [[Fields|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:<br />
<br />
; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.<br />
; Institution-specific field types : e.g. "library reference number" - people can enter a number into the field, and this is automatically turned into a direct link to your library webpages<br />
; Module-specific field types : e.g. "wiki page" - people see a drop-down list containing the names of pages in your wiki, and can choose which page this particular entry refers to<br />
<br />
==Basic concepts==<br />
<br />
To create a new field type in Moodle we need to create a new folder in /moodle/mod/data/field. Inside this folder will be PHP code telling Moodle:<br />
<br />
# What HTML to output when people are looking at a record in the database<br />
# What form fields to output when people are adding/editing a record in the database<br />
# What to do (what info to store) when someone submits the record-add/edit form<br />
# What form fields to output when the teacher is adding/editing an instance of the field<br />
# What to do (what info to store) when the teacher submits the field-add/edit form<br />
<br />
==The files==<br />
<br />
The best way to get an understanding of the plugin architecture is to look at an existing field type - I recommend you look at '''the URL field type''', stored in /moodle/mod/data/field/url. There are three files:<br />
<br />
* '''field.class.php''' - the most important file, this defines a PHP class which defines the majority of the data field's behaviour. See below for more detail on this.<br />
* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.<br />
* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field.<br />
<br />
<br />
==The PHP class==<br />
<br />
If you look at the file "field.class.php" for the URL field type you'll see that the class is named "data_field_url" and it is a subclass of "data_field_base". This is very important - the class "data_field_base" (defined in /moodle/mod/data/lib.php, by the way) defines some of the core behaviours without which your field will not work.<br />
<br />
Your class's name should match the subfolder you have created. For example, if we're creating a new data type called "Tastiness", we want to create our plugin in a folder "tastiness" and the PHP class should be data_field_tastiness. The class should also define a class variable $type, which again should use the same name - in our example, we'd give it the value 'tastiness'. So the top of our field.class.php would look like this:<br />
<br />
<br />
<?php <br />
class data_field_tastiness extends data_field_base {<br />
var $type = 'tastiness';<br />
<br />
<br />
If you want to take an existing field type, duplicate it, and rename it to a new type (which you can modify later), this is all you need to do. You might like to try this (again, the URL field is a good one to start with) and see how it works.<br />
<br />
The base class defines some simple behaviours which you can override in your subclass, to make the plugin do exactly what you want. For example:<br />
<br />
function display_add_field($recordid=0) // Return some HTML for use when a user is adding/editing a record<br />
function display_browse_field($recordid, $template) // Return some HTML for displaying a record<br />
function update_content($recordid, $value, $name='') // Used when a user stores data for a record<br />
function get_sort_sql($fieldname) // Specify SQL for how this field should be sorted<br />
<br />
If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen. <br />
<br />
<br />
''To be continued...''<br />
<br />
{{stub}}<br />
<br />
{{Developer}}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Database_fields&diff=14757Development:Database fields2006-08-23T12:36:43Z<p>Danstowell: </p>
<hr />
<div>Moodle's [[Database module]] has some predefined [[Fields|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:<br />
<br />
; Discipline-specific field types : e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.<br />
; Institution-specific field types : e.g. "library reference number" - people can enter a number into the field, and this is automatically turned into a direct link to your library webpages<br />
; Module-specific field types : e.g. "wiki page" - people see a drop-down list containing the names of pages in your wiki, and can choose which page this particular entry refers to<br />
<br />
==Basic concepts==<br />
<br />
To create a new field type in Moodle we need to create a new folder in /moodle/mod/data/field. Inside this folder will be PHP code telling Moodle:<br />
<br />
# What HTML to output when people are looking at a record in the database<br />
# What form fields to output when people are adding/editing a record in the database<br />
# What to do (what info to store) when someone submits the record-add/edit form<br />
# What form fields to output when the teacher is adding/editing an instance of the field<br />
# What to do (what info to store) when the teacher submits the field-add/edit form<br />
<br />
==The files==<br />
<br />
The best way to get an understanding of the plugin architecture is to look at an existing field type - I recommend you look at '''the URL field type''', stored in /moodle/mod/data/field/url. There are three files:<br />
<br />
* '''field.class.php''' - the most important file, this defines a PHP class which defines the majority of the data field's behaviour. See below for more detail on this.<br />
* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.<br />
* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field.<br />
<br />
<br />
==The PHP class==<br />
<br />
If you look at the file "field.class.php" for the URL field type you'll see that the class is named "data_field_url" and it is a subclass of "data_field_base". This is very important - the class "data_field_base" (defined in /moodle/mod/data/lib.php, by the way) defines some of the core behaviours without which your field will not work.<br />
<br />
Your class's name should match the subfolder you have created. For example, if we're creating a new data type called "Tastiness", we want to create our plugin in a folder "tastiness" and the PHP class should be data_field_tastiness. The class should also define a class variable $type, which again should use the same name - in our example, we'd give it the value 'tastiness'. So the top of our field.class.php would look like this:<br />
<br />
<br />
<?php <br />
class data_field_tastiness extends data_field_base {<br />
var $type = 'tastiness';<br />
<br />
<br />
If you want to take an existing field type, duplicate it, and rename it to a new type (which you can modify later), this is all you need to do. You might like to try this (again, the URL field is a good one to start with) and see how it works.<br />
<br />
The base class defines some simple behaviours which you can override in your subclass, to make the plugin do exactly what you want. For example:<br />
<br />
function display_add_field($recordid=0) // Return some HTML for use when a user is adding/editing a record<br />
function display_browse_field($recordid, $template) // Return some HTML for displaying a record<br />
function update_content($recordid, $value, $name='') // Used when a user stores data for a record<br />
function get_sort_sql($fieldname) // Specify SQL for how this field should be sorted<br />
<br />
If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen. <br />
<br />
<br />
''To be continued...''<br />
<br />
{{stub}}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Database_fields&diff=14756Development:Database fields2006-08-23T12:35:45Z<p>Danstowell: Adding some developer docs for database fields</p>
<hr />
<div>Moodle's [[Database module]] has some predefined [[Fields|field types]] (text, date, URL, picture, etc), but you can customise this to create new field types. For example, you might like to create:<br />
<br />
* Discipline-specific field types<br />
** e.g. "Protein PDB code" - people can enter the PDB code for a protein, and then the display could (for example) include a 3D viewer for the protein structure, or link out to molecular databases.<br />
* Institution-specific field types<br />
** e.g. "library reference number" - people can enter a number into the field, and this is automatically turned into a direct link to your library webpages<br />
* Module-specific field types<br />
** e.g. "wiki page" - people see a drop-down list containing the names of pages in your wiki, and can choose which page this particular entry refers to<br />
<br />
==Basic concepts==<br />
<br />
To create a new field type in Moodle we need to create a new folder in /moodle/mod/data/field. Inside this folder will be PHP code telling Moodle:<br />
<br />
# What HTML to output when people are looking at a record in the database<br />
# What form fields to output when people are adding/editing a record in the database<br />
# What to do (what info to store) when someone submits the record-add/edit form<br />
# What form fields to output when the teacher is adding/editing an instance of the field<br />
# What to do (what info to store) when the teacher submits the field-add/edit form<br />
<br />
==The files==<br />
<br />
The best way to get an understanding of the plugin architecture is to look at an existing field type - I recommend you look at '''the URL field type''', stored in /moodle/mod/data/field/url. There are three files:<br />
<br />
* '''field.class.php''' - the most important file, this defines a PHP class which defines the majority of the data field's behaviour. See below for more detail on this.<br />
* '''mod.html''' - contains a HTML "fragment" defining how the form fields will appear when the teacher is adding/editing an instance of the field.<br />
* '''icon.gif''' - the icon to be displayed along with the field, as a visual cue to the teacher about what sort of data is stored in this field.<br />
<br />
<br />
==The PHP class==<br />
<br />
If you look at the file "field.class.php" for the URL field type you'll see that the class is named "data_field_url" and it is a subclass of "data_field_base". This is very important - the class "data_field_base" (defined in /moodle/mod/data/lib.php, by the way) defines some of the core behaviours without which your field will not work.<br />
<br />
Your class's name should match the subfolder you have created. For example, if we're creating a new data type called "Tastiness", we want to create our plugin in a folder "tastiness" and the PHP class should be data_field_tastiness. The class should also define a class variable $type, which again should use the same name - in our example, we'd give it the value 'tastiness'. So the top of our field.class.php would look like this:<br />
<br />
<br />
<?php <br />
class data_field_tastiness extends data_field_base {<br />
var $type = 'tastiness';<br />
<br />
<br />
If you want to take an existing field type, duplicate it, and rename it to a new type (which you can modify later), this is all you need to do. You might like to try this (again, the URL field is a good one to start with) and see how it works.<br />
<br />
The base class defines some simple behaviours which you can override in your subclass, to make the plugin do exactly what you want. For example:<br />
<br />
function display_add_field($recordid=0) // Return some HTML for use when a user is adding/editing a record<br />
function display_browse_field($recordid, $template) // Return some HTML for displaying a record<br />
function update_content($recordid, $value, $name='') // Used when a user stores data for a record<br />
function get_sort_sql($fieldname) // Specify SQL for how this field should be sorted<br />
<br />
If you don't bother to specify these functions inside your new class, then the default behaviours specified by data_field_base will be used. Simply add these functions to your new class to make something different happen. <br />
<br />
<br />
''To be continued...''<br />
<br />
{{stub}}</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Developer_documentation&diff=14755Development:Developer documentation2006-08-23T12:04:54Z<p>Danstowell: /* How you can contribute */</p>
<hr />
<div>==Guidelines==<br />
The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:<br />
*[[Coding|Coding guidelines]] have to be followed by all Moodle developers<br />
*[[Moodle architecture]] spells out the basic design goals behind Moodle<br />
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface<br />
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS<br />
*[[Unit tests]] explains how to run the unit tests, and how to write new test cases.<br />
*[[Tracker]] explains the Moodle Tracker for keeping track of bugs, issues, feature requests etc <br />
<br />
== Resources and tools ==<br />
<br />
*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle<br />
*[http://tracker.moodle.org/ Moodle bug tracker] - bug reports, feature requests and other tracked issues<br />
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]<br />
*[http://moodle.cvs.sourceforge.net/moodle/moodle/ CVS code] - browse the Moodle code via the web<br />
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code<br />
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference] - automatically generated documentation<br />
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course<br />
*[http://developer.yahoo.com/yui YUI documentation] - YUI is the official AJAX library in moodle.<br />
*[[Setting up Eclipse for Moodle development]] - Eclipse is a great editor to use for php development, if you can work out how to set it up.<br />
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD<br />
<br />
==How you can contribute==<br />
<br />
The M in Moodle stands for 'Modular'. There are many different types of components that you can contribute that can be plugged into Moodle to provide additional functionality. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. The following types of plugins currently exist (in alphabetical order):<br />
*[[Modules (developer)|Activity modules]]<br />
*[[Assignment types]]<br />
*[[Authentication|Authentication methods]]<br />
*[[Blocks Howto|Blocks]]<br />
*[[Course formats]]<br />
*[[Database fields (developer)|Database fields]]<br />
*[[Database presets]]<br />
*[[Enrolment plugins (developer)|Enrolment plugins]]<br />
*[[Filters (developer)|Filters]]<br />
*[[Question import/export formats]]<br />
*[[Question types]]<br />
*[[Quiz reports]]<br />
*[[Resource types]]<br />
*[[SSO plugins]]<br />
<br />
There are also ways you can contribute that don't involve PHP programming:<br />
*[[Themes]]<br />
*[[Translation]]<br />
*[[Database Schemas|Database schemas]]<br />
<br />
You can also help a lot by<br />
*[[Tests|Testing]]<br />
*[[Bug tracker|Participating in the bug tracker]]<br />
<br />
==Plans for the future==<br />
Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.<br />
<br />
Once ideas begin to crystalize on the forums they can be summarized in this wiki, either as part of the [[Roadmap]] or in the form of [[Developer notes]]. These pages then form the basis for further discussion in the forums.<br />
*[[Roadmap]]<br />
*[[Developer notes]]<br />
*[[Student projects]]<br />
*[[Developer conference|Developer conferences]]<br />
<br />
==Documentation for core components==<br />
This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Developer notes]] or on the [[Roadmap]].<br />
<br />
*[[UTF-8 migration|Migration to UTF-8]]<br />
*[[Question engine]]<br />
*[[Quiz developer docs|Quiz module]]<br />
*[[SCORM schema|SCORM module 1.5 schema]]<br />
*[[Authentication API]]<br />
*[[Stats package]]<br />
*[[Email processing]]<br />
*[[Cookieless Sessions]]<br />
<br />
==Documentation for contributed code==<br />
Many Moodle users contribute code for the benefit of other Moodle users. This can take the form of new activity modules, blocks, themes, resource plug-ins, assignment plug-ins, question type plug-ins, question import/export formats, quiz report plug-ins, course formats, ... This code is initially posted on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course and then often go into the [http://cvs.sourceforge.net/viewcvs.py/moodle/contrib/ contrib area] of the Moodle [[CVS]] repository. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. Developer documentation for these components should be listed here.<br />
<br />
==See also==<br />
*[http://security.moodle.org/ Moodle Security Centre]<br />
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services<br />
<br />
[[Category:Developer]]<br />
[[es:Documentación para Desarrolladores]]<br />
[[fr:Documentation développeur]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Developer_documentation&diff=14754Development:Developer documentation2006-08-23T12:04:42Z<p>Danstowell: /* How you can contribute */</p>
<hr />
<div>==Guidelines==<br />
The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:<br />
*[[Coding|Coding guidelines]] have to be followed by all Moodle developers<br />
*[[Moodle architecture]] spells out the basic design goals behind Moodle<br />
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface<br />
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS<br />
*[[Unit tests]] explains how to run the unit tests, and how to write new test cases.<br />
*[[Tracker]] explains the Moodle Tracker for keeping track of bugs, issues, feature requests etc <br />
<br />
== Resources and tools ==<br />
<br />
*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle<br />
*[http://tracker.moodle.org/ Moodle bug tracker] - bug reports, feature requests and other tracked issues<br />
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]<br />
*[http://moodle.cvs.sourceforge.net/moodle/moodle/ CVS code] - browse the Moodle code via the web<br />
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code<br />
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference] - automatically generated documentation<br />
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course<br />
*[http://developer.yahoo.com/yui YUI documentation] - YUI is the official AJAX library in moodle.<br />
*[[Setting up Eclipse for Moodle development]] - Eclipse is a great editor to use for php development, if you can work out how to set it up.<br />
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD<br />
<br />
==How you can contribute==<br />
<br />
The M in Moodle stands for 'Modular'. There are many different types of components that you can contribute that can be plugged into Moodle to provide additional functionality. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. The following types of plugins currently exist (in alphabetical order):<br />
*[[Modules (developer)|Activity modules]]<br />
*[[Assignment types]]<br />
*[[Authentication|Authentication methods]]<br />
*[[Blocks Howto|Blocks]]<br />
*[[Course formats]]<br />
*[[Database fields(developer)|Database fields]]<br />
*[[Database presets]]<br />
*[[Enrolment plugins (developer)|Enrolment plugins]]<br />
*[[Filters (developer)|Filters]]<br />
*[[Question import/export formats]]<br />
*[[Question types]]<br />
*[[Quiz reports]]<br />
*[[Resource types]]<br />
*[[SSO plugins]]<br />
<br />
There are also ways you can contribute that don't involve PHP programming:<br />
*[[Themes]]<br />
*[[Translation]]<br />
*[[Database Schemas|Database schemas]]<br />
<br />
You can also help a lot by<br />
*[[Tests|Testing]]<br />
*[[Bug tracker|Participating in the bug tracker]]<br />
<br />
==Plans for the future==<br />
Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.<br />
<br />
Once ideas begin to crystalize on the forums they can be summarized in this wiki, either as part of the [[Roadmap]] or in the form of [[Developer notes]]. These pages then form the basis for further discussion in the forums.<br />
*[[Roadmap]]<br />
*[[Developer notes]]<br />
*[[Student projects]]<br />
*[[Developer conference|Developer conferences]]<br />
<br />
==Documentation for core components==<br />
This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Developer notes]] or on the [[Roadmap]].<br />
<br />
*[[UTF-8 migration|Migration to UTF-8]]<br />
*[[Question engine]]<br />
*[[Quiz developer docs|Quiz module]]<br />
*[[SCORM schema|SCORM module 1.5 schema]]<br />
*[[Authentication API]]<br />
*[[Stats package]]<br />
*[[Email processing]]<br />
*[[Cookieless Sessions]]<br />
<br />
==Documentation for contributed code==<br />
Many Moodle users contribute code for the benefit of other Moodle users. This can take the form of new activity modules, blocks, themes, resource plug-ins, assignment plug-ins, question type plug-ins, question import/export formats, quiz report plug-ins, course formats, ... This code is initially posted on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course and then often go into the [http://cvs.sourceforge.net/viewcvs.py/moodle/contrib/ contrib area] of the Moodle [[CVS]] repository. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. Developer documentation for these components should be listed here.<br />
<br />
==See also==<br />
*[http://security.moodle.org/ Moodle Security Centre]<br />
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services<br />
<br />
[[Category:Developer]]<br />
[[es:Documentación para Desarrolladores]]<br />
[[fr:Documentation développeur]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Roadmap&diff=14258Roadmap2006-08-11T13:37:58Z<p>Danstowell: /* Version 1.7 - Expected August 2006 */</p>
<hr />
<div>This roadmap collects the best information about upcoming features in Moodle. It is not 100% certain - features may change according to available funding and developers.<br />
<br />
<br />
== Version 1.7 - Expected August 2006 ==<br />
<br />
* [[Roles]] - Moodle.com<br />
::This new system will allow the creation of custom roles at site, course and activity level<br />
* [[Accessibility]] - Moodle.com <br />
::Full compliance with all major accessibility standards<br />
* [[XML Database Schema]] - Moodle.com <br />
::Conversion to full database independence using new XML schema for ADOdb. This will give us support for MS SQL, Oracle etc.<br />
* [[Repository API]] - Open University<br />
::Abstract all file operations to an API that allows plugins for different external repositories<br />
* [[Gradebook]] - Arab Open University<br />
::The gradebook system will be revamped for performance, switching from our older "pull" model to a "push" model where all modules will now publish grades as necessary into a central table.<br />
* [[Multi Authentication]] - Iñaki Arenaza?<br />
* [[Learning Design export]] - Moodle.com and Open University of The Netherlands<br />
::We plan to have a very simple export for any Moodle course into IMS LD format, as a proof of concept and to help the community start learning about IMS LD.<br />
* [[Fields#Latitude.2Flongitude|Latitude/longitude data type]] - Dan Stowell<br />
::A new field type for database activities, storing geographic locations, with integrated links with [http://earth.google.com Google Earth], [http://www.openstreetmap.org/ OpenStreetMap], and more.<br />
<br />
== Version 2.0 - Expected early 2007 ==<br />
<br />
* [[IMS Learning Design]] - Moodle.com<br />
::Support for importing/exporting LD, converting Moodle activities and sequences of activities into a standard format for sharing, and importing standard sequences into Moodle courses<br />
* [[Conditional activities]] - Moodle.com<br />
::Allowing dependencies and forced paths through the content<br />
* [[Metadata]] - Moodle.com<br />
::Build on the keywords in 1.6 to provide metadata for all activities and courses, linkable to standard lists of metadata such as State-based learning outomes and curricula<br />
* [[Web Services API]]<br />
::Providing remote control and access of Moodle services by other systems, as well as sharing of information between Moodle sites with trust relationships.<br />
* [[Student Information API]]<br />
::API for integrating external systems for managing student information<br />
* [[Community hub]] - Moodle.com <br />
::Leverage above improvements into a system to network Moodles together<br />
<br />
== Version 2.1 ==<br />
<br />
* [[Site groups|Groups]] <br />
::Groups can also be defined at the site level, and activities can be assigned to course groups<br />
* [[Portfolio API]]<br />
::Interface Moodle activities and repositories to help produce portfolios for internal assessment AND external publication<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
[[es:Planificación]]<br />
[[fr:Planification]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Database_fields&diff=14257Database fields2006-08-11T13:35:44Z<p>Danstowell: Added lat/long</p>
<hr />
<div>{{Databases}}<br />
<br />
A '''field''' is a named unit of information. Each entry in a [[Database module|database]] can have multiple fields of multiple types e.g. a text field called 'favourite color' which allows you to type in your favourite shade, or a menu called 'state' that lets you choose one from a list of the 50 that make up the United States of America. By combining several fields with appropriate names and types you should be able to capture all the relevant information about the items in your database.<br />
<br />
== Field name and description ==<br />
<br />
All fields ask you for a name and a description when you create them. <br />
NB: You cannot change the field type after it's saved. You'll have to create a new field with desired field type. Field names must be unique and they should be short, and sensible! Moodle will not warn you before submitting that you are using a duplicate field name.<br />
<br />
Spaces in your field names will automatically be_filled_with_underscores. It appears that at least some special characters are also stripped: '"...<br />
<br />
<br />
For ex: "I personally achieved..." will become <nowiki>_I_personally_achieved._</nowiki><br />
<br />
== Field types ==<br />
<br />
=== Checkbox ===<br />
<br />
Allows one or more checkboxes. Each line in the options box is a different checkbox. The text entered is what will be the case if the checkbox is checked e.g. 'valid' for something that can be valid or not. This word will appear beside the checkbox on entry, and then by itself when viewing if the box has been checked. If you wish to ensure that the user actively selects one of the options you can use [[Fields#Radio buttons|radio buttons]] instead<br />
<br />
Multiple checboxes could be use, for example, in a movie database that has Horror, Comedy, Western etc. checkboxes for different film genres, and you would be able to check more than one in the case of Horror-Comedies or Comedy-Westerns. The [[Fields#Menu (multi-select)|menu (multi-select)]] field also achieves this, but clicking multiple checkboxes is usually a more obvious interface.<br />
<br />
=== Date ===<br />
<br />
Allows users to enter a date by picking a day, month and year from a drop down list.<br />
<br />
=== File ===<br />
<br />
Asks users to upload a file from their computer. If it is an image file then the picture field may be a better choice.<br />
<br />
=== Menu ===<br />
<br />
The text entered in the ''options'' area will be presented as a drop-down list for the user to choose from. Each line become a different option.<br />
<br />
=== Menu (Multi-select) ===<br />
<br />
The text entered in the ''options'' area will be presented as a list for the user to choose from and each line become a different option. By holding down control or shift as they click, users will be able to select multiple options. This is a fairly advanced computer skill so it may be wise to use multiple checkboxes instead.<br />
<br />
=== Number ===<br />
<br />
Asks the user to enter a number. The number must be an integer, though it can be negative ( e.g. ...,-2,-1,0,1,2,3,...). If you enter anything else but numbers and a leading minus sign the number will be truncated or converted to zero e.g. "3.14" becomes "3", "1,000,000" becomes "1" and "six" becomes "0".<br />
<br />
=== Picture ===<br />
<br />
The user can upload an image file from their computer.<br />
<br />
=== Radio buttons ===<br />
<br />
Allows the user to choose one from a range of options. If the user doesn't select any of these options then they will be prompted to do so and can only submit the entry when one option is chosen.<br />
<br />
If you only have two options and they are opposites (true/false, yes/no) then you could simply use a single checkbox instead. However checkboxes default to their unchecked status and so people could submit without actively selecting one of the options. This may not always be appropriate.<br />
<br />
=== Text ===<br />
<br />
Users can enter text up to 60 characters in length. For longer text, or for text that requires formatting such as headers and bullet points, you can use a textarea field.<br />
<br />
=== Textarea ===<br />
<br />
Allows users to enter a long piece of text including formatting similar to that found when creating forum posts.<br />
Max number of characters in text area = ?<br />
<br />
=== URL ===<br />
<br />
Ask the user to enter a URL. If you select ''autolink'' then the URL becomes a clickable link. If you also enter a ''forced name for the link'' then that text will be used for the hyperlink. For example in a database of authors you may wish people to enter the author's website. If you enter the text 'homepage' as a forced name then clicking on text "homepage" will take you to the entered URL.<br />
<br />
=== Latitude/longitude ===<br />
<br />
Users can enter a geographic location, by specifying the location's latitude and longitude. For example, [http://moodle.com/hq/ Moodle HQ] is at latitude -31.9545, longitude 115.877. When viewing the record, links are automatically generated linking to geographic data services such as [http://earth.google.com Google Earth], [http://www.openstreetmap.org/ OpenStreetMap], [http://www.geabios.com/ GeaBios], and more. (The teacher can choose which of those links appear, if any.)<br />
<br />
[[Category:Teacher]]<br />
[[Category:Database]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Roadmap&diff=14254Roadmap2006-08-11T13:21:18Z<p>Danstowell: /* Version 1.7 - Expected August 2006 */</p>
<hr />
<div>This roadmap collects the best information about upcoming features in Moodle. It is not 100% certain - features may change according to available funding and developers.<br />
<br />
<br />
== Version 1.7 - Expected August 2006 ==<br />
<br />
* [[Roles]] - Moodle.com<br />
::This new system will allow the creation of custom roles at site, course and activity level<br />
* [[Accessibility]] - Moodle.com <br />
::Full compliance with all major accessibility standards<br />
* [[XML Database Schema]] - Moodle.com <br />
::Conversion to full database independence using new XML schema for ADOdb. This will give us support for MS SQL, Oracle etc.<br />
* [[Repository API]] - Open University<br />
::Abstract all file operations to an API that allows plugins for different external repositories<br />
* [[Gradebook]] - Arab Open University<br />
::The gradebook system will be revamped for performance, switching from our older "pull" model to a "push" model where all modules will now publish grades as necessary into a central table.<br />
* [[Multi Authentication]] - Iñaki Arenaza?<br />
* [[Learning Design export]] - Moodle.com and Open University of The Netherlands<br />
::We plan to have a very simple export for any Moodle course into IMS LD format, as a proof of concept and to help the community start learning about IMS LD.<br />
* Latitude/longitude data type - Dan Stowell<br />
::A new field type for database activities, storing geographic locations, with integrated links with [http://earth.google.com Google Earth], [http://www.openstreetmap.org/ OpenStreetMap], and more.<br />
<br />
== Version 2.0 - Expected early 2007 ==<br />
<br />
* [[IMS Learning Design]] - Moodle.com<br />
::Support for importing/exporting LD, converting Moodle activities and sequences of activities into a standard format for sharing, and importing standard sequences into Moodle courses<br />
* [[Conditional activities]] - Moodle.com<br />
::Allowing dependencies and forced paths through the content<br />
* [[Metadata]] - Moodle.com<br />
::Build on the keywords in 1.6 to provide metadata for all activities and courses, linkable to standard lists of metadata such as State-based learning outomes and curricula<br />
* [[Web Services API]]<br />
::Providing remote control and access of Moodle services by other systems, as well as sharing of information between Moodle sites with trust relationships.<br />
* [[Student Information API]]<br />
::API for integrating external systems for managing student information<br />
* [[Community hub]] - Moodle.com <br />
::Leverage above improvements into a system to network Moodles together<br />
<br />
== Version 2.1 ==<br />
<br />
* [[Site groups|Groups]] <br />
::Groups can also be defined at the site level, and activities can be assigned to course groups<br />
* [[Portfolio API]]<br />
::Interface Moodle activities and repositories to help produce portfolios for internal assessment AND external publication<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
[[es:Planificación]]<br />
[[fr:Planification]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Roadmap&diff=14253Roadmap2006-08-11T13:20:58Z<p>Danstowell: /* Version 1.7 - Expected August 2006 */</p>
<hr />
<div>This roadmap collects the best information about upcoming features in Moodle. It is not 100% certain - features may change according to available funding and developers.<br />
<br />
<br />
== Version 1.7 - Expected August 2006 ==<br />
<br />
* [[Roles]] - Moodle.com<br />
::This new system will allow the creation of custom roles at site, course and activity level<br />
* [[Accessibility]] - Moodle.com <br />
::Full compliance with all major accessibility standards<br />
* [[XML Database Schema]] - Moodle.com <br />
::Conversion to full database independence using new XML schema for ADOdb. This will give us support for MS SQL, Oracle etc.<br />
* [[Repository API]] - Open University<br />
::Abstract all file operations to an API that allows plugins for different external repositories<br />
* [[Gradebook]] - Arab Open University<br />
::The gradebook system will be revamped for performance, switching from our older "pull" model to a "push" model where all modules will now publish grades as necessary into a central table.<br />
* [[Multi Authentication]] - Iñaki Arenaza?<br />
* [[Learning Design export]] - Moodle.com and Open University of The Netherlands<br />
::We plan to have a very simple export for any Moodle course into IMS LD format, as a proof of concept and to help the community start learning about IMS LD.<br />
* Latitude/longitude data type - Dan Stowell<br />
::A new field type for database activities, storing geographic locations, with integrated links with [http://earth.google.com Google Earth], [http://www.openstreetmap.org/OpenStreetMap], and more.<br />
<br />
== Version 2.0 - Expected early 2007 ==<br />
<br />
* [[IMS Learning Design]] - Moodle.com<br />
::Support for importing/exporting LD, converting Moodle activities and sequences of activities into a standard format for sharing, and importing standard sequences into Moodle courses<br />
* [[Conditional activities]] - Moodle.com<br />
::Allowing dependencies and forced paths through the content<br />
* [[Metadata]] - Moodle.com<br />
::Build on the keywords in 1.6 to provide metadata for all activities and courses, linkable to standard lists of metadata such as State-based learning outomes and curricula<br />
* [[Web Services API]]<br />
::Providing remote control and access of Moodle services by other systems, as well as sharing of information between Moodle sites with trust relationships.<br />
* [[Student Information API]]<br />
::API for integrating external systems for managing student information<br />
* [[Community hub]] - Moodle.com <br />
::Leverage above improvements into a system to network Moodles together<br />
<br />
== Version 2.1 ==<br />
<br />
* [[Site groups|Groups]] <br />
::Groups can also be defined at the site level, and activities can be assigned to course groups<br />
* [[Portfolio API]]<br />
::Interface Moodle activities and repositories to help produce portfolios for internal assessment AND external publication<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
[[es:Planificación]]<br />
[[fr:Planification]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Wikindx&diff=14096Development:Wikindx2006-08-09T07:59:53Z<p>Danstowell: </p>
<hr />
<div>'''Notes on the possible integration of [http://wikindx.sourceforge.net/index2.html WIKINDX] with Moodle.'''<br />
<br />
[http://wikindx.sourceforge.net/index2.html WIKINDX]is a free bibliographic and quotations/notes management and article authoring system designed either for single use (on a variety of operating sytems) or multi-user collaborative use across the internet.<br />
<br />
Please also see the Moodle Discussion at http://moodle.org/mod/forum/discuss.php?d=23022<br />
<br />
==Wikindx filter for Moodle==<br />
<br />
Dan Stowell has created a "Wikindx filter" for Moodle which allows you to cross-link to a wikindx entry by typing (for example) wikindx:646. The filter is in contrib CVS, named "filter_wikindx" or can be downloaded at http://download.moodle.org/download.php/modules/filter_wikindx.zip<br />
<br />
==Outline thoughts on integration...==<br />
<br />
1. Do we need to allowing a user already logged into a Moodle site to be seamlessly logged in to a wikindx? Or maybe just use the same login details between the two (like the way that Moodle.org and MoodleDocs works). If necessary, something could be added to wikindx to enable this. In most cases though, with the right config settings, wikindx will allow any read only request without requiring login.<br />
<br />
2. Another issue is how to integrate the paper writing function of Wikindx into Moodle. What about use of the HTML editor? Could it be integrated some way with the Netpublish module? Imagine students or professors being able to use it to write academic papers and then publish those on the Moodle site. Currently wikindx publishes papers solely to RTF. It should be simple to publish to HTML since that's what the raw document is anyway (a matter of adding HTML header/footer, formatting citations and appending bibliographies -- most of this code is already in wikindx but not (yet) made available to the word processor). Compared to other HTML editors, the only additional options wikindx offers in its version are buttons to import citations, metadata and insert footnotes. All the rest (barring stats, timestamps, save etc.) are font/text formatting.<br />
<br />
3. For the filter above, how do you decide what bibliographic style to present in (APA, Chicago, IEEE etc.)? Presumably, this is something that could be set in the filter config file. (Although I haven't seen the filter in operation, I'm assuming it picks up a properly formatted reference for insert. Either short (Grimshaw, 2006) or long (Grimshaw, Mark N. 2006, WIKINDX [OSS].) for example. Is the only method of citation available parenthetical? Is it possible to use endnotes (or footnotes) as well? Yes, endnote/footnote styles are available as well.<br />
<br />
:''Note from DS: No, at present the Wikindx filter simply displays the text "wikindx:646" (for example). It's a very simple start and I hope that people with more knowledge of Wikindx will be able to modify it to extract the properly-formatted reference direct from Wikindx. If wikindx had a system whereby a certain URL call would supply the reference text in whatever style was configured for wikindx, this would be a good way to display the citation nicely within Moodle. Does such a call exist? I don't think so. Something like mywikindx.com/index.php?'''action=resourceGrabCitation'''&id=501 would be required.''<br />
<br />
4. Mark, your remarks in 2 have gotten me thinking. Although not everyone likes the Moodle HTML area editor that much, it still is the standard way of creating text in Moodle and perhaps a way of integrating Wikindx would be to add buttons for Wikindx to it, just like the kind described above in Wikindx's native editor. I needed to integrate a hieroglyph editor into my site and Janne Mikkonen helped me to add it through a button in the html editor that pops up a window, in which the student type the hieroglyphs they need, and then click a button to have them inserted back into the editor-similar to the way the insert image popup works. I would imagine something similar could be done with Wikindx. The advantage of this is that it would make Wikindx accessible anywhere within Moodle, rather than just as a separate module. You might also want a standalone module option whereby students could collaborate on creating bibliographies together. Adding the appropriate buttons would be my suggestion. In wikindx, citations are added by the popup automatically adding something like<br />
[cite]146:22-23[/cite]<br />
where 146 is the resource ID in the database and 22-23 are the page nos. This can be added via a cite button or will be appended to an inserted quotation/paraphrase via the wikindx 'insert metadata' button. Footnotes (i.e. parenthetical thoughts as opposed to citation footnotes - WIKINDX does handle those footnotes/endnotes as well) are inserted via a button which encloses the inserted footnote in:<br />
[footnote]....[/footnote]<br />
<br />
Exporting to RTF, the cite tags are substituted with the formatted citation marker (in-text or footnote/endnote), bibliographic information is extracted and appended to a bibliography and footnote tags are converted to RTF footnotes. Of course, all HTML code (font/text formatting, tables, lists, images etc.) are converted to their appropriate RTF code too.<br />
<br />
5. Re the citation/bibliographic formatting, the PHP code for this has been extracted from wikindx and made available to other OSS apps at http://bibliophile.sourceforge.net (I think Aigaion and Bibliograph use it or are about to) so it may be easy enough for Moodle to use this too. In fact doubly easy if moodle interfaces with a wikindx because the quickest way to set up the formatting engine is to provide data to it in exactly the same PHP associative array that wikindx natively expects.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Wikindx&diff=14095Development:Wikindx2006-08-09T07:59:37Z<p>Danstowell: </p>
<hr />
<div>'''Notes on the possible integration of [http://wikindx.sourceforge.net/index2.html WIKINDX] with Moodle.'''<br />
<br />
[http://wikindx.sourceforge.net/index2.html WIKINDX]is a free bibliographic and quotations/notes management and article authoring system designed either for single use (on a variety of operating sytems) or multi-user collaborative use across the internet.<br />
<br />
Please also see the Moodle Discussion at http://moodle.org/mod/forum/discuss.php?d=23022<br />
<br />
==Wikindx filter for Moodle==<br />
<br />
Dan Stowell has created a "Wikindx filter" for Moodle which allows you to cross-link to a wikindx entry by typing (for example) wikindx:646. The filter is in contrib CVS, named "filter_wikindx" or can be downloaded at http://download.moodle.org/download.php/modules/filter_wikindx.zip<br />
<br />
==Outline thoughts on integration...==<br />
<br />
1. Do we need to allowing a user already logged into a Moodle site to be seamlessly logged in to a wikindx? Or maybe just use the same login details between the two (like the way that Moodle.org and MoodleDocs works). If necessary, something could be added to wikindx to enable this. In most cases though, with the right config settings, wikindx will allow any read only request without requiring login.<br />
<br />
2. Another issue is how to integrate the paper writing function of Wikindx into Moodle. What about use of the HTML editor? Could it be integrated some way with the Netpublish module? Imagine students or professors being able to use it to write academic papers and then publish those on the Moodle site. Currently wikindx publishes papers solely to RTF. It should be simple to publish to HTML since that's what the raw document is anyway (a matter of adding HTML header/footer, formatting citations and appending bibliographies -- most of this code is already in wikindx but not (yet) made available to the word processor). Compared to other HTML editors, the only additional options wikindx offers in its version are buttons to import citations, metadata and insert footnotes. All the rest (barring stats, timestamps, save etc.) are font/text formatting.<br />
<br />
3. For the filter above, how do you decide what bibliographic style to present in (APA, Chicago, IEEE etc.)? Presumably, this is something that could be set in the filter config file. (Although I haven't seen the filter in operation, I'm assuming it picks up a properly formatted reference for insert. Either short (Grimshaw, 2006) or long (Grimshaw, Mark N. 2006, WIKINDX [OSS].) for example. Is the only method of citation available parenthetical? Is it possible to use endnotes (or footnotes) as well? Yes, endnote/footnote styles are available as well.<br />
<br />
:''Note from DS: No, at present the Wikindx filter simply displays the text "wikindx:646" (for example). It's a very simple start and I hope that people with more knowledge of Wikindx will be able to modify it to extract the properly-formatted reference direct from Wikindx. If wikindx had a system whereby a certain URL call would supply the reference text in whatever style was configured for wikindx, this would be a good way to display the citation nicely within Moodle. Does such a call exist? I don't think so. Something like mywikindx.com/index.php&'''action=resourceGrabCitation'''&id=501 would be required.''<br />
<br />
4. Mark, your remarks in 2 have gotten me thinking. Although not everyone likes the Moodle HTML area editor that much, it still is the standard way of creating text in Moodle and perhaps a way of integrating Wikindx would be to add buttons for Wikindx to it, just like the kind described above in Wikindx's native editor. I needed to integrate a hieroglyph editor into my site and Janne Mikkonen helped me to add it through a button in the html editor that pops up a window, in which the student type the hieroglyphs they need, and then click a button to have them inserted back into the editor-similar to the way the insert image popup works. I would imagine something similar could be done with Wikindx. The advantage of this is that it would make Wikindx accessible anywhere within Moodle, rather than just as a separate module. You might also want a standalone module option whereby students could collaborate on creating bibliographies together. Adding the appropriate buttons would be my suggestion. In wikindx, citations are added by the popup automatically adding something like<br />
[cite]146:22-23[/cite]<br />
where 146 is the resource ID in the database and 22-23 are the page nos. This can be added via a cite button or will be appended to an inserted quotation/paraphrase via the wikindx 'insert metadata' button. Footnotes (i.e. parenthetical thoughts as opposed to citation footnotes - WIKINDX does handle those footnotes/endnotes as well) are inserted via a button which encloses the inserted footnote in:<br />
[footnote]....[/footnote]<br />
<br />
Exporting to RTF, the cite tags are substituted with the formatted citation marker (in-text or footnote/endnote), bibliographic information is extracted and appended to a bibliography and footnote tags are converted to RTF footnotes. Of course, all HTML code (font/text formatting, tables, lists, images etc.) are converted to their appropriate RTF code too.<br />
<br />
5. Re the citation/bibliographic formatting, the PHP code for this has been extracted from wikindx and made available to other OSS apps at http://bibliophile.sourceforge.net (I think Aigaion and Bibliograph use it or are about to) so it may be easy enough for Moodle to use this too. In fact doubly easy if moodle interfaces with a wikindx because the quickest way to set up the formatting engine is to provide data to it in exactly the same PHP associative array that wikindx natively expects.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Wikindx&diff=14094Development:Wikindx2006-08-09T07:38:41Z<p>Danstowell: </p>
<hr />
<div>'''Notes on the possible integration of [http://wikindx.sourceforge.net/index2.html WIKINDX] with Moodle.'''<br />
<br />
[http://wikindx.sourceforge.net/index2.html WIKINDX]is a free bibliographic and quotations/notes management and article authoring system designed either for single use (on a variety of operating sytems) or multi-user collaborative use across the internet.<br />
<br />
Please also see the Moodle Discussion at http://moodle.org/mod/forum/discuss.php?d=23022<br />
<br />
==Wikindx filter for Moodle==<br />
<br />
Dan Stowell has created a "Wikindx filter" for Moodle which allows you to cross-link to a wikindx entry by typing (for example) wikindx:646. The filter is in contrib CVS, named "filter_wikindx" or can be downloaded at http://download.moodle.org/download.php/modules/filter_wikindx.zip<br />
<br />
==Outline thoughts on integration...==<br />
<br />
1. Do we need to allowing a user already logged into a Moodle site to be seamlessly logged in to a wikindx? Or maybe just use the same login details between the two (like the way that Moodle.org and MoodleDocs works). If necessary, something could be added to wikindx to enable this. In most cases though, with the right config settings, wikindx will allow any read only request without requiring login.<br />
<br />
2. Another issue is how to integrate the paper writing function of Wikindx into Moodle. What about use of the HTML editor? Could it be integrated some way with the Netpublish module? Imagine students or professors being able to use it to write academic papers and then publish those on the Moodle site. Currently wikindx publishes papers solely to RTF. It should be simple to publish to HTML since that's what the raw document is anyway (a matter of adding HTML header/footer, formatting citations and appending bibliographies -- most of this code is already in wikindx but not (yet) made available to the word processor). Compared to other HTML editors, the only additional options wikindx offers in its version are buttons to import citations, metadata and insert footnotes. All the rest (barring stats, timestamps, save etc.) are font/text formatting.<br />
<br />
3. For the filter above, how do you decide what bibliographic style to present in (APA, Chicago, IEEE etc.)? Presumably, this is something that could be set in the filter config file. (Although I haven't seen the filter in operation, I'm assuming it picks up a properly formatted reference for insert. Either short (Grimshaw, 2006) or long (Grimshaw, Mark N. 2006, WIKINDX [OSS].) for example. Is the only method of citation available parenthetical? Is it possible to use endnotes (or footnotes) as well? Yes, endnote/footnote styles are available as well.<br />
<br />
:''Note from DS: No, at present the Wikindx filter simply displays the text "wikindx:646" (for example). It's a very simple start and I hope that people with more knowledge of Wikindx will be able to modify it to extract the properly-formatted reference direct from Wikindx. If wikindx had a system whereby a certain URL call would supply the reference text in whatever style was configured for wikindx, this would be a good way to display the citation nicely within Moodle. Does such a call exist?''<br />
<br />
4. Mark, your remarks in 2 have gotten me thinking. Although not everyone likes the Moodle HTML area editor that much, it still is the standard way of creating text in Moodle and perhaps a way of integrating Wikindx would be to add buttons for Wikindx to it, just like the kind described above in Wikindx's native editor. I needed to integrate a hieroglyph editor into my site and Janne Mikkonen helped me to add it through a button in the html editor that pops up a window, in which the student type the hieroglyphs they need, and then click a button to have them inserted back into the editor-similar to the way the insert image popup works. I would imagine something similar could be done with Wikindx. The advantage of this is that it would make Wikindx accessible anywhere within Moodle, rather than just as a separate module. You might also want a standalone module option whereby students could collaborate on creating bibliographies together. Adding the appropriate buttons would be my suggestion. In wikindx, citations are added by the popup automatically adding something like<br />
[cite]146:22-23[/cite]<br />
where 146 is the resource ID in the database and 22-23 are the page nos. This can be added via a cite button or will be appended to an inserted quotation/paraphrase via the wikindx 'insert metadata' button. Footnotes (i.e. parenthetical thoughts as opposed to citation footnotes - WIKINDX does handle those footnotes/endnotes as well) are inserted via a button which encloses the inserted footnote in:<br />
[footnote]....[/footnote]<br />
<br />
Exporting to RTF, the cite tags are substituted with the formatted citation marker (in-text or footnote/endnote), bibliographic information is extracted and appended to a bibliography and footnote tags are converted to RTF footnotes. Of course, all HTML code (font/text formatting, tables, lists, images etc.) are converted to their appropriate RTF code too.<br />
<br />
5. Re the citation/bibliographic formatting, the PHP code for this has been extracted from wikindx and made available to other OSS apps at http://bibliophile.sourceforge.net (I think Aigaion and Bibliograph use it or are about to) so it may be easy enough for Moodle to use this too. In fact doubly easy if moodle interfaces with a wikindx because the quickest way to set up the formatting engine is to provide data to it in exactly the same PHP associative array that wikindx natively expects.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Wikindx&diff=14093Development:Wikindx2006-08-09T07:37:01Z<p>Danstowell: </p>
<hr />
<div>'''Notes on the possible integration of [http://wikindx.sourceforge.net/index2.html WIKINDX] with Moodle.'''<br />
<br />
[http://wikindx.sourceforge.net/index2.html WIKINDX]is a free bibliographic and quotations/notes management and article authoring system designed either for single use (on a variety of operating sytems) or multi-user collaborative use across the internet.<br />
<br />
Please also see the Moodle Discussion at http://moodle.org/mod/forum/discuss.php?d=23022<br />
<br />
==Wikindx filter for Moodle==<br />
<br />
Dan Stowell has created a "Wikindx filter" for Moodle which allows you to cross-link to a wikindx entry by typing (for example) wikindx:646. The filter is in contrib CVS, named "filter_wikindx" or can be downloaded at http://download.moodle.org/download.php/modules/filter_wikindx.zip<br />
<br />
==Outline thoughts on integration...==<br />
<br />
1. Do we need to allowing a user already logged into a Moodle site to be seamlessly logged in to a wikindx? Or maybe just use the same login details between the two (like the way that Moodle.org and MoodleDocs works). If necessary, something could be added to wikindx to enable this. In most cases though, with the right config settings, wikindx will allow any read only request without requiring login.<br />
<br />
2. Another issue is how to integrate the paper writing function of Wikindx into Moodle. What about use of the HTML editor? Could it be integrated some way with the Netpublish module? Imagine students or professors being able to use it to write academic papers and then publish those on the Moodle site. Currently wikindx publishes papers solely to RTF. It should be simple to publish to HTML since that's what the raw document is anyway (a matter of adding HTML header/footer, formatting citations and appending bibliographies -- most of this code is already in wikindx but not (yet) made available to the word processor). Compared to other HTML editors, the only additional options wikindx offers in its version are buttons to import citations, metadata and insert footnotes. All the rest (barring stats, timestamps, save etc.) are font/text formatting.<br />
<br />
3. For the filter above, how do you decide what bibliographic style to present in (APA, Chicago, IEEE etc.)? Presumably, this is something that could be set in the filter config file. (Although I haven't seen the filter in operation, I'm assuming it picks up a properly formatted reference for insert. Either short (Grimshaw, 2006) or long (Grimshaw, Mark N. 2006, WIKINDX [OSS].) for example. Is the only method of citation available parenthetical? Is it possible to use endnotes (or footnotes) as well? Yes, endnote/footnote styles are available as well.<br />
<br />
:''Note from DS: No, at present the Wikindx filter simply displays the text "wikindx:646" (for example). It's a very simple start and I hope that people with more knowledge of Wikindx will be able to modify it to extract the properly-formatted reference direct from Wikindx.''<br />
<br />
4. Mark, your remarks in 2 have gotten me thinking. Although not everyone likes the Moodle HTML area editor that much, it still is the standard way of creating text in Moodle and perhaps a way of integrating Wikindx would be to add buttons for Wikindx to it, just like the kind described above in Wikindx's native editor. I needed to integrate a hieroglyph editor into my site and Janne Mikkonen helped me to add it through a button in the html editor that pops up a window, in which the student type the hieroglyphs they need, and then click a button to have them inserted back into the editor-similar to the way the insert image popup works. I would imagine something similar could be done with Wikindx. The advantage of this is that it would make Wikindx accessible anywhere within Moodle, rather than just as a separate module. You might also want a standalone module option whereby students could collaborate on creating bibliographies together. Adding the appropriate buttons would be my suggestion. In wikindx, citations are added by the popup automatically adding something like<br />
[cite]146:22-23[/cite]<br />
where 146 is the resource ID in the database and 22-23 are the page nos. This can be added via a cite button or will be appended to an inserted quotation/paraphrase via the wikindx 'insert metadata' button. Footnotes (i.e. parenthetical thoughts as opposed to citation footnotes - WIKINDX does handle those footnotes/endnotes as well) are inserted via a button which encloses the inserted footnote in:<br />
[footnote]....[/footnote]<br />
<br />
Exporting to RTF, the cite tags are substituted with the formatted citation marker (in-text or footnote/endnote), bibliographic information is extracted and appended to a bibliography and footnote tags are converted to RTF footnotes. Of course, all HTML code (font/text formatting, tables, lists, images etc.) are converted to their appropriate RTF code too.<br />
<br />
5. Re the citation/bibliographic formatting, the PHP code for this has been extracted from wikindx and made available to other OSS apps at http://bibliophile.sourceforge.net (I think Aigaion and Bibliograph use it or are about to) so it may be easy enough for Moodle to use this too. In fact doubly easy if moodle interfaces with a wikindx because the quickest way to set up the formatting engine is to provide data to it in exactly the same PHP associative array that wikindx natively expects.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Speech_tools&diff=14052Speech tools2006-08-08T10:11:43Z<p>Danstowell: </p>
<hr />
<div>Moodle has no built-in tools for speech messaging or audioconferencing. However, there are some interesting projects which are working towards enabling the use of voice tools within Moodle, at various stages of maturity:<br />
<br />
==Free tools==<br />
<br />
* '''[http://www.covell.org COVCELL]''', an EU-funded project to provide various enhancements for online language learning, including audio conferencing. See also [http://moodle.org/mod/forum/view.php?id=5368 COVCELL discussion forum on moodle.org] The audio conferencing will use a RED5 Flash-based server.<br />
* Integration of Moodle with '''[http://gong.ust.hk/ Gong]''' (requires a Java server)<br />
* Integration of Moodle with '''[http://www.dimdim.com/ dimdim]''' open-source webconferencing system. (Not sure what the server requirements are.)<br />
* '''[http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex]''' Java applets for voice messaging (note: does not require any modifications/additions to the server setup)<br />
<br />
==Commercial tools==<br />
<br />
* The '''Horizon Wimba''' company provides a subsription-based service providing [http://www.horizonwimba.com/products/voicetools/ voice tools] for use in VLEs. Moodle integration of these tools is forthcoming.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Language_teaching&diff=13979Language teaching2006-08-06T13:07:08Z<p>Danstowell: </p>
<hr />
<div>* [http://moodle.org/course/view.php?id=31 Moodle for language teaching] community area<br />
* [[Speech tools]]<br />
<br />
[[Category:Teacher]]<br />
[[Category:Discipline-specific Moodling]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Voice_tools&diff=13978Voice tools2006-08-06T13:04:11Z<p>Danstowell: </p>
<hr />
<div>#REDIRECT [[Speech tools]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Audioconferencing&diff=13977Audioconferencing2006-08-06T13:03:47Z<p>Danstowell: </p>
<hr />
<div>#REDIRECT [[Speech tools]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Speech_tools&diff=13976Speech tools2006-08-06T13:03:18Z<p>Danstowell: </p>
<hr />
<div>Moodle has no built-in tools for speech messaging or audioconferencing. However, there are some interesting projects which are working towards enabling the use of voice tools within Moodle, at various stages of maturity:<br />
<br />
* '''[http://www.covell.org COVCELL]''', an EU-funded project to provide various enhancements for online language learning, including audio conferencing. See also [http://moodle.org/mod/forum/view.php?id=5368 COVCELL discussion forum on moodle.org] The audio conferencing will use a RED5 Flash-based server.<br />
* Integration of Moodle with '''[http://gong.ust.hk/ Gong]''' (requires a Java server)<br />
* Integration of Moodle with '''[http://www.dimdim.com/ dimdim]''' open-source webconferencing system. (Not sure what the server requirements are.)<br />
* '''[http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex]''' Java applets for voice messaging (note: does not require any modifications/additions to the server setup)<br />
* The '''Horizon Wimba''' company provides a subsription-based service providing [http://www.horizonwimba.com/products/voicetools/ voice tools] for use in VLEs. Moodle integration of these tools is forthcoming.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Speech_tools&diff=13975Speech tools2006-08-06T13:02:17Z<p>Danstowell: </p>
<hr />
<div>Moodle has no built-in tools for speech messaging or audioconferencing. However, there are some interesting projects which are working towards enabling the use of voice tools within Moodle, at various stages of maturity:<br />
<br />
* [http://www.covell.org COVCELL], an EU-funded project to provide various enhancements for online language learning, including audio conferencing. See also [http://moodle.org/mod/forum/view.php?id=5368 COVCELL discussion forum on moodle.org] The audio conferencing will use a RED5 Flash-based server.<br />
* Integration of Moodle with [http://gong.ust.hk/ Gong] (requires a Java server)<br />
* Integration of Moodle with [http://www.dimdim.com/ dimdim] open-source webconferencing system. (Not sure what the server requirements are.)<br />
* [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] Java applets for voice messaging (note: does not require any modifications/additions to the server setup)<br />
* The Horizon Wimba company provides a subsription-based service providing [http://www.horizonwimba.com/products/voicetools/ voice tools] for use in VLEs. Moodle integration of these tools is forthcoming.</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Developer_documentation&diff=13293Development:Developer documentation2006-07-21T16:59:18Z<p>Danstowell: /* See also */</p>
<hr />
<div>==Guidelines==<br />
The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:<br />
*[[Coding|Coding guidelines]] have to be followed by all Moodle developers<br />
*[[Moodle architecture]] spells out the basic design goals behind Moodle<br />
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface<br />
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS<br />
*[[Unit tests]] explains how to run the unit tests, and how to write new test cases.<br />
<br />
== Resources and tools ==<br />
<br />
*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle<br />
*[http://moodle.org/bugs/ Moodle bug tracker] - bug reports, feature requests and other tracked issues<br />
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]<br />
*[http://moodle.cvs.sourceforge.net/moodle/moodle/ CVS code] - browse the Moodle code via the web<br />
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code<br />
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference] - automatically generated documentation<br />
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course<br />
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD<br />
<br />
==How you can contribute==<br />
<br />
The M in Moodle stands for 'Modular'. There are many different types of components that you can contribute that can be plugged into Moodle to provide additional functionality. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. The following types of plugins currently exist (in alphabetical order):<br />
*[[Modules (developer)|Activity modules]]<br />
*[[Assignment types]]<br />
*[[Authentication|Authentication methods]]<br />
*[[Blocks Howto|Blocks]]<br />
*[[Course formats]]<br />
*[[Database fields]]<br />
*[[Database presets]]<br />
*[[Enrolment plugins (developer)|Enrolment plugins]]<br />
*[[Filters (developer)|Filters]]<br />
*[[Question import/export formats]]<br />
*[[Question types]]<br />
*[[Quiz reports]]<br />
*[[Resource types]]<br />
*[[SSO plugins]]<br />
<br />
There are also ways you can contribute that don't involve PHP programming:<br />
*[[Themes]]<br />
*[[Translation]]<br />
*[[Database Schemas|Database schemas]]<br />
<br />
You can also help a lot by<br />
*[[Tests|Testing]]<br />
*[[Bug tracker|Participating in the bug tracker]]<br />
<br />
==Plans for the future==<br />
Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.<br />
<br />
Once ideas begin to crystalize on the forums they can be summarized in this wiki, either as part of the [[Roadmap]] or in the form of [[Developer notes]]. These pages then form the basis for further discussion in the forums.<br />
*[[Roadmap]]<br />
*[[Developer notes]]<br />
*[[Student projects]]<br />
*[[Developer conference|Developer conferences]]<br />
<br />
==Documentation for core components==<br />
This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Developer notes]] or on the [[Roadmap]].<br />
<br />
*[[UTF-8 migration|Migration to UTF-8]]<br />
*[[Question engine]]<br />
*[[Quiz developer docs|Quiz module]]<br />
*[[SCORM schema|SCORM module 1.5 schema]]<br />
*[[Authentication API]]<br />
*[[Stats package]]<br />
*[[Email processing]]<br />
*[[Cookieless Sessions]]<br />
<br />
==Documentation for contributed code==<br />
Many Moodle users contribute code for the benefit of other Moodle users. This can take the form of new activity modules, blocks, themes, resource plug-ins, assignment plug-ins, question type plug-ins, question import/export formats, quiz report plug-ins, course formats, ... This code is initially posted on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course and then often go into the [http://cvs.sourceforge.net/viewcvs.py/moodle/contrib/ contrib area] of the Moodle [[CVS]] repository. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. Developer documentation for these components should be listed here.<br />
<br />
==See also==<br />
*[http://security.moodle.org/ Moodle Security Centre]<br />
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services<br />
<br />
[[Category:Developer]]<br />
[[es:Documentación para Desarrolladores]]<br />
[[fr:Documentation développeur]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Developer_documentation&diff=13292Development:Developer documentation2006-07-21T16:59:01Z<p>Danstowell: /* See also */</p>
<hr />
<div>==Guidelines==<br />
The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:<br />
*[[Coding|Coding guidelines]] have to be followed by all Moodle developers<br />
*[[Moodle architecture]] spells out the basic design goals behind Moodle<br />
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface<br />
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS<br />
*[[Unit tests]] explains how to run the unit tests, and how to write new test cases.<br />
<br />
== Resources and tools ==<br />
<br />
*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle<br />
*[http://moodle.org/bugs/ Moodle bug tracker] - bug reports, feature requests and other tracked issues<br />
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]<br />
*[http://moodle.cvs.sourceforge.net/moodle/moodle/ CVS code] - browse the Moodle code via the web<br />
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code<br />
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference] - automatically generated documentation<br />
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course<br />
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD<br />
<br />
==How you can contribute==<br />
<br />
The M in Moodle stands for 'Modular'. There are many different types of components that you can contribute that can be plugged into Moodle to provide additional functionality. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. The following types of plugins currently exist (in alphabetical order):<br />
*[[Modules (developer)|Activity modules]]<br />
*[[Assignment types]]<br />
*[[Authentication|Authentication methods]]<br />
*[[Blocks Howto|Blocks]]<br />
*[[Course formats]]<br />
*[[Database fields]]<br />
*[[Database presets]]<br />
*[[Enrolment plugins (developer)|Enrolment plugins]]<br />
*[[Filters (developer)|Filters]]<br />
*[[Question import/export formats]]<br />
*[[Question types]]<br />
*[[Quiz reports]]<br />
*[[Resource types]]<br />
*[[SSO plugins]]<br />
<br />
There are also ways you can contribute that don't involve PHP programming:<br />
*[[Themes]]<br />
*[[Translation]]<br />
*[[Database Schemas|Database schemas]]<br />
<br />
You can also help a lot by<br />
*[[Tests|Testing]]<br />
*[[Bug tracker|Participating in the bug tracker]]<br />
<br />
==Plans for the future==<br />
Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.<br />
<br />
Once ideas begin to crystalize on the forums they can be summarized in this wiki, either as part of the [[Roadmap]] or in the form of [[Developer notes]]. These pages then form the basis for further discussion in the forums.<br />
*[[Roadmap]]<br />
*[[Developer notes]]<br />
*[[Student projects]]<br />
*[[Developer conference|Developer conferences]]<br />
<br />
==Documentation for core components==<br />
This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Developer notes]] or on the [[Roadmap]].<br />
<br />
*[[UTF-8 migration|Migration to UTF-8]]<br />
*[[Question engine]]<br />
*[[Quiz developer docs|Quiz module]]<br />
*[[SCORM schema|SCORM module 1.5 schema]]<br />
*[[Authentication API]]<br />
*[[Stats package]]<br />
*[[Email processing]]<br />
*[[Cookieless Sessions]]<br />
<br />
==Documentation for contributed code==<br />
Many Moodle users contribute code for the benefit of other Moodle users. This can take the form of new activity modules, blocks, themes, resource plug-ins, assignment plug-ins, question type plug-ins, question import/export formats, quiz report plug-ins, course formats, ... This code is initially posted on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course and then often go into the [http://cvs.sourceforge.net/viewcvs.py/moodle/contrib/ contrib area] of the Moodle [[CVS]] repository. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. Developer documentation for these components should be listed here.<br />
<br />
==See also==<br />
*[http://security.moodle.org/ Moodle Security Centre]<br />
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services<br />
*[[Developer FAQ]]<br />
<br />
[[Category:Developer]]<br />
[[es:Documentación para Desarrolladores]]<br />
[[fr:Documentation développeur]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Developer_documentation&diff=13291Development:Developer documentation2006-07-21T16:58:22Z<p>Danstowell: /* See also */</p>
<hr />
<div>==Guidelines==<br />
The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:<br />
*[[Coding|Coding guidelines]] have to be followed by all Moodle developers<br />
*[[Moodle architecture]] spells out the basic design goals behind Moodle<br />
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface<br />
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS<br />
*[[Unit tests]] explains how to run the unit tests, and how to write new test cases.<br />
<br />
== Resources and tools ==<br />
<br />
*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle<br />
*[http://moodle.org/bugs/ Moodle bug tracker] - bug reports, feature requests and other tracked issues<br />
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]<br />
*[http://moodle.cvs.sourceforge.net/moodle/moodle/ CVS code] - browse the Moodle code via the web<br />
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code<br />
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference] - automatically generated documentation<br />
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course<br />
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD<br />
<br />
==How you can contribute==<br />
<br />
The M in Moodle stands for 'Modular'. There are many different types of components that you can contribute that can be plugged into Moodle to provide additional functionality. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. The following types of plugins currently exist (in alphabetical order):<br />
*[[Modules (developer)|Activity modules]]<br />
*[[Assignment types]]<br />
*[[Authentication|Authentication methods]]<br />
*[[Blocks Howto|Blocks]]<br />
*[[Course formats]]<br />
*[[Database fields]]<br />
*[[Database presets]]<br />
*[[Enrolment plugins (developer)|Enrolment plugins]]<br />
*[[Filters (developer)|Filters]]<br />
*[[Question import/export formats]]<br />
*[[Question types]]<br />
*[[Quiz reports]]<br />
*[[Resource types]]<br />
*[[SSO plugins]]<br />
<br />
There are also ways you can contribute that don't involve PHP programming:<br />
*[[Themes]]<br />
*[[Translation]]<br />
*[[Database Schemas|Database schemas]]<br />
<br />
You can also help a lot by<br />
*[[Tests|Testing]]<br />
*[[Bug tracker|Participating in the bug tracker]]<br />
<br />
==Plans for the future==<br />
Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.<br />
<br />
Once ideas begin to crystalize on the forums they can be summarized in this wiki, either as part of the [[Roadmap]] or in the form of [[Developer notes]]. These pages then form the basis for further discussion in the forums.<br />
*[[Roadmap]]<br />
*[[Developer notes]]<br />
*[[Student projects]]<br />
*[[Developer conference|Developer conferences]]<br />
<br />
==Documentation for core components==<br />
This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Developer notes]] or on the [[Roadmap]].<br />
<br />
*[[UTF-8 migration|Migration to UTF-8]]<br />
*[[Question engine]]<br />
*[[Quiz developer docs|Quiz module]]<br />
*[[SCORM schema|SCORM module 1.5 schema]]<br />
*[[Authentication API]]<br />
*[[Stats package]]<br />
*[[Email processing]]<br />
*[[Cookieless Sessions]]<br />
<br />
==Documentation for contributed code==<br />
Many Moodle users contribute code for the benefit of other Moodle users. This can take the form of new activity modules, blocks, themes, resource plug-ins, assignment plug-ins, question type plug-ins, question import/export formats, quiz report plug-ins, course formats, ... This code is initially posted on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course and then often go into the [http://cvs.sourceforge.net/viewcvs.py/moodle/contrib/ contrib area] of the Moodle [[CVS]] repository. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. Developer documentation for these components should be listed here.<br />
<br />
==See also==<br />
*[http://security.moodle.org/ Moodle Security Centre]<br />
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services<br />
*[Developer FAQ]<br />
<br />
[[Category:Developer]]<br />
[[es:Documentación para Desarrolladores]]<br />
[[fr:Documentation développeur]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Jmol_filter&diff=13290Jmol filter2006-07-21T13:44:28Z<p>Danstowell: </p>
<hr />
<div>[[Image:Jmol-quiz-example.png|thumb|200px|right|An example of the Jmol filter in action]]<br />
<br />
Jmol is open-source Java software for interactive 3D viewing of molecular structures. It can easily be embedded into a webpage... including a Moodle page.<br />
<br />
The Moodle Jmol filter makes it incredibly simple for teachers to embed these viewers into teaching material (quizzes, discussion messages, etc).<br />
<br />
* '''[http://download.moodle.org/download.php/modules/filter_jmol.zip Download the Jmol filter]''''<br />
<br />
The Jmol filter is very useful for including a molecule viewer in a variety of situations - e.g. in a [[Label]], a [[Forums | Forum]] discussion, or a [[Quizzes| Quiz]] question. If you wish to load a molecule data file as a "resource", you should also consider installing the [[Jmol resource module]].<br />
<br />
<br />
It requires no additional capability on your web server, but requires both Java and a JavaScript-enabled browser for the user.<br />
<br />
* [http://moodle.yeovil.ac.uk/course/view.php?id=63 See it in action in this course] (Log in as guest)<br />
<br />
<br />
===How to use===<br />
<br />
# Upload a molecule data file to the Moodle server. (This is important - Jmol refuses to display data files held on other servers, so you can't just link to a file that exists somewhere else on the web.)<br />
# Simply create a link to the molecule file, wherever you want the molecule viewer to appear.<br />
## Parameters can be added to the end of the URL to specify certain display options. Add '''?c=0''' to hide the controls, or '''?s=150''' to set the viewer's size at 150 pixels. Or '''?c=0&s=150''' to do both.<br />
## The filter will output its own form tags. If you're displaying the molecule inside an existing form, please make sure you use the '''?f=0''' parameter to make sure the filter doesn't output its own form tags. This will ensure things work correctly in most web browsers.<br />
# If you wish to run extra [http://jmol.sourceforge.net/scripting/ Jmol script] upon intialisation, write '''JMOLSCRIPT{}''' straight after the link, and put your code inside the braces. For example:<br />
<br />
[http://cvs.sf.net/viewcvs.py/*checkout*/moodle/contrib/filter_jmol/filter/jmol/manywater.pdb Water molecules] JMOLSCRIPT{rotate x 15; zoom 50; set axes on;}<br />
<br />
===Important: Using the filter in quizzes===<br />
<br />
The filter can be used to display molecular viewers in quiz questions. But '''please make sure you use the ?f=0 parameter at the end of each URL''', to prevent the filter outputting its own "form" tags.<br />
<br />
<br />
[[Category:Administrator]]<br />
[[Category:Filter]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Roles&diff=13288Development:Roles2006-07-21T11:30:55Z<p>Danstowell: /* Core-level Capabilities */ Added moodle/user:viewdetails</p>
<hr />
<div>'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.<br />
<br />
''Please note that none of the following is finalised.''<br />
<br />
==Definitions==<br />
<br />
By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.<br />
<br />
A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.<br />
<br />
==The existing system==<br />
<br />
Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.<br />
<br />
==The new roles and capability system==<br />
<br />
The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role. <br />
<br />
To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.<br />
<br />
''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''<br />
<br />
==The plan==<br />
<br />
There are a few major things that need to be done. Here's a list (in no particular order):<br />
<br />
#Identify permissions required for site/course/each module.<br />
#Define the database structure for storing roles and capabilities.<br />
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).<br />
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?<br />
#Consider interface issues, especially how to manage conflicting role/exception rules.<br />
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?<br />
#Consider the impact on backup/restore.<br />
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.<br />
<br />
==Capabilities==<br />
<br />
This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?<br />
<br />
What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)<br />
<br />
Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.<br />
<br />
Do we need to add canview and cansearch logs at site/course/user/group level?<br />
<br />
I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)<br />
<br />
<br />
<br />
===Core-level Capabilities===<br />
<br />
Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php<br />
Do we still keep student view? What is a student view?<br />
<br />
#moodle/site:config - applicable in admin/index.php and config.php (might break down later)<br />
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now)<br />
#moodle/site:backup - can create a course backup<br />
#moodle/site:restore - can restore into this context<br />
#moodle/site:import - can import other courses into this context<br />
#moodle/blog:view - read blogs<br />
#moodle/blog:create - write new blog posts<br />
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use<br />
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use<br />
#moodle/blog:manageentries - edit/delete all blog entries<br />
#moodle/course:create - create courses<br />
#moodle/course:delete - create courses<br />
#moodle/course:update - update course settings<br />
#moodle/course:view - can use this to find participants<br />
#moodle/course:viewparticipants - allows a user to view participant list<br />
#moodle/course:viewscales - view scales (i.e. in a help window?)<br />
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)<br />
#moodle/course:managescales - add, delete, edit scales, move scales up and down<br />
#moodle/course:managegroups - managing groups, add, edit, delete<br />
#moodle/course:visibility - hide/show courses<br />
#moodle/category:create - create category<br />
#moodle/category:delete - create category<br />
#moodle/category:update - update category settings<br />
#moodle/category:visibility - hide/show categories<br />
#moodle/user:create - create user<br />
#moodle/user:delete - create user<br />
#moodle/user:update - update user settings<br />
#moodle/user:viewdetails - view personally-identifying user details (e.g. name, photo). This ties in with the "visitor" scenario described below.<br />
#moodle/calendar:manageownentries - create/edit/delete <br />
#moodle/calendar:manageentries - create/edit/delete<br />
<br />
===Module-level Capabilities===<br />
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.<br />
<br />
The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.<br />
<br />
#Assignment<br />
##mod/assignment:view- reading the assignment description<br />
##mod/assignment:grade - grading, viewing of list of submitted assignments<br />
#Chat<br />
##mod/chat:chat - allows a user to participate in this chat<br />
##mod/chat:readlog - allows a user to read past chat session logs<br />
##mod/chat:deletelog - allows a user to delete past chat logs<br />
#Choice<br />
##mod/choice:choose - make a choice<br />
##mod/choice:readresponses - read all responses<br />
##mod/choice:deleteresponses - deletes all responses<br />
##mod/choice:downloadresponses - download responses<br />
#Database<br />
##mod/data:readentry - reads other people's entry<br />
##mod/data:writeentry - add / edit and delete (own) entries<br />
##mod/data:managetemplates - add, delete, edit fields and templates<br />
##mod/data:manageentries - edit/delete all entries<br />
##mod/data:comment - comment<br />
##mod/data:managecomments - edit/delete all comments<br />
##mod/data:rate - rate an entry<br />
##mod/data:approve - approves an entry<br />
##mod/data:uploadentries - batch upload of entries<br />
#Exercise<br />
##mod/exercise:assess<br />
#Forum<br />
##mod/forum:viewforum<br />
##mod/forum:viewdiscussion<br />
##mod/forum:viewdiscussionsfromallgroups<br />
##mod/forum:startdiscussion<br />
##mod/forum:replypost<br />
##mod/forum:viewrating<br />
##mod/forum:rate<br />
##mod/forum:attachments<br />
##mod/forum:deleteownpost<br />
##mod/forum:deleteanypost<br />
##mod/forum:splitdiscussions<br />
##mod/forum:movediscussions<br />
##mod/forum:editanypost<br />
#Glossary<br />
##mod/glossary:view - read entries<br />
##mod/glossary:write - add entries<br />
##mod/glossary:manageentries - add, edit, delete entries<br />
##mod/glossary:managecategories - create, delete, edit categories<br />
##mod/glossary:comment - comment on an entry<br />
##mod/glossary:managecomments - edit, delete comments<br />
##mod/glossary:import - import glossaries<br />
##mod/glossary:export - export glossaries<br />
##mod/glossary:approve - approve glossaries<br />
##mod/glossary:rate - rates glossary<br />
##mod/glossary:readrate - view rating?<br />
#Hotpot<br />
##mod/hotpot:view<br />
#Label<br />
##none<br />
#Lams<br />
##TBD<br />
#Lesson<br />
##TBD<br />
#Quiz<br />
##TBD<br />
#Resource<br />
##mod/resource:view<br />
#Scorm<br />
##mod/scorm:view<br />
##mod/scorm:viewgrades<br />
#Survey<br />
##mod/survey:download - downloads survery result<br />
##mod/survey:participate - participate/ do survey<br />
##mod/survey:readresponses - read all user's responese<br />
#Wiki<br />
##Waiting on new wiki<br />
#Workshop<br />
##Waiting on new Workshop<br />
<br />
<br />
<br />
==Questions==<br />
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].<br />
<br />
==Scenarios==<br />
<br />
This section is for brainstorming some example roles that we would like to support:<br />
<br />
===Student===<br />
Has this one been missed?<br />
<br />
===Site Designers===<br />
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.<br />
<br />
===Educational Authority Adviser===<br />
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.<br />
<br />
===Educational Inspector===<br />
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.<br />
<br />
===Second Marker / Moderator===<br />
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.<br />
<br />
===Peer observer of teaching===<br />
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).<br />
<br />
===External Examiner===<br />
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.<br />
<br />
===Parent===<br />
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.<br />
<br />
In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.<br />
<br />
In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.<br />
<br />
In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.<br />
<br />
Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.<br />
<br />
In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face. <br />
<br />
The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.<br />
<br />
In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.<br />
<br />
===Manager===<br />
''Please add text here...''<br />
<br />
===Weekly Seminar Leader===<br />
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''<br />
<br />
===Mentor/Mentee===<br />
''Please add text here...''<br />
<br />
===Community-Designed Rating Criteria===<br />
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''<br />
<br />
===Visitor===<br />
<br />
This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant. <br />
<br />
===Former Student===<br />
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?<br />
<br />
Is this the same as '''ALUMNUS''' ? An ALUMNUS should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when an ALUMNUS is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)<br />
<br />
===Librarian===<br />
<br />
Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.<br />
<br />
===Teacher===<br />
<br />
Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity. <br />
<br />
I think that what is needed is a simple heirarchy of permissions and levels of granularity.<br />
<br />
I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)<br />
<br />
===Community Education Tutors/Trainers===<br />
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.<br />
<br />
===Secretary/Student Worker===<br />
<br />
We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.<br />
<br />
===Teaching Assistant===<br />
<br />
Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker<br />
<br />
===Admin - Catgory based===<br />
<br />
Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.<br />
<br />
===PROCESS ROLES===<br />
<br />
organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:<br />
<li>1. Give a student the role of forum-moderator with edit and chunk-rights<br />
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week<br />
<li>3. Give students different resources, depending of their roles in a rolegame/simulation<br />
<li>4. Give a student the rights to create the section content of next week (and only that week..)<br />
<li>5. ..<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
<br />
[[ru:Роли]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Roles&diff=13287Development:Roles2006-07-21T11:27:17Z<p>Danstowell: /* Former Student */</p>
<hr />
<div>'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.<br />
<br />
''Please note that none of the following is finalised.''<br />
<br />
==Definitions==<br />
<br />
By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.<br />
<br />
A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.<br />
<br />
==The existing system==<br />
<br />
Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.<br />
<br />
==The new roles and capability system==<br />
<br />
The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role. <br />
<br />
To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.<br />
<br />
''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''<br />
<br />
==The plan==<br />
<br />
There are a few major things that need to be done. Here's a list (in no particular order):<br />
<br />
#Identify permissions required for site/course/each module.<br />
#Define the database structure for storing roles and capabilities.<br />
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).<br />
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?<br />
#Consider interface issues, especially how to manage conflicting role/exception rules.<br />
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?<br />
#Consider the impact on backup/restore.<br />
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.<br />
<br />
==Capabilities==<br />
<br />
This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?<br />
<br />
What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)<br />
<br />
Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.<br />
<br />
Do we need to add canview and cansearch logs at site/course/user/group level?<br />
<br />
I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)<br />
<br />
<br />
<br />
===Core-level Capabilities===<br />
<br />
Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php<br />
Do we still keep student view? What is a student view?<br />
<br />
#moodle/site:config - applicable in admin/index.php and config.php (might break down later)<br />
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now)<br />
#moodle/site:backup - can create a course backup<br />
#moodle/site:restore - can restore into this context<br />
#moodle/site:import - can import other courses into this context<br />
#moodle/blog:view - read blogs<br />
#moodle/blog:create - write new blog posts<br />
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use<br />
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use<br />
#moodle/blog:manageentries - edit/delete all blog entries<br />
#moodle/course:create - create courses<br />
#moodle/course:delete - create courses<br />
#moodle/course:update - update course settings<br />
#moodle/course:view - can use this to find participants<br />
#moodle/course:viewparticipants - allows a user to view participant list<br />
#moodle/course:viewscales - view scales (i.e. in a help window?)<br />
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)<br />
#moodle/course:managescales - add, delete, edit scales, move scales up and down<br />
#moodle/course:managegroups - managing groups, add, edit, delete<br />
#moodle/course:visibility - hide/show courses<br />
#moodle/category:create - create category<br />
#moodle/category:delete - create category<br />
#moodle/category:update - update category settings<br />
#moodle/category:visibility - hide/show categories<br />
#moodle/user:create - create user<br />
#moodle/user:delete - create user<br />
#moodle/user:update - update user settings<br />
#moodle/calendar:manageownentries - create/edit/delete <br />
#moodle/calendar:manageentries - create/edit/delete<br />
<br />
===Module-level Capabilities===<br />
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.<br />
<br />
The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.<br />
<br />
#Assignment<br />
##mod/assignment:view- reading the assignment description<br />
##mod/assignment:grade - grading, viewing of list of submitted assignments<br />
#Chat<br />
##mod/chat:chat - allows a user to participate in this chat<br />
##mod/chat:readlog - allows a user to read past chat session logs<br />
##mod/chat:deletelog - allows a user to delete past chat logs<br />
#Choice<br />
##mod/choice:choose - make a choice<br />
##mod/choice:readresponses - read all responses<br />
##mod/choice:deleteresponses - deletes all responses<br />
##mod/choice:downloadresponses - download responses<br />
#Database<br />
##mod/data:readentry - reads other people's entry<br />
##mod/data:writeentry - add / edit and delete (own) entries<br />
##mod/data:managetemplates - add, delete, edit fields and templates<br />
##mod/data:manageentries - edit/delete all entries<br />
##mod/data:comment - comment<br />
##mod/data:managecomments - edit/delete all comments<br />
##mod/data:rate - rate an entry<br />
##mod/data:approve - approves an entry<br />
##mod/data:uploadentries - batch upload of entries<br />
#Exercise<br />
##mod/exercise:assess<br />
#Forum<br />
##mod/forum:viewforum<br />
##mod/forum:viewdiscussion<br />
##mod/forum:viewdiscussionsfromallgroups<br />
##mod/forum:startdiscussion<br />
##mod/forum:replypost<br />
##mod/forum:viewrating<br />
##mod/forum:rate<br />
##mod/forum:attachments<br />
##mod/forum:deleteownpost<br />
##mod/forum:deleteanypost<br />
##mod/forum:splitdiscussions<br />
##mod/forum:movediscussions<br />
##mod/forum:editanypost<br />
#Glossary<br />
##mod/glossary:view - read entries<br />
##mod/glossary:write - add entries<br />
##mod/glossary:manageentries - add, edit, delete entries<br />
##mod/glossary:managecategories - create, delete, edit categories<br />
##mod/glossary:comment - comment on an entry<br />
##mod/glossary:managecomments - edit, delete comments<br />
##mod/glossary:import - import glossaries<br />
##mod/glossary:export - export glossaries<br />
##mod/glossary:approve - approve glossaries<br />
##mod/glossary:rate - rates glossary<br />
##mod/glossary:readrate - view rating?<br />
#Hotpot<br />
##mod/hotpot:view<br />
#Label<br />
##none<br />
#Lams<br />
##TBD<br />
#Lesson<br />
##TBD<br />
#Quiz<br />
##TBD<br />
#Resource<br />
##mod/resource:view<br />
#Scorm<br />
##mod/scorm:view<br />
##mod/scorm:viewgrades<br />
#Survey<br />
##mod/survey:download - downloads survery result<br />
##mod/survey:participate - participate/ do survey<br />
##mod/survey:readresponses - read all user's responese<br />
#Wiki<br />
##Waiting on new wiki<br />
#Workshop<br />
##Waiting on new Workshop<br />
<br />
<br />
<br />
==Questions==<br />
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].<br />
<br />
==Scenarios==<br />
<br />
This section is for brainstorming some example roles that we would like to support:<br />
<br />
===Student===<br />
Has this one been missed?<br />
<br />
===Site Designers===<br />
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.<br />
<br />
===Educational Authority Adviser===<br />
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.<br />
<br />
===Educational Inspector===<br />
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.<br />
<br />
===Second Marker / Moderator===<br />
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.<br />
<br />
===Peer observer of teaching===<br />
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).<br />
<br />
===External Examiner===<br />
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.<br />
<br />
===Parent===<br />
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.<br />
<br />
In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.<br />
<br />
In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.<br />
<br />
In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.<br />
<br />
Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.<br />
<br />
In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face. <br />
<br />
The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.<br />
<br />
In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.<br />
<br />
===Manager===<br />
''Please add text here...''<br />
<br />
===Weekly Seminar Leader===<br />
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''<br />
<br />
===Mentor/Mentee===<br />
''Please add text here...''<br />
<br />
===Community-Designed Rating Criteria===<br />
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''<br />
<br />
===Visitor===<br />
<br />
This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant. <br />
<br />
===Former Student===<br />
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?<br />
<br />
Is this the same as '''ALUMNUS''' ? An ALUMNUS should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when an ALUMNUS is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)<br />
<br />
===Librarian===<br />
<br />
Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.<br />
<br />
===Teacher===<br />
<br />
Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity. <br />
<br />
I think that what is needed is a simple heirarchy of permissions and levels of granularity.<br />
<br />
I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)<br />
<br />
===Community Education Tutors/Trainers===<br />
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.<br />
<br />
===Secretary/Student Worker===<br />
<br />
We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.<br />
<br />
===Teaching Assistant===<br />
<br />
Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker<br />
<br />
===Admin - Catgory based===<br />
<br />
Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.<br />
<br />
===PROCESS ROLES===<br />
<br />
organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:<br />
<li>1. Give a student the role of forum-moderator with edit and chunk-rights<br />
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week<br />
<li>3. Give students different resources, depending of their roles in a rolegame/simulation<br />
<li>4. Give a student the rights to create the section content of next week (and only that week..)<br />
<li>5. ..<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
<br />
[[ru:Роли]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Roles&diff=13286Development:Roles2006-07-21T11:25:00Z<p>Danstowell: /* Peer observer (teacher) */</p>
<hr />
<div>'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.<br />
<br />
''Please note that none of the following is finalised.''<br />
<br />
==Definitions==<br />
<br />
By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.<br />
<br />
A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.<br />
<br />
==The existing system==<br />
<br />
Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.<br />
<br />
==The new roles and capability system==<br />
<br />
The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role. <br />
<br />
To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.<br />
<br />
''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''<br />
<br />
==The plan==<br />
<br />
There are a few major things that need to be done. Here's a list (in no particular order):<br />
<br />
#Identify permissions required for site/course/each module.<br />
#Define the database structure for storing roles and capabilities.<br />
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).<br />
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?<br />
#Consider interface issues, especially how to manage conflicting role/exception rules.<br />
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?<br />
#Consider the impact on backup/restore.<br />
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.<br />
<br />
==Capabilities==<br />
<br />
This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?<br />
<br />
What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)<br />
<br />
Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.<br />
<br />
Do we need to add canview and cansearch logs at site/course/user/group level?<br />
<br />
I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)<br />
<br />
<br />
<br />
===Core-level Capabilities===<br />
<br />
Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php<br />
Do we still keep student view? What is a student view?<br />
<br />
#moodle/site:config - applicable in admin/index.php and config.php (might break down later)<br />
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now)<br />
#moodle/site:backup - can create a course backup<br />
#moodle/site:restore - can restore into this context<br />
#moodle/site:import - can import other courses into this context<br />
#moodle/blog:view - read blogs<br />
#moodle/blog:create - write new blog posts<br />
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use<br />
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use<br />
#moodle/blog:manageentries - edit/delete all blog entries<br />
#moodle/course:create - create courses<br />
#moodle/course:delete - create courses<br />
#moodle/course:update - update course settings<br />
#moodle/course:view - can use this to find participants<br />
#moodle/course:viewparticipants - allows a user to view participant list<br />
#moodle/course:viewscales - view scales (i.e. in a help window?)<br />
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)<br />
#moodle/course:managescales - add, delete, edit scales, move scales up and down<br />
#moodle/course:managegroups - managing groups, add, edit, delete<br />
#moodle/course:visibility - hide/show courses<br />
#moodle/category:create - create category<br />
#moodle/category:delete - create category<br />
#moodle/category:update - update category settings<br />
#moodle/category:visibility - hide/show categories<br />
#moodle/user:create - create user<br />
#moodle/user:delete - create user<br />
#moodle/user:update - update user settings<br />
#moodle/calendar:manageownentries - create/edit/delete <br />
#moodle/calendar:manageentries - create/edit/delete<br />
<br />
===Module-level Capabilities===<br />
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.<br />
<br />
The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.<br />
<br />
#Assignment<br />
##mod/assignment:view- reading the assignment description<br />
##mod/assignment:grade - grading, viewing of list of submitted assignments<br />
#Chat<br />
##mod/chat:chat - allows a user to participate in this chat<br />
##mod/chat:readlog - allows a user to read past chat session logs<br />
##mod/chat:deletelog - allows a user to delete past chat logs<br />
#Choice<br />
##mod/choice:choose - make a choice<br />
##mod/choice:readresponses - read all responses<br />
##mod/choice:deleteresponses - deletes all responses<br />
##mod/choice:downloadresponses - download responses<br />
#Database<br />
##mod/data:readentry - reads other people's entry<br />
##mod/data:writeentry - add / edit and delete (own) entries<br />
##mod/data:managetemplates - add, delete, edit fields and templates<br />
##mod/data:manageentries - edit/delete all entries<br />
##mod/data:comment - comment<br />
##mod/data:managecomments - edit/delete all comments<br />
##mod/data:rate - rate an entry<br />
##mod/data:approve - approves an entry<br />
##mod/data:uploadentries - batch upload of entries<br />
#Exercise<br />
##mod/exercise:assess<br />
#Forum<br />
##mod/forum:viewforum<br />
##mod/forum:viewdiscussion<br />
##mod/forum:viewdiscussionsfromallgroups<br />
##mod/forum:startdiscussion<br />
##mod/forum:replypost<br />
##mod/forum:viewrating<br />
##mod/forum:rate<br />
##mod/forum:attachments<br />
##mod/forum:deleteownpost<br />
##mod/forum:deleteanypost<br />
##mod/forum:splitdiscussions<br />
##mod/forum:movediscussions<br />
##mod/forum:editanypost<br />
#Glossary<br />
##mod/glossary:view - read entries<br />
##mod/glossary:write - add entries<br />
##mod/glossary:manageentries - add, edit, delete entries<br />
##mod/glossary:managecategories - create, delete, edit categories<br />
##mod/glossary:comment - comment on an entry<br />
##mod/glossary:managecomments - edit, delete comments<br />
##mod/glossary:import - import glossaries<br />
##mod/glossary:export - export glossaries<br />
##mod/glossary:approve - approve glossaries<br />
##mod/glossary:rate - rates glossary<br />
##mod/glossary:readrate - view rating?<br />
#Hotpot<br />
##mod/hotpot:view<br />
#Label<br />
##none<br />
#Lams<br />
##TBD<br />
#Lesson<br />
##TBD<br />
#Quiz<br />
##TBD<br />
#Resource<br />
##mod/resource:view<br />
#Scorm<br />
##mod/scorm:view<br />
##mod/scorm:viewgrades<br />
#Survey<br />
##mod/survey:download - downloads survery result<br />
##mod/survey:participate - participate/ do survey<br />
##mod/survey:readresponses - read all user's responese<br />
#Wiki<br />
##Waiting on new wiki<br />
#Workshop<br />
##Waiting on new Workshop<br />
<br />
<br />
<br />
==Questions==<br />
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].<br />
<br />
==Scenarios==<br />
<br />
This section is for brainstorming some example roles that we would like to support:<br />
<br />
===Student===<br />
Has this one been missed?<br />
<br />
===Site Designers===<br />
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.<br />
<br />
===Educational Authority Adviser===<br />
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.<br />
<br />
===Educational Inspector===<br />
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.<br />
<br />
===Second Marker / Moderator===<br />
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.<br />
<br />
===Peer observer of teaching===<br />
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).<br />
<br />
===External Examiner===<br />
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.<br />
<br />
===Parent===<br />
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.<br />
<br />
In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.<br />
<br />
In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.<br />
<br />
In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.<br />
<br />
Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.<br />
<br />
In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face. <br />
<br />
The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.<br />
<br />
In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.<br />
<br />
===Manager===<br />
''Please add text here...''<br />
<br />
===Weekly Seminar Leader===<br />
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''<br />
<br />
===Mentor/Mentee===<br />
''Please add text here...''<br />
<br />
===Community-Designed Rating Criteria===<br />
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''<br />
<br />
===Visitor===<br />
<br />
This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant. <br />
<br />
===Former Student===<br />
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?<br />
<br />
Is this the same as '''ALUMNI''' ? An ALUMNI should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when a ALUMNI is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)<br />
<br />
===Librarian===<br />
<br />
Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.<br />
<br />
===Teacher===<br />
<br />
Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity. <br />
<br />
I think that what is needed is a simple heirarchy of permissions and levels of granularity.<br />
<br />
I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)<br />
<br />
===Community Education Tutors/Trainers===<br />
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.<br />
<br />
===Secretary/Student Worker===<br />
<br />
We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.<br />
<br />
===Teaching Assistant===<br />
<br />
Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker<br />
<br />
===Admin - Catgory based===<br />
<br />
Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.<br />
<br />
===PROCESS ROLES===<br />
<br />
organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:<br />
<li>1. Give a student the role of forum-moderator with edit and chunk-rights<br />
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week<br />
<li>3. Give students different resources, depending of their roles in a rolegame/simulation<br />
<li>4. Give a student the rights to create the section content of next week (and only that week..)<br />
<li>5. ..<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
<br />
[[ru:Роли]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:Roles&diff=13285Development:Roles2006-07-21T11:24:34Z<p>Danstowell: /* Scenarios */ Added peer reviewer</p>
<hr />
<div>'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.<br />
<br />
''Please note that none of the following is finalised.''<br />
<br />
==Definitions==<br />
<br />
By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.<br />
<br />
A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.<br />
<br />
==The existing system==<br />
<br />
Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.<br />
<br />
==The new roles and capability system==<br />
<br />
The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role. <br />
<br />
To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.<br />
<br />
''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''<br />
<br />
==The plan==<br />
<br />
There are a few major things that need to be done. Here's a list (in no particular order):<br />
<br />
#Identify permissions required for site/course/each module.<br />
#Define the database structure for storing roles and capabilities.<br />
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).<br />
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?<br />
#Consider interface issues, especially how to manage conflicting role/exception rules.<br />
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?<br />
#Consider the impact on backup/restore.<br />
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.<br />
<br />
==Capabilities==<br />
<br />
This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?<br />
<br />
What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)<br />
<br />
Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.<br />
<br />
Do we need to add canview and cansearch logs at site/course/user/group level?<br />
<br />
I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)<br />
<br />
<br />
<br />
===Core-level Capabilities===<br />
<br />
Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php<br />
Do we still keep student view? What is a student view?<br />
<br />
#moodle/site:config - applicable in admin/index.php and config.php (might break down later)<br />
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now)<br />
#moodle/site:backup - can create a course backup<br />
#moodle/site:restore - can restore into this context<br />
#moodle/site:import - can import other courses into this context<br />
#moodle/blog:view - read blogs<br />
#moodle/blog:create - write new blog posts<br />
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use<br />
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use<br />
#moodle/blog:manageentries - edit/delete all blog entries<br />
#moodle/course:create - create courses<br />
#moodle/course:delete - create courses<br />
#moodle/course:update - update course settings<br />
#moodle/course:view - can use this to find participants<br />
#moodle/course:viewparticipants - allows a user to view participant list<br />
#moodle/course:viewscales - view scales (i.e. in a help window?)<br />
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)<br />
#moodle/course:managescales - add, delete, edit scales, move scales up and down<br />
#moodle/course:managegroups - managing groups, add, edit, delete<br />
#moodle/course:visibility - hide/show courses<br />
#moodle/category:create - create category<br />
#moodle/category:delete - create category<br />
#moodle/category:update - update category settings<br />
#moodle/category:visibility - hide/show categories<br />
#moodle/user:create - create user<br />
#moodle/user:delete - create user<br />
#moodle/user:update - update user settings<br />
#moodle/calendar:manageownentries - create/edit/delete <br />
#moodle/calendar:manageentries - create/edit/delete<br />
<br />
===Module-level Capabilities===<br />
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.<br />
<br />
The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.<br />
<br />
#Assignment<br />
##mod/assignment:view- reading the assignment description<br />
##mod/assignment:grade - grading, viewing of list of submitted assignments<br />
#Chat<br />
##mod/chat:chat - allows a user to participate in this chat<br />
##mod/chat:readlog - allows a user to read past chat session logs<br />
##mod/chat:deletelog - allows a user to delete past chat logs<br />
#Choice<br />
##mod/choice:choose - make a choice<br />
##mod/choice:readresponses - read all responses<br />
##mod/choice:deleteresponses - deletes all responses<br />
##mod/choice:downloadresponses - download responses<br />
#Database<br />
##mod/data:readentry - reads other people's entry<br />
##mod/data:writeentry - add / edit and delete (own) entries<br />
##mod/data:managetemplates - add, delete, edit fields and templates<br />
##mod/data:manageentries - edit/delete all entries<br />
##mod/data:comment - comment<br />
##mod/data:managecomments - edit/delete all comments<br />
##mod/data:rate - rate an entry<br />
##mod/data:approve - approves an entry<br />
##mod/data:uploadentries - batch upload of entries<br />
#Exercise<br />
##mod/exercise:assess<br />
#Forum<br />
##mod/forum:viewforum<br />
##mod/forum:viewdiscussion<br />
##mod/forum:viewdiscussionsfromallgroups<br />
##mod/forum:startdiscussion<br />
##mod/forum:replypost<br />
##mod/forum:viewrating<br />
##mod/forum:rate<br />
##mod/forum:attachments<br />
##mod/forum:deleteownpost<br />
##mod/forum:deleteanypost<br />
##mod/forum:splitdiscussions<br />
##mod/forum:movediscussions<br />
##mod/forum:editanypost<br />
#Glossary<br />
##mod/glossary:view - read entries<br />
##mod/glossary:write - add entries<br />
##mod/glossary:manageentries - add, edit, delete entries<br />
##mod/glossary:managecategories - create, delete, edit categories<br />
##mod/glossary:comment - comment on an entry<br />
##mod/glossary:managecomments - edit, delete comments<br />
##mod/glossary:import - import glossaries<br />
##mod/glossary:export - export glossaries<br />
##mod/glossary:approve - approve glossaries<br />
##mod/glossary:rate - rates glossary<br />
##mod/glossary:readrate - view rating?<br />
#Hotpot<br />
##mod/hotpot:view<br />
#Label<br />
##none<br />
#Lams<br />
##TBD<br />
#Lesson<br />
##TBD<br />
#Quiz<br />
##TBD<br />
#Resource<br />
##mod/resource:view<br />
#Scorm<br />
##mod/scorm:view<br />
##mod/scorm:viewgrades<br />
#Survey<br />
##mod/survey:download - downloads survery result<br />
##mod/survey:participate - participate/ do survey<br />
##mod/survey:readresponses - read all user's responese<br />
#Wiki<br />
##Waiting on new wiki<br />
#Workshop<br />
##Waiting on new Workshop<br />
<br />
<br />
<br />
==Questions==<br />
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].<br />
<br />
==Scenarios==<br />
<br />
This section is for brainstorming some example roles that we would like to support:<br />
<br />
===Student===<br />
Has this one been missed?<br />
<br />
===Site Designers===<br />
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.<br />
<br />
===Educational Authority Adviser===<br />
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.<br />
<br />
===Educational Inspector===<br />
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.<br />
<br />
===Second Marker / Moderator===<br />
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.<br />
<br />
===Peer observer (teacher)===<br />
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).<br />
<br />
===External Examiner===<br />
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.<br />
<br />
===Parent===<br />
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.<br />
<br />
In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.<br />
<br />
In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.<br />
<br />
In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.<br />
<br />
Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.<br />
<br />
In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face. <br />
<br />
The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.<br />
<br />
In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.<br />
<br />
===Manager===<br />
''Please add text here...''<br />
<br />
===Weekly Seminar Leader===<br />
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''<br />
<br />
===Mentor/Mentee===<br />
''Please add text here...''<br />
<br />
===Community-Designed Rating Criteria===<br />
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''<br />
<br />
===Visitor===<br />
<br />
This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant. <br />
<br />
===Former Student===<br />
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?<br />
<br />
Is this the same as '''ALUMNI''' ? An ALUMNI should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when a ALUMNI is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)<br />
<br />
===Librarian===<br />
<br />
Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.<br />
<br />
===Teacher===<br />
<br />
Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity. <br />
<br />
I think that what is needed is a simple heirarchy of permissions and levels of granularity.<br />
<br />
I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)<br />
<br />
===Community Education Tutors/Trainers===<br />
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.<br />
<br />
===Secretary/Student Worker===<br />
<br />
We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.<br />
<br />
===Teaching Assistant===<br />
<br />
Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker<br />
<br />
===Admin - Catgory based===<br />
<br />
Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.<br />
<br />
===PROCESS ROLES===<br />
<br />
organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:<br />
<li>1. Give a student the role of forum-moderator with edit and chunk-rights<br />
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week<br />
<li>3. Give students different resources, depending of their roles in a rolegame/simulation<br />
<li>4. Give a student the rights to create the section content of next week (and only that week..)<br />
<li>5. ..<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion<br />
<br />
[[Category:Developer]]<br />
[[Category:Future]]<br />
<br />
<br />
[[ru:Роли]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:UK_MoodleMoot_06_hackfest&diff=13284Development:UK MoodleMoot 06 hackfest2006-07-21T11:10:44Z<p>Danstowell: Added MoodleSpeex</p>
<hr />
<div>''Willkommen zum Hackfest'' (OK - I've been watching too much WorldCup on TV). <br />
<br />
The first MoodleMoot hackfest is nearly upon us... and we don't have an agenda!<br />
<br />
This is an open source agenda for the hackfest. We'll have a day before the Moot to geek out on some code, maybe develop a feature or two, fix some bugs and generally make our favorite learning system a happier place. But I leave it up to you to tell me exactly what we should do. We have four or five rooms with internet connections, a few projectors, and I'll try to get pizza. <br />
<br />
Let's start by brainstorming some ideas here for a few days. If someone posts something you're interested in, put your name under it as a vote. The top votes become our central organizing ideas. For example<br />
<br />
==Practical arrangements==<br />
<br />
'''Date''': Monday 24th July, 2006<br />
<br />
'''Time''': From about 10:00am<br />
<br />
'''How to get to the OU''': http://www3.open.ac.uk/contact/locations.aspx<br />
<br />
'''Where to go first''': You will need to report to main OU reception (in red on the [http://www3.open.ac.uk/contact/maps/wh-campus.gif campus map]) when you arrive to get signed in (I assume). I assume that Jason will have given reception a list of names, so they know who to expect.<br />
<br />
'''Where to go next''': We will be in the Christodoulou Meeting rooms. On the map, find Walton Drive, and follow the line of that up.<br />
<br />
'''What to bring''': Please bring a laptop if you can. Food and drink are available on the OU campus, so you don't need to bring that.<br />
<br />
==1 Bug fixing==<br />
<br />
Let's spend a few hours and hunt down as many outstanding bugs in 1.6 as possible. Bounties for most bugs killed, trickiest bug killed, and most unusual bug killed.<br />
<br />
''I'm Interested:''<br />
# Jason Cole<br />
# skodak<br />
# martin langhoff (auth & enrolment specifically).<br />
# Martin Dougiamas<br />
# Juliette White (arriving late though!)<br />
# Dan Stowell<br />
<br />
(iarenaza) I won't be there, but here are a couple of bugs for Martin L., related to auth: #4648 and #5373. Very easy to fix :-)<br />
<br />
==2 What next for the quiz module?==<br />
<br />
If any other quizzy people are there, we should have a talk about where we see the quiz module going.<br />
<br />
I/the OU have the following priorities:<br />
<br />
# Make question type plugins really plug-in-able. At the moment there are some limitations:<br />
#* All the lang strings are still in lang/en_utf8/quiz.php.<br />
#* qtype plugins cannot easily feed CSS and Javascript into the page.<br />
#* pluggable qtypes and pluggable inport/export filters don't play nicely together.<br />
# Write some new question types.<br />
# Make some improvements to existing question types.<br />
# Get RQP working again, so our in-house question engine can talk to Moodle.<br />
<br />
I'm not going to be there, but I think it would be helpful if you were to discuss ways in which the teacher's usage of the quiz module could be made more efficient, more in terms of grading than in creating quizzes (as there have already been a lot of improvements in that respect in 1.6). I've submitted a lot of bug reports about this already but personally efficiency would be more of a priority to me than new question types.--[[User:N Hansen|N Hansen]] 08:27, 12 July 2006 (WST)<br />
<br />
''I'm Interested:''<br />
# Tim Hunt<br />
# Jamie Pratt<br />
<br />
==Performance profiling==<br />
<br />
Pick a (memory|database) hog and put it on a diet. <br />
<br />
''I'm interested''<br />
<br />
# martin langhoff<br />
# dave scotson (particularly the TinyMCE performance issues mentioned recently by Martin D)<br />
<br />
(iarenaza) Once again, I won't be there, but here's an unfixed bug in 1.6.x and HEAD (was fixed in 1.5.x, but not applied to HEAD at the moment): bug #4591<br />
<br />
==Hacking on the OLPC Board==<br />
<br />
MartinL will be bringing the OLPC board (if it is booting, and customs allows!) for people to have a play with it. If we have any Mozilla/XUL experts in the house, he will want to explore building a limited cached Moodle UI with it for offline work.<br />
<br />
'''Note:''' We will need some spare parts & hardware to get the board going. I will bring a power supply, but a VGA monitor, USB mouse + keyboard, USB ext disk, USB hub, and open wifi (no ethernet on the board) will be needed. <br />
<br />
''JC: We'll make sure you have the appropriate stuff. I need a USB disk anyway.''<br />
<br />
''I'm interested:''<br />
<br />
# martin langhoff<br />
# Jason Cole<br />
<br />
==How to save/retrieve a complete section from stock?==<br />
Now the sections become more and more accepted as the tasksets for a week, our teachers wish to have topic oriented stores (courses for the moment) as section stores and want to copy one/more sections form that task store to a clean course..<br />
<br />
''(In the end we wish that students can select sections from the store to compose their own courses, until the teacher freezes their choice set and the learning game can begin.)''<br />
<br />
''I'm interested:''<br />
# Ger Tielemans (I arrive a little later, so start with the bugs first, please :))<br />
# Jan Kater (same arrival=same message as Ger T.)<br />
<br />
==How to reveale files outside a course without using datadir for course 1?==<br />
Can someone explain the right setup and use of the exception array: <br />
- we want to show a student (after login) only his own file from that store<br />
- we want to show a teacher/tutor only the files from the students in his course(s)<br />
<br />
''I'm interested:''<br />
# Ger Tielemans<br />
# Jan Kater<br />
<br />
==How to repair the last bug in the old bookmark option ?==<br />
We changed William's bookmark in a student only note-taking tool and (thanks Chardelle!) almost repaired the complete bookmark for 1.6. (and it can be accessed from My Page)<br />
Bug: Only when the user tries to sort the heder in the overview, the text of the headers disappear.<br />
Code clean-up: how to remove obsolete code and make the bookmark pages secure?<br />
(Wish for new code: categories are privat, so allow a student to delete a self created category)<br />
<br />
''I'm interested:''<br />
Ger Tielemans<br />
<br />
==How to insert a HTML-editor in old code block and make it secure ?==<br />
To make the set of student note-taking tools complete, I found old code to have a global private notebook.<br />
(I group this with bookmarks in the calender, so the student has: 1. privat time-related-notes in the calendar, 2. a button for the overview of the privat page-related-notes under the calendar and 3. a global privat notebook for other scribbles..) <br />
On this moment this piece of code has a flat text editor, would be nice to have HTML or even the new (Ajax?) miniWiki?) <br />
<br />
With the new "View as student button" check like if isstudent() {..show..} offers teachers and admins empty - only for real student - spots (so an error)<br />
<br />
''I'm interested:''<br />
# Ger Tielemans<br />
# Jan Kater<br />
<br />
== Improve the way we integrate Rubrics in Moodle, like... ==<br />
http://docs.subjectivemetrics.com/User/cam/rubistar/rs_overview.html (Warning! Has loud audio!)<br />
<br />
maybe with some flavors of...<br />
<br />
http://ipeer.apsc.ubc.ca/ipeer_site/<br />
<br />
== ImportOOI in Lesson==<br />
KISS, a tweak of ImportPPT that just grabs the jpgs from a web folder created by Open Office Impress and inserts them into page content of branch tables. No text. Maybe as an option routine if it can't find the outline.htm file ? Or as a version of ImportPPT that only imports these jpg files. <br />
<br />
#chris collman - wish I could join you and learn<br />
<br />
http://moodle.org/mod/forum/discuss.php?d=49714<br />
<br />
==Page-Based Chat Roster and Whiteboard ==<br />
<br />
The COVCELL project is developing a chat module (based on jabber) for Moodle. Chat rosters are to be generated on a per-page basis, so that anyone who is logged in and is viewing a particular page will be able to see who else is viewing that page and start a chat session with them. Group chat will be supported and it will be possible to use a whiteboard (based on Coccinella) in the chat.<br />
<br />
More information can be found at:<br />
* http://covcell.cms.hu-berlin.de/tracov/wiki/Phase_I<br />
* http://covcell.org/<br />
<br />
''I'm Interested:''<br />
# Heinz Kuper<br />
# Steinn Sigurðarson<br />
# Jens-Martin Loebel<br />
<br />
==AV Conferencing and Recording ==<br />
<br />
The COVCELL project is developing a module to provide audio-visual conferencing functionality within Moodle. It shall also be possible to record streams. Our development is based on the Red5 project, which is an open source development of the Flash Comm server.<br />
<br />
More information can be found at:<br />
* http://www.osflash.org/red5<br />
* http://covcell.org/<br />
<br />
''I'm Interested:''<br />
# Heinz Kuper<br />
# Steinn Sigurðarson<br />
# Jens-Martin Loebel<br />
# Alex Little<br />
# Dan Stowell<br />
# Andrew Slaughter<br />
<br />
==MoodleSpeex voice messaging==<br />
<br />
I've developed a java applet framework for voice messaging called [http://moodle.org/mod/forum/discuss.php?d=50265 MoodleSpeex] (because it uses the [http://www.speex.org/ Speex codec]). It currently allows forums to be converted into speech-based forums, but there are other potential applications. If there are any Java coders in the house it would be great to get some improvements into that.<br />
<br />
''I'm Interested:''<br />
# Dan Stowell<br />
<br />
<br />
==Add your suggestion here ...==<br />
<br />
<br />
<br />
Go on, you know you want to.<br />
<br />
==See also==<br />
* [http://moodlemoot.org/ http://moodlemoot.org/]<br />
<br />
[[Category:Developer]]</div>Danstowellhttps://docs.moodle.org/37/en/index.php?title=Development:UK_MoodleMoot_06_hackfest&diff=13236Development:UK MoodleMoot 06 hackfest2006-07-20T09:49:53Z<p>Danstowell: /* AV Conferencing and Recording */</p>
<hr />
<div>''Willkommen zum Hackfest'' (OK - I've been watching too much WorldCup on TV). <br />
<br />
The first MoodleMoot hackfest is nearly upon us... and we don't have an agenda!<br />
<br />
This is an open source agenda for the hackfest. We'll have a day before the Moot to geek out on some code, maybe develop a feature or two, fix some bugs and generally make our favorite learning system a happier place. But I leave it up to you to tell me exactly what we should do. We have four or five rooms with internet connections, a few projectors, and I'll try to get pizza. <br />
<br />
Let's start by brainstorming some ideas here for a few days. If someone posts something you're interested in, put your name under it as a vote. The top votes become our central organizing ideas. For example<br />
<br />
==Practical arrangements==<br />
<br />
'''Date''': Monday 24th July, 2006<br />
<br />
'''Time''': From about 10:00am<br />
<br />
'''How to get to the OU''': http://www3.open.ac.uk/contact/locations.aspx<br />
<br />
'''Where to go first''': You will need to report to main OU reception (in red on the [http://www3.open.ac.uk/contact/maps/wh-campus.gif campus map]) when you arrive to get signed in (I assume). I assume that Jason will have given reception a list of names, so they know who to expect.<br />
<br />
'''Where to go next''': We will be in the Christodoulou Meeting rooms. On the map, find Walton Drive, and follow the line of that up.<br />
<br />
'''What to bring''': Please bring a laptop if you can. Food and drink are available on the OU campus, so you don't need to bring that.<br />
<br />
==1 Bug fixing==<br />
<br />
Let's spend a few hours and hunt down as many outstanding bugs in 1.6 as possible. Bounties for most bugs killed, trickiest bug killed, and most unusual bug killed.<br />
<br />
''I'm Interested:''<br />
# Jason Cole<br />
# skodak<br />
# martin langhoff (auth & enrolment specifically).<br />
# Martin Dougiamas<br />
# Juliette White (arriving late though!)<br />
# Dan Stowell<br />
<br />
(iarenaza) I won't be there, but here are a couple of bugs for Martin L., related to auth: #4648 and #5373. Very easy to fix :-)<br />
<br />
==2 What next for the quiz module?==<br />
<br />
If any other quizzy people are there, we should have a talk about where we see the quiz module going.<br />
<br />
I/the OU have the following priorities:<br />
<br />
# Make question type plugins really plug-in-able. At the moment there are some limitations:<br />
#* All the lang strings are still in lang/en_utf8/quiz.php.<br />
#* qtype plugins cannot easily feed CSS and Javascript into the page.<br />
#* pluggable qtypes and pluggable inport/export filters don't play nicely together.<br />
# Write some new question types.<br />
# Make some improvements to existing question types.<br />
# Get RQP working again, so our in-house question engine can talk to Moodle.<br />
<br />
I'm not going to be there, but I think it would be helpful if you were to discuss ways in which the teacher's usage of the quiz module could be made more efficient, more in terms of grading than in creating quizzes (as there have already been a lot of improvements in that respect in 1.6). I've submitted a lot of bug reports about this already but personally efficiency would be more of a priority to me than new question types.--[[User:N Hansen|N Hansen]] 08:27, 12 July 2006 (WST)<br />
<br />
''I'm Interested:''<br />
# Tim Hunt<br />
# Jamie Pratt<br />
<br />
==Performance profiling==<br />
<br />
Pick a (memory|database) hog and put it on a diet. <br />
<br />
''I'm interested''<br />
<br />
# martin langhoff<br />
# dave scotson (particularly the TinyMCE performance issues mentioned recently by Martin D)<br />
<br />
(iarenaza) Once again, I won't be there, but here's an unfixed bug in 1.6.x and HEAD (was fixed in 1.5.x, but not applied to HEAD at the moment): bug #4591<br />
<br />
==Hacking on the OLPC Board==<br />
<br />
MartinL will be bringing the OLPC board (if it is booting, and customs allows!) for people to have a play with it. If we have any Mozilla/XUL experts in the house, he will want to explore building a limited cached Moodle UI with it for offline work.<br />
<br />
'''Note:''' We will need some spare parts & hardware to get the board going. I will bring a power supply, but a VGA monitor, USB mouse + keyboard, USB ext disk, USB hub, and open wifi (no ethernet on the board) will be needed. <br />
<br />
''JC: We'll make sure you have the appropriate stuff. I need a USB disk anyway.''<br />
<br />
''I'm interested:''<br />
<br />
# martin langhoff<br />
# Jason Cole<br />
<br />
==How to save/retrieve a complete section from stock?==<br />
Now the sections become more and more accepted as the tasksets for a week, our teachers wish to have topic oriented stores (courses for the moment) as section stores and want to copy one/more sections form that task store to a clean course..<br />
<br />
''(In the end we wish that students can select sections from the store to compose their own courses, until the teacher freezes their choice set and the learning game can begin.)''<br />
<br />
''I'm interested:''<br />
# Ger Tielemans (I arrive a little later, so start with the bugs first, please :))<br />
# Jan Kater (same arrival=same message as Ger T.)<br />
<br />
==How to reveale files outside a course without using datadir for course 1?==<br />
Can someone explain the right setup and use of the exception array: <br />
- we want to show a student (after login) only his own file from that store<br />
- we want to show a teacher/tutor only the files from the students in his course(s)<br />
<br />
''I'm interested:''<br />
# Ger Tielemans<br />
# Jan Kater<br />
<br />
==How to repair the last bug in the old bookmark option ?==<br />
We changed William's bookmark in a student only note-taking tool and (thanks Chardelle!) almost repaired the complete bookmark for 1.6. (and it can be accessed from My Page)<br />
Bug: Only when the user tries to sort the heder in the overview, the text of the headers disappear.<br />
Code clean-up: how to remove obsolete code and make the bookmark pages secure?<br />
(Wish for new code: categories are privat, so allow a student to delete a self created category)<br />
<br />
''I'm interested:''<br />
Ger Tielemans<br />
<br />
==How to insert a HTML-editor in old code block and make it secure ?==<br />
To make the set of student note-taking tools complete, I found old code to have a global private notebook.<br />
(I group this with bookmarks in the calender, so the student has: 1. privat time-related-notes in the calendar, 2. a button for the overview of the privat page-related-notes under the calendar and 3. a global privat notebook for other scribbles..) <br />
On this moment this piece of code has a flat text editor, would be nice to have HTML or even the new (Ajax?) miniWiki?) <br />
<br />
With the new "View as student button" check like if isstudent() {..show..} offers teachers and admins empty - only for real student - spots (so an error)<br />
<br />
''I'm interested:''<br />
# Ger Tielemans<br />
# Jan Kater<br />
<br />
== Improve the way we integrate Rubrics in Moodle, like... ==<br />
http://docs.subjectivemetrics.com/User/cam/rubistar/rs_overview.html (Warning! Has loud audio!)<br />
<br />
maybe with some flavors of...<br />
<br />
http://ipeer.apsc.ubc.ca/ipeer_site/<br />
<br />
== ImportOOI in Lesson==<br />
KISS, a tweak of ImportPPT that just grabs the jpgs from a web folder created by Open Office Impress and inserts them into page content of branch tables. No text. Maybe as an option routine if it can't find the outline.htm file ? Or as a version of ImportPPT that only imports these jpg files. <br />
<br />
#chris collman - wish I could join you and learn<br />
<br />
http://moodle.org/mod/forum/discuss.php?d=49714<br />
<br />
==Page-Based Chat Roster and Whiteboard ==<br />
<br />
The COVCELL project is developing a chat module (based on jabber) for Moodle. Chat rosters are to be generated on a per-page basis, so that anyone who is logged in and is viewing a particular page will be able to see who else is viewing that page and start a chat session with them. Group chat will be supported and it will be possible to use a whiteboard (based on Coccinella) in the chat.<br />
<br />
More information can be found at:<br />
* http://covcell.cms.hu-berlin.de/tracov/wiki/Phase_I<br />
* http://covcell.org/<br />
<br />
''I'm Interested:''<br />
# Heinz Kuper<br />
# Steinn Sigurðarson<br />
# Jens-Martin Loebel<br />
<br />
==AV Conferencing and Recording ==<br />
<br />
The COVCELL project is developing a module to provide audio-visual conferencing functionality within Moodle. It shall also be possible to record streams. Our development is based on the Red5 project, which is an open source development of the Flash Comm server.<br />
<br />
More information can be found at:<br />
* http://www.osflash.org/red5<br />
* http://covcell.org/<br />
<br />
''I'm Interested:''<br />
# Heinz Kuper<br />
# Steinn Sigurðarson<br />
# Jens-Martin Loebel<br />
# Alex Little<br />
# Dan Stowell<br />
<br />
==Add your suggestion here ...==<br />
<br />
<br />
<br />
Go on, you know you want to.<br />
<br />
==See also==<br />
* [http://moodlemoot.org/ http://moodlemoot.org/]<br />
<br />
[[Category:Developer]]</div>Danstowell