Difference between revisions of "Event reminders"

Jump to: navigation, search
Line 1: Line 1:
 
==Introduction ==
 
==Introduction ==
 
[[File:reminders_icon.png]] <br>
 
[[File:reminders_icon.png]] <br>
Reminders plugin is about creating a set of reminders for Moodle calendar events and sending them automatically to relevant users on timely manner via Moodle message interface. This is a local plugin.
+
The Calendar Reminders plugin creates reminders for Moodle calendar events and sends them automatically to relevant users in a timely manner via Moodle messaging interface. This is a local plugin controlled by the site administrator.
  
 
==Features==
 
==Features==
* Reminders can be customized by message content or delivering time/methods according to the event types.
+
* Reminders can have customised delivery times/methods according to event types.
* Plugin is responsible to send reminders for calendar events.
+
* Users can control how they receive calendar reminders in their messaging preferences.
* Automatic sending of reminders.
+
* Reminders are automatically sent (as long as the system [[Cron]] process is set up).
  
 
==Installation==
 
==Installation==
:1. Fetch the plug-in from following location.
+
# Fetch the plug-in from following location.
::* Goto [http://moodle.org/plugins/view.php?plugin=local_reminders Reminders] and download the latest version from the repository.
+
#* Go to [http://moodle.org/plugins/view.php?plugin=local_reminders Reminders] and download the latest version from the repository.
:2. Go to the 'local' directory inside Moodle root directory.
+
# Go to the 'local' directory inside Moodle root directory.
:3. Now extract the downloaded zip file inside to this folder. After it is extracted, all files and folders must compliance with given structure as shown in [https://docs.moodle.org/dev/Email_reminders_for_calendar_events developer documentation].
+
# Extract the downloaded zip file inside to this folder. After it is extracted, there should be a "reminders" folder in the local folder with a structure as shown in the [[:dev:Email_reminders_for_calendar_events|project developer documentation]].
:4. Log into the Moodle site as the admin user. Usually the new plug-in must be identified and notified you when logged-in. If not then go to Site Administration -> Notifications to detect and automatically install the local plug-in.
+
# Log into the Moodle site as the admin user. Usually the new plugin will be identified and notified you when logged-in. If not, go to Settings > Site administration > Notifications to detect and automatically install the local plug-in.
:5. Now you can change the plug-in specific settings via Site Administration -> Plugins -> Local Plugins -> Reminders.
+
# Now you can change the plug-in specific settings via Settings > Site Administration > Plugins > Local plugins > Reminders.
  
 
== Screenshots ==
 
== Screenshots ==
Line 26: Line 26:
 
* If you want to change the cron frequency of reminders plugin, open version.php file in the reminders directory and change the value corresponding to $plugin->cron. That value must be in seconds and it is the interval between two cron cycles.
 
* If you want to change the cron frequency of reminders plugin, open version.php file in the reminders directory and change the value corresponding to $plugin->cron. That value must be in seconds and it is the interval between two cron cycles.
  
== Credits ==
+
== Acknowledgements ==
 
* Mentors: [http://moodle.org/user/view.php?id=381842&course=5 Michael de Raadt] and [http://moodle.org/user/view.php?id=955449&course=5 Rossiani Wijaya]
 
* Mentors: [http://moodle.org/user/view.php?id=381842&course=5 Michael de Raadt] and [http://moodle.org/user/view.php?id=955449&course=5 Rossiani Wijaya]
 
* Special thanks goes to [http://moodle.org/user/profile.php?id=1297063 Luiggi Sansonetti] who translated the plugin into French language.
 
* Special thanks goes to [http://moodle.org/user/profile.php?id=1297063 Luiggi Sansonetti] who translated the plugin into French language.
 +
 +
== Bugs and Improvements ==
 +
* Please report bugs and improvements on the Tracker using the [http://tracker.moodle.org/browse/CONTRIB/component/12134 Local: Calendar Reminders] component.
  
 
== See also ==
 
== See also ==
 
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
 
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
* CONTRIB-3647 Automating Email reminders for calendar events.
+
* [http://tracker.moodle.org/browse/CONTRIB-3647 CONTRIB-3647] Automating Email reminders for calendar events project in Tracker.
 
* Plugin development [https://github.com/isuru89/moodle-reminders-for-calendar-events Repository]
 
* Plugin development [https://github.com/isuru89/moodle-reminders-for-calendar-events Repository]
 
* Forum post [http://moodle.org/mod/forum/discuss.php?d=201744 Local Plugin - Email Reminders for Calendar Events]
 
* Forum post [http://moodle.org/mod/forum/discuss.php?d=201744 Local Plugin - Email Reminders for Calendar Events]
 
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].
 
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

Revision as of 03:59, 7 August 2012

Introduction

reminders icon.png
The Calendar Reminders plugin creates reminders for Moodle calendar events and sends them automatically to relevant users in a timely manner via Moodle messaging interface. This is a local plugin controlled by the site administrator.

Features

  • Reminders can have customised delivery times/methods according to event types.
  • Users can control how they receive calendar reminders in their messaging preferences.
  • Reminders are automatically sent (as long as the system Cron process is set up).

Installation

  1. Fetch the plug-in from following location.
    • Go to Reminders and download the latest version from the repository.
  2. Go to the 'local' directory inside Moodle root directory.
  3. Extract the downloaded zip file inside to this folder. After it is extracted, there should be a "reminders" folder in the local folder with a structure as shown in the project developer documentation.
  4. Log into the Moodle site as the admin user. Usually the new plugin will be identified and notified you when logged-in. If not, go to Settings > Site administration > Notifications to detect and automatically install the local plug-in.
  5. Now you can change the plug-in specific settings via Settings > Site Administration > Plugins > Local plugins > Reminders.

Screenshots

Sample e-mail reminder

sample reminder msg.png

Administrator settings page

admin settings.jpg

Tips and tricks

  • If you want to change the cron frequency of reminders plugin, open version.php file in the reminders directory and change the value corresponding to $plugin->cron. That value must be in seconds and it is the interval between two cron cycles.

Acknowledgements

Bugs and Improvements

See also