Add ical documentation

2015-05-18 14:51:17 -04:00 · 2015-05-18 14:51:17 -04:00 · db95e96f92
parent dde63e12fd
commit db95e96f92
22 changed files with 76 additions and 22 deletions
--- a/README.markdown
+++ b/README.markdown
@ -117,6 +117,7 @@ Documentation
 - [Sendgrid](docs/sendgrid.markdown)
 - [Slack](docs/slack.markdown)
 - [Postmark](docs/postmark.markdown)
+- [iCalendar subscriptions](docs/ical.markdown)

 #### More

--- a/app/Locale/da_DK/translations.php
+++ b/app/Locale/da_DK/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/de_DE/translations.php
+++ b/app/Locale/de_DE/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/es_ES/translations.php
+++ b/app/Locale/es_ES/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/fi_FI/translations.php
+++ b/app/Locale/fi_FI/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/fr_FR/translations.php
+++ b/app/Locale/fr_FR/translations.php
@ -919,7 +919,7 @@ return array(
    'Subtasks time tracking' => 'Suivi du temps par rapport aux sous-tâches',
    'User calendar view' => 'Vue en mode utilisateur du calendrier',
    'Automatically update the start date' => 'Mettre à jour automatiquement la date de début',
-    'iCalendar (iCal format, *.ics)' => 'iCalendar (format iCal, *.ics)',
+    'iCal feed' => 'Abonnement iCal',
    'Preferences' => 'Préférences',
    'Security' => 'Sécurité',
    'Two factor authentication disabled' => 'Authentification à deux facteurs désactivé',
--- a/app/Locale/hu_HU/translations.php
+++ b/app/Locale/hu_HU/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/it_IT/translations.php
+++ b/app/Locale/it_IT/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/ja_JP/translations.php
+++ b/app/Locale/ja_JP/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/nl_NL/translations.php
+++ b/app/Locale/nl_NL/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/pl_PL/translations.php
+++ b/app/Locale/pl_PL/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/pt_BR/translations.php
+++ b/app/Locale/pt_BR/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/ru_RU/translations.php
+++ b/app/Locale/ru_RU/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/sr_Latn_RS/translations.php
+++ b/app/Locale/sr_Latn_RS/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/sv_SE/translations.php
+++ b/app/Locale/sv_SE/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/th_TH/translations.php
+++ b/app/Locale/th_TH/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/tr_TR/translations.php
+++ b/app/Locale/tr_TR/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Locale/zh_CN/translations.php
+++ b/app/Locale/zh_CN/translations.php
@ -917,7 +917,7 @@ return array(
    // 'Subtasks time tracking' => '',
    // 'User calendar view' => '',
    // 'Automatically update the start date' => '',
-    // 'iCalendar (iCal format, *.ics)' => '',
+    // 'iCal feed' => '',
    // 'Preferences' => '',
    // 'Security' => '',
    // 'Two factor authentication disabled' => '',
--- a/app/Template/project/share.php
+++ b/app/Template/project/share.php
@ -8,7 +8,7 @@
        <ul class="no-bullet">
            <li><strong><i class="fa fa-share-alt"></i> <?= $this->a(t('Public link'), 'board', 'readonly', array('token' => $project['token']), false, '', '', true) ?></strong></li>
            <li><strong><i class="fa fa-rss-square"></i> <?= $this->a(t('RSS feed'), 'project', 'feed', array('token' => $project['token']), false, '', '', true) ?></strong></li>
-            <li><strong><i class="fa fa-calendar"></i> <?= $this->a(t('iCalendar (iCal format, *.ics)'), 'ical', 'project', array('token' => $project['token']), false, '', '', true) ?></strong></li>
+            <li><strong><i class="fa fa-calendar"></i> <?= $this->a(t('iCal feed'), 'ical', 'project', array('token' => $project['token']), false, '', '', true) ?></strong></li>
        </ul>
    </div>

--- a/app/Template/user/share.php
+++ b/app/Template/user/share.php
@ -6,7 +6,7 @@

    <div class="listing">
        <ul class="no-bullet">
-            <li><strong><i class="fa fa-calendar"></i> <?= $this->a(t('iCalendar (iCal format, *.ics)'), 'ical', 'user', array('token' => $user['token']), false, '', '', true) ?></strong></li>
+            <li><strong><i class="fa fa-calendar"></i> <?= $this->a(t('iCal feed'), 'ical', 'user', array('token' => $user['token']), false, '', '', true) ?></strong></li>
        </ul>
    </div>

--- a/docs/ical.markdown
+++ b/docs/ical.markdown
@ -0,0 +1,49 @@
+Syncing your calendars
+======================
+
+Kanboard supports iCal feeds for projects and users.
+This feature allow you to import Kanboard tasks in almost any calendar program (by example Microsoft Outlook, Apple Calendar and Google Calendar).
+
+Calendar subscriptions are **read-only** access, you cannot create tasks from an external calendar software.
+The Calendar feed export follow the iCal standard.
+
+Project calendars
+-----------------
+
+- Each project have its own calendar.
+- The subscription link is unique per project, the link is activated when you enable the public access of your project: **Project settings > Public access**.
+- This calendar show only tasks for the selected project.
+
+User calendars
+--------------
+
+- Each user have its own calendar.
+- The subscription link is unique per user, the link is activated when you enable the public access of your user: **User profile > Public access**.
+- This calendar show tasks assigned to the user for all projects.
+
+Adding your Kanboard calendar to Apple Calendar
+-----------------------------------------------
+
+- Open Calendar
+- Select **File > New Calendar Subscription**
+- Copy and paste the iCal feed url from Kanboard
+
+![Add iCal subscription](http://kanboard.net/screenshots/documentation/apple-calendar-add-subscription.png)
+
+- You can choose to synchronize the calendar with iCloud to be available across all your devices
+- Don't forget to select the refresh frequency
+
+![Edit iCal subscription](http://kanboard.net/screenshots/documentation/apple-calendar-edit-subscription.png)
+
+Adding your Kanboard calendar to Google Calendar
+------------------------------------------------
+
+- Click the down-arrow next to **Other calendars**.
+- Select **Add by URL** from the menu.
+- Copy and paste the iCal feed url from Kanboard
+
+![Google Calendar](http://kanboard.net/screenshots/documentation/google-calendar-add-subscription.png)
+
+Your Kanboard calendar can also be available from your Android device if you enable the synchronization.
+
+Note: According to the Google Support, external calendars are not refreshed very often, [read the documentation](https://support.google.com/calendar/answer/37100?hl=en&ref_topic=1672445).
--- a/docs/sharing-projects.markdown
+++ b/docs/sharing-projects.markdown
@ -21,11 +21,15 @@ Select your project, then click on "Public access" and finally click on the butt

 ![Enable public access](http://kanboard.net/screenshots/documentation/project-enable-sharing.png)

-After that, you got the public link and the RSS feed.
-The activity feed is available only when the public access is activated.
+When the public access is enabled, a couple of links are generated:
+
+- Public board view
+- RSS feed subscription link
+- iCalendar subscription link

 ![Disable public access](http://kanboard.net/screenshots/documentation/project-disable-sharing.png)

 You can also disable the public access whenever you want.
+
 Each time, you enable or disable the public access a new random token is generated.
-The old link will not work anymore.
+The previous links will not work anymore.