1TIMEW-ANNOTATE(1)                User Manuals                TIMEW-ANNOTATE(1)
2
3
4

NAME

6       timew-annotate - add an annotation to intervals
7

SYNOPSIS

9       timew annotate [<id>...] <annotation>
10

DESCRIPTION

12       The 'annotate' command is used to add an annotation to an interval.
13
14       See the 'summary' command on how to display the <id> and <annotation>
15       of an interval.
16

EXAMPLES

18       Annotate a single interval
19
20           Call the command with an id and the annotation:
21
22               $ timew annotate @2 'Lorem ipsum'
23               Annotated @2 with "Lorem ipsum"
24
25       Remove an annotation
26
27           Annotating an interval with an empty string removes the annotation:
28
29               $ timew annotate @1 ''
30               Removed annotation from @1
31
32       Annotate multiple intervals
33
34           You can annotate multiple intervals with the same annotation at
35           once, by specifying their ids:
36
37               $ timew annotate @2 @10 @23 'Lorem ipsum'
38               Annotated @1 with "Lorem ipsum"
39               Annotated @10 with "Lorem ipsum"
40               Annotated @23 with "Lorem ipsum"
41
42       Annotate the current open interval
43
44           If there is active time tracking, you can omit the ID when you want
45           to add an annotation to the current open interval:
46
47               $ timew start foo
48               ...
49               $ timew annotate bar
50               Annotated @1 with "bar"
51
52           This results in the current interval having tag 'foo' and
53           annotation 'bar'.
54

BUGS & LIMITATIONS

56       The summary command truncates annotations longer than 15 characters. To
57       display longer annotations, one can use the 'export' command, or a
58       custom report.
59
60       Currently, the annotation command picks the last token from the command
61       line and uses it as annotation. I.e. using no quotes in an annotation
62       command like
63
64           $ timew annotate @1 lorem ipsum
65
66       will result in interval @1 having only 'ipsum' as its annotation. Use
67       quotes to avoid this.
68

SEE ALSO

70       timew-export(1), timew-summary(1), timew-tag(1)
71
72
73
74timew 1.6.0                       2023-09-18                 TIMEW-ANNOTATE(1)