1.1 --- a/docs/wiki/CalendarManager Tue Nov 03 23:55:11 2015 +0100
1.2 +++ b/docs/wiki/CalendarManager Tue Nov 03 23:56:13 2015 +0100
1.3 @@ -7,7 +7,7 @@
1.4 and to create events to be shared with others.
1.5
1.6 The management interface is deployed according to the
1.7 -[[../WebServerIntegration|Web server integration guide]], and if enabled will be
1.8 +[[../WebServerIntegration|Web server integration guide]] and, if enabled, will be
1.9 advertised in messages sent by imip-agent to users receiving calendar-related
1.10 messages, with links being provided like this (subject to the configuration):
1.11
1.12 @@ -17,3 +17,91 @@
1.13
1.14 Upon following such a link, users should be asked to log in. They should then be
1.15 presented with the details of an event received via e-mail.
1.16 +
1.17 +== The Calendar View ==
1.18 +
1.19 +The root resource of the management interface shows a simple calendar view for
1.20 +the logged-in user. The following elements are displayed:
1.21 +
1.22 + * The name of the user, linking to a profile page
1.23 +
1.24 + * Any requests/invitations that require attention, linking to those items in the
1.25 + calendar
1.26 +
1.27 + * The period being shown, along with controls to navigate forwards and backwards
1.28 + in the calendar, and controls to show and hide empty days and busy periods
1.29 +
1.30 + * Participants for scheduling: details of other users whose schedules are shown
1.31 + alongside the user's own schedule
1.32 +
1.33 + * The calendar itself, featuring events, and possibly featuring a column
1.34 + containing requests and invitations
1.35 +
1.36 +Adding scheduling participants, specifying their e-mail address, results in a new
1.37 +schedule column being added for each new participant in the calendar. When creating
1.38 +an event, all scheduling participants are automatically added as attendees.
1.39 +
1.40 +The calendar is divided into days, and these are divided into periods depending on
1.41 +the nature of any events that feature in the calendar. Days for which no events are
1.42 +recorded are hidden by default; such days can be shown if desired.
1.43 +
1.44 +Whole days can be chosen by selecting day headings in the calendar. Similarly,
1.45 +individual periods can be chosen either by selecting period headings along the side
1.46 +of the calendar or by selecting cells in the calendar. Upon selecting periods,
1.47 +controls will appear for the creation of a new event, and if all periods are
1.48 +deselected, such controls will disappear.
1.49 +
1.50 +Events appear in the calendar as filled regions, and their labels correspond to the
1.51 +summary information defined for each event. These labels link to the event details
1.52 +unless a request has updated the event: in which case, the request label will link
1.53 +to the updated event details.
1.54 +
1.55 +Requests/invitations appear alongside events in a separate column in the calendar,
1.56 +and their label links to the details of the request (and thus updated event). Such
1.57 +items disappear from the calendar once processed by the user.
1.58 +
1.59 +== The User Profile ==
1.60 +
1.61 +Each user's profile details are presented in a table mostly corresponding to the
1.62 +system's [[../Preferences|preferences]], with the most significant settings given
1.63 +first. Many users will probably only want to change their participation in the
1.64 +calendar system, their name, language or time zone, at least if the defaults
1.65 +chosen for deployment are reasonable.
1.66 +
1.67 +The settings names correspond to the preferences as follows:
1.68 +
1.69 +## This is generated by the docs/tools/profile_prefs.sh script...
1.70 +
1.71 +|| '''Label''' || '''Setting''' ||
1.72 +|| Participate in the calendar system || [[../Preferences#participating|participating]] ||
1.73 +|| Your common name || [[../Preferences#CN|CN]] ||
1.74 +|| Language || [[../Preferences#LANG|LANG]] ||
1.75 +|| Time zone/regime || [[../Preferences#TZID|TZID]] ||
1.76 +|| How to present incoming calendar messages || [[../Preferences#incoming|incoming]] ||
1.77 +|| Share free/busy information || [[../Preferences#freebusy_sharing|freebusy_sharing]] ||
1.78 +|| Bundle free/busy details with messages || [[../Preferences#freebusy_bundling|freebusy_bundling]] ||
1.79 +|| Publish free/busy details via the Web || [[../Preferences#freebusy_publishing|freebusy_publishing]] ||
1.80 +|| Deliver details of received free/busy messages || [[../Preferences#freebusy_messages|freebusy_messages]] ||
1.81 +|| How to respond to messages adding events || [[../Preferences#add_method_response|add_method_response]] ||
1.82 +|| How to handle event refresh requests || [[../Preferences#event_refreshing|event_refreshing]] ||
1.83 +|| Recognise whom as a new organiser of an event? || [[../Preferences#organiser_replacement|organiser_replacement]] ||
1.84 +
1.85 +== The Event View ==
1.86 +
1.87 +The event view consists of the following elements:
1.88 +
1.89 + * Basic event details: summary, start and end dates/times, and the organiser
1.90 +
1.91 + * A list of attendees with controls to add and remove attendees, depending on
1.92 + the role of the user
1.93 +
1.94 + * Some controls to change or process the event
1.95 +
1.96 +In addition, some other elements may appear in the event view:
1.97 +
1.98 + * Periods during which the event recurs
1.99 +
1.100 + * Counter-proposals sent by attendees to the organiser of an event, appearing
1.101 + if the user has the organiser role, with controls to process these items
1.102 +
1.103 + * Periods that conflict with the event's own periods