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: Removed obsolete dom.txt

Browse source
This commit is contained in:
Paul Beckingham 2016-07-16 17:22:48 -04:00
parent b99c9e9df2
commit 62989d2d1f
1 changed files with 0 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

57
doc/dom.txt
View file

@ -1,57 +0,0 @@
DOM - Document Object Model
===========================
Timewarrior needs DOM support, so that it can service a 'get' command and
provide access to data and rules. Both are important for extensions.
Data to be Accessed
-------------------
Here are the data accessible via DOM references:
- Configuration
- Exclusions
- Command line args in raw form (for rules, not 'get')
Syntax
------
All DOM references have this form:
dom.<name>
Supported Names
---------------
dom.tag.count --> 14 Count of all tags
dom.tag.1 --> 'tag' Nth tag used
dom.active --> 0/1 Boolean indicator that tracking is active
dom.active.tag.count --> N Count of active tags
dom.active.tag.1 --> 'tag' Active Nth tag
dom.active.start --> YYYY-MM-DDTHH:MM:SS Active start time
dom.active.duration --> PT1H25M8S Active elapsed
dom.active.json --> {...} Active interval as JSON
dom.tracked.count --> N Count of tracked intervals
dom.tracked.1.tag.count --> N Tracked Nth, count of tags
dom.tracked.1.tag.1 --> 'tag' Tracked Nth, Nth tag
dom.tracked.1.start --> YYYY-MM-DDTHH:MM:SS Tracked Nth, start time
dom.tracked.1.end --> YYYY-MM-DDTHH:MM:SS Tracked Nth, end time, blank if closed
dom.tracked.1.duration --> PT1H25M8S Tracked Nth, elapsed
dom.tracked.1.json --> {...} Tracked Nth, interval as JSON
dom.rc.<name> --> ... Configuration setting
--- Raw Notes ---
Proposed:
dom.tag.[1-3] --> 't1', 't2', 't3' First three tags
dom.tag.[1,2,3] --> 't1', 't2', 't3' First three tags
dom.tag.* --> 't1', ... 't14' All tags
dom.gap.today
...