From c9e41c1f3540cb66edfee64b881ec2e53259b83e Mon Sep 17 00:00:00 2001 From: callumalpass Date: Mon, 8 Jun 2026 19:39:53 +1000 Subject: [PATCH] clarify default base file docs --- docs/features/inline-tasks.md | 2 +- docs/settings/general.md | 8 ++++++++ docs/settings/integrations.md | 8 +++++--- docs/troubleshooting.md | 2 +- docs/views/agenda-view.md | 2 +- docs/views/task-list.md | 2 +- 6 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/features/inline-tasks.md b/docs/features/inline-tasks.md index 664db703..95ab705d 100644 --- a/docs/features/inline-tasks.md +++ b/docs/features/inline-tasks.md @@ -198,7 +198,7 @@ These settings are replaced in v4 by: - `showRelationships` and `relationshipsPosition` -If you had project subtasks enabled in v3, the relationships widget is enabled automatically after upgrading to v4. The underlying Bases file changed from `TaskNotes/Views/project-subtasks.base` to `TaskNotes/Views/relationships.base`. Run the **Create default files** action in `Settings -> TaskNotes -> Integrations` if `relationships.base` is missing. +If you had project subtasks enabled in v3, the relationships widget is enabled automatically after upgrading to v4. The underlying Bases file changed from `TaskNotes/Views/project-subtasks.base` to `TaskNotes/Views/relationships.base`. Run the **Create files** action in `Settings -> TaskNotes -> General -> Views & base files` if `relationships.base` is missing. ## Natural Language Processing diff --git a/docs/settings/general.md b/docs/settings/general.md index 0b766c3a..4e1c5061 100644 --- a/docs/settings/general.md +++ b/docs/settings/general.md @@ -18,6 +18,8 @@ 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. +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. + ### 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. @@ -42,6 +44,12 @@ If your task identification tag is `task` and a task has the tags `#task`, `#tas Use **Excluded folders** to omit paths from Notes tab indexing and keep large archive areas out of regular task browsing. +## 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. diff --git a/docs/settings/integrations.md b/docs/settings/integrations.md index cf3fbd05..755ace6d 100644 --- a/docs/settings/integrations.md +++ b/docs/settings/integrations.md @@ -5,7 +5,7 @@ These settings control the integration with other plugins and services, such as ![Integrations Settings](../assets/settings-integrations.png) -## Bases Integration +## Bases TaskNotes v4 uses Obsidian's Bases core plugin for its main views. For setup instructions, see [Core Concepts](../core-concepts.md#bases-integration). @@ -13,7 +13,7 @@ TaskNotes v4 uses Obsidian's Bases core plugin for its main views. For setup ins View command settings map TaskNotes commands and ribbon actions to specific `.base` files. This is useful when you maintain custom variants of the default views and want first-class command access to those files. -Access these settings in **Settings → TaskNotes → General → View Commands**. +Access these settings in **Settings → TaskNotes → General → Views & base files**. Default mappings: @@ -27,7 +27,9 @@ Default mappings: Each command allows you to specify a custom `.base` file path and includes a reset button to restore the default path. -**Create Default Files**: Button to generate all default `.base` files in the `TaskNotes/Views/` directory. Existing files are not overwritten. +**Auto-create default files**: When enabled, TaskNotes creates missing default `.base` files automatically on startup. + +**Create files**: Button to generate all default `.base` files in the `TaskNotes/Views/` directory. Existing files are not overwritten. The generated Pomodoro statistics Base reads Pomodoro sessions from daily notes frontmatter. If your Pomodoro history is still stored in plugin data, migrate it from **Settings → TaskNotes → Features** before using that Base file. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 82152fe4..941c43e5 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -10,7 +10,7 @@ When debugging, start with the smallest reproducible scenario: one affected task **Symptoms**: TaskNotes views show errors or don't display tasks -First confirm Bases is enabled (`Settings -> Core Plugins -> Bases`), then restart Obsidian once. If views are still missing, verify `.base` files exist in `TaskNotes/Views/`. If needed, regenerate defaults from `Settings -> TaskNotes -> Integrations` (`Create default files`). +First confirm Bases is enabled (`Settings -> Core Plugins -> Bases`), then restart Obsidian once. If views are still missing, verify `.base` files exist in `TaskNotes/Views/`. If needed, regenerate defaults from `Settings -> TaskNotes -> General -> Views & base files` (`Create files`). ### Commands Open Wrong Files diff --git a/docs/views/agenda-view.md b/docs/views/agenda-view.md index 6a33de70..19adff39 100644 --- a/docs/views/agenda-view.md +++ b/docs/views/agenda-view.md @@ -11,7 +11,7 @@ The Agenda view is a dedicated `.base` file that opens the calendar in list mode - Command: **Open Agenda View** (ribbon icon and command palette) - Configure the file path in **Settings → TaskNotes → General → View Commands** -The file is created automatically the first time you run the command, and you can replace it with your own `.base` file if you maintain multiple agendas. +TaskNotes creates missing default `.base` files automatically on startup when **Auto-create default files** is enabled. You can replace the command path with your own `.base` file if you maintain multiple agendas. ## Default Configuration diff --git a/docs/views/task-list.md b/docs/views/task-list.md index c4fd48d6..321ad1ec 100644 --- a/docs/views/task-list.md +++ b/docs/views/task-list.md @@ -22,7 +22,7 @@ If commands open empty or unexpected views, first confirm Bases is enabled and t ### View File Location -When you use the "Open Tasks View" command or ribbon icon, TaskNotes opens the `.base` file configured under `Settings -> TaskNotes -> General` (`View Commands`) (initially `TaskNotes/Views/tasks-default.base`). The default file is created automatically the first time you use the command, and you can point the command to any other `.base` file if you maintain multiple task-list layouts. +When you use the "Open Tasks View" command or ribbon icon, TaskNotes opens the `.base` file configured under `Settings -> TaskNotes -> General -> Views & base files` (initially `TaskNotes/Views/tasks-default.base`). TaskNotes creates missing default `.base` files automatically on startup when **Auto-create default files** is enabled, and you can point the command to any other `.base` file if you maintain multiple task-list layouts. ## Configuration