SoC calendar plugin

From GeeklogWiki
Revision as of 23:42, 4 March 2010 by Vinny (talk | contribs) (Separated out "must haves" and "nice to haves". Added Notes section. Fixed some spelling, grammer, and "clarity" errors.)

Jump to: navigation, search
(This is an idea page for the Google Summer of Code)

Overview

Geeklog's current calendar plugin is old and unmaintainable. It has no support for modern calendar standards and cannot support such basic functionality as recurring events. It's interface is antiquated and its sharing/group features are extremely limited.

A new Calendar plugin, written from scratch, could be designed from the ground up to work with calendar standards and support a wide variety of use cases.


Requirements

Listed below are an initial set of requirements. Students applying to complete this project can use the below list as a design outline. Though, don't let the requirement set here limit you!

Basic Requirements

  • The calendar shall support events for individual users.
    • Individuals shall be able to create multiple calendars (possibly limited to a number defined by an administrator).
    • The calendar owner shall be able to control the visibility of the calendar (private, shared to a group, public).
  • The calendar shall support site wide events.
    • Who can submit site wide events shall be controlled by the site administrator.
    • When given permission to submit site wide events, users can submit a copy of an existing individual events to the site wide calendar.
    • The site administrator shall be able to moderate events submitted by non-admin users.
    • Only site administrators shall be able to modify existing events.
  • The calendar shall support recurring events.
  • The calendar shall have an efficient implementation (responsive).
    • A smart design will be needed to support recurring events without causing a lack of responsiveness.
  • The calendar shall implement Geeklog's Multi-language support.
  • The calendar shall support "locales".
    • Configurable date and time format (e.g. 01/21/2010 vs 2010/01/21 vs 21/01/2010, 8:00pm vs 20:00h)
      • also for date and time entry
    • Configurable first day of week (e.g. Monday vs Sunday)

Nice to Haves

This is a set of items that would be nice for a calendar plugin to have. At the very least, a calendar plugin should be designed so that adding these features would not be difficult.

  • The calendar shall support group events.
  • The calendar shall have the ability to import, export and perhaps sync using the iCal (RFC5545) format.
    • Ability to share with services like Upcoming, Dopplr, or Google Calendar, so events only have to be entered once.
    • The calendar shall optionally support WebDAV (RFC2518) for calendar and schedule sharing.
  • The calendar shall support HCalendar.
  • The calendar shall support for event reminders.
  • The calendar shall support sending event invitations and tracking responses.

Bonus Items

Listed here are items that do not have a direct impact on the plugin design, but are features that would be nice to have if time permits.

  • A migration utility to convert existing Geeklog calendar tables to work with the new plugin.
  • Create a calendar block for display in Geeklog's left or right blocks.


Notes

If desired, a license compatible (Geeklog is licensed GPL 2.0) PHP library/program can be used. However, this should definitely be researched and decided upon before an application is submitted.


Level of Difficulty

medium to difficult

The level of difficulty on this project will be dependent upon the design and feature set chosen to be implemented.


Further Reading

References

Bug Tracker

Retrieved from "http://wiki.geeklog.net/index.php?title=SoC_calendar_plugin&oldid=5751"