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 exclusions use case

Browse source
This commit is contained in:
Paul Beckingham 2016-02-29 11:27:14 -05:00
parent dba98e9f4e
commit 668d722c15
1 changed files with 17 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

28
doc/examples.txt
View file

@ -5,6 +5,7 @@ gradually change into a feature spec. The use cases are grouped functionally:
[1] Basic Usage
[2] Reports
[3] Exclusions
[1.1] Basic Usage: clock
@ -54,8 +55,23 @@ preset periods:
$ timew report
[3.1] Exclusions: Work Week
--------------------------
This uses a 'default' tag. By using tags, this becomes:
$ timew define holidays eng-USA
$ timew define holidays work 2015-11-26
$ timew define workweek mon-fri
$ timew define workday start 8:30am
$ timew define workday end 1730
$ timew define workday tue end 3pm
By using tags, this becomes:
$ timew start tag1 # Start tracking now
$ timew start "Home Improvement Project" # Stop old interval, start new interval now
@ -117,16 +133,6 @@ These two example assume that there is no empty slot at the end of yesterday,
because it would also be filled.
Defining Exclusions
-------------------
$ timew define holidays eng-USA
$ timew define holidays work 2015-11-26
$ timew define workweek mon-fri
$ timew define workday start 8:30am
$ timew define workday end 1730
$ timew define workday tue end 3pm
The above examples simply use ad-hoc tags, which is an undefined tag. They are
simply used as tags, and have no metadata. Defining a tag allows it to have
associated metadata: