joplin-plugin-tag-navigator - npm Package Compare versions

Comparing version 0.1.3 to 0.2.0

package.json

 {
   "name": "joplin-plugin-tag-navigator",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "scripts": {
@@ -18,2 +18,3 @@ "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
   "devDependencies": {
+    "@joplin/lib": "~2.9",
     "@types/node": "^18.7.13",
@@ -28,5 +29,8 @@ "chalk": "^4.1.0",
     "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0",
-    "@joplin/lib": "~2.9"
+    "webpack-cli": "^4.10.0"
+  },
+  "dependencies": {
+    "markdown-it": "^14.0.0",
+    "markdown-it-task-lists": "^2.1.1"
   }
 }

publish/joplin.plugin.alondmnt.tag-navigator.json

@@ -5,5 +5,5 @@ {
 	"app_min_version": "2.10",
-	"version": "0.1.3",
+	"version": "0.2.0",
 	"name": "Inline Tag Navigator",
-	"description": "Convert inline tags to native joplin tags, or navigate between tags using a dedicated panel.",
+	"description": "A system to organize, search, browse and convert inline tags via dedicated panels.",
 	"author": "Alon Diament",
@@ -21,4 +21,4 @@ "homepage_url": "https://github.com/alondmnt/joplin-plugin-tag-navigator#readme",
 	"icons": {},
-	"_publish_hash": "sha256:e17cdfed452edb837ba5d1a2203f4113ec41c786f010f5d5bc54fa9c5d28b93c",
-	"_publish_commit": "main:3a3279a0799f567ef7a42adc81fcf1af66f496d6"
+	"_publish_hash": "sha256:61c6122776402b4b54f072bd1466c0f391348570db129ad28b9abd7cffb45ef2",
+	"_publish_commit": "main:bf37d63fc62c83cde020946349a61e23bbe9ca8f"
 }

README.md

 # Inline Tag Navigator
 
-This plugin adds inline tag support (such as #inline-tag) to [Joplin](https://joplinapp.org) in two ways:
+This plugin adds inline tag support (such as #inline-tag) to [Joplin](https://joplinapp.org) in three ways:
 
-- It adds a panel for navigating between inline tags that appear in the current note
-- It can convert your existing inline tags to native Joplin tags, so that they are accessible using tag search
-    - To convert a single note, use `Tools-->Tag Navigator-->Convert note's inline tags to Joplin tags`
-    - To convert all notes, use `Tools-->Tag Navigator-->Convert all notes' inline tags to Joplin tags`
-    - To periodically convert all notes, define the update period in `Settings-->Tag Navigator-->Periodic update (minutes)`
+- It adds a panel for searching tagged paragraphs across your notes. ([YouTube](https://www.youtube.com/watch?v=im0zjQFoXb0))
+- It adds a panel for navigating between inline tags that appear in the current note.
+- It can convert your existing inline tags to native Joplin tags, so that they are accessible using tag search.
 
+After installing the plugin, check the commands listed under `Tag Navigator` in the `Tools` menu, as well as the corresponding settings section.
+
+## Demos
+
+- Watch the tag search demo on YouTube:
+
+[![Watch the video](https://img.youtube.com/vi/im0zjQFoXb0/hqdefault.jpg)](https://www.youtube.com/watch?v=im0zjQFoXb0)
+
+- Watch the navigation panel demo:
+
 ![tag-navigator demo](img/tag-navigator.gif)
 
+## Tips
+
+- Tag search can be used to search, filter and toggle checkboxes (inline TODOs) directly from the panel.
+- The definition of a "tag" can be adjusted with user-defined regular expression.
+    - For example, every word in the text may be defined as a tag using a regex such as `[A-Za-z0-9]+[\w]*`.
+
+## Motivation
+
+- Notes are arguably the atomic blocks of information in [Joplin](https://joplinapp.org). They can be linked to, tagged, and come up in search results. Joplin is optimized for this, and these features are pretty efficient.
+- However, among 100s-1000s of long-form notes (that are hardly "atomic"), it remains challenging to find a small piece of information, idea, or memory.
+- Tags can be especially helpful in distinguishing between the content of a text (what it's about) and its form or function (what type of text it is or what purpose it serves). The first is more easily captured by traditional or [semantic search](https://github.com/alondmnt/joplin-plugin-jarvis). The latter can be conveniently captured by tags, such as #concept, #plan, #memory, #realization, #idea, #review, #bug, #feature, and others.
+- I'd like to experiment here with information retrieval from single paragraphs, or outline items, as atomic blocks of information, using inline tags.
+
+## Objectives
+
+1. Be able to tag and efficiently search single paragraphs among all notes, using tags and free text.
+2. Browse the entire content of these paragraphs without having to open each note.
+3. Make this accessible and user-friendly.
+
 ## Companion plugins
@@ -14,0 +41,0 @@

No alert changes

Improved metrics

Total package byte prevSize

186835

increased by801.93%

Number of lines in readme file

43

increased by168.75%

Worsened metrics

Dependency count

2

increased byInfinity%

Dependency changes

• + Addedmarkdown-it@^14.0.0

• + Addedmarkdown-it-task-lists@^2.1.1

• + Addedargparse@2.0.1(transitive)

• + Addedentities@4.5.0(transitive)

• + Addedlinkify-it@5.0.0(transitive)

• + Addedmarkdown-it@14.1.0(transitive)

• + Addedmarkdown-it-task-lists@2.1.1(transitive)

• + Addedmdurl@2.0.0(transitive)

• + Addedpunycode.js@2.3.1(transitive)

• + Addeduc.micro@2.1.0(transitive)