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: Illustrated exclusion syntax

Browse source
This commit is contained in:
Paul Beckingham 2016-04-21 21:12:12 -04:00
parent 27713000e3
commit e93302032b
4 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/data.txt
View file

@ -59,11 +59,11 @@ exclusions.
An example file looks like this: An example file looks like this:
exc monday <8:00:00 12:00:00-12:45:00 >17:30:00 exc monday <8:00 12:00-12:45 >17:30
exc tuesday <8:00:00 12:00:00-12:45:00 >18:30:00 exc tuesday <8:00 12:00-12:45 >18:30
exc wednesday <8:00:00 12:00:00-13:30:00 >17:30:00 exc wednesday <8:00 12:00-13:30 >17:30
exc thursday <8:00:00 12:00:00-12:45:00 >17:30:00 exc thursday <8:00 12:00-12:45 >17:30
exc friday <8:00:00 12:00:00-12:45:00 >17:30:00 exc friday <8:00 12:00-12:45 >17:30
exc day on 2016-01-01 exc day on 2016-01-01
exc day off 2016-01-02 exc day off 2016-01-02
@ -73,7 +73,7 @@ An example file looks like this:
Blank lines are ignored. Here we see a set of exclusions that define a work week Blank lines are ignored. Here we see a set of exclusions that define a work week
and two inclusions, the first of which represents a four hour block of time with and two inclusions, the first of which represents a four hour block of time with
two tags 'Upgrade' and 'Planning'. The second inclusion is open ended, having two tags 'Upgrade' and 'Planning'. The second inclusion is open ended, having
only a start time (1pm), but three tags 'Upgrade', 'Presentation' and 'ABCD only a start time (1pm UTC), but three tags 'Upgrade', 'Presentation' and '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

2
doc/dom.txt
View file

@ -37,7 +37,7 @@ All DOM references have this form:
dom.tracked.today --> 2 Quantity today dom.tracked.today --> 2 Quantity today
dom.tracked.today.1 --> {...} 1st interval today JSON dom.tracked.today.1 --> {...} 1st interval today JSON
dom.tracked.today.1.start --> YYYYMMDDTHHMMSSZ 1st interval today start dom.tracked.today.1.start --> YYYYMMDDTHHMMSSZ 1st interval today start
dom.tracked.today.1.end --> YYYYMMDDTÞHMMSSZ 1st interval today end dom.tracked.today.1.end --> YYYYMMDDTHHMMSSZ 1st interval today end
dom.tracked.today.1.tags --> 1 1st interval today tag count dom.tracked.today.1.tags --> 1 1st interval today tag count
dom.tracked.today.1.tag.1 --> 'tag1' 1st interval today tag dom.tracked.today.1.tag.1 --> 'tag1' 1st interval today tag
dom.tracked.today.1.duration --> P1H25M8S 1st interval today duration dom.tracked.today.1.duration --> P1H25M8S 1st interval today duration

12
doc/intro.txt
View file

@ -34,15 +34,15 @@ More sophisticated use is possible if you have defined your work week with:
define exclusions: define exclusions:
monday = <8:00:00 12:00:00-12:45:00 >17:30:00 monday = <8:00:00 12:00:00-12:45:00 >17:30:00
tuesday = <8:00:00 12:00:00-12:45:00 >18:30:00 tuesday = <8:00:00 12:00:00-12:45:00 >18:30:00
wednesday = <8:00:00 12:00:00-13:30:00 >17:30:00 wednesday = <8:00 12:00-13:30 >17:30
thursday = <8:00:00 12:00:00-12:45:00 >17:30:00 thursday = <8:00 12:00-12:45 >17:30
friday = <8:00:00 12:00:00-12:45:00 >17:30:00 friday = <8:00 12:00-12:45 >17:30
$ timew track yesterday Home Painting $ timew track yesterday Home Painting
Once the work week is recorded, vague terms like 'yesterday' can be resolved Note that the second (':00') are optional. Once the work week is recorded,
into actual start/stop timestamps. If you define holidays, then it knows not to vague terms like 'yesterday' can be resolved into actual start/stop timestamps.
track time on those days: If you define holidays, then it knows not to track time on those days:
import /path/to/holidays/holidays.en-US import /path/to/holidays/holidays.en-US

6
doc/rules.txt
View file

@ -79,9 +79,9 @@ be stored in a readily-interpreted form:
define exclusions: define exclusions:
monday = <8:00:00 12:00:00-12:45:00 >17:30:00 monday = <8:00:00 12:00:00-12:45:00 >17:30:00
tuesday = <8:00:00 12:00:00-12:45:00 >18:30:00 tuesday = <8:00:00 12:00:00-12:45:00 >18:30:00
wednesday = <8:00:00 12:00:00-13:30:00 >17:30:00 wednesday = <8:00 12:00-13:30 >17:30
thursday = <8:00:00 12:00:00-12:45:00 >17:30:00 thursday = <8:00 12:00-12:45 >17:30
friday = <8:00:00 12:00:00-12:45:00 >17:30:00 friday = <8:00 12:00-12:45 >17:30
days: days:
2016_01_01 = Working 2016_01_01 = Working