Merge pull request #1773 from nextcloud/add-groupware-section

Add Groupware section

.gitignore

@@ -30,3 +30,6 @@ developer_manual/design/icons.txt
 
 # Exclude Eclipse project
 .project
+
+# pipenv / virtualenv
+venv

admin_manual/configuration_server/occ_command.rst

@@ -451,6 +451,7 @@ A set of commands to create and manage addressbooks and calendars::
   dav:list-calendars            List all calendars of a user
   dav:move-calendar             Move a calendar from an user to another
   dav:remove-invalid-shares     Remove invalid dav shares
+  dav:send-event-reminders      Sends event reminders
   dav:sync-birthday-calendar    Synchronizes the birthday calendar
   dav:sync-system-addressbook   Synchronizes users to the system 
                                 addressbook
@@ -483,6 +484,11 @@ This example will move calendar named personal from user dennis to user sabine::
 
 ``dav:remove-invalid-shares`` will remove invalid shares created by a bug into the calendar app
 
+``dav:send-event-reminders`` is a command that should be called regularly through a dedicated
+cron job to send event reminder notifications.
+
+See :doc:`../groupware/calendar` for more information on how to use this command.
+
 ``dav:sync-birthday-calendar`` adds all birthdays to your calendar from 
 addressbooks shared with you. This example syncs to your calendar from user 
 bernie::

admin_manual/contents.rst

@@ -14,6 +14,7 @@ Table of contents
     configuration_user/index
     configuration_files/index
     file_workflows/index
+    groupware/index
     configuration_database/index
     configuration_mimetypes/index
     maintenance/index

admin_manual/groupware/calendar.rst

@@ -0,0 +1,74 @@
+========
+Calendar
+========
+
+Invitations
+-----------
+Nextcloud can send invitations for event attendees if this option is activated.
+Be sure to have configured the email server first so that the invitations go through.
+See :doc:`../configuration_server/email_configuration`.
+
+You must also make sure the "Send invitations to attendees" setting is activated in the admin setting groupware section for the emails to be sent.
+
+Birthday calendar
+-----------------
+Contacts that have a birthday date filled are automatically added as events to a special Birthday calendar.
+If you deactivate this option, all users will no longer have this calendar.
+
+When activating this option, users birthday calendars won't be available right away because they need to be generated
+by a background task. See :doc:`../configuration_server/occ_command` section Dav commands.
+
+Reminder notifications
+----------------------
+Since version 17, Nextcloud handles sending notifications for events.
+
+Nextcloud currently handles two types of reminder notifications: Build-in Nextcloud notifications and
+email notifications. For the emails to be send, you'll need a configured email server.
+See :doc:`../configuration_server/email_configuration`.
+
+Make sure the "Send notifications for events" and the "Enable notifications for events via push" are activated in the admin setting groupware section for this feature to work.
+
+Background jobs
+~~~~~~~~~~~~~~~
+As this can be a expensive task, depending on the number of events, reminders and event sharees and attendees that also needs to happen
+often enough so that the notifications are send on time, you can use a dedicated occ command that should be run
+more often than the standard cron system::
+
+ # crontab -u www-data -e
+ */5 * * * * php -f /var/www/nextcloud/occ dav:send-event-reminders
+
+See :doc:`../configuration_server/occ_command` section Dav commands.
+
+You'll also need to change the sending mode from ``background-job`` to ``occ``::
+
+ php occ config:app:set dav sendEventRemindersMode --value occ
+
+If you don't use this dedicated command, the reminders will just be send as soon as possible when the background jobs run.
+
+FreeBusy
+--------
+
+When logged-in, Nextcloud can return FreeBusy information for all users of the instance, to know when they are available so that you can schedule an event at the right time.
+If you don't wish for users to have this possibility, you can disable FreeBusy for the whole instance with the following setting::
+
+ php occ config:app:set dav disableFreeBusy --value yes
+
+Subscriptions
+----------------------
+Refresh rate
+~~~~~~~~~~~~
+
+Calendar subscriptions are cached on server and refreshed periodically. The default refresh rate is of one week, unless the subscription itself tells otherwise.
+
+To set up a different default refresh rate, change the ``calendarSubscriptionRefreshRate`` option::
+
+ php occ config:app:set dav calendarSubscriptionRefreshRate --value "P1D"
+
+Where the value is a `DateInterval <https://www.php.net/manual/dateinterval.construct.php>`_, for instance with the above command all of the Nextcloud instance's calendars would be refreshed every day.
+
+Allow subscriptions on local network
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Because of security issues, Nextcloud forbids subscriptions from local network hosts. If you need to allow this, change the following parameter to::
+
+ php occ config:app:set dav webcalAllowLocalAccess --value yes

admin_manual/groupware/index.rst

@@ -0,0 +1,9 @@
+===============
+Groupware
+===============
+
+
+.. toctree::
+    :maxdepth: 2
+
+    calendar

user_manual/pim/calendar.rst

@@ -1,5 +1,5 @@
 ======================
-Using the calendar app
+Using the Calendar app
 ======================
 
 .. note:: The calendar app is not enabled by default and needs to be installed
@@ -75,19 +75,37 @@ hard drive or delete it forever.
 
 2. Click on ``Edit``, ``Download`` or ``Delete``.
 
+Sharing calendars
+~~~~~~~~~~~~~~~~~
+
+You may share your calendar with other users or groups. Calendars may be shared with write access or read-only. When sharing a calendar with write access, users with whom the calendar is shared will be able to create new events into the calendar as well as edit and delete existing ones.
+
+.. note:: Calendar shares currently can't be accepted or rejected. If you want to stop having a calendar that someone shared with you, you can click on the 3-dot menu next to the calendar in the calendar list and click on "Unshare from me".
+
+Publishing a calendar
+~~~~~~~~~~~~~~~~~~~~~
+
+Calendars can be published through a public link to make them viewable (read-only) to external users. You may create a public link by opening the share menu for a calendar and clicking on « + » next to « Share link ». Once created you can copy the public link to your clipboard or send it through email.
+
+There's also an « embedding code » that provides an HTML iframe to embed your calendar into public pages.
+
+On the public page, users are able to get the subscription link for the calendar and download the whole calendar directly.
+
 Subscribe to a Calendar
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 You can subscribe to iCal calendars directly inside of your Nextcloud. By
 supporting this interoperable standard (RFC 5545) we made Nextcloud calendar
 compatible to Google Calendar, Apple iCloud and many other calendar-servers
-you can exchange your calendars with.
+you can exchange your calendars with, including subscription links from calendar published on other Nextcloud instances, as described above.
 
 1. Click on ``+ New Subscription`` in the left sidebar.
-2. Type in the link of the shared calendar you want to subscribe to.
+2. Type in or paste the link of the shared calendar you want to subscribe to.
 
 Finished. Your calendar subscriptions will be updated regularly.
 
+.. note:: Subscriptions are refreshed every week by default. Your admin may have changed this setting.
+
 Managing Events
 ---------------
 
@@ -129,11 +147,49 @@ If you want to edit or delete a specific event, you just need to click on it.
 After that you will be able to re-set all of the events details and open the
 advanced sidebar-editor by clicking on ``More...``.
 
-Clicking on the blue ``Update``-button will update the event. Clicking on the
-``Cancel``-button will not save your edits.
+Clicking on the blue ``Update``-button will update the event. To cancel your changes, click on the close icon on top right of the popup or sidebar editor.
 
-If you click on the red ``Delete``-button the event will be removed from your
-calendar.
+If you open the sidebar view and click the three dot menu next to the event name, you have an option to export the event as an ``.ics`` file or remove the event from your calendar.
+
+  .. figure:: images/calendar_event_menu.png
+
+Invite attendees to an event
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You may add attendees to an event to let them know they're invited. They will receive an email confirmation and will be able to confirm or cancel their participation to the event.
+Attendees may be other users on your Nextcloud instances, contacts in your addressbooks and direct email addresses. You also may change the level of participation per-attendees, or disable email confirmation for a specific attendee.
+
+  .. figure:: images/calendar_event_invitation_level.png
+
+.. tip:: When adding other Nextcloud users as attendees to an event, you may access their FreeBusy information if it's available, helping you to determine when is the best time slot for your event.
+
+.. attention:: Only the calendar owner can send out invitations, the sharees are not able to do that, whether they have write access to the event's calendar or not.
+
+Setup Reminders
+~~~~~~~~~~~~~~~
+
+You can set up reminders to be notified before an event occurs. Currently supported notification methods are :
+
+* Email notifications
+* Nextcloud notifications
+
+You may set reminders at a time relative to the event or at a specific date.
+
+.. figure:: images/calendar_event_reminders.png
+
+.. note:: Only the calendar owner and people or groups with whom the calendar is shared with write access will get notifications. If you don't get any notifications but think you should, your Administrator could also have disabled this for your server.
+
+.. note:: If you synchronize your calendar with mobile devices or other 3rd-party
+          clients, notifications may also show up there.
+
+Add recurring options
+~~~~~~~~~~~~~~~~~~~~~
+
+An event may be set as "recurring", so that it can happen every day, week, month or year. Specific rules can be added to set which day of the week the event happens or more complex rules, such as every fourth Wednesday of each month.
+
+You can also tell when the recurrence ends.
+
+.. figure:: images/calendar_event_repeat.png
 
 Birthday calendar
 -----------------
@@ -143,5 +199,5 @@ fetch the birthdays from your contacts. The only way to edit this calendar is by
 filing your contacts with birthday dates. You can not directly edit this calendar
 from the calendar-app.
 
-.. note:: If you do not see the birthday calendar, your Administrator may has
+.. note:: If you do not see the birthday calendar, your Administrator may have
           disabled this for your server.

user_manual/pim/sync_android.rst

@@ -64,11 +64,12 @@ steps are required after installing DAVx⁵
 7. Select the data you want to sync.
 8. When requested, grant access permissions to DAVx⁵ for your
    contacts, calendars and optionally tasks.
-   
-.. note:: Enter your email address as DAVx⁵ account name (mandatory if you want 
+
+.. note:: Enter your email address as DAVx⁵ account name (mandatory if you want
    to be able to send calendar invitation) If your email address is
    registered in your Nextcloud preferences and you have set up your
    account using the Nextcloud mobile app, this should be aready the case.
 
 
-   
+.. tip:: DAVx⁵ lists the calendar subscriptions made through the Nextcloud Calendar app, but you need to install the `ICSx⁵ (formerly known as ICSDroid) <https://icsx5.bitfire.at/>`_ app on your Android device, `from the Google Play Store <https://play.google.com/store/apps/details?id=at.bitfire.icsdroid>`_ or `from F-Droid <https://f-droid.org/packages/at.bitfire.icsdroid/>`_ to sync them.
+

user_manual/pim/sync_kde.rst

@@ -32,9 +32,9 @@ This can be done by following these steps:
 
 .. image:: ../images/KOrganizer_test2.png
 
-7. Pick a name for this resource, for example ``Work`` or ``Home``. By default, both CalDAV (Calendar) and CardDAV (Contacts) are synced. 
+7. Pick a name for this resource, for example ``Work`` or ``Home``. By default, both CalDAV (Calendar) and CardDAV (Contacts) are synced.
 
-.. note:: You can set a manual refresh rate four your calendar and contacts resources. By default this setting is set to 5 minutes and should be fine for the most use cases. You may want to change this for saving your power or cellular data plan.  that you can update with a right-click on the item in the calendar list and when you create a new appointment it is synced to Nextcloud right away.
+.. note:: You can set a manual refresh rate for your calendar and contacts resources. By default this setting is set to 5 minutes and should be fine for the most use cases. You may want to change this for saving your power or cellular data plan.  that you can update with a right-click on the item in the calendar list and when you create a new appointment it is synced to Nextcloud right away.
 
 .. image:: ../images/KOrganizer_pick_resources.png