callumalpass_tasknotes/docs/settings/general.md

66 lines
4 KiB
Markdown
Raw Permalink Normal View History

# General Settings
These settings control the foundational aspects of the plugin, such as task identification, file storage, and click behavior.
![General Settings](../assets/settings-general.png)
## Task Storage
Task storage settings define where new and inline-created task files are created and how archived tasks are relocated. **Default tasks folder** sets the base location and supports folder template variables, including `{{currentNotePath}}` and `{{currentNoteTitle}}` for creating command-palette or ribbon tasks beside the active note. It also supports date variables such as `{{year}}` and Daily Notes-style date tokens such as `YYYY/MM/DD`. **Folder for inline-created tasks** controls the Create Inline Task command and instant conversion output. Leave it empty to use the default tasks folder, set a fixed folder path to centralize inline tasks, or use `{{currentNotePath}}` and `{{currentNoteTitle}}` placeholders for contextual routing. Relative path segments such as `../` are normalized after variables are expanded. If archive moves are enabled, completed archived tasks are moved automatically to your configured archive folder.
## Task Identification
Feat/Optionally hide identifying tags (Implements FR #937) (#956) * feat: add option to hide identifying tags in task cards Add a new setting "Hide identification tags in task cards" that allows users to hide tags matching the task identification tag (including hierarchical matches) from task card displays. Key features: - Setting only visible when using tag-based identification method - Filters exact matches and hierarchical children (e.g., task/project) - Backward compatible (default: false, shows all tags) - Comprehensive test coverage (14 test cases) Implementation: - Added hideIdentifyingTagsInCards boolean to settings - Conditional UI toggle in settings tab - Tag filtering logic in TaskCard.ts using FilterUtils - i18n translations for new setting Files modified: - src/types/settings.ts - src/settings/defaults.ts - src/settings/tabs/generalTab.ts - src/i18n/resources/en.ts - src/ui/TaskCard.ts - tests/unit/ui/TaskCard.hideIdentifyingTags.test.ts (new) * docs: add documentation for hide identifying tags feature Add comprehensive documentation for the 'Hide identification tags in task cards' setting in the General Settings page. Documentation includes: - Detailed explanation of when the setting is available (tag-based identification only) - How hierarchical tag matching works (exact matches and children) - Visual demo with animated GIF - Practical before/after example - Clarification that tags remain in frontmatter (only visual display is affected) Files added: - docs/assets/demo-hide-identification-tags.gif (visual demo) Files modified: - docs/settings/general.md (expanded Task Identification section)
2025-10-26 00:42:07 +00:00
TaskNotes can identify task notes using either a tag or a frontmatter property.
Use **Identify tasks by** to select a strategy.
- **Tag mode** uses a configured task tag (for example `task`) and can optionally hide that identifying tag in card displays.
- **Property mode** matches a property/value pair (for example `isTask: true` or `category: task`) and is useful when you avoid tag-based identification.
Feat/Optionally hide identifying tags (Implements FR #937) (#956) * feat: add option to hide identifying tags in task cards Add a new setting "Hide identification tags in task cards" that allows users to hide tags matching the task identification tag (including hierarchical matches) from task card displays. Key features: - Setting only visible when using tag-based identification method - Filters exact matches and hierarchical children (e.g., task/project) - Backward compatible (default: false, shows all tags) - Comprehensive test coverage (14 test cases) Implementation: - Added hideIdentifyingTagsInCards boolean to settings - Conditional UI toggle in settings tab - Tag filtering logic in TaskCard.ts using FilterUtils - i18n translations for new setting Files modified: - src/types/settings.ts - src/settings/defaults.ts - src/settings/tabs/generalTab.ts - src/i18n/resources/en.ts - src/ui/TaskCard.ts - tests/unit/ui/TaskCard.hideIdentifyingTags.test.ts (new) * docs: add documentation for hide identifying tags feature Add comprehensive documentation for the 'Hide identification tags in task cards' setting in the General Settings page. Documentation includes: - Detailed explanation of when the setting is available (tag-based identification only) - How hierarchical tag matching works (exact matches and children) - Visual demo with animated GIF - Practical before/after example - Clarification that tags remain in frontmatter (only visual display is affected) Files added: - docs/assets/demo-hide-identification-tags.gif (visual demo) Files modified: - docs/settings/general.md (expanded Task Identification section)
2025-10-26 00:42:07 +00:00
2026-06-08 09:39:53 +00:00
If you change the task tag after creating default Base views, existing `.base` filters will still point at the old tag until you update the default Base files or edit those filters.
Feat/Optionally hide identifying tags (Implements FR #937) (#956) * feat: add option to hide identifying tags in task cards Add a new setting "Hide identification tags in task cards" that allows users to hide tags matching the task identification tag (including hierarchical matches) from task card displays. Key features: - Setting only visible when using tag-based identification method - Filters exact matches and hierarchical children (e.g., task/project) - Backward compatible (default: false, shows all tags) - Comprehensive test coverage (14 test cases) Implementation: - Added hideIdentifyingTagsInCards boolean to settings - Conditional UI toggle in settings tab - Tag filtering logic in TaskCard.ts using FilterUtils - i18n translations for new setting Files modified: - src/types/settings.ts - src/settings/defaults.ts - src/settings/tabs/generalTab.ts - src/i18n/resources/en.ts - src/ui/TaskCard.ts - tests/unit/ui/TaskCard.hideIdentifyingTags.test.ts (new) * docs: add documentation for hide identifying tags feature Add comprehensive documentation for the 'Hide identification tags in task cards' setting in the General Settings page. Documentation includes: - Detailed explanation of when the setting is available (tag-based identification only) - How hierarchical tag matching works (exact matches and children) - Visual demo with animated GIF - Practical before/after example - Clarification that tags remain in frontmatter (only visual display is affected) Files added: - docs/assets/demo-hide-identification-tags.gif (visual demo) Files modified: - docs/settings/general.md (expanded Task Identification section)
2025-10-26 00:42:07 +00:00
### Hide Identification Tags
When using tag-based identification, you may want to keep your task identification tags in the frontmatter for organizational purposes, but hide them from the visual display in task cards to reduce clutter.
The **Hide identification tags in task cards** setting allows you to do this. When enabled:
- Tags that exactly match your task identification tag (e.g., `#task`) will be hidden
- Hierarchical child tags (e.g., `#task/project`, `#task/work/urgent`) will also be hidden
- Other tags that don't match the identification pattern will still be displayed
- The setting only affects the visual display—tags remain in the frontmatter
![Hide identification tags demo](../assets/demo-hide-identification-tags.gif)
**Example:**
If your task identification tag is `task` and a task has the tags `#task`, `#task/project`, `#important`, and `#review`:
- With the setting **disabled** (default): All tags are shown: `#task`, `#task/project`, `#important`, `#review`
- With the setting **enabled**: Only non-identifying tags are shown: `#important`, `#review`
## Folder Management
Use **Excluded folders** to omit paths from Notes tab indexing and keep large archive areas out of regular task browsing.
2026-06-08 09:39:53 +00:00
## Views & Base Files
TaskNotes uses Obsidian Bases files (`.base`) to power its task views. By default, missing view files are created automatically on startup.
Use **Create files** to generate missing default files in `TaskNotes/Views/` without overwriting existing files. Use **Update files** to overwrite the configured default files with templates generated from your current TaskNotes settings.
## Frontmatter
This section only appears when you have markdown links enabled globally in Obsidian settings.
**Use markdown links in frontmatter** switches project/dependency serialization from wikilinks (`[[path]]`) to markdown links (`[text](path)`). This requires the `obsidian-frontmatter-markdown-links` plugin.
## Task Interaction
Task interaction settings define default click behavior on task cards. You can independently choose single-click and double-click actions (edit task, open note, or no action for double click).
## Release Notes
**View release notes** opens the release notes view for the current version. Notes also open automatically after updates and remain available from the command palette.