445a5a0dd5
Persist each column's collapsed/expanded state in the Base view file
(key folded_{periodType}) and restore it on reopen, gated by a new
global "Remember column state" setting (default on).
- FoldableColumn: initiallyFolded + onFoldChange options.
- View createColumn: restore from / persist to Base config when enabled.
- New global setting rememberColumnState (type, default, load, tab).
- Config-key helper getColumnFoldedConfigKey + spec. Docs updated.
6.4 KiB
Configuration
Plugin Settings
Located in Settings → Community plugins → Journal Bases.
Period Type Settings
Each period type (daily, weekly, monthly, quarterly, yearly) has:
| Setting | Description |
|---|---|
| Enabled | Toggle this period type on/off |
| Folder | Vault path where notes are stored (e.g., Journal/Daily) |
| Format | Moment.js format string for filenames |
| Template | Path to Templater template file |
Done Status
| Setting | Default | Description |
|---|---|---|
| Property name | periodic_review_completed |
Frontmatter property used to mark notes as done |
Periodic Review
| Setting | Type | Default | Description |
|---|---|---|---|
| Collapse frontmatter | Toggle | On | Fold a note's YAML frontmatter when it opens in a column |
| Remember column state | Toggle | On | Persist each column's collapsed state in the Base file |
Global settings (not per-Base view options), so each switch applies to every
Periodic Review base. Plugin-specific like donePropertyName, so they survive
Periodic Notes settings sync.
- Collapse frontmatter — implemented via
EmbeddableEditor.foldFrontmatter(); only takes effect in source mode (the mode the review view forces). - Remember column state — on fold/unfold, the column's state is written to the
Base view config via
config.set('folded_{periodType}', folded)and restored on open. Disabling stops writes immediately and columns open expanded; any previously stored keys are ignored while off.
Settings Sync
When Periodic Notes plugin is enabled with meaningful configuration:
- Settings are synced automatically from Periodic Notes
- Plugin settings become read-only
- Settings persist even if Periodic Notes is later disabled
Sync criteria: At least one period type must have enabled=true AND non-empty folder.
View Configuration
View-specific options are configured per Base view instance via the view options menu.
Periodic Notes View
| Option | Type | Default | Description |
|---|---|---|---|
| Period type | Dropdown | Daily | Which period type to display |
| Future periods | Slider | 1 | Number of future periods (0-12) |
| Expand first card | Toggle | On | Auto-expand the most recent card |
| Show missing periods | Toggle | On | Show create buttons for missing notes |
Periodic Review View
| Option | Type | Default | Description |
|---|---|---|---|
| Show daily column | Toggle | On | Display daily column |
| Show weekly column | Toggle | On | Display weekly column |
| Show monthly column | Toggle | On | Display monthly column |
| Show quarterly column | Toggle | Off | Display quarterly column |
| Show yearly column | Toggle | Off | Display yearly column |
| Column width | Slider | 400 | Column width in pixels (300-600) |
Column toggles only appear for period types enabled in plugin settings.
Date Format Reference
Uses Moment.js format tokens. Common patterns:
| Token | Output | Example |
|---|---|---|
YYYY |
4-digit year | 2025 |
MM |
2-digit month | 01-12 |
MMMM |
Full month name | January |
MMM |
Short month name | Jan |
DD |
2-digit day | 01-31 |
dddd |
Full weekday name | Saturday |
ddd |
Short weekday name | Sat |
gggg |
ISO week year | 2025 |
ww |
ISO week | 01-53 |
[Q] |
Literal "Q" | Q |
Q |
Quarter | 1-4 |
[text] |
Literal text | text |
Decorative / redundant tokens (e.g. weekday name dddd, or a month name
alongside the month number as in YYYY-MM-MMMM) are supported for both formatting
and detection. date-utils converts Moment tokens to date-fns and reverse-parses
filenames; because date-fns parse rejects some combinations Moment accepts
(weekday name + yyyy; duplicate month tokens), parseDateFromFormat falls back to
a tolerant regex extractor (parseDateFromFormatTolerant) when the direct parse
fails. See documentation/history/2026-06-30.md (issue #42).
Default Formats:
- Daily:
YYYY-MM-DD - Weekly:
gggg-[W]ww - Monthly:
YYYY-MM - Quarterly:
YYYY-[Q]Q - Yearly:
YYYY
Path in Format: Formats can include / for folder structure:
YYYY/MM/YYYY-MM-DDcreates2025/12/2025-12-18.md
Required Plugins
Templater (Optional)
Required for template-based note creation.
- Plugin ID:
templater-obsidian - Templates specified in period settings
- Without Templater: Notes created empty
Periodic Notes (Optional)
Settings sync when enabled.
- Plugin ID:
periodic-notes - Settings auto-sync on changes
- Synced settings are read-only
Life Tracker (Optional)
Command integration.
- Plugin ID:
life-tracker - Provides
getFiles()viaLifeTrackerPluginFileProvider - Returns focused card's file or all visible files
Base Configuration
The plugin registers two Base view types:
| View Type | ID | Icon |
|---|---|---|
| Periodic Notes | periodic-notes |
calendar |
| Periodic Review | periodic-review |
columns |
To use: Create a Base → Switch view type → Select "Periodic Notes" or "Periodic Review".
Base Query Requirements
The Base query should return files matching your periodic notes:
- Filter by folder path
- No specific frontmatter required
- Note detection uses folder path matching
- Date extraction uses filename parsing
Example filter: path contains "Journal/Daily"