summaryrefslogtreecommitdiff
path: root/doc/timetable.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/timetable.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/timetable.markdown')
-rw-r--r--doc/timetable.markdown46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/timetable.markdown b/doc/timetable.markdown
new file mode 100644
index 00000000..5d2f4c86
--- /dev/null
+++ b/doc/timetable.markdown
@@ -0,0 +1,46 @@
+User Timetable
+==============
+
+Each user can have a predefined timetable.
+This feature mainly is used for time tracking, project budget calculation and to display subtasks in the calendar.
+
+Each user have his own timetable. At the moment, that need to be specified manually for each person.
+You can also schedule time-off or overtime.
+
+The timetable section is available from the user profile: **User profile > Timetable**.
+
+Work timetable
+--------------
+
+This timetable is dynamically calculated according to the regular week timetable, time-off and overtime.
+
+![Timetable](http://kanboard.net/screenshots/documentation/timetable.png)
+
+Week timetable
+--------------
+
+![Week Timetable](http://kanboard.net/screenshots/documentation/week-timetable.png)
+
+The week timetable is used to define regular work hours for the selected user.
+
+To add a new time slot, just select the day of the week and the time range.
+
+Time off timetable
+------------------
+
+The time-off timetable is used to schedule not worked time slot.
+This time is deducted from the regular work hours.
+
+When you check the box "All day", the regular day timetable is used to define the regular work hours.
+
+Overtime timetable
+------------------
+
+![Overtime Timetable](http://kanboard.net/screenshots/documentation/overtime-timetable.png)
+
+The overtime timetable is used to define worked hours outside of regular hours.
+
+Day timetable
+-------------
+
+This timetable is used when the checkbox "All day" is checked for overtime and time-off entries.