MoodleDocs - User contributions [en]

Email reminders for calendar events

2012-09-06T11:54:50Z

Isuru89:

== Introduction ==
Reminders are very useful for both students as well as teachers to recall their scheduled event before the actual moment. This project 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. It will be implemented as a local plugin to the Moodle.

== Requirements ==
Moodle 2.2 required

== Community Bonding Period ==

=== Milestones ===
# DONE - Refine the project proposal with Michael, Rossiani and the community
# DONE - Feature discussion
# DONE - Create mockups

=== Features ===
Following features are expecting to package with the reminders plugin.

:1. Reminders can be sent by customizing according to each event type.
::* Separate message providers for each event type.
::* Ability to customize message content according to event type.
:2. Administrator configurations
::* Administrator can enable/disable the process of sending reminders without uninstalling the plugin.
::* Ability to choose how many days ahead should the reminders be created ''for each event type''.
::** Reminders can be created only by days.
::** Supported only fixed amount of days ahead such as 7 days, 3 days and 1 day.
::* Ability to keep/remove history of reminder events.
:2. User configurations
::* User can select desired method of receiving reminder notifications on each message provider.

== Coding Period ==

=== Milestones ===

:1. DONE - Finalize the abstract architecture.
:2. DONE - Implementing the basic structure of the plugin. (CONTRIB-3648)
::* DONE - Creating a suitable version file.
::* DONE - Creating a language file.
::* DONE - Creating a message provider file.
::* DONE - Creating a lib file for the cron function.
:3. DONE - Implementing message providers for each event type. (CONTRIB-3659)
:4. DONE - Providing a administrator settings page. (CONTRIB-3660)
:5. DONE - Implementing necessary reminder classes. (CONTRIB-3669)
::* DONE - Creating abstract reminder class.
::* DONE - Creating concrete reminder classes for each event type.
:6. DONE - Building functionality.
::* DONE - Generation of message content for reminders. (CONTRIB-3671)
::* DONE - Implementation of Cron function. (CONTRIB-3670)
::* DONE - Extending to support plugin for repeated events. (CONTRIB-3672)
:7. IN PROGRESS - Testing
:8. IN PROGRESS - Bug fixing

=== File Structure ===
Following shows expected file structure of the plugin. Plugin name would be "''reminders''".

* contents/course_reminder.class.php
* contents/site_reminder.class.php
* contents/group_reminder.class.php
* contents/user_reminder.class.php
* contents/due_reminder.class.php
* db/access.php
* db/message.php
* db/upgrade.php
* lang/en/local_reminders.php
* reminder.class.php
* version.php
* lib.php
* settings.php
* README

=== Explanation ===
Picking up relevant events to send reminders in advance is very important and critical. Reminders must be sent only once for a event on predefined ahead of days. Identifying such events has to be done efficiently and carefully. It shows below how it can be achieved.

Events are checked against a ''fixed amount of time period'' in each and every cron cycle.

If any of event is falling exactly 1, 3 or 7 days ahead for that checking time period, that event will be marked as
a ready event to send reminders. In mathematically, if any event should satisfy to send reminders

(t(Ei) - X > T1) AND (t(Ei) - X <= T2) AND (t(Ei) > T2)

Where t(Ei) is the start time of the event and X is a set of constants indicates 1,3 or 7 days in seconds.

That ''fixed amount of time period'' is decided as the timestamp different between last cron cycle (this timestamp is not the
timestamp corresponding to the start of that cron cycle, but the time it began to check for its previous timeslot. This
can be extracted from info field in log record) and current time.

:1. If the running cron cycle is the first ever cron cycle (i.e. no log record could find for a previous cron cycle), then the time will be cutoff by X amount of days before as configured.
[[File:first_cron.jpg]]

::* (t1,t2) is the time period the time period that cron is running.
::* (T1,T2) is the time period which will be checked against events. (T1-T2) will be a constant and will be used at most once.

:2. Otherwise,
[[File:nth_cron.jpg]]
::* (t1,t2) is the interval between two cron cycles as defined in plugin.
::* (T1,T2) is the time inspecting region. (T1 will be decided by log record for the last cron cycle)

=== High Level Architecture Diagram ===

[[File:overall_architecture.jpg]]

=== Reminders Class Diagram ===
[[File:reminder_class_diagram_1.jpg]]

== Mockups ==
=== Administrator Setting Page ===
[[File:reminders_admin_config_page.jpg]]

=== Message Format (HTML) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}

[[File:message_format_HTML.jpg]]

=== Message Format (Plain-text) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}
* Message Content:

: '''${message_title}'''
: Reminder - #n days remaining

: When -> ${event_time}
: What -> ${event_course} or ${event_type}
: Description -> ${event_description}

== Screenshots ==
=== Admin Settings Page ===
[[File:settings_page_1.jpg]]

=== Sample e-mail reminder for course event ===
[[File:sample_email_reminder_course.jpg]]

=== Sample e-mail reminder for due event ===
[[File:sample_email_reminder_due.jpg]]

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

== Tracker ==
* CONTRIB-3647 Automating Email reminders for calendar events

== See also ==
* Plugin development [https://github.com/isuru89/moodle-reminders-for-calendar-events Repository]
* [https://docs.moodle.org/dev/Projects_for_new_developers Moodle - Google Summer of Code 2012 Idea List]
* [http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/isuru89/1 Original Proposal - GSoC 2012]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

Email reminders for calendar events

2012-08-02T02:04:11Z

Isuru89:

== Introduction ==
Reminders are very useful for both students as well as teachers to recall their scheduled event before the actual moment. This project 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. It will be implemented as a local plugin to the Moodle.

== Requirements ==
Moodle 2.2 required

== Community Bonding Period ==

=== Milestones ===
# DONE - Refine the project proposal with Michael, Rossiani and the community
# DONE - Feature discussion
# DONE - Create mockups

=== Features ===
Following features are expecting to package with the reminders plugin.

:1. Reminders can be sent by customizing according to each event type.
::* Separate message providers for each event type.
::* Ability to customize message content according to event type.
:2. Administrator configurations
::* Administrator can enable/disable the process of sending reminders without uninstalling the plugin.
::* Ability to choose how many days ahead should the reminders be created ''for each event type''.
::** Reminders can be created only by days.
::** Supported only fixed amount of days ahead such as 7 days, 3 days and 1 day.
::* Ability to keep/remove history of reminder events.
:2. User configurations
::* User can select desired method of receiving reminder notifications on each message provider.

== Coding Period ==

=== Milestones ===

:1. DONE - Finalize the abstract architecture.
:2. DONE - Implementing the basic structure of the plugin. (CONTRIB-3648)
::* DONE - Creating a suitable version file.
::* DONE - Creating a language file.
::* DONE - Creating a message provider file.
::* DONE - Creating a lib file for the cron function.
:3. DONE - Implementing message providers for each event type. (CONTRIB-3659)
:4. DONE - Providing a administrator settings page. (CONTRIB-3660)
:5. DONE - Implementing necessary reminder classes. (CONTRIB-3669)
::* DONE - Creating abstract reminder class.
::* DONE - Creating concrete reminder classes for each event type.
:6. DONE - Building functionality.
::* DONE - Generation of message content for reminders. (CONTRIB-3671)
::* DONE - Implementation of Cron function. (CONTRIB-3670)
::* DONE - Extending to support plugin for repeated events. (CONTRIB-3672)
:7. IN PROGRESS - Testing
:8. IN PROGRESS - Bug fixing

=== File Structure ===
Following shows expected file structure of the plugin. Plugin name would be "''reminders''".

* contents/course_reminder.class.php
* contents/site_reminder.class.php
* contents/group_reminder.class.php
* contents/user_reminder.class.php
* contents/due_reminder.class.php
* db/access.php
* db/message.php
* db/upgrade.php
* lang/en/local_reminders.php
* reminder.class.php
* version.php
* lib.php
* settings.php
* README

=== Explanation ===
Picking up relevant events to send reminders in advance is very important and critical. Reminders must be sent only once for a event on predefined ahead of days. Identifying such events has to be done efficiently and carefully. It shows below how it can be achieved.

Events are checked against a ''fixed amount of time period'' in each and every cron cycle.

If any of event is falling exactly 1, 3 or 7 days ahead for that checking time period, that event will be marked as
a ready event to send reminders. In mathematically, if any event should satisfy to send reminders

(t(Ei) - X > T1) AND (t(Ei) - X <= T2) AND (t(Ei) > T2)

Where t(Ei) is the start time of the event and X is a set of constants indicates 1,3 or 7 days in seconds.

That ''fixed amount of time period'' is decided as the timestamp different between last cron cycle (this timestamp is not the
timestamp corresponding to the start of that cron cycle, but the time it began to check for its previous timeslot. This
can be extracted from info field in log record) and current time.

:1. If the running cron cycle is the first ever cron cycle (i.e. no log record could find for a previous cron cycle), then the time will be cutoff by X amount of days before as configured.
[[File:first_cron.jpg]]

::* (t1,t2) is the time period the time period that cron is running.
::* (T1,T2) is the time period which will be checked against events. (T1-T2) will be a constant and will be used at most once.

:2. Otherwise,
[[File:nth_cron.jpg]]
::* (t1,t2) is the interval between two cron cycles as defined in plugin.
::* (T1,T2) is the time inspecting region. (T1 will be decided by log record for the last cron cycle)

=== High Level Architecture Diagram ===

[[File:overall_architecture.jpg]]

=== Reminders Class Diagram ===
[[File:reminder_class_diagram_1.jpg]]

== Mockups ==
=== Administrator Setting Page ===
[[File:reminders_admin_config_page.jpg]]

=== Message Format (HTML) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}

[[File:message_format_HTML.jpg]]

=== Message Format (Plain-text) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}
* Message Content:

: '''${message_title}'''
: Reminder - #n days remaining

: When -> ${event_time}
: What -> ${event_course} or ${event_type}
: Description -> ${event_description}

== Screenshots ==
=== Admin Settings Page ===
[[File:settings_page_1.jpg]]

=== Sample e-mail reminder for course event ===
[[File:sample_email_reminder_course.jpg]]

=== Sample e-mail reminder for due event ===
[[File:sample_email_reminder_due.jpg]]

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

== Tracker ==
* CONTRIB-3647 Automating Email reminders for calendar events

== See also ==
* Plugin development [https://github.com/isuru89/moodle-reminders-for-calendar-events Repository]
* [https://docs.moodle.org/dev/Projects_for_new_developers Moodle - Google Summer of Code 2012 Idea List]
* [http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/isuru89/1 Original Proposal - GSoC 2012]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

Email reminders for calendar events

2012-06-27T02:59:06Z

Isuru89:

== Introduction ==
Reminders are very useful for both students as well as teachers to recall their scheduled event before the actual moment. This project 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. It will be implemented as a local plugin to the Moodle.

== Requirements ==
Moodle 2.2 required

== Community Bonding Period ==

=== Milestones ===
# DONE - Refine the project proposal with Michael, Rossiani and the community
# DONE - Feature discussion
# DONE - Create mockups

=== Features ===
Following features are expecting to package with the reminders plugin.

:1. Reminders can be sent by customizing according to each event type.
::* Separate message providers for each event type.
::* Ability to customize message content according to event type.
:2. Administrator configurations
::* Administrator can enable/disable the process of sending reminders without uninstalling the plugin.
::* Ability to choose how many days ahead should the reminders be created ''for each event type''.
::** Reminders can be created only by days.
::** Supported only fixed amount of days ahead such as 7 days, 3 days and 1 day.
::* Ability to keep/remove history of reminder events.
:2. User configurations
::* User can select desired method of receiving reminder notifications on each message provider.

== Coding Period ==

=== Milestones ===

:1. DONE - Finalize the abstract architecture.
:2. DONE - Implementing the basic structure of the plugin. (CONTRIB-3648)
::* DONE - Creating a suitable version file.
::* DONE - Creating a language file.
::* DONE - Creating a message provider file.
::* DONE - Creating a lib file for the cron function.
:3. DONE - Implementing message providers for each event type. (CONTRIB-3659)
:4. DONE - Providing a administrator settings page. (CONTRIB-3660)
:5. DONE - Implementing necessary reminder classes. (CONTRIB-3669)
::* DONE - Creating abstract reminder class.
::* DONE - Creating concrete reminder classes for each event type.
:6. IMPLEMENTING - Building functionality.
::* DONE - Generation of message content for reminders. (CONTRIB-3671)
::* DONE - Implementation of Cron function. (CONTRIB-3670)
::* Extending to support plugin for repeated events. (CONTRIB-3672)
:7. Testing
:8. Bug fixing

=== File Structure ===
Following shows expected file structure of the plugin. Plugin name would be "''reminders''".

* contents/course_reminder.class.php
* contents/site_reminder.class.php
* contents/group_reminder.class.php
* contents/user_reminder.class.php
* contents/due_reminder.class.php
* db/access.php
* db/message.php
* db/upgrade.php
* lang/en/local_reminders.php
* reminder.class.php
* version.php
* lib.php
* settings.php
* README

=== Explanation ===
Picking up relevant events to send reminders in advance is very important and critical. Reminders must be sent only once for a event on predefined ahead of days. Identifying such events has to be done efficiently and carefully. It shows below how it can be achieved.

Events are checked against a ''fixed amount of time period'' in each and every cron cycle.

If any of event is falling exactly 1, 3 or 7 days ahead for that checking time period, that event will be marked as
a ready event to send reminders. In mathematically, if any event should satisfy to send reminders

(t(Ei) - X > T1) AND (t(Ei) - X <= T2) AND (t(Ei) > T2)

Where t(Ei) is the start time of the event and X is a set of constants indicates 1,3 or 7 days in seconds.

That ''fixed amount of time period'' is decided as the timestamp different between last cron cycle (this timestamp is not the
timestamp corresponding to the start of that cron cycle, but the time it began to check for its previous timeslot. This
can be extracted from info field in log record) and current time.

:1. If the running cron cycle is the first ever cron cycle (i.e. no log record could find for a previous cron cycle), then the time will be cutoff by X amount of days before as configured.
[[File:first_cron.jpg]]

::* (t1,t2) is the time period the time period that cron is running.
::* (T1,T2) is the time period which will be checked against events. (T1-T2) will be a constant and will be used at most once.

:2. Otherwise,
[[File:nth_cron.jpg]]
::* (t1,t2) is the interval between two cron cycles as defined in plugin.
::* (T1,T2) is the time inspecting region. (T1 will be decided by log record for the last cron cycle)

=== High Level Architecture Diagram ===

[[File:overall_architecture.jpg]]

=== Reminders Class Diagram ===
[[File:reminder_class_diagram_1.jpg]]

== Mockups ==
=== Administrator Setting Page ===
[[File:reminders_admin_config_page.jpg]]

=== Message Format (HTML) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}

[[File:message_format_HTML.jpg]]

=== Message Format (Plain-text) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}
* Message Content:

: '''${message_title}'''
: Reminder - #n days remaining

: When -> ${event_time}
: What -> ${event_course} or ${event_type}
: Description -> ${event_description}

== Screenshots ==
=== Admin Settings Page ===
[[File:settings_page_1.jpg]]

=== Sample e-mail reminder for course event ===
[[File:sample_email_reminder_course.jpg]]

=== Sample e-mail reminder for due event ===
[[File:sample_email_reminder_due.jpg]]

== Tracker ==
* CONTRIB-3647 Automating Email reminders for calendar events

== See also ==
* Plugin development [https://github.com/isuru89/moodle-reminders-for-calendar-events Repository]
* [https://docs.moodle.org/dev/Projects_for_new_developers Moodle - Google Summer of Code 2012 Idea List]
* [http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/isuru89/1 Original Proposal - GSoC 2012]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

File:nth cron.jpg

2012-06-17T05:18:34Z

Isuru89:

File:first cron.jpg

2012-06-17T05:18:13Z

Isuru89:

Email reminders for calendar events

2012-06-17T05:17:40Z

Isuru89:

== Introduction ==
Reminders are very useful for both students as well as teachers to recall their scheduled event before the actual moment. This project 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. It will be implemented as a local plugin to the Moodle.

== Requirements ==
Moodle 2.2 required

== Community Bonding Period ==

=== Milestones ===
# DONE - Refine the project proposal with Michael, Rossiani and the community
# DONE - Feature discussion
# DONE - Create mockups

=== Features ===
Following features are expecting to package with the reminders plugin.

:1. Reminders can be sent by customizing according to each event type.
::* Separate message providers for each event type.
::* Ability to customize message content according to event type.
:2. Administrator configurations
::* Administrator can enable/disable the process of sending reminders without uninstalling the plugin.
::* Ability to choose how many days ahead should the reminders be created ''for each event type''.
::** Reminders can be created only by days.
::** Supported only fixed amount of days ahead such as 7 days, 3 days and 1 day.
::* Ability to keep/remove history of reminder events.
:2. User configurations
::* User can select desired method of receiving reminder notifications on each message provider.

== Coding Period ==

=== Milestones ===

:1. DONE - Finalize the abstract architecture.
:2. DONE - Implementing the basic structure of the plugin. (CONTRIB-3648)
::* DONE - Creating a suitable version file.
::* DONE - Creating a language file.
::* DONE - Creating a message provider file.
::* DONE - Creating a lib file for the cron function.
:3. DONE - Implementing message providers for each event type. (CONTRIB-3659)
:4. DONE - Providing a administrator settings page. (CONTRIB-3660)
:5. DONE - Implementing necessary reminder classes. (CONTRIB-3669)
::* DONE - Creating abstract reminder class.
::* DONE - Creating concrete reminder classes for each event type.
:6. IMPLEMENTING - Building functionality.
::* DONE - Generation of message content for reminders. (CONTRIB-3671)
::* DONE - Implementation of Cron function. (CONTRIB-3670)
::* Extending to support plugin for repeated events. (CONTRIB-3672)
:7. Testing
:8. Bug fixing

=== File Structure ===
Following shows expected file structure of the plugin. Plugin name would be "''reminders''".

* contents/course_reminder.class.php
* contents/site_reminder.class.php
* contents/group_reminder.class.php
* contents/user_reminder.class.php
* contents/due_reminder.class.php
* db/access.php
* db/message.php
* db/upgrade.php
* lang/en/local_reminders.php
* reminder.class.php
* version.php
* lib.php
* settings.php
* README

=== Explanation ===
Picking up relevant events to send reminders in advance is very important and critical. Reminders must be sent only once for a event on predefined ahead of days. Identifying such events has to be done efficiently and carefully. It shows below how it can be achieved.

Events are checked against a ''fixed amount of time period'' in each and every cron cycle.

If any of event is falling exactly 1, 3 or 7 days ahead for that checking time period, that event will be marked as
a ready event to send reminders. In mathematically, if any event should satisfy to send reminders

(t(Ei) - X >= T1) AND (t(Ei) - X <= T2) AND (t(Ei) > T2)

Where t(Ei) is the start time of the event and X is a set of constants indicates 1,3 or 7 days in seconds.

That ''fixed amount of time period'' is decided as the timestamp different between last cron cycle (this timestamp is not the
timestamp corresponding to the start of that cron cycle, but the time it began to check for its previous timeslot. This
can be extracted from info field in log record) and current time.

:1. If the running cron cycle is the first ever cron cycle (i.e. no log record could find for a previous cron cycle), then the time will be cutoff by X amount of days before as configured.
[[File:first_cron.jpg]]

::* (t1,t2) is the time period the time period that cron is running.
::* (T1,T2) is the time period which will be checked against events. (T1-T2) will be a constant and will be used at most once.

:2. Otherwise,
[[File:nth_cron.jpg]]
::* (t1,t2) is the interval between two cron cycles as defined in plugin.
::* (T1,T2) is the time inspecting region. (T1 will be decided by log record for the last cron cycle)

=== High Level Architecture Diagram ===

[[File:overall_architecture.jpg]]

=== Reminders Class Diagram ===
[[File:reminder_class_diagram_1.jpg]]

== Mockups ==
=== Administrator Setting Page ===
[[File:reminders_admin_config_page.jpg]]

=== Message Format (HTML) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}

[[File:message_format_HTML.jpg]]

=== Message Format (Plain-text) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}
* Message Content:

: '''${message_title}'''
: Reminder - #n days remaining

: When -> ${event_time}
: What -> ${event_course} or ${event_type}
: Description -> ${event_description}

== Screenshots ==
=== Admin Settings Page ===
[[File:settings_page_1.jpg]]

=== Sample e-mail reminder for course event ===
[[File:sample_email_reminder_course.jpg]]

=== Sample e-mail reminder for due event ===
[[File:sample_email_reminder_due.jpg]]

== Tracker ==
* CONTRIB-3647 Automating Email reminders for calendar events

== See also ==
* Plugin development [https://github.com/isuru89/moodle-reminders-for-calendar-events Repository]
* [https://docs.moodle.org/dev/Projects_for_new_developers Moodle - Google Summer of Code 2012 Idea List]
* [http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/isuru89/1 Original Proposal - GSoC 2012]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

File:sample email reminder due.jpg

2012-06-16T07:33:24Z

Isuru89:

File:sample email reminder course.jpg

2012-06-16T07:32:42Z

Isuru89:

File:settings page 1.jpg

2012-06-16T07:32:12Z

Isuru89:

Email reminders for calendar events

2012-06-16T07:31:35Z

Isuru89:

Email reminders for calendar events

2012-06-16T07:27:57Z

Isuru89:

Email reminders for calendar events

2012-06-16T07:21:59Z

Isuru89:

Email reminders for calendar events

2012-06-16T07:21:28Z

Isuru89:

Email reminders for calendar events

2012-06-16T07:20:29Z

Isuru89:

File:reminder class diagram 1.jpg

2012-06-16T07:16:54Z

Isuru89:

Email reminders for calendar events

2012-06-16T07:16:08Z

Isuru89:

GSOC/2012

2012-06-15T15:51:21Z

Isuru89: /* Email reminders for calendar events */

[[Image:banner-gsoc2012.png|right|400px]]This page provides an overview of the [http://www.google-melange.com/gsoc/program/home/google/gsoc2012 Google Summer of Code 2012] projects for Moodle.

==Improving SCORM 2004 Support==

:'''Student''': [http://moodle.org/user/view.php?id=1277285&course=5 Mayank Gupta]
:'''Mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]
:'''Specification''': [[Improve_SCORM_2004_Support]]

See also:
* MDL-7068
* Developer blog [http://www.guptamayank.com/ # Mayank Gupta]

==Improving Plagiarism API==

:'''Student''': [http://moodle.org/user/profile.php?id=1411986 Kanika Goyal]
:'''Mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]
:'''Specification''': [[Plagiarism_API_improvements]]

See also:
* MDL-32225

==Email reminders for calendar events==
:'''Student''': [http://moodle.org/user/view.php?id=1240428&course=5 Isuru Madushanka Weerarathna]
:'''Mentors''': [http://moodle.org/user/view.php?id=381842&course=5 Michael de Raadt], [http://moodle.org/user/view.php?id=955449&course=5 Rossiani Wijaya]
:'''Specification''': [[Email reminders for calendar events]]

See also:

* Tracker issue MDL-1329
* Developer blog [http://uisurumadushanka89.blogspot.com Isuru's Ideas]

==Video/audio capture repository plugin==
:'''Student''': [http://moodle.org/user/profile.php?id=1439658 Ankit Gupta]
:'''Mentor''': [http://moodle.org/user/profile.php?id=1328988 Rajesh Taneja]
:'''Specification''': [[ Audio/Video Capture repository plugin ]]

See also:
* Tracker Issue CONTRIB-3631
* Developer blog [http://ankitgupta90.tumblr.com/ # Ankit Gupta]
[[Category:GSOC]]

Email reminders for calendar events

2012-05-29T01:59:18Z

Isuru89:

Email reminders for calendar events

2012-05-27T10:48:17Z

Isuru89:

File:reminders admin config page.jpg

2012-05-22T06:13:57Z

Isuru89:

Email reminders for calendar events

2012-05-22T06:11:52Z

Isuru89:

File:reminders admin settings page.jpg

2012-05-22T06:06:26Z

Isuru89: uploaded a new version of "File:reminders admin settings page.jpg"

File:reminders class diagram.jpg

2012-05-22T06:02:49Z

Isuru89:

Email reminders for calendar events

2012-05-22T05:01:21Z

Isuru89:

Email reminders for calendar events

2012-05-21T15:47:12Z

Isuru89:

== Introduction ==
Reminders are very useful for both students as well as teachers to recall their scheduled event before the actual moment. This project 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. It will be implemented as a local plugin to the Moodle.

== Requirements ==
Moodle 2.2 required

== Community Bonding Period ==

=== Milestones ===
# Refine the project proposal with Michael and the community
# Feature discussion
# Create mockups

=== Features ===
Following features are expecting to package with the reminders plugin.

:1. Administrator configurations
::* Administrator can enable/disable the process of sending reminders without uninstalling the plugin.
::* Ability to choose how many days ahead should the reminders be created for every due event in Moodle calendar.
::** Reminders can be created only by days.
::** Supported only fixed amount of days ahead such as 7 days, 5 days, 3 days and 1 day.
::* Ability to keep/remove history of reminder events.
:2. User configurations
::* User can select desired method of receiving reminder notifications on corresponding message provider.

== Coding Period ==

=== Milestones ===

:1. Finalize the overall architecture.
:2. Finalize file structure and database table schema.
:3. Designing a proper message content.
:4. Building the basic structure of the plugin - Implementation Phase 1
::* Creating a suitable version file.
::* Define the database structure in XMLDB file.
::* Define capabilities.
::* Define the message provider.
::* Define a set of administrator page settings
::** Implementation of an option for enabling/disabling reminder.
::** Implementation of a set of options to configure per-defined number of days ahead which reminders should be invoked.
::* Implementation of the initial script to be run.
::* Creating a language file.
:5. Building functions - Implementation Phase 2
::* Implementation of supportive functions for main cron function.
::** HTML message content.
::** Reminder Plain-text.
::* Implementation of the cron function.
::** Removing expired reminders.
::** Fetching all active reminders.
::** Fetching all users correspondent to the event.
::** Deleting reminders that have been already sent.
:6. Testing
:7. Bug fixing

=== File Structure ===
Plugin name would be "''reminders''".

* db/access.php
* db/message.php
* db/install.php
* db/install.xml
* db/upgrade.php
* db/events.php
* lang/en/local_reminders.php
* version.php
* lib.php
* settings.php
* README

=== Database Structure ===
A single database will be used to store these reminders. Database name would be "''local_reminders''". Following shows its structure. (Subject to change)

{| class="nicetable"
|-
! Field
! Type
! width="500" | Description
|-
| id
| bigint(10)
| Primary key for reminder records.
|-
| eventid
| bigint(10)
| Foreign key for corresponding event.
|-
| daysahead
| bigint(10)
| Number of days ahead such that reminder should be invoked.
|-
| enabled
| smallint(4)
| Indicates whether this single reminder is enabled or not. Disabled reminder will not be invoked only for that time. If it has been found enabled later, then it would be invoked.
|-
| mailed
| smallint(4)
| Indicates whether this reminder has been already mailed. Mailed reminders will be deleted after sometime.
|}

=== High Level Architecture Diagram ===

[[File:overall_architecture.jpg]]

== Mockups ==
=== Administrator Setting Page ===
[[File:reminders_admin_settings_page.jpg]]

=== Message Format (HTML) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}

[[File:message_format_HTML.jpg]]

=== Message Format (Plain-text) ===
* Message Title : Reminder: ${event_detail} @ ${event_date_time}
* Message Content:

: '''${message_title}'''
: Reminder - #n days remaining

: When -> ${event_time}
: What -> ${event_course} or ${event_type}
: Description -> ${event_description}

== Screenshots ==

== Tracker ==
* [http://tracker.moodle.org/browse/CONTRIB-3647 Automating Email reminders for calendar events]

== See also ==
* [https://docs.moodle.org/dev/Projects_for_new_developers Moodle - Google Summer of Code 2012 Idea List]
* [http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/isuru89/1 Original Proposal - GSoC 2012]
* RSS Feed from Personal Blog, [http://uisurumadushanka89.blogspot.com/feeds/posts/default/-/gsoc RSS Feed].

File:reminders admin settings page.jpg

2012-05-21T15:45:44Z

Isuru89:

Email reminders for calendar events

2012-05-21T15:42:19Z

Isuru89:

File:admin settings page.jpg

2012-05-21T15:40:12Z

Isuru89: uploaded a new version of "File:admin settings page.jpg"

Email reminders for calendar events

2012-05-11T14:51:32Z

Isuru89:

File:overall architecture.jpg

2012-05-11T14:35:52Z

Isuru89:

Email reminders for calendar events

2012-05-11T14:35:22Z

Isuru89:

Email reminders for calendar events

2012-05-10T15:16:22Z

Isuru89:

File:message format HTML.jpg

2012-05-10T15:15:03Z

Isuru89: uploaded a new version of "File:message format HTML.jpg": Reverted to version as of 15:13, 10 May 2012

File:message format HTML.jpg

2012-05-10T15:14:41Z

Isuru89: uploaded a new version of "File:message format HTML.jpg"

File:message format HTML.jpg

2012-05-10T15:13:01Z

Isuru89:

Email reminders for calendar events

2012-05-10T15:12:15Z

Isuru89:

File:admin settings page.jpg

2012-05-10T15:11:30Z

Isuru89:

Email reminders for calendar events

2012-05-10T15:09:56Z

Isuru89:

Email reminders for calendar events

2012-05-10T13:45:44Z

Isuru89:

Email reminders for calendar events

2012-05-08T04:30:16Z

Isuru89: /* Introduction */

Email reminders for calendar events

2012-05-08T03:46:04Z

Isuru89: Created page with "== Introduction == This project is about creating a set of reminders for Moodle Calendar events and sending them ''automatically'' to relevant users on timely manner."

== Introduction ==

This project is about creating a set of reminders for Moodle Calendar events and sending them ''automatically'' to relevant users on timely manner.