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

Docs: Added data.txt

Browse source
This commit is contained in:
Paul Beckingham 2015-12-17 00:25:40 -05:00
parent 079cd0cbf6
commit 05bb15d8ab
2 changed files with 22 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

86
doc/notes.txt
View file

@ -145,92 +145,6 @@ On that same timeline, here are some example tracked intervals:
|
now
Time tracking is based on the inclusion intervals derived from the above rule.
For week 48 those would be:
2015-11-23 510-1050
2015-11-24 510-900
2015-11-25 510-1050
2015-11-27 510-1050
Given these intervals, tracking becomes a set of basic modifications:
The date 'yesterday' refers to the whole day, and overrides any other
intervals:
$ timew track +tag1 +tag2 yesterday
--> 'yesterday' resolves to 2015-11-23
--> delete all intervals for 2015-11-23
--> obtain inclusions for 2015-11-23: 510-1050
--> store: 2015-11-23 0-1439 tag1 tag2
--> Describe the above in feedback
The date 'today' refers to the whole day, and overrides any other intervals:
$ timew track +tag1 +tag2 today
--> 'today' resolves to 2015-11-24
--> delete all intervals for 2015-11-24
--> obtain inclusions for 2015-11-24: 510-900
--> store: 2015-11-24 0-1439 tag1 tag2
The 'start' command uses 'now' (12:00pm) in this alternate example:
$ timew start +tag1 +tag2
--> 'now' resolves to 2015-11-24T12:00
--> obtain inclusions for 2015-11-24: 510-900
--> store: 2015-11-24 720- tag1 tag2
Note the open-ended interval
The 'start' recognizes 'backfill' to indicate that earlier, untracked
inclusions should be tracked:
$ timew start +tag1 +tag2 backfill
--> 'now' resolves to 2015-11-24T12:00
--> obtain inclusions for 2015-11-24: 510-900
--> store: 2015-11-24 510- tag1 tag2
Note the open-ended, back-dated interval
Inserting tracked time into an existing set of intervals:
$ timew track +tag3 yesterday 2pm - 4pm
--> 'yesterday' resolves to 2015-11-23
--> '2pm' - '4pm' resolves to 840-960
--> obtain inclusions for 2015-11-23: 510-1050
--> store: 2015-11-23 840-960 tag3
Change tagging for an interval:
$ timew track -tag3 +tag4 yesterday 2pm - 4pm
TBD
Data Format
-----------
Intervals of tracked time are stored in a text file, with one line of text
representing one day. Here is a single tracked interval:
YYYY-MM-DD <start>-<end> <tagset>
Here is an open-ended, currently tracked active interval, notice the missing
<end> timestamp:
YYYY-MM-DD <start>- <tagset>
A typical day might look like this:
2015-12-10 480-720 Upgrade Planning, 780- Upgrade Presentation "ABCD Inc"
The "480-720" is a time range, in this case from 8:00am to 12:00pm, associated
with the two tags "Upgrade" and "Planning". A second interval started at 1:00pm
and is incomplete, associated with three tags "Upgrade", "Presentation" and
"ABCD Inc". A tag must be quoted, if it contains whitespace.
Reporting
---------