joplin-plugin-tag-navigator 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +58 -14
  2. package/package.json +1 -1
  3. package/publish/joplin.plugin.alondmnt.tag-navigator.jpl +0 -0
  4. package/publish/joplin.plugin.alondmnt.tag-navigator.json +3 -3
package/README.md CHANGED
@@ -18,7 +18,7 @@ Type inline #tags in the note editor. View your tagged paragraphs and tasks / TO
18
18
  This plugin adds inline tag support (such as #inline-tag) to [Joplin](https://joplinapp.org) in five ways:
19
19
 
20
20
  1. It adds a panel for searching and viewing tagged paragraphs across all your notes ([video](https://www.youtube.com/watch?v=im0zjQFoXb0)).
21
- - **Save search queries** in notes and sync them across devices ([video](https://www.youtube.com/watch?v=xIBZl2Ala9A)).
21
+ - **Save search queries** in notes and sync them across devices ([video](https://www.youtube.com/watch?v=GuzCwYxyYZ0)).
22
22
  - **Tag-by-notes:** Search for links or [[wikilinks]] to notes (including backlinks to the current note).
23
23
  - **Edit tags:** Add, replace and remove inline tags via the panel context menu (right-click on a tag).
24
24
  - **Toggle checkboxes** / TODOs from the panel, including [[x]it! style](https://xit.jotaen.net) checkboxes (click, or right-click for 6 task states).
@@ -27,7 +27,7 @@ This plugin adds inline tag support (such as #inline-tag) to [Joplin](https://jo
27
27
  - Search tags by **today's date**. Examples: #today, #today+1 (tomorrow), #today-10 (ten days ago)
28
28
  2. It can generate a note with all tagged paragaraphs that match a saved query (dynamically updated).
29
29
  - Save a query in a note, and switch note view on: `Tools --> Tag Navigator --> Toggle search results display in note`
30
- 3. It adds a panel for quickly navigating between inline tags that appear in the current note.
30
+ 3. It adds a panel for quickly navigating between inline tags that appear in the current note, or in all notes ([video](https://www.youtube.com/watch?v=h-HdX7npbIw)).
31
31
  4. It can convert your existing inline tags to native Joplin tags, so that they are accessible using Joplin's built-in tag search.
32
32
  5. It can convert your existing native Joplin tags to inline tags, so that they are accessible using inline tag search (this plugin).
33
33
 
@@ -35,39 +35,83 @@ After installing the plugin, check the commands listed under `Tag Navigator` in
35
35
 
36
36
  ## Demos
37
37
 
38
- - Watch the tag search demo on YouTube:
38
+ - [Inline tag search](#inline-tag-search)
39
+ - [Saved search queries](#saved-search-queries)
40
+ - [Navigation panel](#navigation-panel)
41
+ - [Tag insertion](#tag-insertion)
39
42
 
40
- <a href="https://www.youtube.com/watch?v=im0zjQFoXb0"><img src="https://img.youtube.com/vi/im0zjQFoXb0/hqdefault.jpg" width="80%" title="search panel demo"></a>
43
+ ### Inline tag search
41
44
 
42
- - Watch the navigation panel demo:
45
+ <img src="img/tag-navigator-search.gif" width="80%" title="search panel demo">
43
46
 
44
- <img src="img/tag-navigator.gif" width="80%" title="navigation panel demo">
47
+ ### Saved search queries
48
+
49
+ <img src="img/tag-navigator-queries.gif" width="80%" title="saved search queries demo">
50
+
51
+ ### Navigation panel
52
+
53
+ <img src="img/tag-navigator-panel.gif" width="80%" title="navigation panel demo">
54
+
55
+ ### Tag insertion
56
+
57
+ <img src="img/tag-navigator-insert.gif" width="80%" title="insert tag demo">
45
58
 
46
59
  ## Tips
47
60
 
61
+ - [Troubleshooting](#troubleshooting)
62
+ - [Custom tag definitions](#custom-tag-definitions)
63
+ - [Inline TODOs](#inline-todos)
64
+ - [Keyboard shortcuts](#keyboard-shortcuts)
65
+
66
+ ### Troubleshooting
67
+
48
68
  - If any of the actions on note results does not work (toggling checkboxes, editing tags), this is usually resolved by a database update (Ctrl+Shift+D).
69
+
70
+ ### Custom tag definitions
71
+
49
72
  - The definition of a "tag" can be adjusted with user-defined regular expressions.
50
73
  - Example: Every word in the text may be defined as a tag using a custom regex such as `[A-Za-z0-9]+[\w]*`.
51
74
  - You may also define an exclusion rule to ignore certain tags.
52
75
  - Example: Numeric (`#123`) or hexanumeric (`#C0FF1E`) tags can be filtered using an exclusion regex such as `#(\d+|[a-fA-F0-9]{6})$`.
53
- - Inline TODOs:
54
- - Filter results by pending tasks (`"- [ ]"`) or ones done (`"- [x]"`).
55
- - 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)`.
56
- - 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)?`.
57
- - You may then use queries to search for tag-tasks based on their state (`- [ ]`, `- [x]`, `- [@]`, ...).
58
- - Supported additional checkbox styles
76
+
77
+ ### Inline TODOs
78
+
79
+ - Filter results by pending tasks (`"- [ ]"`) or ones done (`"- [x]"`).
80
+ - 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)`.
81
+ - Supported additional checkbox styles (inspired by `[x]it!`).
82
+ - Set any of them to done by clicking the checkbox in the search panel.
59
83
 
60
84
  ![custom checkboxes](img/checkboxes.png)
61
85
 
86
+ - Toggle between all states by right-clicking on a checkbox.
87
+
88
+ ![checkbox commands](img/checkboxes-commands.png)
89
+
62
90
  - 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).
63
- - Tag / note filter keyboard shortcuts:
91
+ - 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)?`.
92
+ - You may then use queries to search for tag-tasks based on their state (`- [ ]`, `- [x]`, `- [@]`, ...).
93
+
94
+ ### Keyboard shortcuts
95
+
96
+ - Default command shortcuts
97
+ - These can be set up in Joplin's keyboard shortcut settings.
98
+
99
+ | Key | Action |
100
+ | --- | ------ |
101
+ | Ctrl + Shift + T | Toggle search panel |
102
+ | Ctrl + Shift + I | Focus on search panel (search tag / insert tag) |
103
+ | Ctrl + Shift + D | Update tag database |
104
+ | Ctrl + Shift + L | Load search query from current note |
105
+
106
+ - Tag / note filter (search panel) shortcuts
64
107
 
65
108
  | Key | Action |
66
109
  | --- | ------ |
67
- | Enter | Add tag(s) / note to query |
110
+ | Enter | Add tag(s) / note to query / note (see config) |
68
111
  | 2nd Enter | Search notes based on current query |
69
112
  | Delete | Remove last added tag / note from query |
70
113
  | Esc | Clear the filter (display all tags / notes) |
114
+ | 2nd Esc | Return to note editor |
71
115
  | Arrow-Down | Toggle negation of last tag / note in query |
72
116
  | Arrow-Up | Toggle last operator AND <--> OR |
73
117
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "joplin-plugin-tag-navigator",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "scripts": {
5
5
  "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
6
6
  "prepare": "npm run dist",
package/publish/joplin.plugin.alondmnt.tag-navigator.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "desktop",
7
7
  "mobile"
8
8
  ],
9
- "version": "1.2.0",
9
+ "version": "1.2.2",
10
10
  "name": "Inline Tag Navigator",
11
11
  "description": "Type inline #tags in the note editor. View your tagged paragraphs and tasks / TODOs in an advanced search panel, or in a generated note. Convert inline and Obsidian tags into Joplin tags, and vice versa.",
12
12
  "author": "Alon Diament",
@@ -24,6 +24,6 @@
24
24
  ],
25
25
  "screenshots": [],
26
26
  "icons": {},
27
- "_publish_hash": "sha256:15e2c34a3524ed03d6299f55d93a4ecd350c94e09aa5047a05540d473be83ff1",
28
- "_publish_commit": "main:6053cb7308536efe4c5c8e65afcc501f47aa62f1"
27
+ "_publish_hash": "sha256:e5d61471add6a477eb69c6815fd493e0b8c7fd9df7daac8103c2f7b8d6d3026a",
28
+ "_publish_commit": "main:fd02fc3bdb3c33271e636befab59b847aa9082e3"
29
29
  }