liamcain/obsidian-periodic-notes

Create/manage your daily, weekly, and monthly notes in Obsidian

Periodic Notes ⌚

The Periodic Notes plugin expands on the idea of daily notes and introduces weekly and monthly notes.

Weekly Notes

Commands

Open Weekly Note

Opens the weekly note for the current week. If one doesn't exist, it will create one automatically for you.

Next Weekly Note

Navigates to the next weekly note chronologically. Skips over weeks with no weekly note file.

Note: This command is only available if the active focused note is a weekly note.

Previous Weekly Note

Navigates to the previous weekly note chronologically. Skips over weeks with no weekly note file.

Note: This command is only available if the active focused note is a weekly note.

Calendar Plugin Integration

If you have "Week numbers" enabled from the Calendar plugin, the calendar will automatically use your weekly note settings to create a seamless experience.

Weekly Notes are moving

If you currently use the Calendar plugin, you might be thinking "doesn't the Calendar plugin already do this?" To which the answer is: yes. This plugin provides the same functionality as the Calendar plugin's weekly notes. However, weekly notes are moving away from the Calendar plugin to this one.

Migrating

If you currently use weekly notes with the Calendar plugin, your settings will automatically be migrated over and the calendar plugin still function the same way it did before.

You can create a Daily Note either by clicking on the calendar icon in the left panel, or with the Command palette. You can also set a hotkey in Keyboard shortcuts.

Weekly Settings

Setting	Description
Folder	The folder that your weekly notes go into. It can be the same or different from your daily notes. By default they are placed in your vault root.
Template	Configure a template for weekly notes. Weekly notes have slightly different template tags than daily notes. See here for the list of supported weekly note template tags.
Format	The date format for the weekly note filename. Defaults to gggg-[W]ww. If you use DD in the week format, this will refer to first day of the week (Sunday or Monday, depending on your settings).

Weekly Template Tags

Tag	Description
title	Works the same as the daily note {{title}}. It will insert the title of the note
date, time	Works the same as the daily note {{date}} and {{time}}. It will insert the date and time of the first day of the week. Useful for creating a heading (e.g. # {{date:gggg [Week] ww}}).
sunday, monday, tuesday, wednesday, thursday, friday, saturday, sunday	Because weekly tags refer to main days, you can refer to individual days like this {{sunday:YYYY-MM-DD}} to automatically insert the date for that particular day. Note, you must specify the date format!

Monthly Notes

Commands

Open Monthly Note

Opens the monthly note for the current week. If one doesn't exist, it will create one automatically for you.

Next Monthly Note

Navigates to the next monthly note chronologically. Skips over weeks with no monthly note file.

Note: This command is only available if the active focused note is a monthly note.

Previous Monthly Note

Navigates to the previous monthly note chronologically. Skips over weeks with no monthly note file.

Note: This command is only available if the active focused note is a monthly note.

Calendar Plugin Integration

Coming soon! I just have to figure out a good place to show it in the UI.

Monthly Settings

Setting	Description
Folder	The folder that your monthly notes go into. It can be the same or different from your daily notes. By default they are placed in your vault root.
Template	Configure a template for monthly notes. Monthly notes have slightly different template tags than daily notes. See here for the list of supported monthly note template tags.
Format	The date format for the monthly note filename. Defaults to YYYY-MM. If you use DD in the week format, this will refer to first day of the week (Sunday or Monday, depending on your settings).

Monthly Template Tags

Tag	Description
title	Works the same as the daily note {{title}}. It will insert the title of the note
date, time	Works the same as the daily note {{date}} and {{time}}. It will insert the date and time of the first day of the week. Useful for creating a heading (e.g. # {{date:MMM YYYY}}).

---

FAQ

How do I use a variable in the folder path?

If you want new daily notes to show up in the folder Journal/2021/ for example, you can include the folder in the "Format" field. For example:

Why the weekly note title is wrong with the week number?

Depending on your locale and operating system you are using, you may have been adopting either ISO week (first week of the year is started on the first Thursday) or Week of Year (first week of the year is started on the first day). Obsidian Periodic Notes uses Week of Year by default (ww), but you can change to ISO week by using (WW) instead. For more details, please refer to MomentJS documentation.

---

Sponsors 🙏

A big thank you to everyone that has sponsored this project.

• Carlo Zottman, creator of Actions for Obsidian
• Brian Grohe
• Ben Hong

obsidian-periodic-notes's Issues

Failed to create file when trying to open weekly note

So... This is weird, especially after taking a look at the code both in this repo and obsidian-daily-notes-interface.

---

Whenever I create a weekly note for the first time, everything works as expected. It creates the note in my designated location, and opens it in the editor. However, when I move to another note and invoke the Periodic Notes: Open weekly note command via the command palette, I get the following error in the console:

Failed to create file: 'Journal/Weekly Reviews/2021-W30.md' Error: File already exists.

Which... makes sense. Because the file already exists. But I expected it to just open the weekly note, just like how it works for the daily notes. These are the settings that I'm using at the moment.

The only thing I could think of is it being an issue with the "escape characters" used in the Format. I could imagine that the code checks if the file exists (to already open it) is somehow "fooled" when using a character like this, and that would always return false. At the same time though, I tried running window.app.vault.create("Journal/Weekly Reviews/2021-W30.md"); manually from the console, but got the same error. So I'm kind of lost here. Hope you can help me out! 😄

Open Note in a new Pane (from Ribbon)

Opening a daily note from the calendar (via mouse) or the hotkey, it replaces the current note. Please add the ability to open in a new pane.

Thanks for considering
-JM

FR: Open periodic note in a new pane if it isn't already open

The idea: provide a simple way of opening periodic notes in a new pane, instead of taking over the current pane.

Right now, the options to do so include:

• Remember what day it is (ha!) and use the Quick Switcher to type out the filename for the corresponding periodic note, or find it in the file explorer, and open it as a new pane
• Open an arbitrary new pane (e.g., open the Quick Switcher and just hit enter on the first result), then invoke the Open [period]'s Note command

Pseudocode:

- Invoke command
- Get the filename for the target note
- Get the open panes
- Check open panes: does one have the filename of the target note?
    - if yes, focus on it
    - if no, open a new pane, then open the target note in the newly opened pane

Week Number - customize / ISO 8601

Hi,

Thanks for the plugin.

My issue is: I want this week (feb 22nd 2020 - feb 28th 2020) to count as week 08 of 2021. This is base on the ISO 8601 standard. Couldn't find anyway to change this from default (counted as W09) in Obsidian / this plugin / your calendar plugin.

Changing the locale in Windows only change the week start date.

Can you help / upgrade the plugin.

Ref:
https://www.epochconverter.com/weeks/2021

Unable to create new file

My weekly note settings:

When I select the command "Open Weekly Note" this message appears

This message only appears after a weekly note has been created. However, the weekly note created when I originally select the command "Open Weekly Note" has the week # listed as 36, while the Weekly note settings claim it should be 37

If I delete the current weekly note, then run the command, a new note is created (but with the wrong week # as previously mentioned).
Furthermore, when I select the command "Open Next Weekly Note," provided a weekly note has already been created, will open the first weekly note I created (even if I'm not currently viewing a weekly note).

Daily Note and Monthly Note function as expected.
Daily Note Settings (through Periodic Notes, not through the core daily note pluggin):

Monthly Note Settings:

And, in the off chance that it is relevant, Calendar Note settings

Obsidian Version: v0.12.15
OS: Windows 10, current version as of September 15th, 2021
Hardware: 5 year old Microsoft Surfacebook

Formatting bug when using Week of Year in template

For context, I am trying to add a link from daily notes back to the corresponding weekly note.

Observed behavior:

[[{{date:gggg}}
-W{{date:ww}}]]

[[{{date:gggg}}-W{{date:ww}}]]

Renders as

[[2021
-W14]]

[[2021}}-13{{3amt3:14]]

Desired behavior

[[{{date:gggg}}-W{{date:ww}}]]

should render as

[[2021-W14]]

Open selectable daily note instead of only current

Love the plugin! Thank you so much.

I know it is easy to create weekly and daily notes for other days than today / current week by clicking on the date in the calendar, and you are thinking how to do the same for monthly notes.

I would love to have that functionality in the command pallet: That is in addition to having Open daily note there would be an option:

Periodic notes: Create daily note for selected date

That would allow me to easily create a daily notes for other dates.

My use case is for example:

• Today, I subscribe to a service that renews in a year. I would love to create a daily note for that date to remind me to cancel / renew the subscription.
• Add a daily node in the past for e.g. birthdays.

It would also be very handy if one could insert that note as a link in the current note:

In the case of subscription above, instead of creating the note as suggested and then add the [[link to note]], maybe the option could be:

Periodic notes: Create daily note for selected date and insert link

Do you think this is something worth adding, or should I search for other ways to achieve this functionality?

Blank page in the periodic notes interface

I updated to the latest version of the periodic notes and calendar plugins and clicked to migrate daily and weekly notes settings. After doing this, the periodic notes setting interface becomes blank.

I tried to re-install it and re-start Obsidian, and it did not change anything.

What is the syntax for weekdays of last week?

The syntax for this week's Monday is [[{{monday: gggg-MM-DD}}]]. What is the syntax for last week's Monday? I use Monday as the start of a week.

Thanks!

[Enhancement] Explanation on Week Number

I recently discovered that week number has different standards, as I'm confused about the wrong week number in my Obsidian. According to the MomentJS documentation, there are

1. ISO week, the first week of the year is the first Thursday (adopted by Google Calendar),
2. Week of Year, the first week of the year is counted as the first day (adopted by iOS & macOS)

While Obsidian Periodic Notes uses ww by default, it would be great to add a note explaining the difference between ww and WW, so users can aware of this potential annoyance and change the naming syntax as they want.

My suggested paragraph for FAQ section, feel free to edit:

Why the weekly note title is wrong with the week number?

Depending on your locale and operating system you are using, you may have been adopting either ISO week (first week of the year is started on the first Thursday) or Week of Year (first week of the year is started on the first day). Obsidian Periodic Notes uses Week of Year by default (ww), but you can change to ISO week by using (WW) instead. For more details, please refer to MomentJS documentation

Next/previous hotkeys could combine for better navigation

Thanks for this plugin - it's extremely useful!

I think the current behaviour of the next/previous hotkeys could be changed to make them more useful for fast navigation through daily/weekly/monthly notes. Currently, these hotkeys don't combine effectively, in the sense that if I navigate back a few weeks using the 'previous week' hotkey, then try to use the next day hotkey, it will jump right back to the earliest daily note I have. It's similar if I'm on a daily note and use the 'next week' hotkey. 'Previous' hotkeys don't do anything unless you're on a periodic note of the same kind.

This makes it difficult to efficiently navigate through periodic notes and seems like wasted potential. It's also a little disruptive to accidentally end up at your earliest daily/weekly note by pressing the wrong hotkey.

My suggestion (and I don't know how difficult it would be to implement) is that if you are on a weekly note and use the 'next day' hotkey, it jumps to the Monday of that week. The 'previous day' hotkey could take you to the Sunday of the week before. This could be generalised to all 6 cases where you're on one kind of periodic note and then use a hotkey corresponding to a different kind of periodic note.

If the calendar view also responded to these hotkeys this would be seriously powerful, and I think desirable for people who enjoy the calendar but prefer not to do too much clicking!

Cheers!
Joe.

Week listed in Weekly note does not match calendar week number

Hi,

Whenever I create a Weekly note, the week number is 2 weeks behind the week number listed in the calendar plug-in. For example, the calendar plug-in says that May 23 - May 29 is Week 22, but when I create the note for this week by clicking on the 22 in the calendar, it creates a weekly note for Week 20.

Am I doing something wrong?

Thanks!

Jonathan

P.S. Great plug-in!

Add the word "Today" somewhere in the daily note command

it'd be nice if the "Open Daily Note" command actually read "Open Daily Note for Today", or something. I find typing "Today" into the command palette more intuitive than "daily"

Weeknote opens wrong week (next week)

Hey

When I'm using your (great) plug-in on macOS 11.2.2 (20D80) with Obsidian v0.11.5 and I use the 'Open Weekly Note' function it opens the note of W10. But it is W09 at the moment:

What might be causing this? I already had a note with the name 2021-W09 when I installed you plug-in. Could it be that the plug-in opens 'the last note created' instead of the current week number?

just today on reddit

v.0.11.0—2 of us posted that yesterday’s Daily Note had disappeared…

Add {{yesterday}} to Daily Notes

Would be nice to be able to add a link to yesterdays notes with {{yesterday:gggg-MM-DD}}.
Currently I use Templater but this only works if the note is created on the exact date*.

* using the review plugin a note is often not created on the exact date.

Different daily note templates for different days of the week

I know this isn't exactly what you intended this plugin to be for, but I wonder if the backend functionality could be extended to allow us to create different daily note templates for different days of the week.

This would be extremely useful for people who tend to do the same things on certain weekdays or, probably the most common example, people who have different weekend schedules.

Monthly Template Tags for days of the month

Just wondering whether it’s possible to create a monthly template tag that would list out every day of the month?

Currently there’s a {{Monday}} to {{Sunday}} tags for the weekly template, can there be a {{monthly_dates}} that would generate all the dates within the month?

Use case: This would help with something like a monthly tracker on the monthly pages.

Time doesn't work when using date:

If I have {{date:HH:mm}} in my template, Periodic notes resolves that to 00:00 when creating a new note.

• Inserting the same template into a blank note works,
• Using the default Daily notes core plugin works,
• Using {{time}} works in Periodic notes.

Suggestions don't update when filling out the monthly note template field

When typing in the monthly template text box, the suggestions won't auto-update:

Additional information

Obsidian version: v0.10.13
OS: Ubuntu 18.04
Portable notes: v0.0.6
Calendar: v1.5.0

"Format contains illegal characters" when using emojis and possibly other allowed symbols.

Not a huge issue. Everything still works though if you ignore it. Reason I ran into this is my template is YYYY-MM📅 so they're easier to find in the graph view.

I pinned the issue down to this line.

obsidian-periodic-notes/src/settings/validation.ts

Line 10 in a1f85d0

const allowedChars = /^[a-z0-9_.@()-/\s[\]]+$/i;

The regex is too strict. I would suggest using a regex that matches anything but obsidian's current prohibited characters /^[^*"\\/<>:|?]+$/ although this might still be too strict in the future due to this request probably getting implemented soon: https://forum.obsidian.md/t/list-of-not-allowed-characters-in-the-file-name-make-it-os-specific

Alternatively, error when the user tries to create the note?

Differences between this plugin and Daily Notes

Hey,

Thanks a lot for your work on Obsidian plugins!

I wonder what the differences are between the Daily notes and this plugin. Is it just an extended version?

I'm also curious whether ivan-lednev/obsidian-day-planner#20 will work with this plugin (instead of Daily notes).

Documentation: Add information about how to escape characters in the momentjs formatted strings (e.g. : `YYYY-MM-DD-[weekly]`)

It would be great if the file naming allowed arbitrary text to be included along with the date info e.g. YYYY-MM-DD-"MyText"

[Minor bug] Duplicate tab in plugin options when toggling on/off periodic notes

When toggling on/off periodic notes, it creates duplicate tabs under the plugin options. See screenshot below. Duplicate tabs are removed after restarting obsidian so it's not a big deal.

[BUG] File Dropdown should filter out non-md files

Weekly Notes not recognized

After the weekly notes are created, Periodic Notes does not recognize it and wants to create another weekly note.

See gifs below:
Error produced in a nested folder.

Error reproduced in a test folder at root of the vault.

Periodic Notes Version: 0.0.8

I appreciate your help.

[Feature] Sidebar ribbon button - allow for restoring old behaviour of opening only today note

While more choice is always good forcing users to choose which note to open may break their workflows.
The 2-clicks and hoovering mouse is more friction than 1-click as it was before.

Proposition
Add toggle in Periodic notes setting that will decide about Ribbon button action

• If the user want to open today daily note or want the new menu with an option to choose

An example of how this might be implemented in settings is a Devonlink plugin
https://github.com/ryanjamurphy/DEVONlink-obsidian

Alternatives:
User will use Obsidian default today note plugin to open today note
Possible problems with this approach:

• it will duplicate the setup of today note
• Icons for both plugins are the same

Obsidian 0.11.9
Plugin Verison 0.0.13

Add support for annual/yearly note

I think that besides the already supported daily, weekly and monthly notes, many people's workflow (including mine) could be enhanced by adding an annual/yearly note for each year, tying together the events/projects/reviews etc. for that year. I'm currently using a workaround to generate annual notes, but I'd love to see it supported by the plugin. Plus it seems a natural extension to the already existing types of periodic notes.

Would this request be technically feasible?

Issue parsing weekly note title

Hi, thanks for this great functionality! It worked great until recently I discovered my weekly note cannot be recognized. After some testing, I think this might relate to how I name the files. I am using gggg-[W]ww_MM-DD. If I switch to gggg-[W]ww, it works as expected.

Variables for note folder names

It would be useful to be able to use variables in the folder names so that my journal directory doesn't get so large over time. For example, I could have a directory structure like [journal]/YYYY/W so that end up with a week's worth of notes in a directory together.

Which icon should I click if I just want to activate Weekly / Month note?

Current Behavior

Weekly & monthly note is only accessible by command, while daily note can be accessible by clicking the Calendar Icon on the left icon bar.

Possible Solution

Not sure if there are plans on supporting this but personally I only use Monthly & Weekly notes only, it would be great if

• there are other icons made for day / week / month? OR
• when user click on the icon, there is a modal asking what kind of periodic note do you want to create? I've created a quick mockup for reference

Request: date math in templates

My use case: I have a header on my daily notes that provides a link from today to yesterday and to tomorrow. Currently I just write "yesterday" and "tomorrow" in the template, and when I first create a day's note I manually rewrite the correct date.

It'd be great to automate this a bit more by allowing date math in templates. Something like e.g., {{date:yyyyMMdd[-1d]}} to subtract a day from the date it was generated for.

Thanks for all the great work! ✨

Sidebar icon to open today's note

Hey there, thanks for the awesome work. The only thing missing from the core Daily Notes plugin – for me – is the little sidebar icon to quickly open today's note.

I hope you'll consider it, thanks for the hard work!

Start week on Monday?

The default is Sunday right now for my locale/PC. Is there a way I could make it start on Monday instead? Thanks for the awesome plugin!

Creating a periodic note does not run variables through community Templater

I use the community Templater plugin to run javascript code for variable templates depending on what day it is. For example, I would have the following within my template: <%* tR += moment.weekdays()[new Date().getDay()] %>. When this template is inserted, today's weekday will be returned.

When opening today's note, the plugin loads the template without parsing any delimiters for variables. Is this intended?

Next/Prev Weekly Note Command Not Working

Unable to move forward and back between weekly notes using the command, however can for daily just fine. Also, when I try to navigate to the current weekly note, a notification reads 'Unable to create new file'

See folder structure:

Weekly Note Template:

Plugin Configuration:

No Daily Note Created if File Found in Sub-folder

I use the Calendar and Periodic Notes plugins with the core Daily Note plug in disabled. I created a sub-folder called _Calendar under my _DailyNotes folder for storing my calendar events for the day. When I create the calendar event file (using iCal Buddy) I name the file the same as my daily note file (YYYY-MM-DD.md) and store it in the/_DailyNotes/_Calendar folder. The Calendar event file gets created before the Daily Notes file. When I click on Open Daily Note in Obsidian, it does not create the daily note but it does open the calendar event file even though that file is not in the _DailyNotes folder, it is in the /_DailyNotes/_Calendar folder. My daily note template includes a link to the calendar event file. I have included screen shots of my Periodic Notes parameters and my file system folders that show that today's daily note does not exist. As a workaround, I could make the _Calendar folder at the same level as the _DailyNotes folder, but I would rather keep it subordinate. Thanks.

Open Next [Week|Day] Doesn't Create New File

To replicate behavior I was seeing in my customized plugin, I created an new, empty test vault, installed only periodic-notes and default settings, then create a note for today and this week

When trying to select either "Periodic Notes: Open next weekly note" (or "... next daily note"), nothing happens. Should the plugin be creating the new file?

Multi Instance

First of all, excellent plugin! Calendar and Periodic is a must have!

Would like to request for "Multiple Instances". e.g. Have a multiple calendar locations.
Personal/Journal/2021...
Business/Journal/2021...
School/...
Therapy/...
Whateva...

Thanks for considering
-JM

Quarterly, annually, septimesally reviewing

I’ve got notes for quarter and annum of my work’s fiscal year. It’s fussy and obnoxious. So I figure it’s the perfect edge case to see it’s in scope!

My company’s fiscal year schedule looks like:
FY22 begins 2021-06-01 ends 2025-05-31
FY22Q1 begins 2021-06-01 ends 2021-08-31

Of course, my personal chronicles use gregorian years and quarters beginning at solstices and equinoxes.

Some day I’ll probably lose it and switch to a lunar calendar and want to do my reviews every seven phases of the moon (septimesal!)

Do any of these sound remotely reasonable?

Weekly notes from last year showing up this year

I was using the same Weekly title format before this plugin came along and now weekly notes from last year are already populated in September until the end of December. Not sure how I'll fix this but open to suggestions.

ISO Weekly Notes File Name is not correct

When I create Weekly Note, even when I'm previewing my current syntax in Preference (which W16 is correct), but the note file name, when create, is W15 instead of W16.

The Result:

Open Daily Note at Startup

Thanks for creating this plugin Liam! This, together with the Calendar plugin, are both very well done.

I have a feature request. The Obsidian Daily Note plugin has a configurable parameter that opens the Daily Note at startup. I have found this to be useful because sometimes I forget to create my daily note. But one thing that I can count on is that I am going to open Obsidian everyday and I like that the daily note is the first thing that I see. I currently have the Daily Note core plugin enabled for this feature. I would like to be able to turn off the core Daily Note plugin and just use Calendar with Periodic Notes and Templater and if Periodic Notes had this I could do that.

Another, or additional option, would be for the plugin to create the daily note at a specific time of day if Obsidian is left open for days on end.

Thank you for what you do!

License for the plugin

Which license does this plugin is published?

I would like fork it to create tool for writing lab notes :P

Open daily note via Obsidian uri

First, thanks for the periodic notes plugin! I'm using a iOS shortcut to open today's note, but unfortunately it fails if the note does not exist yet. Therefore my feature request:

Let's make it possible to open today's note via Obsidian's URI scheme - similar to the feature request in the forum.

This should be quite simple to implement, because plugins can use registerObsidianProtocolHandler.

I might even find time to get this done, but wanted to check if that's a feature you'd like to support.

More than one icon at a time in side bar

Hello,

Awesome plugin but I was wondering if it would be possible to have more than one icon in the side bar at a time when more than one option is enabled. E.g. when daily and weekly notes are enabled only one usually daily, will appear on the left hand side. Can it not show both or all 3 if daily, weekly and monthly are enabled?

Templater

Hello
Small question here
Does this plugin works with template created with templater?

Thanks

Enabling Periodic Notes force Calendar plugin to Ignore Daily Notes Obsidian Plugin settings

Enabling Periodic Note force Calendar plugin to Ignore Daily Notes Obsidian Plugin settings, even if Daily Notes setting is disabled

see Here liamcain/obsidian-calendar-plugin#148

Use templates when opening links to weekly/daily/monthly notes

Many of my templates have links to the relevant week/days/months too (eg., all weeks in a month; the days of the week; the week from a day; the month from a week)

When I use the Calendar view or Command Palette to pop into a week/day, the templates are used and populated with links to where the other relevant files will be. Yay!

Buuuuuut when I click into the links in the doc instead of the Calendar view or Command Palette, I end up in an empty note without the template applied 😔

Is there any way for this plugin to hook into that flow?

Feature Request: Allow date formats in folder names

I'm revamping how I do my daily notes (again) and considering using this plugin in conjunction with the Folder Note plugin to create hierarchical folders like the following:

• 01 journal/
  • YYYY/
    • MM/
      • MM.md
      • ww/
        • ww.md
        • DD.md
          (This structure isn't final, but also is only provided as an example, anyway)

When I attempt to add a / character into the format to try and create this structure (for example, a daily note format of YYYY/MM/ww/DD it will tell me that I've used an invalid character. Indeed, if it did accept the character, it would probably fail because it's not making the folders.

So my request is to either specifically cater for the / in the format and create all the intermediate folders or otherwise allow formatting in the 'Note Folder' option (which also caters for creating intermediate folders)