First set of source files for the Kolab web client user guide. The helpdocs directory will be symlinked into the _plugins directory f the roundcubemail-helpdocs generator.

This commit is contained in:
Thomas Bruederli 2014-01-29 19:35:14 +01:00
parent 2230e97ee9
commit 15bef340b0
11 changed files with 333 additions and 0 deletions

View file

@ -0,0 +1 @@
larry

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View file

@ -0,0 +1,19 @@
.. index:: Import
.. _calendar-import:
****************
Importing Events
****************
TBD.
.. index:: Export
.. _calendar-export:
****************
Exporting Events
****************
TBD.

View file

@ -0,0 +1,18 @@
.. index:: Calendar
.. _calendar:
********
Calendar
********
The *Calendar* gives you access to your personal and shared calendar and scheduling functions.
.. toctree::
:maxdepth: 2
overview
manage
invitations
importexport
sharing

View file

@ -0,0 +1,22 @@
.. calendar-invitations:
Handle Event Invitations
========================
TBD.
Receive Event Invitations
-------------------------
TBD.
Accept/Decline Invitations
--------------------------
TBD.

View file

@ -0,0 +1,108 @@
.. _calendar-manage:
Manage Your Schedule
====================
All functions to maintain your events are accessible from the main calendar view.
Add Events to a Calendar
------------------------
**Via toolbar**
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
add it to the selected calendar.
**At a specific date/time**
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
should start and releasing it again at time it finishes. This will open the event dialog
with the selected time/date range already filled it.
In order to create new all-day events, double-click the desired day in the calendar view.
.. index:: Recurring events, Participants, Participants
.. _calendar-edit-event:
Edit and Reschedule Events
--------------------------
The Event Dialog
^^^^^^^^^^^^^^^^
When clicking an event in the calendar view, a dialog showing its details is displayed.
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
of the dialog.
**Summary**
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
notifications and category assignments.
The *Calendar* selector allows you to move an event from one calendar to another.
**Recurrence**
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
the for below offers more options to further refine the rules how the event is repeated and for how long.
**Participants**
An important part of managing your schedule is to invite others to events and track their RSVP.
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.
**Participants**
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
files works pretty much the same as :ref:`attaching them to email messages <mail-compose-attachments>`:
first select a file from your local disk and click *Upload* in order to attach it.
.. note:: Don't forget to finally save the changes by clicking *Save* in the event edit dialog.
Even switching back and forth the tabs will not yet save the data.
Moving and Resizing with the Mouse
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. container:: image-right
.. image:: _static/_skin/event-resize.png
If an existing event shall be rescheduled to another time or date, you'll find it handy
to do that directly in the calendar view without opening the edit form. Simply grab the event
block with the mouse and move it to the new date or time. Release the mouse button to complete.
In *Month* and *Day* view, the event blocks have a small handle at the bottom. Drag this with the
mouse in order to resize the event meaning to adjust its duration.
.. index:: Notifications, Reminders, Alarms
.. _calendar-event-alarms:
Get Notifications
-----------------
TBD.
.. index:: Invite
.. _calendar-event-participants:
Invite others
-------------
TBD.
Receive Event Invitations
-------------------------
TBD.

View file

@ -0,0 +1,136 @@
*************
Overview
*************
The screen of the calendar module presents the following parts: the :ref:`Calendar View <calendar-view>`
itself, a small :ref:`Calendar Widget <calendar-minicalendar>` the :ref:`calendar-lists` as well as the usual
toolbar and search box.
.. index:: Month View, Week View, Day View, Agenda
.. _calendar-view:
Calendar View
=============
The central part of the screen displays the schedule with events from the active calendars matching the current
date range. The active date range is displayed above the calendar in the toolbar area and can be moved forward or
backward in time using the arrow buttons right next to the title.
.. image:: _static/_skin/calendar-header.png
Change Views
------------
You can view your calendar events in Day, Week, Month or Agenda view. Toggle the view mode using the toolbar buttons
above the calendar view.
**Day**
All events of a single day appear at the time the begin and spawn a box until their end time. The time
scale is displayed in the left side of the view. All-day events appear at the top.
**Week**
Similar to the day view but lists all days of the week horizontally. All-day events again appear at the top.
**Month**
Shows all events of the selected month at a time. Each event only appears as a single line and if there are
more events in a day than can be listed, a number at the bottom of the day field indicates that. Click that
link to open a zoomed view of that single day.
**Agenda**
The agenda view shows a list of events for the selected range in a chronological order and divided by
headers denoting either days, weeks or months. Both the number of the days considered for the listing as well
as the mode how to divide list can be adjusted with the controls at the bottom of the agenda view.
.. _calendar-minicalendar:
For all the views, the small calendar on the left highlights the currently listed days.
Go to a specific Date
---------------------
Use the mini calendar widget on the left to jump to a specific date. Simply click a date and the date range of the current
view moves to include the selected day. The left/right arrows in the mini calendar's header quickly cycle through the months.
Use the drop-down menus hidden under the month and year display in the widget header to directly jump to another month or year.
A shortcut to switch the calendar view back to today or the current week provides the *Today* button located in the toolbar.
Show Event Details
------------------
Click an event box in the calendar view to open a dialog displaying all details of the event.
Searching Events
----------------
The search box above the calendar view lets you quickly get a list of events matching the entered keyword
in either the title, location, description or attendees. Enter the search term into the box and press <Enter>
on your keyboard to start the search. The calendar view will switch to *Agenda* mode in order to display
a list of matches. Of course you can switch the view again to display the search results differently.
.. note:: Events are searched within a certain date reange only which is displayed above the calendar view.
Use the mini calendar widget or the arrow toolbar buttons and the range selector below the agenda view
to adjust the time frame to search in.
For searching as well as for normal views, only events from active calendars are displayed. Use the checkboxes
in the :ref:`calendar-lists` to add or hide events from different calendars.
Reset the search by clicking the *Reset search* icon on the right border of the search box. This will
also switch the calendar view to whatever mode you had before the search.
.. index:: Calendars
.. _calendar-lists:
Calendars List
==============
Events can be organized in different calendars which are all displayed in the lower left list.
Use the checkboxes in that list to show or hide events from the specific calendars in the main view.
.. only:: kolab
Beside your personal calendars, the list also displays calendars shared by other users
or ones that are shared amongst your workgroup. Small icons in the list give a hint
about the origin and some of them are possibly read-only which is denoted with a small lock icon.
Colorized Events
----------------
In order to better distinguish the events from various calendars in the calendar view, calendars have
a color assigned which is used to colorize the events on the screen. Check the :ref:`settings-calendar`
for more advanced options how to colorize events in the calendar view.
You can create any number of calendars to store all your events and name them individually.
Create a New Calendar
---------------------
1. Click the + icon in the calendars list footer.
2. In the dialog, give the new calendar a unique name and assign a color.
3. Click *Save* to create it.
The calendar view will reload and list the new calendar on the left.
Edit Calendar Names and Settings
--------------------------------
1. Select the calendar to edit by clicking it in the list.
2. Click the gear icon in the calendars list footer and select *Edit* from the options menu.
3. Adjust name, color or alarms settings in the edit dialog.
4. Click *Save* to finally update the calendar.
Remove entire Calendars
-----------------------
1. Select the calendar to edit by clicking it in the list.
2. Click the gear icon in the calendars list footer and select *Remove* from the options menu.
3. After a confirmation dialog, the selected calendar with all its events will be deleted.
Caution: This action cannot be undone!

View file

@ -0,0 +1,9 @@
.. _settings-calendar:
********************
Calendar Preferences
********************
TBD.

View file

@ -0,0 +1,20 @@
.. calendar-sharing:
Share Calendars
===============
TBD.
Share a Calendar with others
----------------------------
TBD.
Subscribe to shared calendars
-----------------------------
TBD.