Docs: Added some report specifics

This commit is contained in:
Paul Beckingham 2015-12-18 09:11:18 -05:00
parent e119e7a779
commit bb03749a40

View file

@ -2,11 +2,12 @@ Reporting
=========
Some basic requirements:
- Reports can be filtered by date range and/or tags.
- Reports should have multiple output formats: TTY, JSON, HTML.
- There will be a few different types of reports:
- Tabular Calendar
- List with subtotals, total
- Reports will be decorated, for example, subtotals, legend, title
- Reports will be decorated, for example, subtotals, legend, title.
- It should be possible to extend Timewarrior to add custom reports, via a
simple hook mechanism.
@ -15,7 +16,13 @@ Report Mockups
--------------
Purely as an example of what might be implemented, here are some report mockups:
...
... (calendar like "task calendar" with table below)
... (large weekly calendar, 5 days, every half-hour)
... (timeline, l-r)
... (table with subtotals)
---
@ -42,8 +49,12 @@ F: good.
P: But yes, most people will want custom, I expect. The number of reports would grow over time I think.
P: reports.txt
There is very little here, so I just want to list a few simple reports in different forms, like a calendar (like tw), and maybe in a couple of different formats. Maybe something in HTML, maybe not.
I think the variations are going to be things like a title, sort by this, break by that, subtotal by this etc.
We could actually provide all reports as extension scripts. Might not be a bad idea.
P: I think the variations are going to be things like:
- a title
- sort by this
- break by that
- subtotal by this
We could provide all reports as extension scripts. Might not be a bad idea.