From 41feea03369574d4ca5b129d90f040d2ab907c8a Mon Sep 17 00:00:00 2001 From: Jonas L Date: Mon, 31 May 2021 23:53:53 +0200 Subject: [PATCH] Document calendar embed parameters This describe additional parameters in order to embed a calendar using iframes. Signed-off-by: jo --- user_manual/pim/calendar.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/user_manual/pim/calendar.rst b/user_manual/pim/calendar.rst index cb5f8dca9..f5147b0f8 100644 --- a/user_manual/pim/calendar.rst +++ b/user_manual/pim/calendar.rst @@ -90,7 +90,14 @@ Calendars can be published through a public link to make them viewable (read-onl There's also an « embedding code » that provides an HTML iframe to embed your calendar into public pages. Multiple calendars can be shared together by adding their unique tokens to the end of an embed link. Individual tokens can be found at the end of each calendar's public link. The full address will look like -``https://cloud.example.com/index.php/apps/calendar/embed/token1-token2-token3`` +``https://cloud.example.com/index.php/apps/calendar/embed/--`` + +To change the default view or date of an embedded calendar, you need to provide an url that look like ``https://cloud.example.com/index.php/apps/calendar/embed///``. +In this url you need to replace the following variables: + +- ```` with the calendar's token. +- ```` with one of ``month``, ``week``, ``day``, ``listMonth``, ``listWeek``, ``listDay``. The default view is ``month`` and the normally used list is ``listMonth``. +- ```` with ``now`` or any date with the following format ``--`` (e.g. ``2019-12-28``). On the public page, users are able to get the subscription link for the calendar and download the whole calendar directly.