Docs: Added overlapping tag discussion and rule

This commit is contained in:
Paul Beckingham 2016-03-13 11:18:18 -04:00
parent a84b1dcdac
commit 3099f92981
2 changed files with 18 additions and 0 deletions

View file

@ -45,6 +45,23 @@ have associated metadata, such as a start date representing the first date on
which it may be used, or an end date, when it expires. A tag may have a budget,
which is the maximum trackable time for a period.
An interval may have multiple tags associated with it, but the tags apply to the
whole interval only. In this example, there are overlapping tags:
$ timew start tag1
...
$ timew start tag2
...
$ timew stop tag1
...
$ timew stop
By default, when the interval for 'tag2' starts, the interval for 'tag1' is
automatically stopped, because tags do not overlap. This then makes the next
command ('timew stop tag1') yield an error, because 'tag1' was not active. If
however, both 'tag1' and 'tag2' are defined with the 'overlap' metadata, then
there will not be an automatic stop for 'tag1'.
Macros
------

View file

@ -131,6 +131,7 @@ and start/end dates for use:
end 2016-06-30
budget 20 hours per week
budget 400 hours total
overlap yes
rule Type: Logging