mirror of
https://github.com/tbabej/taskwiki.git
synced 2025-08-18 21:33:07 +02:00
Add documentation for preset headers
This commit is contained in:
parent
5bf0c89ae8
commit
f35d1a29f4
2 changed files with 53 additions and 0 deletions
26
README.md
26
README.md
|
@ -139,6 +139,32 @@ In such case, you can specify the defaults explicitly:
|
|||
|
||||
Viewports can be inspected by hitting [CR] with cursor above them.
|
||||
|
||||
#### Preset headers
|
||||
|
||||
A preset header has a similar syntax to a viewport:
|
||||
|
||||
== Home tasks || project:Home ==
|
||||
|
||||
In contrast to viewports it does not generate a list of associated tasks.
|
||||
Instead it sets a filter for all viewports and default attributes for all new
|
||||
tasks in the corresponding section.
|
||||
|
||||
Like with viewports for complex filters the default attributes can be given
|
||||
manually.
|
||||
|
||||
== Home tasks || project:house or project:garden || project:house ==
|
||||
|
||||
Multiple levels of preset headers are chained. So you can do this:
|
||||
|
||||
== Taskwiki development || project:Taskwiki ==
|
||||
* Non-task notes
|
||||
=== Bugs || +bugs ===
|
||||
* [ ] Bug #42
|
||||
=== Features || +features ===
|
||||
* [ ] Some Feature
|
||||
|
||||
Here both tasks are assigned the Taskwiki project, as well the respective tag.
|
||||
|
||||
#### Report splits
|
||||
|
||||
Taskwiki can provide additional information reports on a task list (selected,
|
||||
|
|
|
@ -105,6 +105,33 @@ In such case, you can specify the defaults explicitly:
|
|||
|
||||
Viewports can be inspected by hitting [CR] with cursor above them.
|
||||
|
||||
----------------------------------------------------------------------------
|
||||
Preset headers
|
||||
|
||||
A preset header has a similar syntax to a viewport:
|
||||
|
||||
~ == Home tasks || project:Home ==
|
||||
|
||||
In contrast to viewports it does not generate a list of associated tasks.
|
||||
Instead it sets a filter for all viewports and default attributes for all new
|
||||
tasks in the corresponding section.
|
||||
|
||||
Like with viewports for complex filters the default attributes can be given
|
||||
manually.
|
||||
|
||||
~ == Home tasks || project:house or project:garden || project:house ==
|
||||
|
||||
Multiple levels of preset headers are chained. So you can do this:
|
||||
|
||||
~ == Taskwiki development || project:Taskwiki ==
|
||||
~ * Non-task notes
|
||||
~ === Bugs || +bugs ===
|
||||
~ * [ ] Bug #42
|
||||
~ === Features || +features ===
|
||||
~ * [ ] Some Feature
|
||||
|
||||
Here both tasks are assigned the Taskwiki project, as well the respective tag.
|
||||
|
||||
----------------------------------------------------------------------------
|
||||
Report splits
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue