Doc: Extended tag definition grammar/examples

This commit is contained in:
Paul Beckingham 2015-12-17 14:56:58 -05:00
parent f3faa1d260
commit 76aaecda94
2 changed files with 8 additions and 4 deletions

View file

@ -25,13 +25,13 @@ next friday, at EOW:
If overlapping intervals are permitted (configuration: interval.overlap=yes), If overlapping intervals are permitted (configuration: interval.overlap=yes),
then this creates overlapping intervals: then this creates overlapping intervals:
[1] $ timew start tag1 1 $ timew start tag1
... ...
[2] $ timew start tag2 2 $ timew start tag2
... ...
[3] $ timew stop tag1 3 $ timew stop tag1
... ...
[4] $ timew stop tag2 4 $ timew stop tag2
With overlapping intervals: With overlapping intervals:
o-------o tag1 o-------o tag1
@ -63,5 +63,7 @@ associated metadata:
$ timew define tag "tag1" description "Description of tag1" $ timew define tag "tag1" description "Description of tag1"
$ timew define tag "tag1" start 2016-01-01 $ timew define tag "tag1" start 2016-01-01
$ timew define tag "tag1" end 2016-06-30 $ timew define tag "tag1" end 2016-06-30
$ timew define tag "tag1" budget 20 hours per week
$ timew define tag "tag1" budget 400 hours total
--- ---

View file

@ -19,6 +19,8 @@ The CLI shall have a well-defined and unambiguous grammar.
timew define tag <tag> description <string> timew define tag <tag> description <string>
timew define tag <tag> start <date> timew define tag <tag> start <date>
timew define tag <tag> end <date> timew define tag <tag> end <date>
timew define tag <tag> budget <number> <units> per <unit>
timew define tag <tag> budget <number> <units> total
timew export ... timew export ...
timew import ... timew import ...