# Presets ## What are Presets? Presets allow you to save commonly used task query instructions and reuse them across multiple queries. Instead of repeatedly typing the same complex filters and sorting options, you can define them once in settings and reference them by name. > [!released] > Introduced in Tasks 7.20.0. ## Why Use Presets? Presets are particularly useful when you: - Use the same query patterns frequently. - Want to maintain consistent formatting across multiple task views. - Need to update search criteria in multiple locations (change once, update everywhere). - Use daily notes, all of which share the same task queries. ## How to Define Presets 1. Open Tasks settings. 2. Navigate to the "Presets" section. 3. Add your preset definitions using the format: - **Name**: A simple identifier (e.g., `my_overdue_tasks`) - **Instructions**: One or more valid task query lines > [!Tip] > Any open Tasks queries are reloaded automatically when presets are edited. ## How to Use Presets There are two ways to use presets in your task queries: ### Basic Usage ```text preset preset_name ``` For example: ```text preset my_overdue_tasks ``` ### Placeholder Usage ```text {{preset.preset_name}} ``` For example: ```text {{preset.my_overdue_tasks}} ``` ### When to Use Each Method Use the **basic syntax** (`preset name`) for most cases where you want to include complete instruction lines. Use the **[[Placeholders|placeholder]] syntax** (`{{preset.name}}`) when you need to: - Include presets within [[Combining Filters|Boolean query combinations]] (AND, OR, NOT). - Define partial instruction lines, such as expressions for `filter by function`, `sort by function`, or `group by function`. ## How to Quickly List Your Presets ### See the Available Presets - When the requested preset does not exist, Tasks writes out the list of available Presets, with their first line. - So for a quick reminder, type `preset xxxx` or any other non-existent Preset name, then switch to Reading or Live Preview modes. For example, with the [[#Default Presets|default settings]], using `preset xxxx` would show this in the Tasks search results: <!-- placeholder to force blank line before included text --><!-- include: DocsForPresets.test.presets_help_message.approved.md --> ```text Cannot find preset "xxxx" in the Tasks settings The following presets are defined in the Tasks settings: hide_date_fields : # Hide any values for all date fields... hide_everything : # Hide everything except description and any tags... hide_non_date_fields: # Hide all the non-date fields, but not tags... hide_query_elements : # Hide postpone, edit and backinks... this_file : path includes {{query.file.path}} this_folder : folder includes {{query.file.folder}} this_folder_only : filter by function task.file.folder === query.file... this_root : root includes {{query.file.root}} ``` <!-- placeholder to force blank line after included text --><!-- endInclude --> ### Remembering what your Presets do 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. ## Default Presets The Tasks plugin defines several useful built-in presets, for demonstration purposes: <!-- placeholder to force blank line before included text --><!-- include: DocsForPresets.test.default-presets.approved.md --> | Name | Instruction(s) | | ----- | ----- | | `this_file` | `path includes {{query.file.path}}` | | `this_folder` | `folder includes {{query.file.folder}}` | | `this_folder_only` | `filter by function task.file.folder === query.file.folder` | | `this_root` | `root includes {{query.file.root}}` | | `hide_date_fields` | `# Hide any values for all date fields`<br>`hide due date`<br>`hide scheduled date`<br>`hide start date`<br>`hide created date`<br>`hide done date`<br>`hide cancelled date` | | `hide_non_date_fields` | `# Hide all the non-date fields, but not tags`<br>`hide id`<br>`hide depends on`<br>`hide recurrence rule`<br>`hide on completion`<br>`hide priority` | | `hide_query_elements` | `# Hide postpone, edit and backinks`<br>`hide postpone button`<br>`hide edit button`<br>`hide backlinks` | | `hide_everything` | `# Hide everything except description and any tags`<br>`preset hide_date_fields`<br>`preset hide_non_date_fields`<br>`preset hide_query_elements` | <!-- placeholder to force blank line after included text --><!-- endInclude --> These defaults can, of course, be edited, renamed and deleted. ## Example: Daily Note Presets A common use case is creating presets for daily notes. > [!Tip] > The following presets work when the daily note's file name matches the pattern `YYYY-MM-DD`. **Preset name**: `overdue_tasks` **Instructions**: ```text not done happens before {{query.file.filenameWithoutExtension}} group by function task.happens.format('YYYY-MM') ``` Then use in your daily note: ````text ```tasks preset overdue_tasks ``` ```` **Preset name**: `today_tasks` **Instructions**: ```text not done happens {{query.file.filenameWithoutExtension}} ``` Then use in your daily note: ````text ```tasks preset today_tasks ``` ```` ## Advanced Usage ### Boolean Combinations The placeholder syntax allows presets to be used within Boolean query combinations: ```text ({{preset.work_tasks}}) AND ({{preset.high_priority}}) ``` ### Partial Instructions You can create presets that define partial instruction lines for use with function-based queries: **Preset name**: `filter_home_context` **Instructions**: ```text task.tags.some(tag => tag.includes('#context/home')) ``` **Usage**: ```text filter by function {{preset.filter_home_context}} ``` This approach is particularly useful for complex filter expressions that you want to reuse across multiple queries. ## Limitations - Preset names should not contain spaces or special characters. - When using basic syntax (`preset name`), presets must contain complete, valid instruction lines. - When using placeholder syntax (`{{preset.name}}`), presets can contain partial instruction lines. - Presets are applied exactly as written and cannot be modified when used. - The basic syntax (`preset name`) cannot be used within Boolean query combinations.