Changes for page Calendar Application

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.evalica
	1	+XWiki.vladm

Content

...	...	@@ -1,1 +1,240 @@
1		-{{warning}}Moved to [[design.xwiki.org:Drafts.CalendarApplication>>http://design.xwiki.org/xwiki/bin/view/Drafts/CalendarApplication]]{{/warning}}
	1	+{{toc/}}
	2	+
	3	+= Main objective =
	4	+
	5	+This application aims to allow end users to create calendars for which they can define and manage events.
	6	+
	7	+
	8	+= Description =
	9	+
	10	+The functionality of the application is similar to Google Calendar.
	11	+The user defines event objects for a specific calendar and the events are visible in different views (day/week/month/year?).
	12	+
	13	+= Functionality =
	14	+
	15	+* Add events: // 1. Button which opens a modal window, allowing the user to insert details and save || 2. Complete form on the page. The users enters all the details and, after submission, he is redirected back to the calendar in view mode//
	16	+* View event list: // A page (modal window) with the list of all the events in the calendar is displayed, using LiveTable, were the user can filter and edit/delete events (if he has the right to do it, additional view to administrate events)//
	17	+* Import/export: // tbd - ical feeds //
	18	+* Microformats support: // tbd//
	19	+* JS drag & drop on the calendar table for changing the dates/hours of the events ?: // an event can be dragged from one slot of the calendar table to another slot//
	20	+* RSS notifications: // a document to generate RSS feed will be created//
	21	+* Email notifications: // emails with information about the event are sent to the calendar creator and to the selected users (when?)//
	22	+* Privacy settings on events: // events can be public or private, public events are visible to everyone, private events are visible only to the calendar creator//
	23	+* Privacy settings on calendar
	24	+* Display events on categories: // the viewer can select a category and only events from that category will be displayed in the calendar event//
	25	+* Event details on hover: // when the user moves the mouse over an event in the calendar table details about the event (startin&ending time, location, description) are displayed//
	26	+* Comment on events: // users have the ability to comment on events//
	27	+* Yearly view of the calendar, where days with events in them are highlighted
	28	+* Monthly view of the calendar, with links to the previous and next months
	29	+* Weekly view of the calendar, with links to the previous and next weeks
	30	+* Daily view of the calendar, listing all the events in that day
	31	+* Have an API for accessing events
	32	+* Each event must be stored in its own document
	33	+* Each calendar is stored in its own space (only 1 calendar/space)
	34	+
	35	+= Alternatives =
	36	+
	37	+**Calendar aggregator**
	38	+
	39	+The WebHome of the application is an aggregated calendar which displays the events from all the calendars of a user.
	40	+The user creates several calendars (e.g. Personal, Work) which can be visualized both individually and together, on the main page of the application.
	41	+This is very similar to Google Calendar, following the same approach. The main advantage of this is the ease of interaction between users' calendars (e.g. sharing a calendar with another user means displaying the specific calendar among his own calendars, inside the WebHome).
	42	+
	43	+
	44	+**Individual calendars with categories**
	45	+
	46	+The users creates calendars which are individual entities and each event is assigned a category when added.
	47	+When the user is invited to other events he can choose to view those events in one or more of his calendars while when another user shares a calendar with him he can only view that calendar, on a separate page.
	48	+The current technicalities are meant for this alternative.
	49	+
	50	+= Detailed Functionality =
	51	+
	52	+== Adding events ==
	53	+
	54	+You may add an event by:
	55	+
	56	+1. Clicking a button which opens a modal window, allowing the user to insert details and save
	57	+1. Filling in a form on the event page. The user enters all the details and, after submission, he is redirected back to the calendar in view mode
	58	+
	59	+Each calendar will be stored in a space. A space can only contain one calendar. Each event must be stored in its own document and should have:
	60	+
	61	+* **Name**
	62	+* **Date**: User should be able to mark an event as **recurring**.
	63	+* **Location**: Link to Google Maps
	64	+* **Description**
	65	+* **Category** : //? Do we need this once a user can have multiple calendars? //
	66	+* **Color**: The event will have a default color and event creators may select a different color for the new event from a given list
	67	+* **Notifications**: Email notifications may be sent to the event creator and the users he selects (10 minutes, 30 minutes, 1 hour, 1 day, 1 week)
	68	+* **Privacy options**: Default, Private, Public
	69	+* The possibility to **add guests**. Guests can appear in the form of wiki users or email addresses. Suggestions should be available if the event creator starts typing in a user's name. Guests will be notified by email they have been invited to the event and they should be able to RSVP (confirm their presence) via email
	70	+* **Set rights for guests**. The event creator can grant users one, some or all of the following rights: modify the event, invite other guests to the event, see the guest list
	71	+* **Attachments**: Documents can be attached to an event. An icon will indicate in the daily and weekly view modes that the event has attachments
	72	+* **Comments**: Users have the ability to comment on an event. An icon will indicate in daily and weekly view modes that the event has comments
	73	+
	74	+**More actions:**
	75	+
	76	+* **Change owner**
	77	+* **RSVP for guests**: Users who are not event owners, but see an event to which they are invited in a calendar, should be able to click the "RSVP" link and confirm their presence
	78	+* **Delete event**
	79	+* **Duplicate event**: Copy an event inside the calendar
	80	+* **Copy event to a different calendar**: Copy an event from the current calendar to a different calendar
	81	+
	82	+== Viewing events ==
	83	+
	84	+**View calendar:**
	85	+
	86	+* Tabbed day, week, month, yearly view
	87	+* **Year view**:
	88	+** There should be 12 cells representing the 12 different months
	89	+** When users click on a month (e.g. //June 2011//) they should be directed to that specific month in the "Month" tab
	90	+** When users click on a day (e.g. //1//) they should be directed to that specific day in the "Day" tab
	91	+** Days that have events associated should be marked with bold
	92	+** The current day should be highlighted with a distinct color or frame
	93	+** Arrows will be available to go to the previous/next year
	94	+* **Month view**:
	95	+** Table view; each column represents a day of the week (Monday, Tuesday...); each cell represents a specific date (1, 2...)
	96	+** When users click on a day (e.g. //1// in the cell header) they should be directed to that specific day in the "Day" tab
	97	+** Events should be displayed chronologically inside each cell. The starting hour of the event should be displayed, the name of the event and an icon indicating if notifications have been set. Clicking or hovering (TBD) on the event will bring up a pop-up with more details and links to edit and delete the event
	98	+** The current day should be highlighted with a distinct color (same as the one used for the "Year" view)
	99	+** Arrows will be available to go to the previous/next month
	100	+* **Week view**
	101	+** Table view; each column represents a day of the week (Monday, Tuesday...); each row represents an hour of the day
	102	+** When users click on a day (e.g. //Fri 6/17// in the table header) they should be directed to that specific day in the "Day" tab
	103	+** Events should be displayed chronologically in each column and occupy the number of cells corresponding to the number of hours the event is scheduled to last. An alert icon should be displayed when a notification is set, an attachment icon when an attachment is present, a comment icon when comments have been added. Clicking or hovering (TBD) on the event will bring up a pop-up with more details and links to edit and delete the event
	104	+** The current day should be highlighted with a distinct color (same as the one used for the other views)
	105	+** Arrows will be available to go to the previous/next week
	106	+* **Day view**
	107	+** Table view; one column representing one day; each row represents an hour of the day
	108	+** Events should be displayed chronologically and occupy the number of cells corresponding to the number of hours the event is scheduled to last. An alert icon should be displayed when a notification is set, an attachment icon when an attachment is present, a comment icon when comments have been added. Clicking or hovering (TBD) on the event will bring up a pop-up with more details and links to edit and delete the event
	109	+** The current day should be highlighted with a distinct color (same as the one used for the other views)
	110	+** Arrows will be available to go to the previous/next day
	111	+
	112	+* **Display events by category**: users can select a category and only events from that category will be displayed in the calendar
	113	+* **Jump to a specific date**
	114	+
	115	+* **Viewing events you are invited to in your calendar**: Calendar owners will have view right by default for their own calendar (space). View rights should also be granted for events he is invited to. This means having view rights on event pages that are located in other calendars (spaces). Other rights, such as edit and comment can also be granted, depending on the settings established by the the owner when creating the event.
	116	+
	117	+**View event list:** A page (modal window) with the list of all the events in the calendar is displayed, using LiveTable, were the user can filter and edit/delete events (if he has the right to do it, additional view to administrate events) // ? Do we need this once the events can be viewed in calendar table? //
	118	+
	119	+== Settings ==
	120	+
	121	+=== General ===
	122	+
	123	+* Calendar **name**
	124	+* **Owner**
	125	+* **Description**
	126	+* **Location**
	127	+
	128	+
	129	+* Week starts on Sunday/Monday/Saturday ? //should this be done automatically depending on the user's location?//
	130	+* Show events you have declined: Yes/No
	131	+* Automatically add invitations to my calendar: Yes/No
	132	+
	133	+=== Privacy ===
	134	+
	135	+**Privacy settings for calendar**
	136	+The calendar can be:
	137	+
	138	+* Public
	139	+* Visible for specific wiki users -> Share calendar
	140	+* Private
	141	+
	142	+**Default privacy settings for events**
	143	+Events can be
	144	+
	145	+* Public: visible to everyone specified in the calendar settings
	146	+* Private: visible only to the event creator
	147	+
	148	+=== Notifications ===
	149	+
	150	+A calendar owner may choose to receive notifications for:
	151	+
	152	+|=Events he is invited to |=Events he owns
	153	+|(((
	154	+* New invitations
	155	+* Changed invitations
	156	+* Canceled invitations
	157	+* Invitation replies
	158	+)))|(((
	159	+* RSVPs from guests (attending, canceling presence)
	160	+* Attachments being added
	161	+* Comments being added
	162	+)))
	163	+
	164	+In addition, **reminders** can be **sent by default to the calendar owner** via email: 10 minutes, 30 minutes, 1 hour, 1 day, 1 week
	165	+
	166	+== Search ==
	167	+
	168	+The "View event list" livetable can be used to filter events by date, location, and even to do searches within the event descriptions.
	169	+
	170	+== Suggestions ==
	171	+
	172	+* Ability to print calendar
	173	+* Keyboard shortcuts
	174	+* Tips or link to documentation
	175	+* Notifications by SMS could be interesting
	176	+* Gadget integration
	177	+
	178	+==Further work==
	179	+
	180	+* Select language?
	181	+* Select from different time zones?
	182	+* Select date format?
	183	+* Select time format?
	184	+* Similarly to Google Calendar, event recurrence should be customizable
	185	+
	186	+= Technicalities =
	187	+
	188	+The event-calendar part of the application will be implemented in the following way:
	189	+
	190	+* 2 classes will be used: EventClass and CalendarClass
	191	+* an event represents a document with an object of EventClass attached
	192	+* a calendar represents a document with an object of CalendarClass attached. When a calendar is added, a space is also created. This space will contain the calendar document and the event documents associated with the calendar.
	193	+
	194	+Event class properties:
	195	+
	196	+* name (Name: text): // the title of the event//
	197	+* startDate (Start date: date(dd/MM/yyy)): // the date when the event starts//
	198	+* startTime (Start time: static list): // the hour when the event starts//
	199	+* endDate (End date: date(dd/MM/yyyy)): // the date when the event ends//
	200	+* endTime (End time: static list): //the hour when the event ends//
	201	+* allDay (All day: bool): //checkbox which indicates that startTime is 00:00 of the startDate and endTime is 00:00 of the day after endDate
	202	+* repeats (Repeats: static list (daily, weekly, monthly, yearly)): // how often the event repeats //
	203	+* repeatsUntil (Until: date(dd/MM/yyyy)): // the date when the recursion of the event ends//
	204	+* description (Description: text): // a short description of the event//
	205	+* location (Location: text): // the location where the event will take place//
	206	+* category (Category: database list): // the category of the event//
	207	+* color (Color: static list): // the color of the event//
	208	+* privacy(Privacy: static list): // set the event to be default, public (visible to everyone) or private (visible only to the user)//
	209	+* emailNotifications (Email Notifications: static list): // indicates when the reminders for the event should be sent to the creator and to the guest list//
	210	+* guestList (Guest List: user list): // the list of users invited to the event, waiting for confirmation//
	211	+* confirmedGuests (Attending guests: user list, disabled): // the list of users who have confirmed their attendance to the event//
	212	+* declinedGuests (Non-attending guests: user list, disabled): // the list of users who have declined their attendance to the event//
	213	+* guestRights (Guests can: static lists): // Indicates if the guests can Modify event, Invite other guests, View guest list //
	214	+
	215	+Calendar class properties:
	216	+
	217	+* name (Name: text): // the name of the calendar//
	218	+* description(Description: text): // a short description of the calendar//
	219	+* privacy(Privacy: static list): // set the calendar to be public(visible to everyone), visible to specific users or private(visisble only to the user)//
	220	+* shareList(Share calendar: user list): // if privacy is set to visible for specific users, this list will contain the users who can view it//
	221	+* owner(Owner: user): // the user who owns the calendar//
	222	+* weekStart(Week starts on: static list): // The day when the week starts (Sunday, Monday or Saturday) ? should this be done automatically depending on the user's location?//
	223	+* showDeclinedEvents(Show Events you have declined: bool): // Indicates if events which have been declined should be added to the calendar//
	224	+* addInvitations(Automatically add invitations to the calendar: bool): // Indicates if the events to which the user has been invited should be added to the calendar//
	225	+
	226	+Calendar class sheets:
	227	+
	228	+* CalendarViewDaySheet: // contains the display of the calendar table in "day" view//
	229	+* CalendarViewWeekSheet: // contains the display of the calendar table in "week" view//
	230	+* CalendarViewMonthSheet: // contains the display of the calendar table in "month" view//
	231	+* CalendarViewYearSheet: // contains the display of the calendar table in "year" view//
	232	+* CreateCalendarEvent: // contains the form for adding new events//
	233	+* CalendarEventListSheet: // contains the list of events for the specific calendar, with edit and delete links if the user has editing rights//
	234	+
	235	+Category class properties:
	236	+
	237	+* title(Title: text): // the title of the category//
	238	+* description(Description: text): // a short description of the category//
	239	+
	240	+