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