Skip to content

folder note pref

aidenlx edited this page Sep 12, 2021 · 5 revisions

Folder Note plugin aims to make the folder and its index note working as one. However, behind the scene, the folder notes are still stored separately, not hardwired with its folder, which means there are several strategies to specify and store folder notes (See discussion Folder as markdown note).

experimental batch convert to new strategy is available with folder-note-core v1.2.0+

The three strategies available in alx-folder-note are as follows:

Methods Inside Folder, Index File Inside Folder, with Same Name Recommended Outside Folder, with Same Name
Folder Path parent/myFolder parent/myFolder parent/myFolder
Folder Note Path parent/myFolder/_about_.md parent/myFolder/myFolder.md parent/myFolder.md
Configuration Index File Name: _about_
(customizable in the setting)
Delete Note with Folder: disabled by default
Pros - The note file belongs to the folder.
- The note filename keeps the same if you rename a folder.
- The note file belongs to the folder.
- The note file has the same name as folder, the note title looks better.
- easier support for other plugins in the future, like quick-explorer
- The note file has the same name as folder, the note title looks better.
- Easy to insert wiki-links like [[myFolder]], no need to keep filename unique
Cons - The note filename and title may look weird.
- Have to use additional file names for linking.
- The note filename will be changed if you change the folder name.
- need to use [[parent/myFolder/myFolder]] to link outside of myFolder when note name is not unique
- The note file does not belong to the folder.
* Need Auto Rename enabled to keep notes and folder in sync
* New notes added from folder note won't be added to folder (patched in folder-note-core v1.1.0)
* Need to move folder note manually when folder is moved outside of vault
* May be difficult to intergrated to other plugins
- The note filename will be changed if you change the folder name.

By default, Inside Folder, With Same Name is used to resolve folder notes and create new folder note. You can change the preference in the Core section of the setting tab.

Thank xpgo for the detailed summary!