summaryrefslogtreecommitdiff
path: root/doc/calendar-configuration.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/calendar-configuration.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/calendar-configuration.markdown')
-rw-r--r--doc/calendar-configuration.markdown42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/calendar-configuration.markdown b/doc/calendar-configuration.markdown
new file mode 100644
index 00000000..95e13e52
--- /dev/null
+++ b/doc/calendar-configuration.markdown
@@ -0,0 +1,42 @@
+Calendar settings
+=================
+
+Go to the menu **Settings**, then choose **Calendar settings** on the left.
+
+![Calendar settings](http://kanboard.net/screenshots/documentation/calendar-settings.png)
+
+There are two different calendars in Kanboard:
+
+- Project calendar
+- User calendar (available from the dashboard)
+
+Project calendar
+----------------
+
+This calendar show tasks with defined due date and tasks based on the creation date or the start date.
+
+### Show tasks based on the creation date
+
+- The start date of the calendar event is the creation date of the task.
+- The end date of the event is the date of completion.
+
+### Show tasks based on the start date
+
+- The start date of the calendar event is the start date of the task.
+- This date can be defined manually.
+- The end date of the event is the date of completion.
+- If there is no start date the task will not appear on the calendar.
+
+User calendar
+-------------
+
+This calendar show only tasks assigned to the user and optionally subtasks information.
+
+### Show subtasks based on the time tracking
+
+- Display subtasks in the calendar from the information recorded in the time tracking table.
+- The intersection with the user timetable is also calculated.
+
+### Show subtask estimates (forecast of future work)
+
+- Display the estimate of future work for subtasks in status "todo" and with a defined "estimate" value.