help text and link for form labels #138 (#143)

* added help for timesheet duration form field - fixes #138
* added label option to link to manual chapter
* created docu chapter "timesheet" and added duration mode docu
* allow field and form option "documentation" to link to chapters in the documentation
This commit is contained in:
Kevin Papst
2018-06-21 18:25:11 +02:00
committed by GitHub
parent 8c686b0714
commit 3dc054b839
9 changed files with 101 additions and 6 deletions

View File

@@ -2,9 +2,15 @@
Welcome to the official Kimai v2 documentation.
The first chapters are meant for developers and administrators:
- [Kimai configurations](configurations.md) - the Kimai core configurations, which can only be set in configuration files
- [Developer docu](developers.md) - information for developer who would like to extend Kimai
- [User and Security](users.md) - everything related to authentication, security, users, roles ...
- [User and Security](users.md) - everything related to user and security, like authentication and roles
The following chapters are meant for users:
- [Timesheets](timesheet.md) - information about timesheets
We know there is a lot missing right now and would appreciate [any help](https://github.com/kevinpapst/kimai2/pulls) in writing.
If you need information which is not available right now, [ask us](https://github.com/kevinpapst/kimai2/issues) and we

View File

@@ -17,6 +17,8 @@ The `start` date is only visible in these forms when editing an active or starti
You can activate the `duration_only` mode by switching the configuration key `kimai.timesheet.duration_only` to `true` in the file [kimai.yaml](../../config/packages/kimai.yaml).
For supported formats while entering the `duration` please see the [timesheet chapter](timesheet.md)
## Remember me login
The default period for the `Remember me` option can be changed in the config file [security.yaml](../../config/packages/security.yaml).

19
var/docs/timesheet.md Normal file
View File

@@ -0,0 +1,19 @@
# Timesheet
User manual on the timesheet tables and actions.
## Edit timesheet
### Duration only
When the `duration_only` mode is activated, you will only see the `date` and `duration` fields (see [configurations chapter](configurations.md)).
The `duration` field supports entering data in the following formats:
| Name | Format | Description | Examples |
|---|---|---|
| Colons | {hours}:{minutes}[:{seconds}] | Seconds are optional, overflow is supported for every field | `2:27` = 2 Hours, 27 Minutes / `3:143:13` = 5 Hours, 23 Minutes, 13 Seconds|
| Natural | {hours}h{minutes}m[{seconds}s] | Seconds are optional, overflow is supported for every field | `2h27m` = 2 Hours, 27 Minutes / `3h143m13s` = 5 Hours, 23 Minutes, 13 Seconds |
| Seconds | {seconds} | | `3600` = 1 Hour / `8820` = 2 Hours, 27 Minutes |
Please note: if time rounding is activated (which is the default behaviour), then your entered seconds might be removed after submitting the form.