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: Updated report design

Browse source
This commit is contained in:
Paul Beckingham 2016-03-19 17:29:20 -04:00
parent 6fa545f805
commit 0d3154bb88
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/reports.txt
View file

@ -3,20 +3,20 @@ Reporting
Anticipating all reporting needs is impossible, therefore custom reports are Anticipating all reporting needs is impossible, therefore custom reports are
required. Rather than copy the Taskwarrior design where a report is a required. Rather than copy the Taskwarrior design where a report is a
combination of a filter, sort, columns and labels, a more flexible approach combination of a filter, sort, columns and labels, a more flexible approach
could encourage shared custom reports. could encourage shared custom reports, and use a more complete API.
Іf all reports are extension scripts/programs, utilizing some form of API, Іf all reports are extension scripts/programs, utilizing an API, then there is
then there is no restriction on the kind of report generated, which would no restriction on the kind of report generated, which would allow for HTML
allow for HTML reports, rather than simply supporting tabular text. reports, rather than simply supporting tabular text.
Requirements Requirements
------------ ------------
Timewarrior will ship with several reports, which serve as example extensions Timewarrior will ship with several reports, which serve as example extensions
for users to evolve. for users to modify and improve.
Timewarrior should handle the command line options for reports, then pass off Timewarrior will handle the command line options for reports, then pass off a
a standardized set of parameters to the report extension. These parameters will standardized set of parameters to the report extension. These parameters will
include: include:
- Date range. Although Timewarrior might support "last month" as a reporting - Date range. Although Timewarrior might support "last month" as a reporting
@ -30,7 +30,7 @@ include:
width. If a report does not fit in a window, it is not an error. width. If a report does not fit in a window, it is not an error.
There will be a default report, which is configurable so that one of the reports There will be a default report, which is configurable so that one of the reports
can be hte default. or commands can be the default.
Report Mockups Report Mockups
@ -76,7 +76,7 @@ With standard input consisting of:
... ...
] ]
That is, the input it line-oriented, with first a header block of name/value That is, the input is line-oriented, with first a header block of name/value
pairs, then a blank line, then the JSON filtered data. The header block has all pairs, then a blank line, then the JSON filtered data. The header block has all
configuration names flattened, i.e. no hierarchy. configuration names flattened, i.e. no hierarchy.