'\" t
.\"     Title: timew-dom
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2025-08-16
.\"    Manual: User Manuals
.\"    Source: timew 1.9.1
.\"  Language: English
.\"
.TH "TIMEW\-DOM" "7" "2025-08-16" "timew 1.9.1" "User Manuals"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
timew-dom \- Timewarrior DOM
.SH "SYNOPSIS"

.SH "DESCRIPTION"
.sp
All DOM references start with \f(CRdom\fP, there are 4 subreferences that can be accessed:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CRdom.tracked\fP, all intervals
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CRdom.active\fP, active time tracking
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CRdom.tags\fP, all tags
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CRdom.rc\fP, configuration settings
.sp
All intervals
.RS 4
\f(CRdom.tracked\fP is a reference to all intervals of the database query result.
When using this reference, filtering by range and tags can be applied.
.sp
.if n .RS 4
.nf
.fam C
dom.tracked.count           Count of all intervals in the query result
dom.tracked.ids             Ids of all intervals in the query result
dom.tracked.tags            Tags of all intervals in the query result
dom.tracked.tags.count      Count of all tags in the query result
dom.tracked.tags.<n>        N\-th Tag of all tags in the query result
.fam
.fi
.if n .RE
.sp
\f(CRdom.tracked.<n>\fP is a reference to the n\-th interval of the database query result.
Depending on the filtering applied, the n\-th interval is not necessarily the one with ID \f(CR@n\fP!
.sp
.if n .RS 4
.nf
.fam C
dom.tracked.<n>.tags        All tags of the n\-th interval
dom.tracked.<n>.tags.count  Count of tags of the n\-th interval
dom.tracked.<n>.tags.<m>    N\-th interval, m\-th tag
dom.tracked.<n>.start       N\-th interval, start time (ISO Extended date)
dom.tracked.<n>.end         N\-th interval, end time (ISO Extended date, blank if open)
dom.tracked.<n>.duration    N\-th interval, duration (ISO Duration)
dom.tracked.<n>.json        N\-th interval, as JSON
.fam
.fi
.if n .RE
.RE
.sp
Active time tracking
.RS 4
\f(CRdom.active\fP is a reference to the latest interval in active time tracking.
It is invalid when no time is tracked.
.sp
.if n .RS 4
.nf
.fam C
dom.active                  \*(Aq1\*(Aq if there is active tracking, otherwise \*(Aq0\*(Aq
dom.active.tags             All tags of the active tracking
dom.active.tags.count       Count of tags
dom.active.tags.<n>         N\-th tag
dom.active.start            Start timestamp (ISO Extended date)
dom.active.duration         Elapsed (ISO Period)
dom.active.json             Interval as JSON
.fam
.fi
.if n .RE
.RE
.sp
All tags
.RS 4
\f(CRdom.tags\fP is a reference to all tags in the database.
.sp
.if n .RS 4
.nf
.fam C
dom.tags                    All tags
dom.tags.count              Count of all tags
dom.tags.1                  N\-th tag
.fam
.fi
.if n .RE
.sp
Without filtering applied, \f(CRdom.tracked.tags\fP refers to the same set of tags as \f(CRdom.tags\fP.
.RE
.sp
Configuration settings
.RS 4
\f(CRdom.rc\fP is a reference to all Timewarrior configuration settings.
As there are no restrictions for the configuration keys, all those references are valid by design.
.sp
.if n .RS 4
.nf
.fam C
dom.rc.<name>              Configuration setting <name>
.fam
.fi
.if n .RE
.RE
.RE