New plugin: taskreport
[ikiwiki.git] / doc / plugins / contrib / taskreport.mdwn
1 [[!template id=plugin name=taskreport author="[[Louis|spalax]]"]]
2
3 # Taskreport
4
5 The taskreport plugin provides the `task` directive (see below), displaying
6 [taskwarrior](http://taskwarrior.org) data as a table.
7
8 ## Plugin options
9
10 * `task_bin`: path to the task binary. Default is "task".
11 * `task_common`: arguments to all task calls. Can be used, for example, to set
12   a non-default taskrc location.
13 * `task_dir`: directory where to find task data files, if non-default. This
14   directory must be handled by IkiWiki. Otherwise, use the `task_common`
15   argument. This argument must be relative to the root of the wiki sources.
16 * `task_tmpdir`: directory where to copy task data files before calling task.
17   It can be used to circumvent [[lack of `--read-only`
18   option|http://taskwarrior.org/issues/424]]. Otherwise, those data files may
19   be modified by the task call. Setting this directory ensure that they are
20   not. This argument should be absolute (I do not know what would happen
21   otherwise).
22 * `task_columns`: List of default columns to display with the
23   [[task|ikiwiki/directive/task]] directive. Default is all available columns.
24
25
26 ## Directive
27
28 ### Directive options
29
30 Options are:
31
32 * `arg`: arguments to add to the task call. For example, to display a list of
33   pending tasks tagged `ikiwiki`, set it to `"status:pending +ikiwiki"`.
34 * `show`: number of tasks to show. Default is 0, and means: print all tasks.
35 * `sort`: tasks are sorted according to this column. Default is `urgency`.
36 * `reverse`: set yes to reverse order.
37 * `annotations`: set to yes to display annotations. Default is "yes".
38
39 ### Task system call
40
41 When using this directive, the result of the following system call is printed:
42
43     TASK_BIN export rc.verbose=nothing TASK_COMMON [rc.data.location=DIR] ARG
44
45 * `TASK_BIN` and `TASK_COMMON` are the `task_bin` and `task_common` options set in ikiwiki setup.
46 * If `task_dir` and `task_tmpdir` are set in ikiwiki setup, `DIR` is `task_tmpdir` ; if only `task_dir` is set, `DIR` is `task_dir` ; otherwise, this part is not used.
47 * `ARG` is the `arg` option of the directive.
48
49 ### CSS
50
51 To allow CSS customization, the following classes are used.
52
53 * `task` is the class of the table.
54 * `urgency`, `project`, etc. are the class of the `th` and `td` elements for the corresponding task attributes.
55 * `annotation` is the class of the `tr` element of the table containing an annotation.
56
57
58 ## Download and install
59
60 Code and documentation can be found here : [[https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Jscalendar]]
61
62 -- Louis