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 tag definitions

Browse source
This commit is contained in:
Paul Beckingham 2015-12-16 23:45:20 -05:00
parent eb90e75383
commit 5deac6340a
2 changed files with 55 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/examples.txt
View file

@ -49,7 +49,19 @@ Record yesterday's time:
Defining Exclusions:
$ timew holidays eng-USA
$ timew 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:
$ timew define tag "tag1"
$ timew define tag "tag1" description "Description of tag1"
$ timew define tag "tag1" start 2016-01-01
$ timew define tag "tag1" end 2016-06-30
---

59
doc/rules.txt
View file

@ -33,24 +33,22 @@ Types of Rules
There are several different types of rules, for example there is the rule that
defines all exclusions:
define rule exclusions:
interval workweek mon,tue,wed,thu,fri
define exclusions:
...
There are rules triggered by changes to the data. In this example, rule 'one'
is a constraint that prevents the value 'foo' from exceeding three. It is
triggered by a change to 'foo', which is a DOM reference, and can prevent the
update by failing:
There are general rules triggered by changes to the data:
define rule one:
tagset tag1
if foo > 3:
error "The value of 'foo' may not exceed 3."
...
Note that this rule is defined as applying to the tagset 'tag1'.
There are rules that define tags and their metadata:
define tag "tag1":
...
Exclusions
----------
Rule Type: Exclusions
---------------------
Because exclusions are resolved at run time, and only when needed, they should
be stored in a form very close to the command line syntax, with no expansion.
For example:
@ -60,7 +58,7 @@ For example:
Should be stored in a rule, whose purpose is to return a set of exclusion
intervals:
define rule exclusions:
define exclusions:
include workweek mon,tue,wed,thu,fri
Further definitions will build on this rule:
@ -69,7 +67,7 @@ Further definitions will build on this rule:
Yields a combined:
define rule exclusions:
define exclusions:
interval workweek mon,tue,wed,thu,fri
interval workday start 8:30am
@ -83,21 +81,50 @@ Possible exclusions include:
Yielding:
define rule exclusions:
define exclusions:
interval holidays eng-USA
interval work 2015-11-26
interval workweek mon,tue,wed,thu,fri
interval workday start 8:30am
interval workday end 1730
interval workday tue end 3pm
Rule Type: General
------------------
There are rules triggered by changes to the data. In this example, rule 'one'
is a constraint that prevents the value 'foo' from exceeding three. It is
triggered by a change to 'foo', which is a DOM reference, and can prevent the
update by failing:
define rule one:
tagset tag1
if foo > 3:
error "The value of 'foo' may not exceed 3."
Note that this rule is defined as applying to the tagset 'tag1'.
Rule Type: Tag
--------------
A defined tag is a way to associate metadata with a tag, such as a description
and start/end dates for use:
define tag "tag1":
description "Description of tag1"
start 2016-01-01
end 2016-06-30
budget 20 hours per week
budget 400 hours total
Built-in Functions
------------------
There are several built-in functions, which may be used by rules:
error "An error occurred"
warning "You have been warned"
info "Yuo have been notified"
info "You have been notified"
An error call terminates processing.