New 'Calendar note Sections to Include' setting for DBW to test

Author: jgclark

jgclark.Dashboard/CHANGELOG.md

@@ -10,6 +10,10 @@ For more details see the [plugin's documentation](https://github.com/NotePlan/pl
 -->
 <!-- - ??? dev: check winowID throughout -->
 
+## [2.4.0.b17] 2026-01-21
+### New
+- added new way to select items to show from Calendar sections: "Calendar note Sections to Include". There is already a way to exclude specific sections in a calendar note; this adds a way to only include specific sections. The matches are partial, so 'Home' will include 'Home' and 'The Home Areas' etc. If left blank, all sections are still included.
+
 ## [2.4.0.b16] 2026-01-20
 ### Fixes
 - suppress "showing all 0 items" message when "nothing on this list" message also appears

jgclark.Dashboard/plugin.json

@@ -8,7 +8,7 @@
   "plugin.description": "A Dashboard for NotePlan, that in one place shows:\n- a compact list of open tasks and checklists from today's note\n- scheduled open tasks and checklists from other notes.\n- similarly for yesterday's note, tomorrow's note, and the weekly, monthly and quarterly notes too (if used)\n- all overdue tasks\n- all open tasks and checklists that contain particular @tags or #mentions of your choosing\n- the next notes ready to review (if you use the 'Projects and Reviews' plugin).\nIt includes many other ways of speeding up managing your tasks: see the website for more details.",
   "plugin.author": "@jgclark",
   "plugin.comment": "TODO: On full release, change minAppVersion down to 3.7?",
-  "plugin.version": "2.4.0.b16",
+  "plugin.version": "2.4.0.b17",
   "plugin.releaseStatus": "beta",
   "plugin.hidden": false,
   "plugin.lastUpdateInfo": "2.4.0: new 'Spaces to Include' setting which controls which (Team)Spaces you wish to include, plus whether or not to include the Private 'Space' (all notes not in a Space)\n2.3.3: new 'Year' section available.\n2.3.2: fix display when there are no priority items shown.\n2.3.1: fix for possible loss of settings error when upgrading.\n2.3.0: Support for NotePlan (Team)Spaces. Can re-order display of Sections.New '/backupSettings' command. Added 'noteTags' feature. Speeded up Tag/Mention sections. Layout improvements. Lots of other small fixes and improvements.\n2.2.1: Add new sorting option for Tag and Overdue sections.\n2.2.0: Add 'Search' section. New keyboard shortcuts. Plus many small improvements, bug fixes and performance improvements. See documentation for details.\n2.1.10: More move-under-heading options. Bug fixes and performance improvements.\n2.1.9: performance improvements and better UI for iPhone users.\n2.1.8: various fixes and small improvements.\n2.1.7: various fixes and small improvements.\n2.1.6: allow all current timeblocks to be shown, not just the first. Add new @repeat()s if using the extended syntax from the Repeat Extensions plugin. Bug fixes.\n2.1.5: fixes to time blocks and scheduling items.\n2.1.4: fix to Interactive Processing, and Edit All Perspectives dialog now shows unsaved changes.",

jgclark.Dashboard/src/dashboardHelpers.js

@@ -427,17 +427,18 @@ export function getOpenItemParasForTimePeriod(
     const latestDate = todayHyphenated > theNoteDateHyphenated ? todayHyphenated : theNoteDateHyphenated
     // logDebug('getOpenItemPFCTP', `timeframe:${calendarPeriodName}: theNoteDateHyphenated: ${theNoteDateHyphenated}, todayHyphenated: ${todayHyphenated}, isToday: ${String(isToday)}`)
 
-    // Keep only non-empty open tasks (and checklists if wanted),
-    // and now add in other timeblock lines (if wanted), other than checklists (if excluded)
+    // Keep only non-empty open tasks and checklists,
+    // and now add in other timeblock lines if wanted
     let openParas = alsoReturnTimeblockLines ? parasToUse.filter((p) => isOpen(p) || isActiveOrFutureTimeBlockPara(p, mustContainString)) : parasToUse.filter((p) => isOpen(p))
     logDebug('getOpenItemPFCTP', `- after initial pull: ${openParas.length} para(s):`)
 
+    // Filter out checklists, if requested
     if (dashboardSettings.ignoreChecklistItems) {
       openParas = openParas.filter((p) => !(p.type === 'checklist'))
       logDebug('getOpenItemPFCTP', `- after filtering out checklists: ${openParas.length} para(s)`)
     }
 
-    // Filter out checklists with timeblocks, if wanted
+    // Filter out checklists with timeblocks, if requested
     if (dashboardSettings.excludeChecklistsWithTimeblocks) {
       openParas = openParas.filter((p) => !(p.type === 'checklist' && isActiveOrFutureTimeBlockPara(p, mustContainString)))
     }
@@ -459,7 +460,10 @@ export function getOpenItemParasForTimePeriod(
     // Filter out anything from 'ignoreItemsWithTerms' setting
     openParas = filterParasByIgnoreTerms(openParas, dashboardSettings, startTime, 'getOpenItemPFCTP')
 
-    // Additionally apply to calendar headings in this note
+    // Filter out anything not matching 'includedCalendarSections' setting, if set
+    openParas = filterParasByIncludedCalendarSections(openParas, dashboardSettings, startTime, 'getOpenItemPFCTP')
+
+    // Filter out anything matching 'ignoreItemsWithTerms' setting, if set
     openParas = filterParasByCalendarHeadingSections(openParas, dashboardSettings, startTime, 'getOpenItemPFCTP')
 
     // -------------------------------------------------------------
@@ -670,6 +674,35 @@ export function filterParasByIgnoreTerms(
   return filteredParas
 }
 
+/**
+ * Filter paragraphs to only include those from included calendar sections.
+ * @param {Array<TParagraph>} paras - paragraphs to filter
+ * @param {TDashboardSettings} dashboardSettings - dashboard settings containing included calendar sections
+ * @param {Date} startTime - timer start time for logging
+ * @param {string} functionName - name of calling function for logging
+ * @returns {Array<TParagraph>} filtered paragraphs
+ */
+export function filterParasByIncludedCalendarSections(
+  paras: Array<TParagraph>,
+  dashboardSettings: TDashboardSettings,
+  startTime: Date,
+  functionName: string
+): Array<TParagraph> {
+  if (!dashboardSettings.includedCalendarSections) {
+    return paras
+  }
+
+  const filteredParas = paras.filter((p) => {
+    // only apply to calendar notes
+    if (p.note?.type !== 'Calendar') return true
+    // Apply to all H4/H3/H2 headings in the hierarchy for this para
+    const theseHeadings = getHeadingHierarchyForThisPara(p)
+    return theseHeadings.some((h) => dashboardSettings.includedCalendarSections.includes(h))
+  })
+  logTimer(functionName, startTime, `- after filtering out calendar headings: ${filteredParas.length} paras`)
+  return filteredParas
+}
+
 /**
  * Filter paragraphs to exclude those with disallowed terms in calendar heading sections.
  * @param {Array<TParagraph>} paras - paragraphs to filter

jgclark.Dashboard/src/dashboardSettings.js

@@ -99,7 +99,16 @@ export const dashboardSettingDefs: Array<TSettingItem> = [
     key: 'includedFolders',
     label: 'Folders to Include',
     description:
-      "Comma-separated list of folder(s) to include when searching for open or closed tasks/checklists. The matches are partial, so 'Home' will include 'Home' and 'The Home Areas' etc. If left blank, all folders are included. Note: Calendar notes are always included, where relevant.",
+      "Comma-separated list of folder(s) to include when selecting open items to show. The matches are partial, so 'Home' will include 'Home' and 'The Home Areas' etc. If left blank, all folders are included. Note: Calendar notes are always included, where relevant.",
+    type: 'input',
+    default: '',
+    compactDisplay: true,
+  },
+  {
+    key: 'includedCalendarSections',
+    label: 'Calendar note Sections to Include',
+    description:
+      "Comma-separated list of calendar note section headings to include when selecting open tasks/checklists to show. The matches are partial, so 'Home' will include 'Home' and 'The Home Areas' etc. If left blank, all sections are included.",
     type: 'input',
     default: '',
     compactDisplay: true,
@@ -108,13 +117,12 @@ export const dashboardSettingDefs: Array<TSettingItem> = [
     key: 'excludedFolders',
     label: 'Folders to Exclude',
     description:
-      "Comma-separated list of folder(s) to ignore when searching for open or closed tasks/checklists. The matches are partial, so 'Work' will exclude 'Work' and 'Work/CompanyA' etc. To ignore notes at the top-level (not in a folder), include '/' in the list. (@Trash is always ignored, but other special folders need to be specified, e.g. @Archive, @Templates.)",
+      "Comma-separated list of folder(s) to ignore when selecting open tasks/checklists to show. The matches are partial, so 'Work' will exclude 'Work' and 'Work/CompanyA' etc. To ignore notes at the top-level (not in a folder), include '/' in the list. (@Trash is always ignored, but other special folders need to be specified, e.g. @Archive, @Templates.)",
     type: 'input',
     default: '@Archive, @Templates, Saved Searches',
     compactDisplay: true,
   },
   {
-    // Note: replaces earlier "ignoreTagMentionsWithPhrase" which applied only to the Tag/Mention section
     key: 'ignoreItemsWithTerms',
     label: 'Ignore items in notes with term(s)',
     description:

np.installer/plugin.json

@@ -21,7 +21,7 @@
 			"name": "development install",
 			"description": "Load a list of plugins and lets you install one, including hidden ones",
 			"jsFunction": "installPluginsIncludingHidden"
-		},
+		}
 	],
 	"plugin.preferences": []
 }