diff --git a/docs/docs/Features/Command palette commands.md b/docs/docs/Features/Command palette commands.md index ea311c6..6c332c7 100644 --- a/docs/docs/Features/Command palette commands.md +++ b/docs/docs/Features/Command palette commands.md @@ -1,16 +1,18 @@ # Command palette commands -## Make current active note a folder note for the folder of the active note +## Use this file as the folder note for its parent folder The note that's currently in focus will be the new folder note for the parent folder of the file. -## Create folder note with a new folder for the active note in the current folder +## Make a folder with this file as its folder note This command creates a new folder and uses the current file that is in focus as the folder note. The new folder will be in the same folder as the folder the file was in. -## Create {type} folder note for current folder of active note +## Create {type} folder note for this folder Create a new folder note for the folder of the current file that is in focus. The plugin will not use the file in focus but instead a completely new file. -## Delete folder note of current folder of active note -Delete the file of the folder note that is for the folder which the current file in focus is in. -## Open folder note of current folder of active note -Open the folder note of the folder that the current file in focus is in. +## Delete this folder's linked note +Delete the folder note (only the file itself) of the parent folder of the currently focused file. +## Open this folder's linked note +Open the folder note of the parent folder of the currently focused file. ## Insert folder overview Insert a folder overview in a note. [Click here to know more about a folder overview](./Folder%20overview.md). -## Create folder note from selected text +## Edit folder overview +Edit the default settings or an already created folder overview in the right view. [Click here to know more about a folder overview](./Folder%20overview.md). +## Create folder note from selection Create a new file, a new folder and the file as the folder note. The text that has been selected will be the name of the folder note and the folder. \ No newline at end of file diff --git a/docs/docs/Features/Exclude folders.md b/docs/docs/Features/Exclude folders.md index 56ae08e..02623b3 100644 --- a/docs/docs/Features/Exclude folders.md +++ b/docs/docs/Features/Exclude folders.md @@ -1,7 +1,9 @@ # Exclude folders -The exclude folder feature can be found in the plugin settings under the tab "Exclude folders". +The exclude folder feature can be found in the plugin settings under the tab "Exclude folders". Depending on what you exclude a folder from you for example can't open a folder note, the file/folder names don't sync, it doesn't show up in the folder overview and more. ## Exclude only one folder To only exclude the folder itself and not the sub folders also you have to click on the edit icon and disable include subfolders in the settings. + +## How to exclude a folder? ### Directly in the settings Click on the plus icon, then click on the text input, search a folder name and then select the folder you want to exclude from the list. ![Video](../assets/xdS3VV7wjIRFNHADE0lx.mp4) @@ -11,7 +13,7 @@ Click on a folder and then use the context menu and click on "exclude folder fro ## Exclude a folder and their subfolders To exclude a folder and its subfolders you have to do the same steps as in how to exclude only one folder but enable include subfolders in the settings of an excluded folder. ## Exclude multiple folders (with a pattern) -The pattern only looks at the names of the folders and nothing else. You have to options to exclude folders with a pattern and the first option is to use * before and after the string. The second option is to use a [regex](https://en.wikipedia.org/wiki/Regular_expression). +The pattern only looks at the names of the folders and nothing else. You have two options to exclude folders with a pattern and the first option is to use * before and after the string. The second option is to use a [regex](https://en.wikipedia.org/wiki/Regular_expression). To use a regex you have to add "{regex}" at the beginning of the string and everything after it is going to be a regex that matches the folder names. @@ -30,4 +32,7 @@ Test* => matches the name Open the exclude folders settings tab and click on a edit button if you've already excluded folders or added patterns to exclude folders. ![Screenshot](../assets/mbZW1SXv8o3fKU4g8j3V.png) ## Default settings -To edit the default settings for new excluded folders/patterns you just have to click on one of the "Manage" buttons in the settings that are next to "Exclude folder/pattern default settings". \ No newline at end of file +To edit the default settings for new excluded folders/patterns you just have to click on one of the "Manage" buttons in the settings that are next to "Exclude folder/pattern default settings". + +## Whitelisted folders +The whitelisted folders overwrite the already excluded folders with options that are the opposite from the excluded folders. For example when you add a pattern to exclude all folders, select to disable opening of folders and then add one specific folder to the whitelist and select "open folder ..." you can only open the specific folder and not all the other folder notes. \ No newline at end of file diff --git a/docs/docs/Features/File context menu commands.md b/docs/docs/Features/File context menu commands.md index 23a57b2..28b64fa 100644 --- a/docs/docs/Features/File context menu commands.md +++ b/docs/docs/Features/File context menu commands.md @@ -2,5 +2,9 @@ ## Create folder note This command creates a new folder and uses the file you clicked on as the folder note. The new folder will be in the same folder as the folder the file was in. + +![Example](../assets/videos/Obsidian_Nc9OYAHHT1.mp4) ## Turn into folder note for "{folderName}" -This command will attach the file to the folder it's in. For example file "test" that is in the folder "test2" will be the new folder note for the folder "test2". \ No newline at end of file +This command will attach the file to the folder it's in. For example file "test" that is in the folder "test2" will be the new folder note for the folder "test2". + +![Example](../assets/videos/Obsidian_bUlTDSG9a9.mp4) \ No newline at end of file diff --git a/docs/docs/Features/Folder context menu commands.md b/docs/docs/Features/Folder context menu commands.md index d4f9aad..362d7d6 100644 --- a/docs/docs/Features/Folder context menu commands.md +++ b/docs/docs/Features/Folder context menu commands.md @@ -1,10 +1,14 @@ # Folder context menu commands + ## Exclude folder from folder notes This will add the folder to the excluded folder list. [Click here to find more about excluded folders out.](Exclude%20folders.md) ## Create {type} folder note This command will create a folder note of the file type you selected and depending on your settings the folder note will be in the folder itself or in the parent folder of the folder. ## Delete folder note -The folder note from the folder you clicked on gets deleted. +The folder note from the folder you clicked on gets deleted. (Only the file and note the folder itself) ## Open folder note -Opens folder notes in the currently active tab or if you have the setting "open folder note in a new tab by default" enabled the note opens in a new tab. \ No newline at end of file +Opens folder notes in the currently active tab or if you have the setting "open folder note in a new tab by default" enabled the note opens in a new tab. + +## Copy Obsidian URL +Copies the Obsidian URL of the file which is linked to the folder and it can be used in other programs to directly open the file. \ No newline at end of file diff --git a/docs/docs/Folder overview.md b/docs/docs/Folder overview.md index 9339a3b..7c353a0 100644 --- a/docs/docs/Folder overview.md +++ b/docs/docs/Folder overview.md @@ -1,4 +1,6 @@ # Folder overview +[The folder overview feature can be installed as a standalone plugin and works without the folder notes plugin by clicking on this.](https://obsidian.md/plugins?id=folder-overview) + This feature/plugin creates a [code block](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Code+blocks) that provides an overview of your entire vault or specific folders. Instructions for creating or editing a folder overview, along with additional guidance, can be found further down the page. Currently there are two styles available: **file explorer** & **list style**, with more coming soon. The **overview updates** itself **automatically** when you create, delete or modify a file. You can also integrate it into **templates**, as explained further down below this page. diff --git a/docs/docs/Getting started.md b/docs/docs/Getting started.md index 964faa6..fdd4183 100644 --- a/docs/docs/Getting started.md +++ b/docs/docs/Getting started.md @@ -3,20 +3,6 @@ ## How to install the plugin The plugin can be downloaded by clicking on [https://obsidian.md/plugins?id=folder-notes](https://obsidian.md/plugins?id=folder-notes) and then on install. ## Basic features -### Create folder overview -Find more out about the folder overview feature on the [folder overview page](./Folder%20overview.md) - -To create a folder overview in a note either use the command "Insert folder overview" or on pc right click and select "create folder overview" - -![Context menu](./assets/VyBTGhA5eJAVVFusZXIz.png){: style="max-width: 40%;max-height: 40%"} - -The folder overview with the default settings looks like this with one note - -![Folder overview](./assets/u6ccTTzVbwzBivySFacZ.png) - -To edit the folder overview click on the little icon on the right that is shown when hovering over the codeblock - -![Folder overview settings](./assets/2wzCXFTpD2.gif) ### Create folder note @@ -30,7 +16,7 @@ On PC either use ctrl or strg (depending on your settings) and then click on a f Open the [command palette](https://help.obsidian.md/Plugins/Command+palette) and then type "folder notes" and select the command you need. -![Command palette](./assets/FKhiQZLm4Juu4VdFTxPC.png) +![Command palette](./assets/screenshots/Obsidian_3VEQ3kOT4S.png) ### Open folder note @@ -44,7 +30,17 @@ The second option is to open one file of the files from the folder from which yo The last option and the option that is only available to desktop users is to use alt or ctrl and click on the folder name. When you don't hold ctrl/alt and click on a folder name the folder gets collapsed as normal. To use this option you first have to enable it in the plugin settings under the tab general. -![Settings page](./assets/2KHZfsNVuJL8dIz6cTF5.png) +![Settings page](./assets/screenshots/Obsidian_7B8zdp5xDh.png) +### Create folder overview +Find more out about the folder overview feature on the [folder overview page](./Folder%20overview.md) +To create a folder overview in a note either use the command "Insert folder overview" or on pc right click and select "create folder overview" + +![Context menu](./assets/VyBTGhA5eJAVVFusZXIz.png){: style="max-width: 40%;max-height: 40%"} + +The folder overview with the default settings looks like this with one note + +![Folder overview](./assets/u6ccTTzVbwzBivySFacZ.png) +To find out how to edit the folder overview have a look at [folder overview page](./Folder%20overview.md) diff --git a/docs/docs/assets/screenshots/Obsidian_3VEQ3kOT4S.png b/docs/docs/assets/screenshots/Obsidian_3VEQ3kOT4S.png new file mode 100644 index 0000000..89b9ef6 Binary files /dev/null and b/docs/docs/assets/screenshots/Obsidian_3VEQ3kOT4S.png differ diff --git a/docs/docs/assets/screenshots/Obsidian_7B8zdp5xDh.png b/docs/docs/assets/screenshots/Obsidian_7B8zdp5xDh.png new file mode 100644 index 0000000..7dbb989 Binary files /dev/null and b/docs/docs/assets/screenshots/Obsidian_7B8zdp5xDh.png differ diff --git a/docs/docs/assets/videos/Obsidian_Nc9OYAHHT1.mp4 b/docs/docs/assets/videos/Obsidian_Nc9OYAHHT1.mp4 new file mode 100644 index 0000000..85e0a72 Binary files /dev/null and b/docs/docs/assets/videos/Obsidian_Nc9OYAHHT1.mp4 differ diff --git a/docs/docs/assets/videos/Obsidian_bUlTDSG9a9.mp4 b/docs/docs/assets/videos/Obsidian_bUlTDSG9a9.mp4 new file mode 100644 index 0000000..82d539f Binary files /dev/null and b/docs/docs/assets/videos/Obsidian_bUlTDSG9a9.mp4 differ