Skip to content

Commit fcdfd49

Browse files
committed
docs: Show what the Presets help message looks like.
1 parent 19b1cfd commit fcdfd49

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/Queries/Presets.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,30 @@ Use the **[[Placeholders|placeholder]] syntax** (`{{preset.name}}`) when you nee
7373
### See the Available Presets
7474

7575
- When the requested preset does not exist, Tasks writes out the list of available Presets, with their first line.
76-
- So for a quick reminder, type `preset xxxxxxxx` or any other non-existent Preset name, then switch to Reading or Live Preview modes.
76+
- So for a quick reminder, type `preset xxxx` or any other non-existent Preset name, then switch to Reading or Live Preview modes.
77+
78+
For example, with the [[#Default Presets|default settings]], using `preset xxxx` would show this in the Tasks search results:
79+
80+
<!-- placeholder to force blank line before included text --><!-- include: DocsForPresets.test.presets_help_message.approved.md -->
81+
82+
```text
83+
Cannot find preset "xxxx" in the Tasks settings
84+
The following presets are defined in the Tasks settings:
85+
hide_date_fields : # Hide any values for all date fields...
86+
hide_everything : # Hide everything except description and any tags...
87+
hide_non_date_fields: # Hide all the non-date fields, but not tags...
88+
hide_query_elements : # Hide postpone, edit and backinks...
89+
this_file : path includes {{query.file.path}}
90+
this_folder : folder includes {{query.file.folder}}
91+
this_folder_only : filter by function task.file.folder === query.file...
92+
this_root : root includes {{query.file.root}}
93+
```
94+
95+
<!-- placeholder to force blank line after included text --><!-- endInclude -->
7796

7897
### Remembering what your Presets do
7998

80-
- For multi-line presets, you can put a descriptive [[Comments|comment]] on their first line (starting with a `#` character).
99+
As the above example shows, for multi-line presets, it is worth adding a descriptive [[Comments|comment]] on their first line (starting with a `#` character), to remind you of their behaviour.
81100

82101
## Default Presets
83102

0 commit comments

Comments
 (0)