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: Replaced 'keyword' with 'hint'

Browse source
This commit is contained in:
Paul Beckingham 2016-04-03 17:29:26 -04:00
parent 4c05fb3e0c
commit 80c169c4cc
3 changed files with 47 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/project.txt
View file

@ -65,13 +65,15 @@ however, both 'tag1' and 'tag2' are defined with the 'overlap' metadata, then
there will not be an automatic stop for 'tag1'.
Macros
------
A macro is a keyword that can take arguments, and expands to a set of one or
more other timew commands, with some dynamic aspect. For example, the macro
named 'staff meeting' could be an interval that is on Wednesdays at 10:00, and
has a set of associated tags. This would then create an appropriately tagged
interval.
Hints
-----
There are built-in hints, that influence processing. For example, ':debug' puts
the program in debug mode, and ':fill' indicates to a 'track' command that you
wish to fill in the available time. Another hint, ':week' means that a command
should only affect the last week.
There are user-defined hints, that can act as macros⁄aliases, for example the
':staff' hint could mean a 'Staff Meeting' and 'Admin' tag set.
Commands