Commit graph

40 commits

Author SHA1 Message Date
Tobias Predel
ceb369508d Fix manual page formatting
Remove brackets in manual page

Signed-off-by: Tobias Predel <tobias.predel@gmail.com>
2024-05-27 10:05:44 +02:00
Thomas Lauf
bf683eedbf Filter summary based on ids
Closes  #573

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-12-23 22:38:31 +01:00
Thomas Lauf
bddb874034 Improve configurability of CMake install directories
Make installation of man pages configurable per section
Use configuration variable TIMEW_BINDIR
Update documentation

Closes #553

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-08-11 15:30:26 +02:00
quazgar
32ac226fec
DOC: Update docs. (#554)
Signed-off-by: Quazgar <quazgar@posteo.de>
2023-08-04 23:14:53 +02:00
Iúri Archer
4469e9056a
Add retag command (#551)
Closes #515 

---------

Signed-off-by: cyberme0w <iuri_archer@hotmail.com>
2023-07-31 22:45:08 +02:00
Thomas Lauf
3008e458e9 Update project to C++17
- Bump CMake to minimum version 3.8
- Set C++ standard to 17
- Remove CMAKE_LEGACY_CYGWIN_WIN32 compatibility mode
- Remove C++11 stuff
- Update documentation

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-06-17 08:41:07 +02:00
Benedikt Fein
dd330aa0db Fix man page build for out-of-source builds
Fixes #461

Signed-off-by: Benedikt Fein <fein@fim.uni-passau.de>
2023-06-08 17:29:05 +02:00
Thomas Lauf
20a8a4a4cc Cleanup CMake files
- Replace tabs with spaces
- Use lowercase for CMake commands
- Unify alignment
- Remove superfluous empty line
- Add space after CMake command

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-05-26 09:53:03 +02:00
Thomas Lauf
a1d418a686 Fix grammar and spelling
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-04-17 08:17:29 +02:00
Thomas Lauf
082708a7ca Fix typos and wording
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-04-04 22:44:44 +02:00
Thomas Lauf
c6130157c6 Specify ranges without ':' in configuration
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-04-02 18:50:35 +02:00
Thomas Lauf
2d7dd35bd5 Update man pages for annotation command and summary report
Closes #444

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2023-01-14 21:20:56 +01:00
Thomas Lauf
55ad661e0d Add tests for configurable report range, update man page
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-31 22:22:49 +01:00
xerus2000
c8069d7cd7 Adjust man page 2022-12-29 23:15:10 +01:00
Thomas Lauf
f9ca6c6f5e Make display of columns for week number and day of week configurable
Closes #389

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 18:06:07 +01:00
Thomas Lauf
817bc492a3 Fix synopsis
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 15:36:59 +01:00
Thomas Lauf
7a020a3384 Replace Markdown syntax with AsciiDoc syntax
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 15:33:38 +01:00
Thomas Lauf
f3ed2f1554 Update documentation on annotation command
Relates to #266

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 15:30:47 +01:00
Thomas Lauf
86117c44e4 Add missing period
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 14:07:41 +01:00
Thomas Lauf
6f141f6301 Make display of tags column configurable
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
2022-12-29 14:07:41 +01:00
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
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
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
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
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