More calendar user guide now including itip invitations and import/export features
This commit is contained in:
parent
15bef340b0
commit
7791c7515d
8 changed files with 146 additions and 29 deletions
BIN
plugins/calendar/helpdocs/en_US/_static/larry/alarms-popup.png
Normal file
BIN
plugins/calendar/helpdocs/en_US/_static/larry/alarms-popup.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
After Width: | Height: | Size: 115 KiB |
BIN
plugins/calendar/helpdocs/en_US/_static/larry/itip-reply.png
Normal file
BIN
plugins/calendar/helpdocs/en_US/_static/larry/itip-reply.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
|
@ -1,19 +1,43 @@
|
||||||
.. index:: Import
|
.. index:: Import, iCal
|
||||||
.. _calendar-import:
|
.. _calendar-import:
|
||||||
|
|
||||||
****************
|
*************
|
||||||
Importing Events
|
Import/Export
|
||||||
****************
|
*************
|
||||||
|
|
||||||
TBD.
|
Event data is usually exchanged using the standard |iCal|_ format
|
||||||
|
which is supported for import and export.
|
||||||
|
|
||||||
|
|
||||||
|
Importing Events
|
||||||
|
----------------
|
||||||
|
|
||||||
|
This is how to add events from an |iCal|_ (.ics) file:
|
||||||
|
|
||||||
|
1. Click the *Import* toolbar button in the calendar view.
|
||||||
|
2. Then select the file to import from your computer's hard drive.
|
||||||
|
3. Select the calendar to import the events to.
|
||||||
|
4. Select the threshold for old events to be imported.
|
||||||
|
5. Click *Import* and wait for the upload to finish.
|
||||||
|
|
||||||
|
The calendar view will be refreshed to display the newly imported events.
|
||||||
|
Verify that the according calendar is active if you don't see them.
|
||||||
|
|
||||||
|
|
||||||
.. index:: Export
|
.. index:: Export
|
||||||
.. _calendar-export:
|
.. _calendar-export:
|
||||||
|
|
||||||
****************
|
|
||||||
Exporting Events
|
Exporting Events
|
||||||
****************
|
----------------
|
||||||
|
|
||||||
TBD.
|
Events from your calendars can be exported and downloaded in the |iCal|_ format.
|
||||||
|
|
||||||
|
1. Click the *Export* toolbar button in the calendar view.
|
||||||
|
2. Select the calendar where events should be exported from.
|
||||||
|
3. With the *Events from* selector you choose the time constraints for exporting.
|
||||||
|
4. Click the *Export* button to start the export.
|
||||||
|
5. Choose where to save the exported .ics file if prompted, otherwise check the "Downloads" folder on your computer.
|
||||||
|
|
||||||
|
|
||||||
|
.. |iCal| replace:: iCalendar
|
||||||
|
.. _iCal: https://en.wikipedia.org/wiki/ICalendar
|
||||||
|
|
|
@ -1,22 +1,55 @@
|
||||||
.. calendar-invitations:
|
.. index:: Invitation, RSVP
|
||||||
|
.. _calendar-invitations:
|
||||||
|
|
||||||
Handle Event Invitations
|
Handle Event Invitations
|
||||||
========================
|
========================
|
||||||
|
|
||||||
TBD.
|
In chapter :ref:`calendar-event-participants` we have learned how to invite
|
||||||
|
other people to an event. This will send out invitation emails to all the
|
||||||
|
participants with the event data attached. That allows one to directly accept
|
||||||
|
or decline an event invitation.
|
||||||
|
|
||||||
|
|
||||||
Receive Event Invitations
|
Receive Event Invitations
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
TBD.
|
When the webmail system opens an invitation email with event data attached, it'll
|
||||||
|
display a yellow box in the preview pane or the email view:
|
||||||
|
|
||||||
|
.. image:: _static/_skin/itip-invitation.png
|
||||||
|
|
||||||
Accept/Decline Invitations
|
Accept/Decline Invitations
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
TBD.
|
Right in the box shown above, you can accept or decline the invitation by clicking the according
|
||||||
|
button. This will send an automated response to the event organizer informing her about your
|
||||||
|
decision and letting her update your participant status in her calendar.
|
||||||
|
|
||||||
|
In case you accept, by either clicking *Accept* or *Maybe*, this will also copy
|
||||||
|
the event into your personal calendar. The selector right next to the buttons lets you
|
||||||
|
choose the right one.
|
||||||
|
|
||||||
|
The copy in your calendar now knows about the invitation and its original sender. If you now
|
||||||
|
delete it from your calendar, you'll be asked whether this should send a declination
|
||||||
|
message to the person who organizes the event.
|
||||||
|
|
||||||
|
After acceping or declining, the email message containing the invitation can be deleted.
|
||||||
|
|
||||||
|
|
||||||
|
Process Invitation Replies
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
As an organizer who has invited others to an event, you'll receive responses to the
|
||||||
|
automatically sent invitations when the attendees either accept or decline them.
|
||||||
|
|
||||||
|
Such messages are also identified by the webmail system and again a yellow box appears
|
||||||
|
in the message view:
|
||||||
|
|
||||||
|
.. image:: _static/_skin/itip-reply.png
|
||||||
|
|
||||||
|
By clicking the *Update the participant's status* button, the original event in
|
||||||
|
your calendar will be updated with the RSVP status from the person who responded here.
|
||||||
|
|
||||||
|
When you now look at the event details in the calendar view, the status icons next
|
||||||
|
to each participant now displays the new status.
|
||||||
|
|
||||||
|
|
|
@ -11,14 +11,14 @@ Add Events to a Calendar
|
||||||
|
|
||||||
**Via toolbar**
|
**Via toolbar**
|
||||||
Click the *New event* button in the toolbar to get an empty dialog where you enter
|
Click the *New event* button in the toolbar to get an empty dialog where you enter
|
||||||
the event properties such as summary, date/time, reminders, etc. Click *Save* to finally
|
the :ref:`event properties <calendar-edit-event>` such as summary, date/time, reminders, etc.
|
||||||
add it to the selected calendar.
|
Click *Save* to finally add it to the selected calendar.
|
||||||
|
|
||||||
**At a specific date/time**
|
**At a specific date/time**
|
||||||
Navigate the calendar view to the date you want to add an event for. Then mark the range
|
Navigate the calendar view to the date you want to add an event for. Then mark the range
|
||||||
of time (or dates in month view) with the mouse by pressing the button at the time the event
|
of time (or dates in month view) with the mouse by pressing the button at the time the event
|
||||||
should start and releasing it again at time it finishes. This will open the event dialog
|
should start and releasing it again at time it finishes. This will open the :ref:`event dialog <calendar-edit-event>`
|
||||||
with the selected time/date range already filled it.
|
with the selected date/time range already filled in.
|
||||||
|
|
||||||
In order to create new all-day events, double-click the desired day in the calendar view.
|
In order to create new all-day events, double-click the desired day in the calendar view.
|
||||||
|
|
||||||
|
@ -36,21 +36,36 @@ When clicking an event in the calendar view, a dialog showing its details is dis
|
||||||
Clicking the *Edit* button in that dialog opens the form to edit all properties of the selected event.
|
Clicking the *Edit* button in that dialog opens the form to edit all properties of the selected event.
|
||||||
|
|
||||||
The edit form is divided into different section which can be switched using the tabs on top
|
The edit form is divided into different section which can be switched using the tabs on top
|
||||||
of the dialog.
|
of the dialog:
|
||||||
|
|
||||||
**Summary**
|
**Summary**
|
||||||
|
|
||||||
This general section has text fields and selectors for various properties of an event.
|
This general section has text fields and selectors for various properties of an event.
|
||||||
This is where you adjust the displayed summary, date/time/duration as well as reminder
|
Here's a description of all the possible values:
|
||||||
notifications and category assignments.
|
|
||||||
|
|
||||||
The *Calendar* selector allows you to move an event from one calendar to another.
|
* ``Summary``: The title of the event. This is what you will see in the calendar view.
|
||||||
|
* ``Location``: Where the event will be taking place.
|
||||||
|
* ``Description``: Any text that describes the event.
|
||||||
|
* ``URL``: A link to more information about this event.
|
||||||
|
* ``Start``: Date and time when the event starts.
|
||||||
|
* ``End``: Date and time when the event starts.
|
||||||
|
* ``all-day``: Check this if the event has no start/end time.
|
||||||
|
* ``Reminder``: Will pop up with an notification at a the specified time before the event.
|
||||||
|
* ``Calendar``: The calendar the event is saved in. Change it to move an event from one calendar to another.
|
||||||
|
* ``Category``: The type of event. Categories can also be used for :ref:`coloring <settings-calendar>`.
|
||||||
|
* ``Show me as``: The representation in your free/busy scheduling calendar visible to others.
|
||||||
|
* ``Priority``: The priority value of the event.
|
||||||
|
* ``Privacy``: Flag an event as "private" or "confidential" when sharing your calendar with others.
|
||||||
|
|
||||||
**Recurrence**
|
**Recurrence**
|
||||||
|
|
||||||
For periodically recurring event series, this tabs has the settings how an event is repeated
|
For periodically recurring event series, this tabs has the settings how an event is repeated
|
||||||
over time. Start with selecting a repetition interval (e.g. monthly). Depending on that interval
|
over time.
|
||||||
the for below offers more options to further refine the rules how the event is repeated and for how long.
|
|
||||||
|
* ``Repeat``: Start with selecting a repetition interval (e.g. monthly)
|
||||||
|
* ``Every``: How often the frequency will be relevant. For example, for an event that takes place every other week choose Weekly and then 2.
|
||||||
|
If you choose a frequency of weekly or monthly you can select which days of the week or month the event will occur.
|
||||||
|
* ``Until``: Determines the duration of the repetition. The recurrence can either run forever, for a number it times or until a specific date.
|
||||||
|
|
||||||
**Participants**
|
**Participants**
|
||||||
|
|
||||||
|
@ -58,7 +73,7 @@ An important part of managing your schedule is to invite others to events and tr
|
||||||
In this part of the edit dialog you can manage the participants of an event. Read more about this
|
In this part of the edit dialog you can manage the participants of an event. Read more about this
|
||||||
further down in the :ref:`calendar-event-participants` section.
|
further down in the :ref:`calendar-event-participants` section.
|
||||||
|
|
||||||
**Participants**
|
**Attachments**
|
||||||
|
|
||||||
Sometimes a description text isn't enough to collect information for a specific event.
|
Sometimes a description text isn't enough to collect information for a specific event.
|
||||||
Switch to this tab to attach files to the current event or to remove them again. Adding
|
Switch to this tab to attach files to the current event or to remove them again. Adding
|
||||||
|
@ -90,19 +105,62 @@ Moving and Resizing with the Mouse
|
||||||
Get Notifications
|
Get Notifications
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
TBD.
|
.. container:: image-right
|
||||||
|
|
||||||
|
.. image:: _static/_skin/alarms-popup.png
|
||||||
|
|
||||||
|
While logged in to the webmail, event reminders will be displayed with pop-up boxes at the specified time
|
||||||
|
before the event starts. You can specify if you want to see alarms for every calendar individually.
|
||||||
|
Enable or disable alarms in :ref:`Calendar Settings <calendar-edit-properties>` from the :ref:`calendar-lists`.
|
||||||
|
|
||||||
|
Dismiss or Snooze Alarms
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
When a reminder box pops up, you can either dismiss the notification for all events or each one individually.
|
||||||
|
When dismissed, no further reminders will be displayed. Choose a time from the *Snooze* menu to get another
|
||||||
|
reminder after the selected time.
|
||||||
|
|
||||||
|
|
||||||
.. index:: Invite
|
.. index:: Invite, Participants, Attendees
|
||||||
.. _calendar-event-participants:
|
.. _calendar-event-participants:
|
||||||
|
|
||||||
Invite others
|
Inviting Other People
|
||||||
-------------
|
---------------------
|
||||||
|
|
||||||
TBD.
|
If you need to set up a meeting, and keep track of who's attending and who is not, the calendar can do this
|
||||||
|
as well as you to automatically send invitations and read their responses.
|
||||||
|
|
||||||
|
When creating a new event, switch to the *Participants* tab. You're already listed as the organizer of the event.
|
||||||
|
|
||||||
|
.. image:: _static/_skin/event-participants.png
|
||||||
|
|
||||||
|
1. Enter the name or email address of the person to invite. Contacts from the address book are suggested as you type.
|
||||||
|
In order to send invitations, make sure the entered contact has an email address. Type it in the form
|
||||||
|
``Person Name <email@address.com>``.
|
||||||
|
2. Click *Add participant* to add the person to the list.
|
||||||
|
3. Select a *Role* (e.g. required or optional) for this person.
|
||||||
|
4. Repeat 1-3 for further participants.
|
||||||
|
5. Check the *Send invitations* box if the application should send out invitation emails.
|
||||||
|
|
||||||
|
Invitations will be sent out when you click *Save* and the event is created.
|
||||||
|
|
||||||
|
.. only:: kolab
|
||||||
|
|
||||||
|
.. index:: Availability
|
||||||
|
|
||||||
|
Find Availability
|
||||||
|
^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Once all the participants are added to the list, you see the individual availability status for each one
|
||||||
|
of them, given that this information is available. In case not everybody is free, click the *Find availability...*
|
||||||
|
button to open the scheduling dialog. In that dialog, detailed availability information for all participants is
|
||||||
|
displayed. Use the *Previous/Next Slot* buttons to find the next time slot where all required participants are
|
||||||
|
available. Or drag the gray area representing the event duration with the mouse to manually select a free slot.
|
||||||
|
|
||||||
|
Click *Select* to copy the rescheduled date/time back into the event form and to close this dialog.
|
||||||
|
|
||||||
|
|
||||||
Receive Event Invitations
|
Receive Event Invitations
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
TBD.
|
How to process incoming event invitations is described in chapter :ref:`calendar-invitations`.
|
|
@ -118,6 +118,8 @@ Create a New Calendar
|
||||||
|
|
||||||
The calendar view will reload and list the new calendar on the left.
|
The calendar view will reload and list the new calendar on the left.
|
||||||
|
|
||||||
|
.. _calendar-edit-properties:
|
||||||
|
|
||||||
Edit Calendar Names and Settings
|
Edit Calendar Names and Settings
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue