MoodleDocs - User contributions [en]

Event reminders

2012-09-06T11:53:11Z

Isuru89:

==Introduction ==
[[File: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==
# Fetch the plug-in from following location.
#* Go to [http://moodle.org/plugins/view.php?plugin=local_reminders Reminders] and download the latest version from the repository.
# Go to the 'local' directory inside Moodle root directory.
# 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]].
# 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.
# Now you can change the plug-in specific settings via Settings > Site Administration > Plugins > Local plugins > Reminders.

==Settings==
# '''Enabled''': This options allows to disable sending reminders temporarily without uninstalling the plugin. If not enabled, the cron cycles will be skipped.
# '''Filter calendar events''': Indicates how the calendar events should be selected before check them for sending reminders. There are three options.
:# ''All events'': Filter all events without any constraints.
:# ''Only visible events in calendar'': Filters only events that are set as visible in calendar by user. Ignores all hidden events.
:# ''Only hidden events in calendar'': Filters only events that are not set as visible in calendar. Ignores all visible events.
# '''Send before''': There are 5 event types, namely, Site, Course, Activity, User and Group events. For each event type it has provided options to setup when reminders should be sent before the actual moment of event happens. Provided options are, 7 days, 3 days and 1 day.
# Activity reminders: In Moodle for a activity there can be two events some times (one to indicate start of the event and other to mark end of the event). There are three options.
:# ''For both openings and closings'': Reminders will be sent for both opening and closing due dates of the event.
:# ''Only for activity openings'': Reminders will be sent only when activity is opening. Reminder will not be sent at closing of the activity.
:# ''Only for activity closings'': Reminders will be sent only when activity is closing. Reminder will not be sent at opening of the activity.

== Screenshots ==
=== Configuration page ===
[[File:admin_settings.jpg]]

=== Sample e-mail reminder ===
[[File:sample_reminder_msg.png]]

==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 ==
* 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.
* Another thank goes to Guido Roessling for providing a German translation for this plugin.

== 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 ==
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
* CONTRIB-3647 Automating Email reminders for calendar events project in Tracker.
* 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]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

Event reminders

2012-08-14T03:07:13Z

Isuru89:

==Introduction ==
[[File: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==
# Fetch the plug-in from following location.
#* Go to [http://moodle.org/plugins/view.php?plugin=local_reminders Reminders] and download the latest version from the repository.
# Go to the 'local' directory inside Moodle root directory.
# 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]].
# 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.
# Now you can change the plug-in specific settings via Settings > Site Administration > Plugins > Local plugins > Reminders.

==Settings==
# '''Enabled''': This options allows to disable sending reminders temporarily without uninstalling the plugin. If not enabled, the cron cycles will be skipped.
# '''Filter calendar events''': Indicates how the calendar events should be selected before check them for sending reminders. There are three options.
:# ''All events'': Filter all events without any constraints.
:# ''Only visible events in calendar'': Filters only events that are set as visible in calendar by user. Ignores all hidden events.
:# ''Only hidden events in calendar'': Filters only events that are not set as visible in calendar. Ignores all visible events.
# '''Send before''': There are 5 event types, namely, Site, Course, Activity, User and Group events. For each event type it has provided options to setup when reminders should be sent before the actual moment of event happens. Provided options are, 7 days, 3 days and 1 day.
# Activity reminders: In Moodle for a activity there can be two events some times (one to indicate start of the event and other to mark end of the event). There are three options.
:# ''For both openings and closings'': Reminders will be sent for both opening and closing due dates of the event.
:# ''Only for activity openings'': Reminders will be sent only when activity is opening. Reminder will not be sent at closing of the activity.
:# ''Only for activity closings'': Reminders will be sent only when activity is closing. Reminder will not be sent at opening of the activity.

== Screenshots ==
=== Configuration page ===
[[File:admin_settings.jpg]]

=== Sample e-mail reminder ===
[[File:sample_reminder_msg.png]]

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

== 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 ==
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
* CONTRIB-3647 Automating Email reminders for calendar events project in Tracker.
* 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]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

Event reminders

2012-08-14T02:35:31Z

Isuru89:

==Introduction ==
[[File: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==
# Fetch the plug-in from following location.
#* Go to [http://moodle.org/plugins/view.php?plugin=local_reminders Reminders] and download the latest version from the repository.
# Go to the 'local' directory inside Moodle root directory.
# 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]].
# 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.
# Now you can change the plug-in specific settings via Settings > Site Administration > Plugins > Local plugins > Reminders.

==Settings==
# '''Enabled''': This options allows to disable sending reminders temporarily without uninstalling the plugin. If not enabled, the cron cycles will be skipped.
# '''Filter calendar events''': Indicates how the calendar events should be selected before check them for sending reminders. There are three options.
:# ''All events'': Filter all events without any constraints.
:# ''Only visible events in calendar'': Filters only events that are set as visible in calendar by user. Ignores all hidden events.
:# ''Only hidden events in calendar'': Filters only events that are not set as visible in calendar. Ignores all visible events.
# '''Send before''': There are 5 event types, namely, Site, Course, Activity, User and Group events. For each event type it has provided options to setup when reminders should be sent before the actual moment of event happens. Provided options are, 7 days, 3 days and 1 day.
# Activity reminders: In Moodle for a activity there can be two events some times (one to indicate start of the event and other to mark end of the event). There are three options.
:# ''For both openings and closings'': Reminders will be sent for both opening and closing due dates of the event.
:# ''Only for activity openings'': Reminders will be sent only when activity is opening. Reminder will not be sent at closing of the activity.
:# ''Only for activity closings'': Reminders will be sent only when activity is closing. Reminder will not be sent at opening of the activity.

== Screenshots ==
=== Administrator settings page ===
[[File:admin_settings.jpg]]

=== Sample e-mail reminder ===
[[File:sample_reminder_msg.png]]

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

== 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 ==
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
* CONTRIB-3647 Automating Email reminders for calendar events project in Tracker.
* 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]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

Event reminders

2012-08-02T02:49:59Z

Isuru89:

==Introduction ==
[[File:reminders_icon.png]] 
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.

==Features==
* Reminders can be customized by message content or delivering time/methods according to the event types.
* Plugin is responsible to send reminders for calendar events.
* Automatic sending of reminders.

==Installation==
:1. 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.
:2. 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].
: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.
:5. Now you can change the plug-in specific settings via Site Administration -> Plugins -> Local Plugins -> Reminders.

== Screenshots ==
=== Sample e-mail reminder ===
[[File:sample_reminder_msg.png]]

=== Administrator settings page ===
[[File: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.

== Credits ==
* 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.

== See also ==
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
* CONTRIB-3647 Automating Email reminders for calendar events.
* 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]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

File:sample reminder msg.png

2012-08-02T02:49:23Z

Isuru89:

File:admin settings.jpg

2012-08-02T02:49:10Z

Isuru89:

File:reminders icon.png

2012-08-02T02:48:36Z

Isuru89:

Event reminders

2012-08-02T02:47:40Z

Isuru89: Created page with "==Introduction == File:reminders_icon.png Reminders plugin is about creating a set of reminders for Moodle calendar events and sending them automatically to relevant use..."

==Introduction ==
[[File:reminders_icon.png]] 
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.

==Features==
* Reminders can be customized by message content or delivering time/methods according to the event types.
* Plugin is responsible to send reminders for calendar events.
* Automatic sending of reminders.

==Installation==
:1. 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.
:2. 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].
: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.
:5. Now you can change the plug-in specific settings via Site Administration -> Plugins -> Local Plugins -> Reminders.

== Screenshots ==
=== Administrator settings page ===
[[File:admin_settings.jpg]]

=== Sample e-mail reminder ===
[[File:sample_reminder_msg.png]]

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

== Credits ==
* 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.

== See also ==
* Download location from plugin repository, [http://moodle.org/plugins/view.php?plugin=local_reminders Local Reminders]
* CONTRIB-3647 Automating Email reminders for calendar events.
* 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]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].