MoodleDocs - User contributions [en]

Implementing Reset course functionality in a module

2008-11-09T20:26:06Z

Dlnsk:

The course reset code is triggered from /course/reset.php. To have your module included, you need to implement the three fuctions described below. To work out how to do this, a good example is to look at the implementations in /mod/fourm/lib.php

==''mymodule''_reset_course_form_definition(&$mform)==

This is called directly by /course/reset.php. It needs to output some form controls to control different options for resetting your module. You should use Form API for create form.

The convention is to call settings relating your your module reset_''mymodule''_''something''.

The forum implementation is a good model:

<pre><nowiki>
/**
* Called by course/reset.php
*/
function forum_reset_course_form_definition(&$mform) {
$mform->addElement('header', 'forumheader', get_string('modulenameplural', 'forum'));

$mform->addElement('checkbox', 'reset_forum_all', get_string('resetforumsall','forum'));

$mform->addElement('select', 'reset_forum_types', get_string('resetforums', 'forum'), forum_get_forum_types_all(), array('multiple' => 'multiple'));
$mform->setAdvanced('reset_forum_types');
$mform->disabledIf('reset_forum_types', 'reset_forum_all', 'checked');

$mform->addElement('checkbox', 'reset_forum_subscriptions', get_string('resetsubscriptions','forum'));
$mform->setAdvanced('reset_forum_subscriptions');

$mform->addElement('checkbox', 'reset_forum_track_prefs', get_string('resettrackprefs','forum'));
$mform->setAdvanced('reset_forum_track_prefs');
$mform->disabledIf('reset_forum_track_prefs', 'reset_forum_all', 'checked');

$mform->addElement('checkbox', 'reset_forum_ratings', get_string('deleteallratings'));
$mform->disabledIf('reset_forum_ratings', 'reset_forum_all', 'checked');
}
</nowiki></pre>

==''mymodule''_reset_userdata($data)==

This actually does the resetting. It is called indirectly, /course/reset.php calls reset_course_userdata() in /lib/moodlelib.php, which then calls the functions for each module.

The $data parameter is what came back from the form printed by forum_reset_course. In particular, $data->courseid is the id of the coures we are cleaning up.

The forum implementation is again a good one to study, here is a very simple example:

<pre><nowiki>
function example_reset_userdata($data) {
if (!empty($data->reset_example_frogs)) {
if (delete_records('example_frogs', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('frogsdeleted', 'example'), 'notifysuccess');
}
}
if (!empty($data->reset_example_newts)) {
if (delete_records('example_newts', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('newtsdeleted', 'example'), 'notifysuccess');
}
}
}
</nowiki></pre>

==''mymodule''_reset_course_form_defaults($course)==

Used for set default values to form's elements displayed by ''mymodule''_reset_course_form_definition. The forum implementation:

<pre><nowiki>
function forum_reset_course_form_defaults($course) {
return array('reset_forum_all'=>1, 'reset_forum_subscriptions'=>0, 'reset_forum_track_prefs'=>0, 'reset_forum_ratings'=>1);
}
</nowiki></pre>

[[ja:開発:コースのリセット機能をモジュールに実装する]]

Implementing Reset course functionality in a module

2008-11-07T19:08:46Z

Dlnsk: Metods renamed, using Form API

The course reset code is triggered from /course/reset.php. To have your module included, you need to implement the three fuctions described below. To work out how to do this, a good example is to look at the implementations in /mod/fourm/lib.php

==''mymodule''_reset_course_form_definition(&$mform)==

This is called directly by /course/reset.php. It needs to output some form controls to control different options for resetting your module. You should use Form API for create form.

The convention is to call settings relating your your module reset_''mymodule''_''something''.

The forum implementation is a good model:

<pre><nowiki>
/**
* Called by course/reset.php
*/
function forum_reset_course_form_definition(&$mform) {
$mform->addElement('header', 'forumheader', get_string('modulenameplural', 'forum'));

$mform->addElement('checkbox', 'reset_forum_all', get_string('resetforumsall','forum'));

$mform->addElement('select', 'reset_forum_types', get_string('resetforums', 'forum'), forum_get_forum_types_all(), array('multiple' => 'multiple'));
$mform->setAdvanced('reset_forum_types');
$mform->disabledIf('reset_forum_types', 'reset_forum_all', 'checked');

$mform->addElement('checkbox', 'reset_forum_subscriptions', get_string('resetsubscriptions','forum'));
$mform->setAdvanced('reset_forum_subscriptions');

$mform->addElement('checkbox', 'reset_forum_track_prefs', get_string('resettrackprefs','forum'));
$mform->setAdvanced('reset_forum_track_prefs');
$mform->disabledIf('reset_forum_track_prefs', 'reset_forum_all', 'checked');

$mform->addElement('checkbox', 'reset_forum_ratings', get_string('deleteallratings'));
$mform->disabledIf('reset_forum_ratings', 'reset_forum_all', 'checked');
}
</nowiki></pre>

==''mymodule''_reset_userdata($data)==

This actually does the resetting. It is called indirectly, /course/reset.php calls reset_course_userdata() in /lib/moodlelib.php, which then calls the functions for each module.

The $data parameter is what came back from the form printed by forum_reset_course. In particular, $data->courseid is the id of the coures we are cleaning up.

The forum implementation is again a good one to study, here is a very simple example:

<pre><nowiki>
function example_reset_userdata($data) {
if (!empty($data->reset_example_frogs)) {
if (delete_records('example_frogs', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('frogsdeleted', 'example'), 'notifysuccess');
}
}
if (!empty($data->reset_example_newts)) {
if (delete_records('example_newts', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('newtsdeleted', 'example'), 'notifysuccess');
}
}
}
</nowiki></pre>

==''mymodule''reset_course_form_defaults($course)==

Used for set default values to form's elements displayed by ''mymodule''_reset_course_form_definition. The forum implementation:

<pre><nowiki>
function forum_reset_course_form_defaults($course) {
return array('reset_forum_all'=>1, 'reset_forum_subscriptions'=>0, 'reset_forum_track_prefs'=>0, 'reset_forum_ratings'=>1);
}
</nowiki></pre>

[[ja:開発:コースのリセット機能をモジュールに実装する]]

Filters schema

2008-03-27T09:48:48Z

Dlnsk: get_html_head_contributions

The objective of this page is to document all the ideas and improvements to be implemented in the "Filters" functionality of Moodle.

Every idea will be documented here, including its associated "thoughts" and potential "implementations". Feel free to add/modify everything as you want!

These are the main areas to discuss/analyse/implement:

* [[Course/site filters | Enable/Disable Filters by Course and Site]]
* [[Course/site filter config | Optional Configuration of Filters by Course and Site]]
* [[Multilang filter | Changes in the Caching System to Support the Multilang Filter]]
* [[Enable/Disable Filters by Activities]]
* Allow filtering data before it will save in database? It will do possible exclude some data from text (like TeX formulas) and save in separate table. It will allow change formula by clicking on it and open popup window.
* It'd be great if you could set the text cache lifetime for individual filters. This would be handy for filters that use external resources (e.g., Wikipedia) that sometimes have slow response times. I'd guess that you could use a cache lifetime of a week or more for a Wikipedia filter without causing major usability problems.
* Mechanism like used with get_html_head_contributions in Questions

==See also==

*[http://moodle.org/bugs/bug.php?op=show&bugid=2400 Bug 2400] - a lot of ideas and request have been written here
http://tracker.moodle.org/browse/MDL-9443 - add support for filtering XHTML resources as well as HTML.

[[Category:Filters schema]]

Wiki features

2008-03-05T12:12:02Z

Dlnsk: Simple access to rendering pages outside Wiki module

Features wanted for the Wiki in Moodle 2.0, and status of existence in existing wikis :

{| border="1" cellpadding="2" cellspacing="0"
|-
!Wanted feature
!eWiki (Moodle 1.8 etc)
!NWiki
!OUWiki
!Comment

|-
|Mediawiki syntax
|No
|Yes
|No
|There should be option to use Mediawiki syntax also in forums, resources, etc. - new text format.

|-
|Ability to quickly summarize a students total overall contributions e.g. words added/words deleted/comments added
|No
|?
|Soon
|I have not had time to fully explore nwikis grading system, but suspect there is a way in there somewhere :)

|-
|Preserve line breaks
|?
|?
|No
|Information is often pasted into a wiki, a wiki is used by younger students, or there are a quick succession of edits during class, such as creating a list, that require preserved line breaks. Using Creole Wiki Markup as the ONLY markup unfortunately destroys pasting in information and trying to find every crlf in a pasted document and replace it with a /n is beyond most users. We have to remember that wikis will often be used by those who have never used one before.

|-
|Ability to add an "add to the page" box anywhere, or multiple times, in a page
|no
|no
|no
|The "Add to the page" box would be added using very simple markup (e.g., it is a plus sign at the beginning of a line in Swiki). The button has a small text area with it that can be typed in and, when the button is clicked, the information goes straight to that spot in a wiki. We use this for brainstorming in class with several groups so they can work in a small group but see and build a common document. Adding comments to students' pages, either by other students, or the students place the box at the top of the page and a teacher can quickly make a comment and move on. Even during meetings several of us share recording duties, and with the add to the page box, we can each be typing then submit. Properly implemented, this eliminates editing collisions in these situations. Each submit is treated as a separate page edit in the editing recored. Additional characters or markup beyond the one to insert the box would give the option of having lines between, keeping the box above the submissions (so it stays in place), or adding a time/date/user stamp in a different font to identify who added the information.

|-
|RSS feeds on changes to a page and changes to the Wiki
|no
|?
|yes
|RSS is increasingly the way I like to consume and remix my information.

|-
|Simple access to rendering pages outside Wiki module
|?
|dfWiki
|?
|Many many time ago I have developed tool for including wiki page in any other Moodle resources. Details here:
http://moodle.org/mod/forum/discuss.php?d=42325

But in NWiki this became impossible because rendering page outside wiki module became very difficult!
I dream that in official Moodle's wiki this will once again become possible! And promise update this tool! ;-)

|-
|
|
|
|
|}

Reporting student contributions to OU wiki is one of the reports we are currently working on, I think.