KTimeTracker: Difference between revisions

From KDE UserBase Wiki
(not subsections; forum link (Kontact & PIM seems to be most fitting place))
 
(52 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|KTimeTracker}}
<languages />


= What is KTimeTracker =
{|class="tablecenter vertical-centered"
|[[Image:ktimetracker.png|thumb|300px|KTimeTracker]]||<translate> <!--T:1-->
'''KTimeTracker is a todo management and time tracking application.</translate>'''
|}
 
<translate>
 
== Overview == <!--T:3-->
 
<!--T:4-->
'''KTimeTracker''' tracks time spent on various tasks.
 
<!--T:5-->
;Challenge: You are a software consultant with several customers and many project assignments. When billing your customers, you are required to report how much time you spend on what task.
 
<!--T:6-->
;Solution: Use '''KTimeTracker''' to hold a list of projects and tasks. Whenever you switch your activity, double-click on the respective task and see how its time gets tracked. At the end of the day (or month) you can obtain a journal how much time you spent on what task.


KTimeTracker tracks time spent on various tasks. It is useful for tracking billable hours and can report the hours logged by task and day.
== Get it == <!--T:34-->
This time history can be exported to a comma-delimited text file for import into other billing and/or project management tools.
KTimeTracker detects when your keyboard and mouse are idle and can associate different tasks with different desktops, two tools that can help keep the timer running on the correct task.


[[Image:ktimetracker.png|500px|center]]
<!--T:35-->
You can install KTimeTracker either


= How it works =
<!--T:36-->
;Challenge: You are a software consultant with several customers and many project assignments. When billing your customers, you are required to report how many time you spend on what task.
* by means of your Linux distribution, or
* by compiling from source code ([https://download.kde.org/stable/ktimetracker/ stable releases], [https://commits.kde.org/ktimetracker Git repository]), or
* with pre-built installers/packages for Windows and macOS for [https://download.kde.org/stable/ktimetracker/5.0.1/ stable releases] and [https://binary-factory.kde.org/ nightly snapshots].


;Solution: Use ktimetracker to hold a list of projects and tasks. Whenever you switch your activity, double-click on the respective task and see how its time gets tracked. At the end of the day (or month) you can obtain a journal how much time you spent on what task.
== Features == <!--T:7-->


= Features =
<!--T:8-->
The current stable version of KTimeTracker (4.1) can:
The current stable version of '''KTimeTracker''' (5.0.1) can:


* organize tasks into subtasks
<!--T:9-->
KTimeTracker allows you to organize your work like a todo-list. You can group your work by tasks and subtask. Every subtask can still have a subtask below it, up to some 1000 levels.
* Organize tasks into subtasks:
**'''KTimeTracker''' allows you to organize your work like a todo-list. You can group your work by tasks and subtask. Every subtask can still have a subtask below it, up to some 1000 levels.


* track your time
<!--T:10-->
Whenever you start working on a new task, just double-click the corresponding task in your todo-list. You will see a clock appearing next to this task indicating its time is now recorded.
* Track your time:
**Whenever you start working on a new task, just double-click the corresponding task in your todo-list. You will see a clock appearing next to this task indicating its time is now recorded.


* edit task history and comments
<!--T:11-->
KTimeTracker allows you to edit your task's history and to put a comment for every event that you have stopped:
* Edit task history and comments:
**'''KTimeTracker''' allows you to edit your task's history and to put a comment for every work-event:


<!--T:12-->
[[Image:ktimetracker-history.png|500px|center]]
[[Image:ktimetracker-history.png|500px|center]]


* pause detection
<!--T:13-->
When going for lunch, it happens that you forget to stop timetracking before. No problem, the idle time detector in ktimetracker will pop up after a configurable amount of time giving you the possibility to revert or continue timing.
* Pause detection:
**When going for lunch, it may happen that you forget to stop timetracking before. No problem: the idle time detector in '''KTimeTracker''' will pop up after a configurable amount of time giving you the possibility to revert (as if you said, "I was '''not''' working during this time.") or continue timing (as if you said "I was working during this time.").
 
== Options == <!--T:14-->


== Options ==
<!--T:15-->
KTimeTracker 4 has not more and not less than the following options:
'''KTimeTracker 5''' has not more and not less than the following options:


<!--T:16-->
[[Image:Snapshot-ktimetracker-options-behavior.png|center]]
[[Image:Snapshot-ktimetracker-options-behavior.png|center]]


<!--T:17-->
[[Image:Snapshot-ktimetracker-options-appearance.png|center]]


[[Image:Snapshot-ktimetracker-options-appearance.png|center]]
<!--T:18-->
Configuration for PDA: Removes the search-bar to gain screen real estate. Assumes a touch-screen and pops up a context menu on every mouse click, even with the left button.
''Configuration for PDA'': Removes the search-bar to gain screen real estate. Assumes a touch-screen and pops up a context menu on every mouse click, even with the left button.


<!--T:19-->
[[Image:Snapshot-ktimetracker-options-storage.png|center]]
[[Image:Snapshot-ktimetracker-options-storage.png|center]]


= Compatibility =
 
There have been 3 file format changes in the over 10-year-history of ktimetracker:
== Compatibility == <!--T:20-->
 
<!--T:21-->
There have been 3 file format changes in the over 10-year-history of KTimeTracker:
{| class="wikitable sortable" border=1
{| class="wikitable sortable" border=1
! KDE version !! ktimetracker file
! KDE SC version !! KTimeTracker file
|-
|-
| -3.1        || flat files  
| -3.1        || flat files  
Line 51: Line 82:
| 3.2-3.5    || iCal files with X-KDE-karm fields, import possibility for flat files
| 3.2-3.5    || iCal files with X-KDE-karm fields, import possibility for flat files
|-
|-
| 4.0-        || iCal files with X-KDE-ktimetracker fields, automated import for iCal files with X-KDE-karm fields
| 4.x, 5.0 || iCal files with X-KDE-KTimeTracker fields, automated import for iCal files with X-KDE-karm fields
|-
|}
 
Because of the iCal file format, ktimetracker is compatible with korganizer. You can even work synchroneously on one file with korganizer and ktimetracker. If one program changes the file, the updates will be propagated to the other application automatically.
 
= ChangeLog =
More details about KArm
{| class="wikitable sortable" border=1
!  !! pre-3.2 !! 3.2 !! 3.3 !! future
|-
| tracking time ||
* idle detection
* flexible task tree
||
* desktop tracking ||
||
* Comment tags for history
      (bug #64879)
* Task budget
* Edit history
      (bug #84499)
|-
| reporting    || AAA    || MMM
|-
| integration
|-
| teaching ||
* handbook
* whatsthis help
|-
|-
|}
|}


KArm's features can be divided into four major sections.
<!--T:22-->
  pre-3.2 3.2 3.3 future
Because of the iCal file format, KTimeTracker is compatible with korganizer. You can even work synchroneously on one file with korganizer and KTimeTracker. If one program changes the file, the updates will be propagated to the other application automatically.
Tracking Time
 
 
 
Reporting
 
    * totals report
    * log history
    * sessions
 
 
    * history report
    * roll up totals
 
 
 
    * Chart history
    * Statistics?
 
Integration  
 
    * iCalendar for storage
 
 
    * CSV export
    * Basic locking
 


    * Advanced locking
== Does it scale? == <!--T:25-->
      (bug #71292)
    * Import / Export of Planner tasks
    * Import / Export of Task Juggler tasks


Teaching
<!--T:26-->
'''KTimeTracker''' scales well and it regularly tested with a 1.2 MB file ([https://bugs.kde.org/attachment.cgi?id=14413&action=view download it]) available from ([https://bugs.kde.org/show_bug.cgi?id=110523 KDE Bug report 110523]). A '''KTimeTracker''' benchmark is available [https://cgit.kde.org/ktimetracker.git/tree/test here].


 
== Support == <!--T:27-->


    * Major handbook update
<!--T:28-->
As you explore '''KTimeTracker''' you'll find questions that need answering.
*Chat with us, the KDE users, on [irc://chat.freenode.net#kde IRC, the KDE users' channel].
*Forum under Kontact & PIM https://forum.kde.org/viewforum.php?f=215


== Videos == <!--T:29-->


    * Complete What's This help
<!--T:30-->
    * Add tooltips where most useful
Video demos are here:
* [http://www.youtube.com/watch?v=LdlEkJAMj_A The "track active applications" demo]


= Does it scale =
== See also == <!--T:31-->
KTimeTracker scales well and it regularly tested with a 1.2 MB file ([https://bugs.kde.org/attachment.cgi?id=14413&action=view download it]) available from ([https://bugs.kde.org/show_bug.cgi?id=110523 KDE Bug report 110523]). A ktimetracker benchmark is available from [http://websvn.kde.org:80/trunk/KDE/kdepim/ktimetracker/test/ktimetrackerbenchmark?view=markup here].


= Support =
<!--T:32-->
As you explore ktimetracker you'll find questions that need answering. Chat with us, the KDE users, on '''irc.kde.org''', channel '''#kde'''.
* [https://community.kde.org/KTimeTracker Become a KTimeTracker developer]


= See also =
<!--T:33-->
* [[KTimeTracker/Developing|become a ktimetracker developer]]
[[Category:Office]]
</translate>

Latest revision as of 16:04, 7 March 2021

KTimeTracker
KTimeTracker is a todo management and time tracking application.


Overview

KTimeTracker tracks time spent on various tasks.

Challenge
You are a software consultant with several customers and many project assignments. When billing your customers, you are required to report how much time you spend on what task.
Solution
Use KTimeTracker to hold a list of projects and tasks. Whenever you switch your activity, double-click on the respective task and see how its time gets tracked. At the end of the day (or month) you can obtain a journal how much time you spent on what task.

Get it

You can install KTimeTracker either

Features

The current stable version of KTimeTracker (5.0.1) can:

  • Organize tasks into subtasks:
    • KTimeTracker allows you to organize your work like a todo-list. You can group your work by tasks and subtask. Every subtask can still have a subtask below it, up to some 1000 levels.
  • Track your time:
    • Whenever you start working on a new task, just double-click the corresponding task in your todo-list. You will see a clock appearing next to this task indicating its time is now recorded.
  • Edit task history and comments:
    • KTimeTracker allows you to edit your task's history and to put a comment for every work-event:
  • Pause detection:
    • When going for lunch, it may happen that you forget to stop timetracking before. No problem: the idle time detector in KTimeTracker will pop up after a configurable amount of time giving you the possibility to revert (as if you said, "I was not working during this time.") or continue timing (as if you said "I was working during this time.").

Options

KTimeTracker 5 has not more and not less than the following options:

Configuration for PDA: Removes the search-bar to gain screen real estate. Assumes a touch-screen and pops up a context menu on every mouse click, even with the left button.


Compatibility

There have been 3 file format changes in the over 10-year-history of KTimeTracker:

KDE SC version KTimeTracker file
-3.1 flat files
3.2-3.5 iCal files with X-KDE-karm fields, import possibility for flat files
4.x, 5.0 iCal files with X-KDE-KTimeTracker fields, automated import for iCal files with X-KDE-karm fields

Because of the iCal file format, KTimeTracker is compatible with korganizer. You can even work synchroneously on one file with korganizer and KTimeTracker. If one program changes the file, the updates will be propagated to the other application automatically.

Does it scale?

KTimeTracker scales well and it regularly tested with a 1.2 MB file (download it) available from (KDE Bug report 110523). A KTimeTracker benchmark is available here.

Support

As you explore KTimeTracker you'll find questions that need answering.

Videos

Video demos are here:

See also