joplin-plugin-tag-navigator 1.5.0 → 2.0.0

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.
package/README.md CHANGED
@@ -17,22 +17,23 @@ Type inline #tags or front matter in the note editor. View your tagged paragraph
17
17
 
18
18
  This plugin adds inline tag support (such as #inline-tag) to [Joplin](https://joplinapp.org) in five ways:
19
19
 
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=GuzCwYxyYZ0)).
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 device. ([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
- - **Tag in front matter:** All Markdown front matter fields can be treated as tags ([video](https://www.youtube.com/watch?v=L3zHletRk54)).
23
+ - **Tag in front matter:** All Markdown front matter fields can be treated as tags. ([video](https://www.youtube.com/watch?v=L3zHletRk54), [tips](#front-matter-tags))
24
24
  - **Edit tags:** Add, replace and remove inline tags via the panel context menu (right-click on a tag).
25
- - **Insert tags** from the panel into the note editor ([video](#tag-insertion)).
26
- - **Toggle checkboxes** / TODOs from the panel, including [[x]it! style](https://xit.jotaen.net) checkboxes (click, or right-click for 6 task states). See also [tips](#inline-todos).
27
- - **Nested tags** hierarchy: Search parent tags to find the locations of their children ([video](https://www.youtube.com/watch?v=h-HdX7npbIw)). Example: #parent/child.
28
- - Search for a **range of tags**, according to their lexicographic order. Example: #2024/07 -> #2024/08
29
- - Search tags by **today's date**. Examples: #today, #today+1 (tomorrow), #today-10 (ten days ago)
30
- 2. It can generate a note with all tagged paragaraphs that match a saved query (dynamically updated) ([video](https://www.youtube.com/watch?v=GuzCwYxyYZ0)).
31
- - Save a query in a note, and switch note view on: `Tools --> Tag Navigator --> Toggle search results display in note`
32
- - Display results in a table / database ([video](https://www.youtube.com/watch?v=L3zHletRk54), [tips](#table-views))
25
+ - **Insert tags** from the panel into the note editor. ([video](#tag-insertion))
26
+ - **Toggle checkboxes** / TODOs from the panel, including [[x]it! style](https://xit.jotaen.net) checkboxes (click, or right-click for 6 task states). ([tips](#inline-todos))
27
+ - **Nested tags** hierarchy: Search parent tags to find the locations of their children. Example: #parent/child. ([video](https://www.youtube.com/watch?v=h-HdX7npbIw))
28
+ - **Tag values**: Assign values to tags. Example: #tag=value. ([tips](#tag-values))
29
+ - **Tag ranges**: Search for a range of tags, according to their lexicographic order. Example: #2024/07 -> #2024/08. ([tips](#tag-ranges))
30
+ - **Today's date**: Search tags by today's date. Examples: #today, #today+1 (tomorrow), #today-10 (ten days ago).
31
+ 2. It can generate a note with all tagged paragaraphs that match a saved query (dynamically updated). ([video](https://www.youtube.com/watch?v=GuzCwYxyYZ0))
32
+ - Save a query in a note, and switch note view on: `Tools --> Tag Navigator --> Toggle search results display in note` .
33
+ - Display results in a table / database. ([video](https://www.youtube.com/watch?v=L3zHletRk54), [tips](#table-views))
33
34
  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)).
34
35
  4. It can convert your existing inline tags to native Joplin tags, so that they are accessible using Joplin's built-in tag search.
35
- 5. It can convert your existing native Joplin tags to inline tags, so that they are accessible using inline tag search (this plugin). See also [tips](#converting-joplin-tags).
36
+ 5. It can convert your existing native Joplin tags to inline tags, so that they are accessible using inline tag search (this plugin). ([tips](#converting-joplin-tags))
36
37
 
37
38
  After installing the plugin, check the commands listed under `Tag Navigator` in the `Tools` menu, as well as the corresponding settings section.
38
39
 
@@ -69,6 +70,8 @@ After installing the plugin, check the commands listed under `Tag Navigator` in
69
70
  - [Troubleshooting](#troubleshooting)
70
71
  - [Custom tag definitions](#custom-tag-definitions)
71
72
  - [Front matter tags](#front-matter-tags)
73
+ - [Tag ranges](#tag-ranges)
74
+ - [Tag values](#tag-values)
72
75
  - [Table views](#table-views)
73
76
  - [Inline TODOs](#inline-todos)
74
77
  - [Keyboard shortcuts](#keyboard-shortcuts)
@@ -85,6 +88,30 @@ After installing the plugin, check the commands listed under `Tag Navigator` in
85
88
  - You may also define an exclusion rule to ignore certain tags.
86
89
  - Example: Numeric (`#123`) or hexanumeric (`#C0FF1E`) tags can be filtered using an exclusion regex such as `#(\d+|[a-fA-F0-9]{6})$`.
87
90
 
91
+ ### Tag ranges
92
+
93
+ - Tag ranges can be used to search for a range of tags, according to their lexicographic order.
94
+ - Example: `#2024/07 -> #2024/08` will search for all tags starting with `#2024/07` and up to `#2024/08` (inclusive, i.e., returning two months).
95
+ - You may also use ranges with the `*` wildcard to search for tags starting with a certain prefix or ending with a suffix.
96
+ - Example: `#prefix* ->` will search for all tags starting with `#prefix`.
97
+ - Example: `*suffix ->` will search for all tags ending with `suffix`.
98
+ - Tag ranges can be inserted using the "Tag range" input boxes, or by right-clicking on a tag in the query area, and selecting `Edit query`.
99
+ - Example: Edit a tag or tag range and type `#prefix* ->` to search for all tags starting with `#prefix`.
100
+ - If you type only `#prefix`, the query will be converted to a standard tag search (matching only the tag `#prefix`).
101
+
102
+ ### Tag values
103
+
104
+ Tag values are a bit similar to nested tags as multiple parts of the tag are treated separately, but are distinct from them as explained below.
105
+
106
+ - Nested tags like `#parent/child` are shown as two separate tags in panels: `#parent` and `#parent/child`.
107
+ - Tag values like `#parent=value` are shown as a single tag in panels: `#parent`.
108
+ - This is useful when you wish to assign many different values to a single tag, and prefer to avoid displaying all of them.
109
+ - As with nested tags, you may search for `#parent`, and may also search for `#parent=value`, or use tag ranges.
110
+ - In order to search for a tag value, right-click on a tag in the query area, and select `Edit query`.
111
+ - You may then add the `=` operator to the tag, and enter the value you would like to search for.
112
+ - The value operator can be customised in the plugin settings.
113
+ - It should also be noted that while nested tags are widely used in note apps, tag values are less common.
114
+
88
115
  ### Front matter tags
89
116
 
90
117
  For example, the following YAML front matter, when inserted at the top of the note:
@@ -99,13 +126,13 @@ tags:
99
126
  ---
100
127
  ```
101
128
 
102
- will be converted to the following inline tags:
129
+ will be converted to the following inline tags and values:
103
130
 
104
131
  ```text
105
- #nested/tag_with_spaces
106
- #arrayed/v1
107
- #arrayed/v2
108
- #arrayed/v3
132
+ #nested=tag_with_spaces
133
+ #arrayed=v1
134
+ #arrayed=v2
135
+ #arrayed=v3
109
136
  #tag1
110
137
  #tag2
111
138
  #frontmatter
@@ -115,13 +142,13 @@ These tags will be accessible in the search panel / notes / tables like standard
115
142
 
116
143
  ### Table views
117
144
 
118
- - Quickly add new entries to the table by clicking on `New table entre note` in the context menu, toolbar, or Tag Navigator menu.
145
+ - Quickly add new entries to the table by clicking on `New table entry note` in the context menu, toolbar, or Tag Navigator menu.
119
146
  - The new note will contain a front matter template with properties for each column.
120
147
  - Tables can be customised using the following settings:
121
148
  - `Note view: Table view columns`: Set the default number of columns (most common ones) to display in the table view.
122
149
  - `Note view: Table view notebook path`: Set to true to display the notebook path in the table view.
123
150
  - `Note view: Note view: Tag case in table view`: Set to "Title Case" / "lowercase".
124
- - Tables can be customised per note using the saved query, by adding an `options` field with the following properties:
151
+ - Tables can be customised per note using the saved query, by adding an `options` field with any of the following properties:
125
152
  - `includeCols`
126
153
  - a comma-separated list of columns (tags / properties) to display in the table view
127
154
  - can be used to slice the table columns, sort them, or add "modified" / "created" timestamps
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "joplin-plugin-tag-navigator",
3
- "version": "1.5.0",
3
+ "version": "2.0.0",
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",
@@ -6,7 +6,7 @@
6
6
  "desktop",
7
7
  "mobile"
8
8
  ],
9
- "version": "1.5.0",
9
+ "version": "2.0.0",
10
10
  "name": "Inline Tag Navigator",
11
11
  "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.",
12
12
  "author": "Alon Diament",
@@ -24,6 +24,6 @@
24
24
  ],
25
25
  "screenshots": [],
26
26
  "icons": {},
27
- "_publish_hash": "sha256:0f91be0641c6be259031e70e13d5adc979e5544a1de73adcb725cb5f9eff66bb",
28
- "_publish_commit": "main:d0fd741bc73006d3e46e6f1803becc9848acaad9"
27
+ "_publish_hash": "sha256:2702ec9710a18f3c70ac9d7d6afb1cbe4d3deee442ed8b357455c86a2f273392",
28
+ "_publish_commit": "main:6f21d5aeb55b3f35ba7843234abf1f73417b35fb"
29
29
  }