[ FR ] Support of the Periodic Notes Plugin

[StefanoRausch]

I have disabled the Daily Notes core plugin and I use the more flexible Periodic Notes one -- I currently have four different calendar sets.

It would be fantastic if DNO could, in addition, support PN and adapt to the active set.

What are your plans in that respect?

[iiz00]

I am very interested in supporting Periodic Notes weekly notes and calendar sets.
I would like to try to support it at some point, but I will have to look into the Periodic Notes code carefully.

I am using the core Daily Note plugin and Periodic Notes v0.0.17(I am not really making good use of Periodic Notes), but I assume you are using the beta version.
I have a couple of points I'd like to ask you:
Is DNO working correctly as for the standard calendar set in your environment? I have a hazy recollection that when I installed the beta version of Periodic Notes during the development of DNO, something didn't work well and I had to roll back.
Also, you mentioned that you have the core Daily Note Plugin turned off, does it cause any problems when it is turned on along with Periodic Notes?

[StefanoRausch]

Yes, I always have the latest ( beta ) version of PN installed and enabled.

I have not tried out the combination of the core DN and your DNO plugins -- DN is restricted to one folder, so it does not help me. Hence, I have deactivated it.

I can run a test for one of my calendar folders to see if there are any issues. Let me know.

I am gladly prepared to test a beta version of your DNO plugin, once it is available.

[iiz00]

Suppoted PN in v1.0.0. Please give it a try. I hope you will feel free to report problems and give me feedback!

[feliao]

Hi, I have just tried the integration with Periodic notes but I have the following issues:

• Weekly view does not seem to work (can not find any notes)

[iiz00]

Thank you for your report and sorry for the inconvenience.
First, please confirm the following points:

• Is Periodic Notes plugin installed and enabled? Is the weekly note enabled and the path set in the Periodic Notes settings?
• In Daily Note Outline plugin settings, is 'periodic notes' turned on?

If the above is okay, could you please provide the following information to help me narrow down the issue:

• Which version of Periodic Notes are you using? 0.0.17 or 1.0.0-beta3 ?
• Can you open the weekly note that you created with Periodic Notes? In other words, can you open that weekly note with the "open weekly note" or "open next/previous note" command in Periodic Notes?
  • DNO uses Periodic Notes' methods to detect weekly notes, so DNO cannot display files that Periodic Notes cannot recognize as weekly notes.
• Are characters indicating granularity, such as 'day', 'week' or 'month', displayed under the UI icons? Can you switch it to "week" by clicking on it?
• Are daily notes displayed? Can you display monthly or yearly notes other than weekly notes?

[feliao]

Is Periodic Notes plugin installed and enabled?
YES
Is the weekly note enabled and the path set in the Periodic Notes settings?
YES
In Daily Note Outline plugin settings, is 'periodic notes' turned on?
YES
If the above is okay, could you please provide the following information to help me narrow down the issue:

Which version of Periodic Notes are you using? 0.0.17 or 1.0.0-beta3 ?
0.0.17
Can you open the weekly note that you created with Periodic Notes?
YES
In other words, can you open that weekly note with the "open weekly note" or "open next/previous note" command in Periodic Notes?
YES
DNO uses Periodic Notes' methods to detect weekly notes, so DNO cannot display files that Periodic Notes cannot recognize as weekly notes.
Are characters indicating granularity, such as 'day', 'week' or 'month', displayed under the UI icons? Can you switch it to "week" by clicking on it?
Yes I can switch to day, quarter or week. Day and Quarter views works but week view is empty
Are daily notes displayed? Can you display monthly or yearly notes other than weekly notes?
Day and Quarter views works but week view is empty

[iiz00]

I see that you are experiencing problems specific to WEEKLY NOTE. I have considered several possible causes. I am sorry, but I would appreciate your further cooperation.

• If the weekly note file itself is not detected, the string "No daily/periodic note found" will appear in DNO view. On the other hand, if there is some error, the area under the UI icons will be blank. Which is it?

• Does the console（Ctrl+Shift+I) show any error messages?

• DNO has a button to create a new daily/periodic note, does this not work? Could you try left-clicking to create this week's note or right-clicking to create next week's note and see if the note is created?

• The most likely cause of the problem is that it is failing to get the file name or path for some reason. I would like to try to reproduce the problem at hand, so if you don't mind, may I have the following information?

  • Format and NoteFolder of weekly notes in Periodic Notes plugin settings
  • Format and NoteFolder of other working daily and quarterly notes

• Other possibilities...

  • Possibly the conversion to date is failing: would turning off "attach date range to weekly notes" in the Periodic Notes section of DNO's settings make any difference?
  • Possibly the DNO configuration file is corrupted for some reason: After closing obsidian, move the data.json file in .obsidian\plugins\obsidian-daily-note-outline to a different location and then restart Obsidian, the DNO settings will be initialized, If a corrupt configuration file is the cause, this should improve the problem.

[feliao]

If the weekly note file itself is not detected, the string "No daily/periodic note found" will appear in DNO view. On the other hand, if there is some error, the area under the UI icons will be blank. Which is it?
A: "No daily/periodic note found" in my case

Does the console（Ctrl+Shift+I) show any error messages?
A: can't active

DNO has a button to create a new daily/periodic note, does this not work? Could you try left-clicking to create this week's note or right-clicking to create next week's note and see if the note is created?
A: Pop up window says unable to create new file

The most likely cause of the problem is that it is failing to get the file name or path for some reason. I would like to try to reproduce the problem at hand, so if you don't mind, may I have the following information?

Format and NoteFolder of weekly notes in Periodic Notes plugin settings
Format and NoteFolder of other working daily and quarterly notes
Other possibilities...

Possibly the conversion to date is failing: would turning off "attach date range to weekly notes" in the Periodic Notes section of DNO's settings make any difference?
A: No. Made no difference.

Possibly the DNO configuration file is corrupted for some reason: After closing obsidian, move the data.json file in .obsidian\plugins\obsidian-daily-note-outline to a different location and then restart Obsidian, the DNO settings will be initialized, If a corrupt configuration file is the cause, this should improve the problem.
A: Made no difference

[iiz00]

What about Format and NoteFolder in Periodic Notes plugin settings?
(In my case, Format is "gggg-[W]WW" for weekly notes, "YYYY-MM-DD_ddddd" for daily notes and "YYYY-[Q]Q" for quarterly notes, and NoteFolder is "Daily" for all.)
I think it is most likely that these settings are affected (conversely, if all of your these settings were default, I can't immediately think of the cause...).

can' active

By the way, what does this mean? The Console is an Obsidian feature unrelated to DNO, so I think it is possible to open it... If you can't open the Console only when you open the weekly notes, it is possible that something is causing a high load. If you are on macOS, the hotkey to open it is different. Here is a help message from Obsidian's Discord channel:

To check for errors, first open the developer tools by pressing Ctrl-Shift-I on Windows/Linux or Cmd-Opt-I on macOS, and then >go to the "Console" tab. you want to save the error to a log file, you can right click on the error and choose "Save as..." .

[feliao]

Here is my weeky note format: YYYY-MM-[Week]ww

I can open the console but can't see anything unusual being triggered when I switch to week DNO view.

[iiz00]

Hmmm, it works fine in my environment in that format...
I will examine the code carefully, so could you please wait a while?

If you have time, I would appreciate it if you could try to see if only the weekly note fails to display in other vaults as well.

[iiz00]

I haven't identified the cause of the problem yet, but there's a report in the Periodic Notes repository that the Calendar plugin is not detecting weekly notes as shown below:
Weekly note not detected by calendar · Issue #165 · liamcain/obsidian-periodic-notes
liamcain/obsidian-periodic-notes#165

According to the latest comment, "Periodic Notes: Open weekly note" works, but the calendar plugin cannot detect and display weekly notes.

Are you using @liamcain's Calendar plugin? Could you please try turning on the "Show week number" setting in the Calendar plugin and see if the weekly notes are displayed on the calendar?
DNO and Calendar plugins both use @liamcain's Daily Note Interface(https://github.com/liamcain/obsidian-daily-notes-interface) to detect Weekly Notes. So, if weekly notes cannot be displayed there as well, I should carefully check the code of the Daily Note Interface. If weekly notes are displayed correctly there, then I should check DNO more carefully.

[benpla]

I have the same problem: DND does not detect the weekly note from Periodic Notes Plugin.
All of feliao's characteristics apply to me as well. The test with @liamcain's Calendar plugin showed that the weekly note was recognized and opened:

My weekly note definition in the Periodic Notes plugin:
GGGG-[w]WW

DND shows "No daily/periodic note found"

Functionality apart from the Periodic Notes plugin: normal display of the Daily Notes.

[iiz00]

Thank you for the detailed information!
After trial and error based on the information from @feliao and @benpla,
I suspect that ’the first day of the week’ (and locale setting) is the cause of the problem.
Could you please try changing the "Start week on" setting in Calendar community plugin to Locale default, Sunday, and Monday and see what happens to weekly notes display for each?

[feliao]

BINGO!!

I set "start week" to Sunday (I normally set it to Monday) and weekly notes are showing in DNO!!!!

[benpla]

I have tested all the settings in the calendar plugin: with none of the settings the Weekly notes are displayed in DND.
I always restarted Obsidian and pressed "Refresh" in DND.

[iiz00]

I was confused by the difference between the two results, but @benpla is using v1.0.0-beta3 of Periodic Notes, right? I mistakenly thought it was v0.0.17, and I didn't have much confirmation of the processing there. Periodic Notes plugin needs to be investigated separately, as the internal processing and behavior varies greatly from between 2 versions. However, I suspect that the day of the week and locale may have an impact as well in the beta version.

If you are using v0.0.17, please use the workaround to set the beginning day of the week to Sunday for now if possible. However, doing so will change the week number for Sunday, which may cause side issues such as the calendar plugin displaying differently, or the destination of embedded daily notes in the weekly note. If you are concerned about such a situation, please wait for a bug fix.

@benpla
Your third screenshot (the one with the 'No daily/periodic note found' message) shows the "day" string and appears to be trying to display a daily note, not a weekly note.

• When you click on the "day" string, the display should change to "week" or "month", but in all cases "No daily/periodic note found" is displayed? Or does the "day" string not change to others?
• In the fourth screenshot, the daily note is shown, but is there some setting that has been changed from the third screenshot?
• By the way, are you using the calendar set switching feature of the beta version of the Periodic Notes plugin? If so, does the calendar set switching work well?

[benpla]

Many Thanks for your investigation!
Your Questions:
1: I can not click on "day" string. If I click, nothing changes. It behaves like like a normal label without beeing clickable.

2: Nothing changed in settings between the third and fourth screenshot. The only change is my click on the date range:

3. I don't use calendar switching. I only use weekly Notes. The daily Notes are not for my Edit, they will be auto filled by obsidian-list-modified-Plugin and contain only files that changed on this day.

I have one more question:
Why are the settings and functionality of the other plugins important, except for taking the format string?
In my opinion DND only needs the format string of the respective note. I can filter the weekly notes in principle also with Dataview, for this I need only the format string (however, I can filter out there only notes, the contents so beautifully represented as in your plugin I get in no case. That is exactly what I find so great in your plugin).

[iiz00]

If clicking on the string "day" to the right of the date range does not switch to week, now I have a feeling that this is a different issue than the LOCALE issue.

Your screenshot shows Daily Notes in the DNO list, even though daily notes is turned off in the Periodic notes settings screen. If it is working as I intended, when daily notes is disabled in Periodic Notes, the string should not be 'day' and starts with 'week'. So I think something is wrong at this point.
I would appreciate further cooperation if possible.

• If I am wrong about your original usage, please let me know.

  • Daily Note core plugin is off, Periodic Notes version is v1.0.0-beta3, daily note is off and only weekly and monthly note is enabled in Periodic Notes setting.

• In the Console (Ctrl+Shift+I), are you seeing any errors when clicking the string 'day'?

• In the Console, Can you type console.log(window.app.plugins.getPlugin("obsidian-daily-note-outline").view.calendarSets); ?

  • This is the command that displays the periodic notes settings DNO acquired from the beta version of Periodic Notes. It is folded, but when you open it, you will see the settings.
    • Is there a string id: "Default"?
    • Is there a string week: { enabled: true (please show me the screenshot if you can)
      

• In the Console, Can you type console.log(window.app.plugins.getPlugin("periodic-notes").cache.cachedFiles) ?

  • This is the command that displays all notes and related information that the beta version of Periodic Notes plugin recognizes as peridoic notes.
  • Can you find the weekly notes you want to display in the result?
    

Why are the settings and functionality of the other plugins important, except for taking the format string?

As for Periodic Notes, DNO reads its version (v0.0.17 or v1.0.0-beta3) and settings such as calendar sets, enabled granularity(day, week, month...), and processing of DNO branches according to those settings. Therefore, knowing the settings is useful to isolate and reproduce the cause of a failure.
As for Calendar plugin, at first I thought it's irrelevant but I found its setting (at least the first day of the week) affects some behavior of Daily Note Interface, a utility by @liamcain which all of DNO, Periodic Notes, Calendar use.

[benpla]

Daily Note core plugin is off --> yes
Periodic Notes version is v1.0.0-beta3 --> yes
daily note is off and only weekly and monthly note is enabled in Periodic Notes setting --> yes

In the settings of DND "Daily Notes plugin not enabled" is displayed. I can't tell if this was there yesterday, I just noticed it now.
But DND is enabled, it also works for the daily notes.

If I click on "day", Console shows nothing.
Console has 0 entries for filter "daily" (Level "Verbose")

I type in Console console.log(window.app.plugins.getPlugin("obsidian-daily-note-outline").view.calendarSets);

I type in Console console.log(window.app.plugins.getPlugin("obsidian-daily-note-outline").view.calendarSets);

[iiz00]

Thank you very much, but it seems that Daily Note Outline is not getting the information on the PERIODIC NOTES correctly...

Sorry, just two more!

• Now, in the console as well, could you type console.log(window.app.plugins.getPlugin("periodic-notes").calendarSetManager.getCalendarSets()); ? This command outputs the calendar set and periodic note settings on the Periodic Notes side. Normally, the output should be exactly the same as the previous 'window.app.plugins.getPlugin("obsidian-daily-note-outline").view.calendarSets'. In other words, if the periodic note settings are output correctly here, the DNO side has failed to acquire them, and if they are also undefined, it is more likely that the settings are not being retained correctly in Peirodic Notes or that they have failed to be acquired internally. If the settings are output, please let me know the contents as in the previous post.
• If the above command does not output the settings, could you please check the contents of "data.json" in the Periodic Notes plugin folder? The following is the data.json of periodic notes in my plugin development vault. Please check if data such as id:Default and week:enabled:true are stored under "calendarSets".

Others

• This is a rare case, but is there more than one Periodic Notes plugin folder in the plugin folder? (ex. Beta and non-beta versions). If there is more than one, the behavior may be incorrect.

Sample of data.json

{
  "installedVersion": "1.0.0-beta1",
  "activeCalendarSet": "Default",
  "showGettingStartedBanner": true,
  "hasMigratedDailyNoteSettings": false,
  "hasMigratedWeeklyNoteSettings": false,
  "calendarSets": [
    {
      "day": {
        "enabled": false,
        "format": "YYYY-MM-DD_dddd",
        "folder": "Daily",
        "openAtStartup": false,
        "templatePath": ""
      },
      "week": {
        "enabled": true,
        "format": "GGGG-[w]WW",
        "folder": "journal/week",
        "openAtStartup": false,
        "templatePath": ""
      },
      "month": {
        "enabled": true,
        "format": "",
        "folder": "journal/daily",
        "openAtStartup": false,
        "templatePath": ""
      },
      "quarter": {
        "format": "",
        "folder": "",
        "openAtStartup": false,
        "templatePath": ""
      },
      "year": {
        "format": "",
        "folder": "",
        "openAtStartup": false,
        "templatePath": ""
      },
      "id": "Default",
      "ctime": "2023-04-26T12:59:27+09:00"
    },
    {
      "day": {
        "folder": "AboutWork",
        "enabled": true
      },
      "week": {
        "folder": "AboutWork",
        "enabled": true
      },
      "month": {},
      "quarter": {},
      "year": {},
      "id": "Work",
      "ctime": "2023-04-26T13:39:59+09:00"
    }
  ],
  "enableTimelineComplication": true,
  "daily": {
    "format": "YYYY-MM-DD_dddd",
    "template": "",
    "folder": "journal/daily",
    "enabled": true
  },
  "weekly": {
    "format": "GGGG-[w]WW",
    "template": "",
    "folder": "journal/week",
    "enabled": true
  },
  "monthly": {
    "format": "",
    "template": "",
    "folder": ""
  },
  "quarterly": {
    "format": "",
    "template": "",
    "folder": ""
  },
  "yearly": {
    "format": "",
    "template": "",
    "folder": ""
  }
}

[benpla]

Putting to Console: console.log(window.app.plugins.getPlugin("periodic-notes").calendarSetManager.getCalendarSets());

Folder:
There is only one "periodic-notes"-folder in /plugins/

contents of /plugins/periodic-notes/data.json:

{
  "installedVersion": "1.0.0-beta1",
  "activeCalendarSet": "Default",
  "showGettingStartedBanner": false,
  "hasMigratedDailyNoteSettings": false,
  "hasMigratedWeeklyNoteSettings": false,
  "calendarSets": [
    {
      "day": {
        "enabled": false,
        "format": "",
        "folder": "journal/day",
        "openAtStartup": false,
        "templatePath": "Wissen/Software/Obsidian/templates/template für dayly note.md"
      },
      "week": {
        "enabled": true,
        "format": "GGGG-[w]WW",
        "folder": "journal/week",
        "openAtStartup": true,
        "templatePath": "Wissen/Software/Obsidian/templates/template für weekly note.md"
      },
      "month": {
        "enabled": true,
        "format": "",
        "folder": "journal/month",
        "openAtStartup": false,
        "templatePath": "Wissen/Software/Obsidian/templates/template für monthly note.md"
      },
      "quarter": {
        "format": "",
        "folder": "",
        "openAtStartup": false,
        "templatePath": ""
      },
      "year": {
        "format": "",
        "folder": "",
        "openAtStartup": false,
        "templatePath": ""
      },
      "id": "Default",
      "ctime": "2022-06-10T08:34:14+02:00"
    }
  ],
  "enableTimelineComplication": true,
  "daily": {
    "format": "",
    "template": "",
    "folder": "",
    "enabled": false
  },
  "weekly": {
    "format": "",
    "template": "Wissen/Software/Obsidian/templates/template für weekly note.md",
    "folder": "journal/week",
    "enabled": true
  },
  "monthly": {
    "format": "",
    "template": "",
    "folder": ""
  },
  "quarterly": {
    "format": "",
    "template": "",
    "folder": ""
  },
  "yearly": {
    "format": "",
    "template": "",
    "folder": ""
  }
}

[iiz00]

Thank you for your help.
Hmm, it seems that DNO is failing to get or keep the configuration information from the Periodic Notes plugin, but so far I have not found the specific cause. I am using the same method(window.app.plugins.getPlugin("periodic-notes").calendarSetManager.getCalendarSets()) in DNO to get the settings information, but in your screenshot, it seems to be working correctly...
I would like to investigate the code further as to the cause, so please bear with us for a while.

In the meantime, possible workarounds and other checks:

• I would suggest that you try reinstalling Daily Note Outline to see if that improves the situation.
• See if the same problem occurs in other vaults (If the problem persists, it may be due to some global environment difference.).
• Try temporarily turning off all community plug-ins except Daily Note Outline and Periodic Notes to exclude a plug-in compatibility issue.
• If you are not using features specific to the beta version of Periodic Notes (e.g., switching between multiple calendar sets), then reverting to the non-beta version of Periodic Notes may work (the process for retrieving settings is completely different between the beta and non-beta versions). However, in that case, you would need to change the day of the week to start from Monday to Sunday.

[benpla]

Hello,
first of all I would like to thank you for the support! This is not a matter of course and I appreciate it very much.

Regarding the weekly notes, I have given up. Because I find your plugin so extremely useful, I've changed my workflow as of today (and have been reposting for the last week):
I now use daily notes instead of weekly and see where that takes me. I loved the weekly notes because of the quick overview even on mobile devices. However, with their plugin I have this overview and find it great. I hope you don't stop development.
Actually I would love to co-develop but my time is scarce as I am doing my PhD part-time.

With my Daily Notes workflow it works great now. But I still have a request for an improvement:
For an overview of when I talked to whom on the phone or that I did a task last Thursday, the output of the weekday is useful.

For this I think 2 alternativ possibilities:

(1)
additional entry in the settings:
"Show first alias if available".

My daily Notes look like this by example :

---
aliases:
- "2023-05-08 Mo"
week: [[2023-w19]]
month: [[2023-05]]
---

CONTENT...

Then this alias is shown in the side pane instead of the filename.

(2) alternatively
additional entry in the settings:
"Date Formatstring for showing in Sidepane".

Then the custom format will be shown in the sidepane instead of the file name of the daily note.

Examples:

Is there a possibility to add one of these variants?
(I would prefer variant (2))

[iiz00]

Hello, @benpla

I expect to be able to fix the problem with 'Monday start in Periodic Notes v0.0.17' in the next release, but I have not actually been able to reproduce the problem you encountered.
From your screenshot I can assume that DNO is able to detect the calendar set in Periodic Notes, but not able to retrieve it properly...
I understand that you have stopped using weekly notes, but I will add the ability to display a slightly more detailed debug message in the console regarding the above process in the next version, so I hope you will give it a try.

I would like to create a new issue regarding your feature request.

[benpla]

Good Idea to create a new issue regarding my feature request. Thank you!

[iiz00]

In v1.1.0, I added an option to display Debug Information in the console. As shown in the attached image, this is to sequentially display the configuration information(calendarSets) of Periodic Notes to see where the information is not being communicated well.
If possible, could you please activate the last option in the settings and tell me how it is displayed at startup of DNO view or when you click on "day" string to switch to weekly notes (I think calendarSets changes to undefined somewhere).

[benpla]

With pleasure:

Periodic Notes Settings:

[iiz00]

From your screenshot(line 1 in the console), it looks like DNO recognizes the version of Periodic Notes plugin as v0.0.17. (verPN = 1).
DNO is reading the version of Periodic Notes plugin from its manifest.json.
Can you check the contents of manifest.json in the .obsidian -> plugins -> periodic-notes folder?
Do you see the string "version": "1.0.0-beta.3" in Periodic Notes' manifest.json?

[benpla]

I checked it: "0.0.17" with the last release.

I had downloaded the last version from obsidian-periodic-notes releases page.

The caption version on releases page says 1.0.0-beta.3, but the content of manifest.json lists "0.0.17".

[iiz00]

We are finally reaching a solution. Thank you so much for your kind and patient help.
I assumed that users would install Periodic Notes plugin using Obsidian BRAT plugin(https://github.com/TfTHacker/obsidian42-brat).
When the beta plugin is installed using the BRAT plugin, the manifest-beta.json in the repository is used as manifest.json. However, when I directly download the files in the Releases section, the version information is indeed 0.0.17...(I honestly hadn't thought of that).

1. reinstall the beta version of Periodic Notes plugin using Obsidian BRAT plugin
2. replace the content of your manifest.json of PN with the manifest-beta.json in the Periodic Notes repository
3. simply change the version in manifest.json from "0.0.17" to "1.0.0-beta.3

I think that by doing one of the above, the switching of periodic notes will work correctly (Please make a backup of data.json just in case).
I will ask the Discord community if getting the version from manifest.json is the right approach. If there is a more appropriate approach, I will fix it in the next version.

[benpla]

YESSSS
Now it shows the files of weeks. Super! Many Thanks!
I think I'll stick with my daily Note workflow for now. I get along quite well with it.

One Question:
In Obsidian daily note standard plugin the date format string is YYYY-MM-DD. Notefolder is journal/day
In Periodic Notes Plugin the daily note setting is YYYY-MM-DD, too. Notefolder is journal/day

DND shows assets from folder Notefolder is journal/day/assets:

Is this behaviour wished?

[iiz00]

That's good to know!
As for the files to be displayed, DNO is not extracting them in its own way, but rather using the cache kept by the Periodic Notes plugin as is. (but only for the beta PN. v0.0.17 should not display these png files.)
But this seems inconvenient. It would be easy to hide files that do not end with the ".md" extension, but would that solve the problem?

[benpla]

Good Morning (I am in germany),
your question: yes, hiding files with ".md" extension would help.
I wish you a good day (my workday starts now)

[iiz00]

v1.1.1 has been released. Please check if the problem has been fixed.
Now I would like to close this issue. If you have any other issues or FRs, please create a new issue.