details: https://code.tryton.org/tryton/commit/6312b8bd8a59 branch: default user: Alex Alias Montserrat <[email protected]> date: Thu Nov 13 12:43:57 2025 +0100 description: Update documentation of timesheet diffstat:
modules/timesheet/CHANGELOG | 26 ++++++++++ modules/timesheet/doc/design.rst | 73 ++++++++++++++++++++++++++++++ modules/timesheet/doc/index.rst | 31 ++---------- modules/timesheet/doc/releases.rst | 7 ++ modules/timesheet/doc/user_application.rst | 1 + 5 files changed, 113 insertions(+), 25 deletions(-) diffs (266 lines): diff -r 3dcd79aff559 -r 6312b8bd8a59 modules/timesheet/CHANGELOG --- a/modules/timesheet/CHANGELOG Sat Mar 28 17:54:47 2026 +0100 +++ b/modules/timesheet/CHANGELOG Thu Nov 13 12:43:57 2025 +0100 @@ -40,48 +40,60 @@ * Bug fixes (see mercurial logs for details) Version 6.4.0 - 2022-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for Python 3.10 * Remove support for Python 3.6 Version 6.2.0 - 2021-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 6.0.0 - 2021-05-03 +-------------------------- * Bug fixes (see mercurial logs for details) * Use window domain to show "open" and "closed" timesheet works * Remove active from timesheet work Version 5.8.0 - 2020-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.5 Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.4.0 - 2019-11-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Use ir.calendar.month in report * Add date to window name when entering timesheet Version 5.2.0 - 2019-05-06 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.0.0 - 2018-10-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Add UUID on line for synchronisation * Remove support for Python 2.7 Version 4.8.0 - 2018-04-23 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.6.0 - 2017-10-30 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.4.0 - 2017-05-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.2.0 - 2016-11-28 +-------------------------- * Bug fixes (see mercurial logs for details) * Add read access to any line for all * Add domain on start/end date of work @@ -90,49 +102,63 @@ * Add optional origin on Work Version 4.0.0 - 2016-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Add Python3 support Version 3.8.0 - 2015-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Split duration into simple and total duration Version 3.6.0 - 2015-04-20 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for PyPy * Use TimeDelta field Version 3.4.0 - 2014-10-20 +-------------------------- * Bug fixes (see mercurial logs for details) Version 3.2.0 - 2014-04-21 +-------------------------- * Bug fixes (see mercurial logs for details) Version 3.0.0 - 2013-10-21 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.8.0 - 2013-04-22 +-------------------------- * Bug fixes (see mercurial logs for details) * Add start/end date to work for timesheet Version 2.6.0 - 2012-10-22 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.4.0 - 2012-04-24 +-------------------------- * Bug fixes (see mercurial logs for details) * Change record rule for work to use the current company instead of main Version 2.2.0 - 2011-10-25 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.0.0 - 2011-04-27 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.8.0 - 2010-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.6.0 - 2010-05-12 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.4.0 - 2009-10-19 +-------------------------- * Initial release diff -r 3dcd79aff559 -r 6312b8bd8a59 modules/timesheet/doc/design.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/timesheet/doc/design.rst Thu Nov 13 12:43:57 2025 +0100 @@ -0,0 +1,73 @@ +****** +Design +****** + +The *Timesheet Module* introduces or extends the following concepts: + +.. _model-timesheet.work: + +Timesheet Work +============== + +A *Timesheet Work* represents a task, project, or any activity for which time +can be recorded. + +Each work can be linked to another record via the :guilabel:`Origin` field, +allowing it to be used for time recording. +When a work has an origin, its name is automatically derived from it. + +A Work may have start and end dates that restrict the period during which time +can be recorded. + +The total time spent on each work is automatically calculated by summing all +related `Timesheet Lines <model-timesheet.line>`. +This calculation can be filtered by a date range and `employees +<company:model-company.employee>`. + +.. seealso:: + + The list of *Works* can be found by opening the main menu item: + + |Timesheet --> Configuration --> Works|__ + + .. |Timesheet --> Configuration --> Works| replace:: :menuselection:`Timesheet --> Configuration --> Works` + __ https://demo.tryton.org/model/timesheet.work + +.. _model-timesheet.line: + +Timesheet Line +============== + +A *Timesheet Line* stores the duration of the time spent by an `employee +<company:model-company.employee>` on a specific `Work <model-timesheet.work>` +for a given date . + +.. seealso:: + + The list of *Lines* can be found by opening the main menu item: + + |Timesheet --> Lines|__ + + .. |Timesheet --> Lines| replace:: :menuselection:`Timesheet --> Lines` + __ https://demo.tryton.org/model/timesheet.line + +Wizards +------- + +.. _wizard-timesheet.line.enter: + +Enter Timesheet Lines +^^^^^^^^^^^^^^^^^^^^^ + +The *Enter Timesheet Lines* wizard helps to quickly record time spent by an +`employee <company:model-company.employee>` on a given day by opening an +editable list of timesheet lines with the employee and date already filled in. + +.. seealso:: + + The *Enter Timesheet Lines* wizard can be accessed from the main menu: + + |Timesheet --> Enter Lines|__ + + .. |Timesheet --> Enter Lines| replace:: :menuselection:`Timesheet --> Enter Lines` + __ https://demo.tryton.org/wizard/timesheet.line.enter diff -r 3dcd79aff559 -r 6312b8bd8a59 modules/timesheet/doc/index.rst --- a/modules/timesheet/doc/index.rst Sat Mar 28 17:54:47 2026 +0100 +++ b/modules/timesheet/doc/index.rst Thu Nov 13 12:43:57 2025 +0100 @@ -1,32 +1,13 @@ +################ Timesheet Module ################ -The timesheet module allow to track the time spent by employees on -various works. This module also comes with several reports that show -the time spent by employees on works following various time periods. - - -Work -**** - -A work is a generic concept that encompass all activities from simple -tasks to long-running projects. It can be alone or linked to another document. -The Work model contains the following fields: - -- Name or Origin: The name or the origin of the work. -- Active: A checkbox that allow to disable the work. -- Company: The company for which the work is (or was) executed. - - -Timesheet Line -************** - -A timesheet line expresses the fact that one employee spends part of -their time doing specific work on a given date. An optional -Description field allows extra information to be recorded about what -has been done. +The *Timesheet Module* allows to track the time employees spend on various +tasks. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 user_application + design + releases diff -r 3dcd79aff559 -r 6312b8bd8a59 modules/timesheet/doc/releases.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/timesheet/doc/releases.rst Thu Nov 13 12:43:57 2025 +0100 @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff -r 3dcd79aff559 -r 6312b8bd8a59 modules/timesheet/doc/user_application.rst --- a/modules/timesheet/doc/user_application.rst Sat Mar 28 17:54:47 2026 +0100 +++ b/modules/timesheet/doc/user_application.rst Thu Nov 13 12:43:57 2025 +0100 @@ -1,3 +1,4 @@ +########################## Timesheet User Application ##########################
