From e93302032b087c0467f3e3dfad6812e4cbe82772 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Thu, 21 Apr 2016 21:12:12 -0400 Subject: [PATCH] Docs: Illustrated exclusion syntax --- doc/data.txt | 12 ++++++------ doc/dom.txt | 2 +- doc/intro.txt | 12 ++++++------ doc/rules.txt | 6 +++--- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/data.txt b/doc/data.txt index 1a04f1a9..d3be6e3c 100644 --- a/doc/data.txt +++ b/doc/data.txt @@ -59,11 +59,11 @@ exclusions. An example file looks like this: - exc monday <8:00:00 12:00:00-12:45:00 >17:30:00 - exc tuesday <8:00:00 12:00:00-12:45:00 >18:30:00 - exc wednesday <8:00:00 12:00:00-13:30:00 >17:30:00 - exc thursday <8:00:00 12:00:00-12:45:00 >17:30:00 - exc friday <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 12:00-12:45 >18:30 + exc wednesday <8:00 12:00-13:30 >17:30 + exc thursday <8:00 12:00-12:45 >17:30 + exc friday <8:00 12:00-12:45 >17:30 exc day on 2016-01-01 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 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 -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. An open-ended inclusion like this means that the tracking continues, but the diff --git a/doc/dom.txt b/doc/dom.txt index 805ccd81..c0e50bae 100644 --- a/doc/dom.txt +++ b/doc/dom.txt @@ -37,7 +37,7 @@ All DOM references have this form: dom.tracked.today --> 2 Quantity today dom.tracked.today.1 --> {...} 1st interval today JSON 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.tag.1 --> 'tag1' 1st interval today tag dom.tracked.today.1.duration --> P1H25M8S 1st interval today duration diff --git a/doc/intro.txt b/doc/intro.txt index 75815553..358b91fa 100644 --- a/doc/intro.txt +++ b/doc/intro.txt @@ -34,15 +34,15 @@ More sophisticated use is possible if you have defined your work week with: define exclusions: 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 - wednesday = <8:00:00 12:00:00-13:30:00 >17:30:00 - thursday = <8:00:00 12:00:00-12:45:00 >17:30:00 - friday = <8:00:00 12:00:00-12:45:00 >17:30:00 + wednesday = <8:00 12:00-13:30 >17:30 + thursday = <8:00 12:00-12:45 >17:30 + friday = <8:00 12:00-12:45 >17:30 $ timew track yesterday Home Painting -Once the work week is recorded, vague terms like 'yesterday' can be resolved -into actual start/stop timestamps. If you define holidays, then it knows not to -track time on those days: +Note that the second (':00') are optional. Once the work week is recorded, +vague terms like 'yesterday' can be resolved into actual start/stop timestamps. +If you define holidays, then it knows not to track time on those days: import /path/to/holidays/holidays.en-US diff --git a/doc/rules.txt b/doc/rules.txt index 9c34f0e7..23a91491 100644 --- a/doc/rules.txt +++ b/doc/rules.txt @@ -79,9 +79,9 @@ be stored in a readily-interpreted form: define exclusions: 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 - wednesday = <8:00:00 12:00:00-13:30:00 >17:30:00 - thursday = <8:00:00 12:00:00-12:45:00 >17:30:00 - friday = <8:00:00 12:00:00-12:45:00 >17:30:00 + wednesday = <8:00 12:00-13:30 >17:30 + thursday = <8:00 12:00-12:45 >17:30 + friday = <8:00 12:00-12:45 >17:30 days: 2016_01_01 = Working