GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-06-26 10:54:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Updated dom.txt to reflect implemented DOM

Browse source
This commit is contained in:
Paul Beckingham 2016-07-16 10:39:03 -04:00
parent 3ed8ffd4ad
commit 8be89d0056
1 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/dom.txt
View file

@ -23,6 +23,13 @@ All DOM references have this form:
Supported Names
---------------
dom.active --> 0/1 Boolean indicator that tracking is active
--- Raw Notes ---
Proposed:
dom.tags --> 14 Tag count
dom.tags.1 --> 'tag' First tag used
@ -30,7 +37,6 @@ Supported Names
dom.tag.[1,2,3] --> 't1', 't2', 't3' First three tags
dom.tag.* --> 't1', ... 't14' All tags
dom.active --> 0/1 Boolean indicator that tracking is active
dom.active.tags --> 2 Active tag count
dom.active.tag.1 --> 'tag' Active 1st tag
@ -42,12 +48,12 @@ Supported Names
dom.tracked.month --> 21 Quantity this month
dom.tracked.week --> 6 Quantity this week
dom.tracked.today --> 2 Quantity today
dom.tracked.@1 --> {...} 1st interval today JSON
dom.tracked.@1.start --> YYYYMMDDTHHMMSSZ 1st interval today start
dom.tracked.@1.end --> YYYYMMDDTHHMMSSZ 1st interval today end
dom.tracked.@1.tags --> 1 1st interval today tag count
dom.tracked.@1.tag.1 --> 'tag1' 1st interval today tag
dom.tracked.@1.duration --> P1H25M8S 1st interval today duration
dom.tracked.@1 --> {...} 1st interval today JSON
dom.tracked.@1.start --> YYYYMMDDTHHMMSSZ 1st interval today start
dom.tracked.@1.end --> YYYYMMDDTHHMMSSZ 1st interval today end
dom.tracked.@1.tags --> 1 1st interval today tag count
dom.tracked.@1.tag.1 --> 'tag1' 1st interval today tag
dom.tracked.@1.duration --> P1H25M8S 1st interval today duration
dom.gap.today
...
@ -55,8 +61,6 @@ Supported Names
rc.<name>
--- Raw Notes ---
- The above does not support totals, as this would turn DOM references into a
query language. Instead, a 'sum' command could do this. The rules.txt doc
already mentions built-in functions.