GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Docs: Updated data docs

Browse source
This commit is contained in:
Paul Beckingham 2016-04-10 09:19:20 -04:00
parent 9e2eb609c9
commit 882236f449
1 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

30
doc/data.txt
View file

@ -13,7 +13,7 @@ as a mask for the inclusions. Here is a visual example:
Exclusion: |---| lunch Exclusion: |---| lunch
Exclusion |---| dinner Exclusion |---| dinner
Timeline: >--o---o---o---o---o---o---o---o---o---o---o---o---o--> Timeline: ..:...:...:...:...:...:...:...:...:...:...:...:...:...
7 8 9 10 11 12 1 2 3 4 5 6 7 7 8 9 10 11 12 1 2 3 4 5 6 7
am pm am pm
@ -30,15 +30,15 @@ example, if these commands were run at 8am and 5pm respectively:
[at 5pm] $ timew stop [at 5pm] $ timew stop
It can be seen that some combination of all the incluѕions and exclusions will It can be seen that some combination of all the incluѕions and exclusions will
yield a complete record of tracked time. yield a record of tracked time.
Exclusions Exclusions
---------- ----------
Exclusions are stored as configuration, and there are several commands that Exclusions are stored as configuration. Whenever an exclusion changes, the set
allow easy manipulation of this. Whenever an exclusion changes, the set of all of all exclusions are written to the data file. This is because all subsequent
exclusions are written to the data file. This is because all subsequent inclusions are to be resolved against the most recent set of exclusions. So if
inclusions are to be resolved against the active set of exclusions. you change from a 9-hour day to an 8-hour day, the tracking remains correct.
Inclusions Inclusions
@ -48,7 +48,7 @@ results in an incluѕion record being written to the data file.
If there is an open-ended inclusion at the time an exclusion is changed, then If there is an open-ended inclusion at the time an exclusion is changed, then
the open-ended inclusion is closed, the exclusions written, and a new open-ended the open-ended inclusion is closed, the exclusions written, and a new open-ended
inclusion is added. inclusion is added. Starting a new inclusion closes existing inclusions.
Data Files Data Files
@ -70,15 +70,15 @@ An example file looks like this:
inc 2016-02-28T08:00:00 - 2016-02-28T12:00:00 # Upgrade Planning inc 2016-02-28T08:00:00 - 2016-02-28T12:00:00 # Upgrade Planning
inc 2016-02-28T13:00:00 # Upgrade Presentation "ABCD Inc" inc 2016-02-28T13:00:00 # Upgrade Presentation "ABCD Inc"
White space is ignored. Here we see a sect of exclusions that define a work week White space is ignored. Here we see a set of exclusions that define a work week
and a two inclusions, the first of which represents a four hour block of time and two inclusions, the first of which represents a four hour block of time with
with two tags 'Upgrade' and 'Planning'. The second inclusion is open ended, two tags 'Upgrade' and 'Planning'. The second inclusion is open ended, having
having only a start time (1pm), but three tags 'Upgrade', 'Presentation' and only a start time (1pm), but three tags 'Upgrade', 'Presentation' and 'ABCD
'ABCD Inc'. The third tag is a quoted string because of the embedded space. Inc'. The third tag is a quoted string because of the embedded space.
An open-ended inclusion like this means that the tracking continues, but the An open-ended inclusion like this means that the tracking continues, but the
exclusions prevent an excess time buildup of the 63 hours that comprise the exclusions prevent an excess time buildup of the 62½ hours that comprise the
weekend (Friday 5:30pm until Monday 8:30am). weekend (Friday 5:30pm until Monday 8:00am).
Data File Names Data File Names
@ -90,6 +90,8 @@ sophisticated archiving. For example:
~/.timewarrior/data/2016-02.data ~/.timewarrior/data/2016-02.data
~/.timewarrior/data/2016-03.data ~/.timewarrior/data/2016-03.data
To archive old data, simply move any subset of files out of this directory.
Undo Data Undo Data
--------- ---------