'\" t
.\"     Title: timew-chart
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2023-12-30
.\"    Manual: User Manuals
.\"    Source: timew 1.7.0-dev
.\"  Language: English
.\"
.TH "TIMEW\-CHART" "1" "2023-12-30" "timew 1.7.0\-dev" "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 pass:[blue\ R\ <\ >]
.\}
.SH "NAME"
timew-chart \- display chart report
.SH "SYNOPSIS"
.sp
.nf
\fBtimew day\fP [\fI<range>\fP] [\fI<tag>\fP\fB...\fP]
\fBtimew month\fP [\fI<range>\fP] [\fI<tag>\fP\fB...\fP]
\fBtimew week\fP [\fI<range>\fP] [\fI<tag>\fP\fB...\fP]
.fi
.br
.SH "DESCRIPTION"
.sp
A chart summarizes the tracked and untracked time with colored blocks drawn on a timeline.
It accepts date ranges and tags for filtering.
There are three types: \fBday\fP, \fBweek\fP, and \fBmonth\fP with their respective commands.
The \fBreports.\fP\fI<type>\fP\fB.range\fP configuration setting overrides the default date range.
One can override the global default date range with the \fBreports.range\fP configuration.
For more details, and precise times, use the \*(Aqsummary\*(Aq report.
.sp
\fBmonth\fP
.RS 4
The month command shows a chart depicting a single month (current month by default).
The default date range shown is \fB:month\fP.
.RE
.sp
\fBweek\fP
.RS 4
The week command shows a chart depicting a single week (current week by default).
The default date range shown is \fB:week\fP.
.RE
.sp
\fBday\fP
.RS 4
The day command shows a chart depicting a single day (today by default).
The default date range shown is \fB:day\fP.
.RE
.SH "CONFIGURATION"
.sp
\fI<type>\fP is one of \fBmonth\fP, \fBweek\fP, \fBday\fP.
.sp
\fBreports.\fP\fI<type>\fP\fB.cell\fP
.RS 4
Determines how many minutes are represented by a single character cell, for the charts.
The value must be greater than \*(Aq0\*(Aq.
A value of \*(Aq15\*(Aq means that an hour is represented by 60/15, or 4 character cells.
Suitable values are the divisors of 60 (30, 20, 15, 12, ...).
Default value is \*(Aq15\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.day\fP
.RS 4
Determines whether the current day of the month is shown at left margin.
Default value is \*(Aqyes\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.holidays\fP
.RS 4
Determines whether relevant holidays are shown beneath the report.
Default value is \*(Aqyes\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.hours\fP
.RS 4
Determines how the <type> report shows all the hours in a day (\*(Aqall\*(Aq), or is limited to only hours when data is tracked (\*(Aqauto\*(Aq).
Default value is \*(Aqall\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.lines\fP
.RS 4
Determines how many lines are used to render each day on the <type> report.
Default value is \*(Aq1\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.month\fP
.RS 4
Determines whether the current month is shown at left margin.
Default value is \*(Aqyes\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.range\fP
.RS 4
For reports that show a range of data, this setting will override the default value.
The value should be a range hint, see
\fBtimew\-hints\fP(7).
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.spacing\fP
.RS 4
Specifies how many spaces are inserted between the hours in the <type> report exclusions.
A value of \*(Aq0\*(Aq yields a more compact report.
Default value is \*(Aq1\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.axis\fP
.RS 4
The value \*(Aqinternal\*(Aq puts the hour markers (timeline at the top) inside the exclusion blocks, \*(Aqexternal\*(Aq puts the hour markers in a separate line; additional values might be defined in the future.
Default is \*(Aqinternal\*(Aq for the day report and \*(Aqexternal\*(Aq for other reports.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.summary\fP
.RS 4
Determines whether the hours summary is shown.
Default value is \*(Aqon\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.totals\fP
.RS 4
Determines whether the time totals are shown for each day on the report.
Default value is \*(Aqon\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.week\fP
.RS 4
Determines whether the current week number is shown at left margin.
Default value is \*(Aqyes\*(Aq.
.RE
.sp
\fBreports.\fP\fI<type>\fP\fB.weekday\fP
.RS 4
Determines whether the current weekday is shown at left margin.
Default value is \*(Aqyes\*(Aq.
.RE
.sp
\fBtags.\fP\fI<tag>\fP\fB.color\fP
.RS 4
Assigns a specific foreground and background color to a tag, instead of the default color palette determined by your current theme.
Examples of valid colors include \*(Aqwhite\*(Aq, \*(Aqgray8\*(Aq, \*(Aqblack on yellow\*(Aq, and \*(Aqrgb345\*(Aq.
.RE
.SH "HINTS"
.sp
\fB:blank\fP
.RS 4
The \*(Aq:blank\*(Aq hint causes only the excluded time to be shown, with no tracked time.
This can be used to see the exclusions.
.RE
.sp
\fB:ids\fP
.RS 4
The \*(Aq:ids\*(Aq hint causes the intervals to be displayed with their ids
.RE
.SH "EXAMPLES"
.sp
Charts accept date ranges and tags for filtering, or shortcut hints:
.sp
.if n .RS 4
.nf
.fam C
$ timew month 1st \- today
$ timew week FOO BAR
$ timew day :week
.fam
.fi
.if n .RE
.SH "SEE ALSO"
.sp
\fBtimew\-day\fP(1),
\fBtimew\-month\fP(1),
\fBtimew\-summary\fP(1),
\fBtimew\-week\fP(1)