GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Clarified Taskwarrior hook requirements, cleaned up text

Browse source
This commit is contained in:
Paul Beckingham 2016-03-13 10:43:54 -04:00
parent dc6b70acf4
commit 8b5b8c2073
1 changed files with 12 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/reports.txt
View file

@ -1,9 +1,9 @@
Reporting
=========
As we cannot anticipate all reporting needs, custom reports are necessary.
Rather than copy the Taskwarrior design where a report is a combination of a
filter, sort, columns and labels, a more flexible approach could encourage
shared custom reports.
Anticipating all reporting needs is impossible, therefore custom reports are
required. Rather than copy the Taskwarrior design where a report is a
combination of a filter, sort, columns and labels, a more flexible approach
could encourage shared custom reports.
Іf all reports are extension scripts/programs, utilizing some form of API,
then there is no restriction on the kind of report generated, which would
@ -12,8 +12,8 @@ allow for HTML reports, rather than simply supporting tabular text.
Requirements
------------
Timewarrior should ship with several reports, which serve as example extensions
for users to evolve‥
Timewarrior will ship with several reports, which serve as example extensions
for users to evolve.
Timewarrior should handle the command line options for reports, then pass off
a standardized set of parameters to the report extension. These parameters will
@ -23,8 +23,8 @@ include:
range, the extensions themselves would be passed precise values, therefore
reducing the complexity of the extensions.
- Data will be filtered by Timewarrior, so that extensions do not need to
implement this.
- Data will be filtered by Timewarrior, so that extensions will not need to
reimplement this.
Report Mockups
@ -46,11 +46,12 @@ Here are some provisional examples of report commands:
$ timew report day [monday] [±<tag> ...]
$ timew report week [±<tag> ...]
$ timew report month
$ timew report month|quarter|year
---
- Taskwarrior Hook script needs to allow 'project' (default) or an arbitrary
UDA for time categorization.
- The Taskwarrior hook script should use a set of attributes for time tracking
tags. Those will include: UUID, project, tags, and any chosen UDAs.
- Need a JSON --> CSV converter, for spreadsheet folks.