joplin-plugin-tag-navigator 2.2.0 → 2.3.1

package/README.md

@@ -72,6 +72,7 @@ After installing the plugin, check the commands listed under `Tag Navigator` in
 - [Tag values](#tag-values)
 - [Front matter tags](#front-matter-tags)
 - [Table views](#table-views)
+- [Filtering results](#filtering-results)
 - [Inline TODOs](#inline-todos)
 - [Colour tags](#colour-tags)
 - [Keyboard shortcuts](#keyboard-shortcuts)
@@ -83,9 +84,9 @@ After installing the plugin, check the commands listed under `Tag Navigator` in
 
 ### Custom tag definitions
 
-- The definition of a "tag" can be adjusted with user-defined regular expressions.
+- The definition of a "tag" can be adjusted with user-defined regular expressions (see the advanced setting `Tag regex`).
     - Example: Every word in the text may be defined as a tag using a custom regex such as `[A-Za-z0-9]+[\w]*`.
-- You may also define an exclusion rule to ignore certain tags.
+- You may also define an exclusion rule to ignore certain tags (see the advanced setting `Exclude regex`).
     - Example: Numeric (`#123`) or hexanumeric (`#C0FF1E`) tags can be filtered using an exclusion regex such as `#(\d+|[a-fA-F0-9]{6})$`.
 
 ### Tag insertion
@@ -151,11 +152,12 @@ These tags will be accessible in the search panel / notes / tables like standard
 
 ### Table views
 
+- To enable table view, start by [saving a query](#saved-search-queries). Next, select `Tools --> Tag Navigator --> Toggle search results display in note` (or the corresponding toolbar button) until the saved query shows the property `"displayInNote": "table"` and a table appears.
 - Quickly add new entries to the table by clicking on `New table entry note` in the context menu, toolbar, or Tag Navigator menu.
-    - The new note will contain a front matter template with properties for each column.
+    - The new note will contain a [front matter](#front-matter-tags) template with properties for each column.
 - Tables can be customised using the following settings:
     - `Note view: Table view columns`: Set the default number of columns (most common ones) to display in the table view.
-    - `Note view: Table view notebook path`: Set to true to display the notebook path in the table view.
+    - `Search: Extract the full notebook path`: Enable this to display the notebook path in the table view, and to allow [filtering results](#filtering-results) by this path.
     - `Note view: Note view: Tag case in table view`: Set to "Title Case" / "lowercase".
 - Tables can be customised per note using the saved query, by adding an `options` field with any of the following properties:
     - `includeCols`
@@ -167,7 +169,7 @@ These tags will be accessible in the search panel / notes / tables like standard
         - a comma-separated list of columns to sort the table by
     - `sortOrder`
         - a comma-separated list of the words "ascending" / "descending" (or "desc", "descend", etc.) corresponding to the columns in the `sortBy` field
-    - example:
+    - Example for a saved query:
 
 ```json
 {
@@ -190,10 +192,18 @@ These tags will be accessible in the search panel / notes / tables like standard
 }
 ```
 
+### Filtering results
+
+- Text entered in the results filter (on the panel or in a saved query) can be used to search within title of the notes, their notebook name / path, or the content of the displayed results.
+- To gain more control over filtering by notebook, you may enable the setting `Search: Extract the full notebook path`.
+    - Example: Limit results to a notebook that appears in the top level by searching for `|/topNotebook`.
+    - Example: Search for `topNotebook/childNotebook` to show only results from childNotebook.
+- You may enable `Search: Use regex for tag / note / content filtering` to filter using regular expressions.
+
 ### Inline TODOs
 
 - Filter results by pending tasks (`"- [ ]"`) or ones done (`"- [x]"`).
-- Add support for [additional tags](https://github.com/CalebJohn/joplin-inline-todo?tab=readme-ov-file#confluence-style) for @mentions, +projects and //due-dates using a custom tag regex such as `(?<=^|\s)([#@+]|\/\/)([^\s#@'\"]*\w)`.
+- Add support for [additional tags](https://github.com/CalebJohn/joplin-inline-todo?tab=readme-ov-file#confluence-style) for @mentions, +projects and //due-dates using a custom tag regex such as `(?<=^|\s)([#@+]|\/\/)([^\s#@+'",.()\[\]:;\?\\]+)`.
 - Supported additional checkbox styles (inspired by `[x]it!`).
     - Set any of them to done by clicking the checkbox in the search panel.
 
@@ -204,7 +214,7 @@ These tags will be accessible in the search panel / notes / tables like standard
 ![checkbox commands](img/checkboxes-commands.png)
 
 - You may increase the checkbox size on smaller screens by setting `Search: Panel style` with the CSS `.itags-search-checkbox { width: 18px; height: 18px; font-size: 18px }` (adjust as needed).
-- Furthermore, every checkbox in the text (even ones that are not tagged by any inline #tag) may be defined as a tag using a custom regex such as `(?<=^|\s)([#]|\-\s\[[x\s@\?!~]\])([^\s#'\"]*\w)?`.
+- Furthermore, every checkbox in the text (even ones that are not tagged by any inline #tag) may be defined as a tag using a custom regex such as `(?<=^|\s)(#([^\s#'",.()\[\]:;\?\\]+)|(\-\s\[[x\s@\?!~]\]))`.
     - You may then use queries to search for tag-tasks based on their state (`- [ ]`, `- [x]`, `- [@]`, ...).
 
 ### Colour tags
@@ -266,7 +276,7 @@ These tags will be accessible in the search panel / notes / tables like standard
 - You can highlight tags in the Markdown editor using [Rich Markdown](https://github.com/CalebJohn/joplin-rich-markdown) (version ≥ 0.14).
     - In `Joplin settings --> Rich Markdown --> Advanced Settings --> Custom classes JSON` enter:
     ```
-    [{"name": "rm-tag", "regex": "(?<=^|\\s)#([^\\s#'\"]*\\w)"}]
+    [{"name": "rm-tag", "regex": "(?<=^|\\s)#([^\\s#'\",.()\\[\\]:;\\?\\\\]+)"}]
     ```
     - In `Joplin settings --> Appearance --> Custom stylesheet for Joplin-wide app styles` add the following to the style sheet:
     ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-tag-navigator",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "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.alondmnt.tag-navigator.json

@@ -6,7 +6,7 @@
 		"desktop",
 		"mobile"
 	],
-	"version": "2.2.0",
+	"version": "2.3.1",
 	"name": "Inline Tag Navigator",
 	"description": "Type inline tags or front matter in the note editor. View your tagged paragraphs and tasks / TODOs in a search panel, or in a generated note. Build a table view / database from notes and tags. Convert between Obsidian tags and Joplin tags.",
 	"author": "Alon Diament",
@@ -24,6 +24,6 @@
 	],
 	"screenshots": [],
 	"icons": {},
-	"_publish_hash": "sha256:211a6a85d6927b055b4defdb83fc9992124062f341b6092a8bfd13caf13c5494",
-	"_publish_commit": "main:97d2216ccbd2da4938b8e5d7273125194fd766be"
+	"_publish_hash": "sha256:af7b3a1476b1d972111811d4765445c92f26d4e9287403e477b7c8b702864d06",
+	"_publish_commit": "main:29d71f03380b411875b8d9f64cbfb646521eefb0"
 }