Skip to Content

Changes for page Calendar Application

Last modified by Ecaterina Valica on 2014/01/15 13:50
From version 25.1
edited by Ecaterina Valica
on 2014/01/15 13:50
Change comment: Moved page to http://design.xwiki.org/xwiki/bin/view/Drafts/CalendarApplication
To version 13.8
edited by Vlad Merticariu
on 2011/06/22 12:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.evalica
1 +XWiki.vladm
Content
... ... @@ -1,1 +1,225 @@
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 +* Have different calendars for each space
34 +
35 += Detailed Functionality =
36 +
37 +== Adding events ==
38 +
39 +You may add an event by:
40 +
41 +1. Clicking a button which opens a modal window, allowing the user to insert details and save
42 +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
43 +
44 +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:
45 +
46 +* **Name**
47 +* **Date**: User should be able to mark an event as **recurring**.
48 +* **Location**: Link to Google Maps
49 +* **Description**
50 +* **Category**
51 +* **Color**: The event will have a default color and event creators may select a different color for the new event from a given list
52 +* **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)
53 +* **Privacy options**: Default, Private, Public
54 +* 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
55 +* **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
56 +* **Attachments**: Documents can be attached to an event. An icon will indicate in the daily and weekly view modes that the event has attachments
57 +* **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
58 +
59 +**More actions:**
60 +
61 +* **Change owner**
62 +* **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
63 +* **Delete event**
64 +* **Duplicate event**: Copy an event inside the calendar
65 +* **Copy event to a different calendar**: Copy an event from the current calendar to a different calendar
66 +
67 +== Viewing events ==
68 +
69 +**View calendar:**
70 +
71 +* Tabbed day, week, month, yearly view
72 +* **Year view**:
73 +** There should be 12 cells representing the 12 different months
74 +** When users click on a month (e.g. //June 2011//) they should be directed to that specific month in the "Month" tab
75 +** When users click on a day (e.g. //1//) they should be directed to that specific day in the "Day" tab
76 +** Days that have events associated should be marked with bold
77 +** The current day should be highlighted with a distinct color or frame
78 +** Arrows will be available to go to the previous/next year
79 +* **Month view**:
80 +** Table view; each column represents a day of the week (Monday, Tuesday...); each cell represents a specific date (1, 2...)
81 +** 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
82 +** 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
83 +** The current day should be highlighted with a distinct color (same as the one used for the "Year" view)
84 +** Arrows will be available to go to the previous/next month
85 +* **Week view**
86 +** Table view; each column represents a day of the week (Monday, Tuesday...); each row represents an hour of the day
87 +** 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
88 +** 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
89 +** The current day should be highlighted with a distinct color (same as the one used for the other views)
90 +** Arrows will be available to go to the previous/next week
91 +* **Day view**
92 +** Table view; one column representing one day; each row represents an hour of the day
93 +** 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
94 +** The current day should be highlighted with a distinct color (same as the one used for the other views)
95 +** Arrows will be available to go to the previous/next day
96 +
97 +* **Display events by category**: users can select a category and only events from that category will be displayed in the calendar
98 +* **Jump to a specific date**
99 +
100 +* **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.
101 +
102 +**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)
103 +
104 +== Settings ==
105 +
106 +=== General ===
107 +
108 +* Calendar **name**
109 +* **Owner**
110 +* **Description**
111 +* **Location**
112 +
113 +
114 +* Week starts on Sunday/Monday/Saturday ? //should this be done automatically depending on the user's location?//
115 +* Show events you have declined: Yes/No
116 +* Automatically add invitations to my calendar: Yes/No
117 +
118 +=== Privacy ===
119 +
120 +**Privacy settings for calendar**
121 +The calendar can be:
122 +
123 +* Public
124 +* Visible for specific wiki users -> Share calendar
125 +* Private
126 +
127 +**Default privacy settings for events**
128 +Events can be
129 +
130 +* Public: visible to everyone specified in the calendar settings
131 +* Private: visible only to the event creator
132 +
133 +=== Notifications ===
134 +
135 +A calendar owner may choose to receive notifications for:
136 +
137 +|=Events he is invited to |=Events he owns
138 +|(((
139 +* New invitations
140 +* Changed invitations
141 +* Canceled invitations
142 +* Invitation replies
143 +)))|(((
144 +* RSVPs from guests (attending, canceling presence)
145 +* Attachments being added
146 +* Comments being added
147 +)))
148 +
149 +In addition, **reminders** can be **sent by default to the calendar owner** via email: 10 minutes, 30 minutes, 1 hour, 1 day, 1 week
150 +
151 +== Search ==
152 +
153 +The "View event list" livetable can be used to filter events by date, location, and even to do searches within the event descriptions.
154 +
155 +== Suggestions ==
156 +
157 +* Ability to print calendar
158 +* Keyboard shortcuts
159 +* Tips or link to documentation
160 +* Notifications by SMS could be interesting
161 +* Gadget integration
162 +
163 +==Further work==
164 +
165 +* Select language?
166 +* Select from different time zones?
167 +* Select date format?
168 +* Select time format?
169 +* Similarly to Google Calendar, event recurrence should be customizable
170 +
171 += Technicalities =
172 +
173 +The event-calendar part of the application will be implemented in the following way:
174 +
175 +* 2 classes will be used: EventClass and CalendarClass
176 +* an event represents a document with an object of EventClass attached
177 +* 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.
178 +
179 +Event class properties:
180 +
181 +* name (Name: text): // the title of the event//
182 +* startDate (Start date: date(dd/MM/yyy)): // the date when the event starts//
183 +* startTime (Start time: static list): // the hour when the event starts//
184 +* endDate (End date: date(dd/MM/yyyy)): // the date when the event ends//
185 +* endTime (End time: static list): //the hour when the event ends//
186 +* 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
187 +* repeats (Repeats: static list (daily, weekly, monthly, yearly)): // how often the event repeats //
188 +* repeatsUntil (Until: date(dd/MM/yyyy)): // the date when the recursion of the event ends//
189 +* description (Description: text): // a short description of the event//
190 +* location (Location: text): // the location where the event will take place//
191 +* category (Category: database list): // the category of the event//
192 +* color (Color: static list): // the color of the event//
193 +* privacy(Privacy: static list): // set the event to be default, public (visible to everyone) or private (visible only to the user)//
194 +* emailNotifications (Email Notifications: static list): // indicates when the reminders for the event should be sent to the creator and to the guest list//
195 +* guestList (Guest List: user list): // the list of users invited to the event, waiting for confirmation//
196 +* confirmedGuests (Attending guests: user list, disabled): // the list of users who have confirmed their attendance to the event//
197 +* declinedGuests (Non-attending guests: user list, disabled): // the list of users who have declined their attendance to the event//
198 +* guestRights (Guests can: static lists): // Indicates if the guests can Modify event, Invite other guests, View guest list //
199 +
200 +Calendar class properties:
201 +
202 +* name (Name: text): // the name of the calendar//
203 +* description(Description: text): // a short description of the calendar//
204 +* privacy(Privacy: static list): // set the calendar to be public(visible to everyone), visible to specific users or private(visisble only to the user)//
205 +* shareList(Share calendar: user list): // if privacy is set to visible for specific users, this list will contain the users who can view it//
206 +* owner(Owner: user): // the user who owns the calendar//
207 +* 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?//
208 +* showDeclinedEvents(Show Events you have declined: bool): // Indicates if events which have been declined should be added to the calendar//
209 +* 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//
210 +
211 +Calendar class sheets:
212 +
213 +* CalendarViewDaySheet: // contains the display of the calendar table in "day" view//
214 +* CalendarViewWeekSheet: // contains the display of the calendar table in "week" view//
215 +* CalendarViewMonthSheet: // contains the display of the calendar table in "month" view//
216 +* CalendarViewYearSheet?
217 +* CalendarFormSheet: // contains the form for adding new events//
218 +* CalendarEventListSheet: // contains the list of events for the specific calendar, with edit and delete links if the user has editing rights//
219 +
220 +Category class properties:
221 +
222 +* title(Title: text): // the title of the category//
223 +* description(Description: text): // a short description of the category//
224 +
225 +
actions.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Size
... ... @@ -1,1 +1,0 @@
1 -70.2 KB
Content
addMenu.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Size
... ... @@ -1,1 +1,0 @@
1 -18.1 KB
Content
eventFields.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Size
... ... @@ -1,1 +1,0 @@
1 -73.9 KB
Content
monthView.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Size
... ... @@ -1,1 +1,0 @@
1 -87.5 KB
Content
weekView.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Size
... ... @@ -1,1 +1,0 @@
1 -62.2 KB
Content
yearView.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Size
... ... @@ -1,1 +1,0 @@
1 -75.8 KB
Content
XWiki.XWikiComments[0]
Date
... ... @@ -1,1 +1,0 @@
1 -2011-06-22 11:59:17.0
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.evalica
Comment
... ... @@ -1,3 +1,0 @@
1 -I don't think we will need a livetable to list all the events since you can see/delete/edit all events in the year/month/week views. The calendar events are much powerful when they are in a timeline than seeing them in a list.
2 -
3 -Also I don't think is necessary the concept of categories when you can have multiple calendars. Right now in Google Calendar you can create multiple calendars and attribute each calendar a goal (have a personal one, a xwiki one, a birthday, etc). In this use case the concept of categories is replaced by multiple calendars.
XWiki.XWikiComments[1]
Date
... ... @@ -1,1 +1,0 @@
1 -2011-06-22 12:35:20.0
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.Enygma
Reply To
... ... @@ -1,1 +1,0 @@
1 -0
Comment
... ... @@ -1,7 +1,0 @@
1 -I agree with this.
2 -
3 -We should have a 2 views:
4 -1. Individual calendar view, that should be available on each calendar's space WebHome
5 -2. Aggregated calendar view for all the calendars and events that are visible to the current user. This could be a new tab in the user's profile (harder for an application to extend right now) or, alternatively, in the Calendar application's space WebHome (easier and makes the Calendar application space useful).
6 -
7 -The event livetable might be useful for an 'advanced search' functionality, allowing to filter events nicely.