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: Simplified rule syntax

Browse source
This commit is contained in:
Paul Beckingham 2016-03-13 10:57:25 -04:00
parent f36937ddff
commit 0228055667
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
doc/rules.txt
View file

@ -34,10 +34,11 @@ Format
The rules are written in a UTF8 text file, in a known location. Other rules The rules are written in a UTF8 text file, in a known location. Other rules
files may be included: files may be included:
import /path/to/other/rules import /path/to/other/rule/file
The syntax of rules is Python-like, in that indentation is significant. The syntax of rules is Python-like, in that indentation is significant.
Types of Rules Types of Rules
-------------- --------------
There are several different types of rules, for example there is the rule that There are several different types of rules, for example there is the rule that
@ -69,7 +70,7 @@ Should be stored in a rule, whose purpose is to return a set of exclusion
intervals: intervals:
define exclusions: define exclusions:
include workweek mon,tue,wed,thu,fri workweek mon,tue,wed,thu,fri
Further definitions will build on this rule: Further definitions will build on this rule:
@ -78,8 +79,8 @@ Further definitions will build on this rule:
Yields a combined: Yields a combined:
define exclusions: define exclusions:
interval workweek mon,tue,wed,thu,fri workweek mon,tue,wed,thu,fri
interval workday start 8:30am workday start 8:30am
Possible exclusions include: Possible exclusions include:
@ -92,12 +93,12 @@ Possible exclusions include:
Yielding: Yielding:
define exclusions: define exclusions:
interval holidays eng-USA holidays eng-USA
interval work 2015-11-26 work 2015-11-26
interval workweek mon,tue,wed,thu,fri workweek mon,tue,wed,thu,fri
interval workday start 8:30am workday start 8:30am
interval workday end 1730 workday end 1730
interval workday tue end 3pm workday tue end 3pm
If you want to track your lunch breaks, then you would make a tag for it, and If you want to track your lunch breaks, then you would make a tag for it, and
track it like any other project. If you do not want to track that time, add an track it like any other project. If you do not want to track that time, add an