Move timetable to a plugin

Plugin repository: https://github.com/kanboard/plugin-timetable
This commit is contained in:
Frederic Guillot
2015-09-20 18:24:15 -04:00
parent 2021dccc5a
commit e6f547abcf
59 changed files with 137 additions and 2468 deletions

View File

@@ -1,34 +0,0 @@
Budget management
=================
Budget management is based on the subtask time tracking, the user timetable and the user hourly rate.
This section is available from project settings page: **Project > Budget**. There is also a shortcut from the dropdown menu on the board.
Budget lines
------------
![Cost Lines](http://kanboard.net/screenshots/documentation/budget-lines.png)
Budget lines are used to define a budget for the project.
This budget can be adjusted by adding a new entry with an effective date.
Cost breakdown
--------------
![Cost Breakdown](http://kanboard.net/screenshots/documentation/budget-cost-breakdown.png)
Based on the subtask time tracking table and user information you can see the cost of each subtask.
The time spent is rounded to nearest quarter.
Budget graph
------------
![Budget Graph](http://kanboard.net/screenshots/documentation/budget-graph.png)
Finally, by combining all information we can generate a graph:
- Expenses represents user cost
- Budget lines are the provisioned budget
- Remaining is the budget left at the given time

View File

@@ -1,34 +0,0 @@
Gestion du budget
=================
La gestion du budget repose sur le suivi du temps d'une sous-tâche, l'emploi du temps de l'utilisateur et le taux horaire de l'utilisateur.
Cette section est accessible depuis la page de paramètres du projet : **Project > Budget**. Il existe également un raccourci depuis le menu déroulant sur le tableau.
Lignes budgétaires
------------
![Ligne des coûts](http://kanboard.net/screenshots/documentation/budget-lines.png)
Les lignes budgétaires sont utilisées pour définir le budget du projet.
Celui-ci peut être ajusté en ajoutant une nouvelle entrée avec une date effective.
Détail des coûts
--------------
![Détail des coûts](http://kanboard.net/screenshots/documentation/budget-cost-breakdown.png)
Selon le tableau qui donne le suivi temporel de la sous-tâche et les informations sur l'utilisateur vous pouvez voir le coût de chaque sous-tâche.
Le temps passé est arrondi au quart d'heure le plus proche.
Graphique du budget
------------
![Graphique du budget](http://kanboard.net/screenshots/documentation/budget-graph.png)
Finalement, en combinant toutes les informations nous pouvons générer un graphique :
- Les dépenses représentent le coût utilisateur
- Les lignes budgétaires sont le budget prévisionnel
- Le restant est le budget qui reste après un délai donné

View File

@@ -1,11 +0,0 @@
Hourly Rate
===========
Each user can have a predefined hourly rate.
This feature is used for budget calculation.
To define a new price, go to **User profile > Hourly rates**.
![Hourly Rate](http://kanboard.net/screenshots/documentation/hourly-rate.png)
Each hourly rate can have an effective date and and different currency.

View File

@@ -26,7 +26,6 @@ Using Kanboard
- [Project permissions](project-permissions.markdown)
- [Swimlanes](swimlanes.markdown)
- [Calendar](calendar.markdown)
- [Budget](budget.markdown)
- [Analytics](analytics.markdown)
- [Gantt chart for tasks](gantt-chart-tasks.markdown)
- [Gantt chart for projects](gantt-chart-projects.markdown)
@@ -49,8 +48,6 @@ Using Kanboard
- [User management](user-management.markdown)
- [Notifications](notifications.markdown)
- [Hourly rate](hourly-rate.markdown)
- [Timetable](timetable.markdown)
- [Two factor authentication](2fa.markdown)
### Settings

View File

@@ -94,6 +94,27 @@ $this->hook->on('hook_name', $callable);
The first argument is the name of the hook and the second is a PHP callable.
### Hooks executed only one time
Some hooks can have only one listener:
#### model:subtask-time-tracking:calculate:time-spent
- Override time spent calculation when subtask timer is stopped
- Arguments:
- `$user_id` (integer)
- `$start` (DateTime)
- `$end` (DateTime)
#### model:subtask-time-tracking:calendar:events
- Override subtask time tracking events to display the calendar
- Arguments:
- `$user_id` (integer)
- `$events` (array)
- `$start` (string, ISO-8601 format)
- `$end` (string, ISO-8601 format)
### Merge hooks
"Merge hooks" act in the same way as the function `array_merge`. The hook callback must return an array. This array will be merged with the default one.
@@ -313,5 +334,7 @@ Kanboard will compare the version defined in your schema and the version stored
Examples of plugins
-------------------
- Budget planning: https://github.com/kanboard/plugin-budget
- Theme plugin sample: https://github.com/kanboard/plugin-example-theme
- [Budget planning](https://github.com/kanboard/plugin-budget)
- [User timetable](https://github.com/kanboard/plugin-timetable)
- [Subtask Forecast](https://github.com/kanboard/plugin-subtask-forecast)
- [Theme plugin sample](https://github.com/kanboard/plugin-example-theme)

View File

@@ -1,46 +0,0 @@
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.