joplin-plugin-collapsible-blocks 1.2.1 → 1.9.0

package/README.md

@@ -1,27 +1,36 @@
-# Joplin Plugin - Collapsible blocks
+# Joplin Plugin - Collapsible Sections
 
-This Joplin plugin allows you to create collapsible blocks with a title and extendable body. The blocks can be nested within each other, remember whether they were left open or closed, and color-coordinate between the editor and webview. 
+This Joplin plugin allows you to create collapsible blocks with a title and extendable body. The blocks: 
+* Can be nested within one another
+* Remember if they were left opened or closed
+* Can color-coordinate between the editor and webview
+* Collapse in both the editor and the webview
+* Support the use of markdown within them
 
-Although the blocks this plugin creates are only collapsible in the webview, not the editor, it seems to pair well with the "Extra Markdown Editor Settings" plugin, which does allow for collapsing text in the editor, if "Enable code folding" is enabled in its settings. The collapsible blocks made by this plugin are detected by it as code, and are editor-foldable. If you're nesting collapsible blocks, only the outermost one (in the editor) will be foldable with this method. 
+Additionally, this plugin allows you to collapse headings within notes, in both the editor and the webview, with no additional syntax. 
 
-**Version**: 1.2.1
+There are many settings available to customize the desired features and behaviors. 
+
+This plugin works on both Desktop and Mobile. 
+
+**Version**: 1.9.0
 
 ### Installation
 
 - Open Joplin and navigate to `Preferences > Plugins`
-- Search for `Collapsible blocks` and click install
+- Search for `Collapsible Sections` and click install
 - Restart Joplin
 
 ### Uninstall
 
 - Open Joplin and navigate to `Tools > Options > Plugins`
-- Search for `Collapsible block` plugin
-- Press `Delete` to remove the plugin or `Disable` to disable it
+- Find the `Collapsible Sections` plugin
+- Press `Delete` to remove the plugin, or click the toggle to disable it
 - Restart Joplin
 
 ## Usage
 
-### Collapsible block
+### Collapsible blocks
 
 In order to create a collapsible block, you can:
 - press on the `Collapsible block` toolbar button to create a template collapsible, or
@@ -45,11 +54,19 @@ Nothing but whitespace may come before the `:{`. The title of the block must alw
 :{
 }:
 
+:{
+
+}:
+
 :{Title}:
 
 :{Title
 }:
 
+:{Title
+
+}:
+
 :{
 Body}:
 
@@ -57,10 +74,6 @@ Body}:
 Body
 }:
 
-:{
-    Body
-}:
-
 :{Title
 Body}:
 
@@ -76,32 +89,40 @@ Blocks will remember if you left them opened or closed. They will do so by editi
 
 If you don't want it to remember if you left a block opened or closed, you can turn this off globally in the plugin settings - or on a per-block basis by doubling the end token, from `}:` to `}:}:`. When you do this, you can still open and close the block in the webview, but they will not save their state in the editor - so the next time the note is loaded, they will be opened or closed again, depending on whether their opening token is `:{:{` or `:{`, respectively. So a block like `:{:{this}:}:` will always be initially open when you open a note, while a block like `:{this}:}:` will always be initially closed when you open a note. 
 
-When nesting blocks within blocks, they will be color-coded in the editor, and may also be color-coded in the webview. These can both be controlled (enabled or disabled) in the plugin Settings tab. 
+When nesting blocks within blocks, they can be color-coded in the editor, and may also be color-coded in the webview. These can both be controlled (enabled or disabled) in the plugin Settings tab. 
 
-## Screenshots
+### Collapsible Headings
 
-Three collapsibles, with one nested inside another, all closed
+When you create headings within a note (by starting a line with `#`, `##`, `###`, `####`, `#####`, or `######`), this plugin automatically makes them collapsible, with no additional syntax required. This can be enabled or disabled in both the editor and the webview in settings. The collapsible region beneath a heading will extend to the next heading of equal or higher precedence. So, for example, a `#` heading will collapse to the next `#` heading, while a `###` heading will collapse to the next `#`, `##`, or `###` heading. Collapsible headings and collapsible blocks do play nicely with each other, and can be nested freely. 
 
-![](screenshots/1.png)
+Headings do remember if they should be left opened or closed (This can be disabled in settings). Due to the lack of special syntax, this is done by adding or removing a space from the end of the line with the heading. A heading with no space at the end is considered opened, while a heading with a space at the end is considered closed. For example:
 
-With the two outer ones opened
-
-![](screenshots/2.png)
+```
+# This heading does not end in a space, and so will render as opened when the note is loaded
+This text will be visible when the note is loaded. 
+# This heading does end in a space, and so will render as closed when the note is loaded 
+This text will not be visible when the note is loaded. That is because there is a space ↑ here, after the word 'loaded', in the previous line. 
+```
 
-With all three opened
+## Screenshots
 
-![](screenshots/3.png)
+Various headings and collapsible blocks, all open, with colors enabled
+![](screenshots/1.png)
 
-With a fourth one added, for three nesting levels, and webview colors enabled
+The same note, with some headings and blocks collapsed
+![](screenshots/2.png)
 
-![](screenshots/4.png)
 
 ## Settings
 There is a settings page for the plugin in the Joplin options. There, you can:
-* Customize the start and end tokens away from the default `:{` and `}:`
 * Enable or disable the color coding in the webview and editor
+* Customize the start and end tokens away from the default `:{` and `}:`
 * Globally disable the plugin's ability to remember if a collapsible block's opened/closed status was changed in the webview
-* Disable automatic CSS indentation of collapsible block text in the editor, or configure it to indent more or less
+* Disable automatic CSS indentation of collapsible block text in the editor, or configure it to indent more or 
+* Enable or disable collapsing within the editor as well as the webview
+* Toggle whether folding changes in one view automatically trigger folding changes in the other view
+* Enable or disable header-based collapsing in the webview or editor
+* Enable or disable remembering whether headers were left opened or closed
 
 ![](screenshots/settings.png)
 
@@ -122,17 +143,17 @@ details.cb-details summary {
 
 }
 
-/* Below are used for styling nested collapsible blocks, and will only
-be applied if "Do Webview Colors" is enabled in the plugin settings */
-
-/* Styling of nested collapsible blocks - use n = 0-7 */
-.cb-details.cb-nest-n {
-
-}
-
-/* Styling of nested collapsible block titles - use n = 0-7 */
-.cb-details.cb-nest-n > summary {
-
+/* Below are used for coloring nested collapsible blocks, and will
+only be applied if colors are enabled in the plugin settings */
+:root {
+    --cb-color-0: #a0a0a0;
+    --cb-color-1: #6b5fd6;  /* blue-violet */
+    --cb-color-2: #2bb0e6;  /* bright cyan-blue */
+    --cb-color-3: #6b5fd6;
+    --cb-color-4: #2bb0e6;
+    --cb-color-5: #6b5fd6;
+    --cb-color-6: #2bb0e6;
+    --cb-color-7: #6b5fd6;
 }
 ```
 
@@ -141,9 +162,9 @@ If the collapsible block is not showing up, or is showing up but you're unable t
 
 ![](screenshots/troubleshooting.png)
 
-## Notes
+## Issues
 
-- **There might be bugs**, [report them here](https://github.com/ntczkjfg/joplin-plugin-collapsible-block/issues) and I'll try to fix them if I can.
+- **Encounter any bugs?** [Report them here](https://github.com/ntczkjfg/joplin-plugin-collapsible-block/issues), and I'll do my best to fix them.
 
 ## Acknowledgement
 
@@ -151,4 +172,6 @@ Thanks to the creator of the [Joplin Spoilers](https://github.com/martinkorelic/
 
 ## Other plugins
 
-See my other plugin, [Click-to-Copy Spans](https://github.com/ntczkjfg/joplin-plugin-click-to-copy-span)! Easily lets you create spans of text that, when clicked, are automatically copied to your clipboard for fast and easy pasting. 
+Check out my other plugins:
+* [Click-to-Copy Spans](https://github.com/ntczkjfg/joplin-plugin-click-to-copy-span)! Easily create spans of text that, when clicked, are automatically copied to your clipboard for fast and easy pasting. 
+* [Hotstrings & Hotkeys]()https://github.com/ntczkjfg/joplin-plugin-hotstrings)! Easily create user-defined hotstrings and hotkeys for simple text insertion and replacement. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-collapsible-blocks",
-  "version": "1.2.1",
+  "version": "1.9.0",
   "scripts": {
     "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
     "prepare": "npm run dist",

package/publish/joplin.plugin.collapsible.blocks.json

@@ -1,10 +1,10 @@
 {
 	"manifest_version": 1,
 	"id": "joplin.plugin.collapsible.blocks",
-	"app_min_version": "3.2",
-	"version": "1.2.1",
-	"name": "Collapsible blocks",
-	"description": "Create collapsible blocks with title and extendable body.",
+	"app_min_version": "3.3",
+	"version": "1.9.0",
+	"name": "Collapsible Sections",
+	"description": "Create collapsible blocks with title and extendable body, and make headings collapsible too.",
 	"author": "ntczkjfg",
 	"homepage_url": "https://github.com/ntczkjfg/joplin-plugin-collapsible-block",
 	"repository_url": "https://github.com/ntczkjfg/joplin-plugin-collapsible-block",
@@ -18,12 +18,17 @@
 		"details",
 		"fold",
 		"foldable",
-		"folding"
+		"folding",
+		"editor",
+		"mobile",
+		"obsidian",
+		"heading",
+		"header"
 	],
 	"platforms": [
 		"desktop",
 		"mobile"
 	],
-	"_publish_hash": "sha256:a7f2e12a0762af2faa225ba92d3f7585c82e596c52535fe0fb1c615523de083d",
-	"_publish_commit": "master:71b1a0e51ff3475b88d69e242622c058735cbc09"
+	"_publish_hash": "sha256:4a55870ddf310d37b226f43c59173699128fd3a4413616baaa7b9e895122acfd",
+	"_publish_commit": "master:dcb50637167916ac6bfad25ae4437473535d65e2"
 }