Configuration
Periodix-Planner offers comprehensive configuration options to customize the plugin to your workflow and preferences.
Settings Overview
Access settings via Settings → Periodix-Planner. The settings are organized into tabs:
- Folders - Configure where notes are stored
- Naming - Customize note naming formats
- Time budget - Set available hours per period
- Categories - Define time investment categories
- Properties - Customize frontmatter property names
- Generation - Control auto-generation behavior
Folders Tab
Configure where periodic notes are stored in your vault.
| Setting | Description | Default |
|---|---|---|
| Daily Folder | Where daily notes are stored | Periodic/Daily |
| Weekly Folder | Where weekly notes are stored | Periodic/Weekly |
| Monthly Folder | Where monthly notes are stored | Periodic/Monthly |
| Quarterly Folder | Where quarterly notes are stored | Periodic/Quarterly |
| Yearly Folder | Where yearly notes are stored | Periodic/Yearly |
Note: Folders are created automatically if they don't exist.
Learn more about note generation
Naming Tab
Customize how periodic notes are named using Luxon format tokens.
| Period | Setting | Default Format | Example |
|---|---|---|---|
| Daily | Daily Format | YYYY-MM-DD | 2025-01-15 |
| Weekly | Weekly Format | YYYY-[W]WW | 2025-W03 |
| Monthly | Monthly Format | YYYY-MM | 2025-01 |
| Quarterly | Quarterly Format | YYYY-[Q]Q | 2025-Q1 |
| Yearly | Yearly Format | YYYY | 2025 |
Common format tokens:
YYYY- 4-digit yearMM- 2-digit monthDD- 2-digit day[W]WW- Week number with "W" prefix[Q]Q- Quarter number with "Q" prefix
Time Budget Tab
Configure available hours for each period type and inheritance behavior.
| Setting | Description | Default |
|---|---|---|
| Hours per Week | Base weekly hour budget for planning | 40 |
| Automatically inherit parent percentages | Auto-fill child periods with parent's allocation distribution | false |
Hours calculations:
- Monthly = Weekly × 4.33
- Quarterly = Monthly × 3
- Yearly = Quarterly × 4
Enable auto-inherit to fill child periods based on parent percentages. Learn more
Categories Tab
Define your time investment categories for budget tracking.
Adding categories:
- Click Add Category
- Enter category name
- Choose color (hex format)
- Click Save
Managing categories:
- Click category to edit
- Delete removes category from all allocations
Properties Tab
Customize frontmatter property names used for note interconnection.
| Setting | Description | Default |
|---|---|---|
| Previous Property | Property name for previous period link | Previous |
| Next Property | Property name for next period link | Next |
| Parent Property | Property name for parent period link | Parent |
| Week Property | Property name for week link | Week |
| Month Property | Property name for month link | Month |
| Quarter Property | Property name for quarter link | Quarter |
| Year Property | Property name for year link | Year |
| Hours Available Property | Property name for available hours | Hours Available |
Learn more about note interconnection
Generation Tab
Control automatic note generation behavior and which period types to enable.
Note Generation
| Setting | Description | Default |
|---|---|---|
| Auto-generate on load | Automatically generate the next period's note when Obsidian loads | true |
| Generate periods ahead | How many periods into the future to generate (1-5) | 1 |
When enabled, the plugin generates notes when Obsidian opens and creates future periods automatically while respecting existing notes.
Enabled Period Types
Select which period types to generate and track. Disabled periods will be skipped in navigation and time budget calculations.
| Setting | Description | Default |
|---|---|---|
| Enable daily notes | Generate and track daily periodic notes | true |
| Enable weekly notes | Generate and track weekly periodic notes | true |
| Enable monthly notes | Generate and track monthly periodic notes | true |
| Enable quarterly notes | Generate and track quarterly periodic notes | true |
| Enable yearly notes | Generate and track yearly periodic notes | true |
How it works:
- Disabled period types are completely skipped in the hierarchy
- Navigation automatically jumps to the next enabled period type
- Time budget calculations adjust based on enabled periods
- Parent/child relationships adapt to your enabled periods
Example: If you disable weekly notes, daily notes will link directly to monthly notes as their parent, and monthly notes will show daily notes as children.
Learn more about note generation and note interconnection
Next: Check out the FAQ for common questions about configuration.