Commit graph

458 commits

Author SHA1 Message Date
Thomas Lauf
5265b26e86 Add configurable default range for reports
Query rule 'reports.<name>.range' for the specific default range of the report.
Use rule 'reports.range' to configure an overall default range for all reports.
Make internal reports 'summary', 'month', 'week', 'day', and 'gaps' use this feature.

Closes #477

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 14:07:41 +01:00
Thomas Lauf
30d1ba2b2a Add example descriptions
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-28 22:13:35 +01:00
Scott Mcdermott
bf26176243 Allow specification of intervals to the export command
This patch checks if intervals are given on cli to 'timew export', and
if so will filter only those numbered IDs out from the db.  This lets
the user that already knows the interval(s) they want to know about, to
ask for only those, without parsing the whole thing (similar to how we
can do this for taskwarrior IDs).

If both intervals and other filters -- time range or tags -- are given,
this is considered an error.  There would seem to be little use to AND
or OR tags/ranges with IDs because anyone that knew IDs to request would
already know those IDs met their requirement.

Fixes #510

Code additions from @lauft PR notes (thanks!):

- factor out 'filtering' so we can do only one call to getTracked()
- simplify (tag || range) to .empty(), which already checks both
- error message phrasing

Signed-off-by: Scott Mcdermott <scott@smemsh.net>
2022-12-28 22:13:35 +01:00
Thomas Lauf
5c93b43f30 Add paragraphs
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-27 23:28:56 +01:00
Stanisław Wysocki
718531f0a8 Update documentation on XDG Base Directory specification support
Signed-off-by: Stanisław Wysocki <garethel@protonmail.com>
2022-10-16 10:52:53 +02:00
Los Patchos
c2f6e7ef77 Clarify 255 RC in report docs
Signed-off-by: Los Patchos <44246129+lospatchos@users.noreply.github.com>
2022-09-14 22:13:11 +02:00
Los Patchos
74a3d94f12 Return report exit code.
Continues to throw an exception and to return 255 if no output is produced.

Signed-off-by: Los Patchos <44246129+lospatchos@users.noreply.github.com>
2022-09-14 22:13:11 +02:00
Thomas Lauf
4044635e08 Add complementary hint :holidays/no-holidays
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-01-02 15:48:03 +01:00
Thomas Lauf
1a6d5cacca Make summary output configurable via rules
- add config `reports.summary.ids` to toggle display of IDs
- add config `reports.summary.annotations` to toggle display of annotations
- add hints `:no-ids` and `:no-annotations` to override positive configs

Closes #474

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-01-02 15:48:03 +01:00
Thomas Lauf
1d07ec4aea Add comma
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-01-01 14:27:51 +01:00
Thomas Lauf
8efb716fbf Fix typo
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-01-01 14:27:35 +01:00
Thomas Lauf
4ac1fd39c9 Remove duplicate line
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-01-01 14:26:39 +01:00
Lim Ding Wen
aa08d0a3f2 SummaryColors: Add colors to summary
Signed-off-by: Lim Ding Wen <limdingwen@gmail.com>
2021-11-12 22:15:05 +01:00
Lim Ding Wen
03443d259d TagColorDoc: Add tag color documentation to timew-chart.
Signed-off-by: Lim Ding Wen <limdingwen@gmail.com>
2021-11-07 15:53:06 +01:00
Lim Ding Wen
3ea6a5ccd4 TagColorDoc: Add line break for easier reading.
Signed-off-by: Lim Ding Wen <limdingwen@gmail.com>
2021-11-07 15:53:06 +01:00
Lim Ding Wen
c7781927ec TagColorDoc: Added man documentation for configuring tag colors.
Signed-off-by: Lim Ding Wen <limdingwen@gmail.com>
2021-11-07 15:53:06 +01:00
Thomas Lauf
14050d84f3 Update documentation
- Add documentation of `:all` hint
- Add `timew-hints` as `SEE ALSO` to `timew-ranges`

Related to #408

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2021-06-11 15:05:40 +02:00
Thomas Lauf
3441b2ed93 Update example en-US holiday file
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2021-05-28 12:24:35 +02:00
Thomas Lauf
b189ccb020 Replace roff man pages with asciidoctor
This replaces the generation of man pages on project setup
by a on-demand generation via asciidoctor.
An exception are the man pages for the commands `day`, `month`, and `week`
which are simply redirects to the man page `timew-chart.1`. Those are now
static files in the Timewarrior repository.

A CMake find module to detect asciidoctor was added.
If asciidoctor is found, the targets `doc`, `man1`, and `man7` are created.
Those targets are also added to the default build target.

If asciidoctor is not available, the target `doc` is available, but it only
emits a message to install asciidoctor first.

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2021-02-21 20:58:30 +01:00
Thomas Lauf
65ef38658b Increase minimal CMake version
Compatibility with CMake < 2.8.12 will be removed from a future version of CMake.
According to our test images all supported distributions have CMake > 3

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2021-02-12 10:50:39 +01:00
Tomas Babej
e5870380a4
doc: Update copyright to 2021 2021-01-02 02:52:39 -05:00
Peter
c9b212ce15 Update dark_blue.theme
fixed the description
2020-11-23 12:46:39 +01:00
Thomas Lauf
13a116a301 Update documentation of 'timew-continue'
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2020-07-02 19:59:47 +02:00
George Buckingham
90081afb97 Update docs links from taskwarrior.org to timewarrior.net
Signed-off-by: George Buckingham <george.buckingham@gmail.com>
2020-06-14 15:12:57 +02:00
Thomas Lauf
ad58309159 Update Copyright
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2020-04-19 12:41:23 +02:00
Daniel
13fb0ad8e3 ENH: Add new interval hint :fortnight (sopw - eow). 2020-03-06 21:56:43 +01:00
Thomas Lauf
5ab9b86e56 Set python version explicitly to python3
- Closes #259

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2020-02-23 21:32:39 +01:00
Thomas Lauf
7997c99106 Update README
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 15:12:33 +01:00
Thomas Lauf
42df2cb08b Update copyright years and holders
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 15:12:33 +01:00
Thomas Lauf
002a04db63 Merge same holidays from different regions
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 15:12:33 +01:00
Thomas Lauf
ff562b8a9e Simplify region filtering by setting a default value
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 15:12:33 +01:00
Thomas Lauf
bb905fd0b9 Inline variable
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 13:21:08 +01:00
Thomas Lauf
38a5afe88c Remove redundant character escape in regex
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 13:20:05 +01:00
Thomas Lauf
452cce6137 Switch to python 3
- #259

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-28 13:18:08 +01:00
Thomas Lauf
f7a3e26d8e Move section 7 files to directory man7
- Amends #262

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-12-27 17:22:00 +01:00
Shaun Ruffell
f0bda68b02 Allow help.t test to find manpages without installing them. 2019-11-19 19:45:18 +01:00
Thomas Lauf
2bdc52c30a Fix typo
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-07-22 14:31:01 +02:00
Thomas Lauf
4556b4f072 Add entries for timew-annnotate and timew-undo in the central man page 2019-06-19 18:05:44 +02:00
Thomas Lauf
3f35f179e7 Fix typo
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-05-07 08:17:26 +02:00
Thomas Lauf
3780966ccd Fix section header 2019-02-25 21:26:32 +01:00
Thomas Lauf
1c85721876 Update EXAMPLES section 2019-02-21 23:46:16 +01:00
Thomas Lauf
fc49a4003a Add CONFIGURATION section 2019-02-21 23:23:22 +01:00
Thomas Lauf
661e9f658e Consolidate chart documentation into timew-chart.1 2019-02-21 23:23:22 +01:00
Thomas Lauf
73bdb819e5 Improve formatting
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-21 23:23:22 +01:00
Thomas Lauf
cf045bc762 Set date in man pages to cmake generation date
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-21 23:23:22 +01:00
Thomas Lauf
e53e92f448 Update man page creation
- add new man pages
- register new installation directory for section 7

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-21 23:23:22 +01:00
Thomas Lauf
4c19a055f4 Rename file
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-15 17:01:53 +01:00
Thomas Lauf
8022d88034 Remove trailing whitespace
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-15 17:00:50 +01:00
Thomas Lauf
ff6e9a4776 Add SEE ALSO section
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-15 17:00:31 +01:00
Thomas Lauf
ebe6bb6ce7 Rename file
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2019-02-15 16:56:32 +01:00