You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A [OneNote](https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-taking-app) plugin for the [Flow launcher](https://github.com/Flow-Launcher/Flow.Launcher), allowing for the ability to quickly access and create notes.
12
12
13
13
<!-- omit from toc -->
14
-
## Contents
14
+
## Contents
15
+
15
16
-[Installation](#installation)
16
17
-[Features](#features)
17
-
- [At a glance](#at-a-glance)
18
-
- [Default Search](#default-search)
19
-
- [Notebook Explorer](#notebook-explorer)
20
-
- [Create New Items](#create-new-items)
21
-
- [Recent Pages](#recent-pages)
22
-
- [Scoped Search](#scoped-search)
23
-
- [Title Search](#title-search)
18
+
-[At a glance](#at-a-glance)
19
+
-[Default Search](#default-search)
20
+
-[Notebook Explorer](#notebook-explorer)
21
+
-[Create New Items](#create-new-items)
22
+
-[Recent Pages](#recent-pages)
23
+
-[Scoped Search](#scoped-search)
24
+
-[Title Search](#title-search)
24
25
-[Settings](#settings)
25
-
- [Keywords](#keywords)
26
-
-[2.0 Changelog](#20-changelog)
26
+
-[Keywords](#keywords)
27
+
-[Changelog](#changelog)
27
28
-[Acknowledgements](#acknowledgements)
28
29
29
30
## Installation
31
+
30
32
Using Flow Launcher type:
33
+
31
34
```
32
35
pm install OneNote
33
36
```
37
+
34
38
> [!IMPORTANT]
35
-
> Requires at least Flow Launcher version 1.16.
39
+
> For [version 2.0+](#changelog) requires at least Flow Launcher version 1.16.
|`` > ``|[Scoped Search](#scoped-search)| Search only within a specific hierarchy item |
57
+
|`` * ``|[Title Search](#title-search)| Search only the title of hierarchy items |
58
+
59
+
> [!NOTE]
60
+
> Hierarchy items are notebooks, section groups, sections and pages.
45
61
46
62
### Default Search
63
+
47
64
```
48
65
on {your search query}
49
66
```
50
-
This is allows you to search OneNote pages. The OneNote API searches both the content in a page as well as the page title.
67
+
68
+
This is allows you to search OneNote pages using the OneNote API which searches both the content in a page as well as the page title.
51
69
52
70
> [!NOTE]
53
71
> You can include bitwise operators like `AND` or `OR` (they must be uppercase) in your search. E.g. `on hello there AND general kenobi`.
54
72
55
-
73
+
![default search gif]()
56
74
57
75
### Notebook Explorer
58
76
59
77
```
60
78
on nb:\
61
79
```
80
+
62
81
Transverse your OneNote notebooks explorer style.
63
82
64
83
- Press <kbd>⏎ Enter</kbd> or <kbd>⇥ Tab</kbd> or left-click on a result to auto complete the query.
65
84
- Press <kbd>⇧ Shift</kbd> + <kbd>⏎ Enter</kbd> or right-click on a result to open it directly in OneNote.
66
85
67
-
see settings for options on recycle bin etc.
86
+
![notebook explorer gif]()
68
87
69
-
70
-
71
-
> [!INFORMATION]
88
+
> [!NOTE]
72
89
> Supports all OneNote hierarchy items i.e. notebooks, section groups, sections and pages.
73
90
74
91
#### Create New Items
75
92
76
93
Whilst using the notebook explorer, if you search query does not match any names of the items in the results, the plugin will give you an option to create a new item.
77
94
78
-
95
+
![create new section gif]()
79
96
80
-
> [!INFORMATION]
97
+
> [!NOTE]
81
98
> Supports all OneNote hierarchy items i.e. notebooks, section groups, sections and pages.
99
+
>
82
100
### Recent Pages
83
101
84
102
```
@@ -89,20 +107,114 @@ Displays your recently modified OneNote pages.
89
107
90
108
Add a number after `` rcntpgs: `` to display that number of recent pages. E.g. the full query ``on rcntpgs:10`` will show the 10 most recently modified pages.
91
109
92
-
110
+
![recent pages gif]()
111
+
93
112
### Scoped Search
94
113
114
+
```
115
+
on nb:\{hierarchy path}\>{your search query}
116
+
```
117
+
118
+
Scoped search is the same as [default search](#default-search) but restricted to search within a specific hierarchy item.
119
+
120
+
> [!IMPORTANT]
121
+
> Must be used with [notebook explorer](#notebook-explorer).
122
+
123
+
![scoped search gif]()
124
+
125
+
<details>
126
+
<summary><h4>Example Queries<h4></summary>
127
+
128
+
```
129
+
on nb:\A Notebook\A Section Group\>hello there
130
+
```
131
+
132
+
Will use the OneNote API to search the hierarchy item `A Section Group` for `hello there`
133
+
134
+
</details>
135
+
95
136
### Title Search
96
137
138
+
```
139
+
on *{your search query}
140
+
```
141
+
142
+
Searches for hierarchy items based on their title alone. Unlike [scoped search](#scoped-search) and [default search](#default-search) which only return pages, title search can return all hierarchy item types.
143
+
144
+
> [!NOTE]
145
+
> Can be used in conjunction with [notebook explorer](#notebook-explorer).
146
+
147
+
![title search gif]()
148
+
149
+
<details>
150
+
<summary><h4>Example Queries<h4></summary>
151
+
152
+
```
153
+
on nb:\A Notebook\A Section Group\*hello there
154
+
```
155
+
156
+
Will search for titles in the hierarchy item `A Section Group` that match or are similar to `hello there`
157
+
158
+
</details>
97
159
98
160
## Settings
99
161
162
+
The plugin has a number of settings such as the ability items in the recycle bin or indicate which pages have unread changes.
All the keywords used can be changed according to user preference.
172
+
173
+
<details>
174
+
<summary>Screenshot of keywords</summary>
175
+
<imgsrc= "doc/keywords.png"alt="keywords">
176
+
</details>
177
+
178
+
<details>
179
+
<summary><h2id="changelog">2.0.0 Changelog: Massive Refactor and New Features</h2></summary>
180
+
181
+
<!-- omit from toc -->
182
+
### 2.0.0 - 2023-mm-dd
183
+
184
+
<!-- omit from toc -->
185
+
#### Added
186
+
187
+
-**[Created custom OneNote parser/library](https://github.com/Odotocodot.OneNote.Linq)** Adding the ability for several new features.
188
+
- Support for section groups when using the notebook explorer.
189
+
- Support for displaying unread results.
190
+
- Support for showing locked sections in results (you still can't see inside them unless they are unlocked).
191
+
- The ability to search by only title.
192
+
- The ability to do a scoped search (e.g. search in one section only).
193
+
-**Settings!** You can change these options:
194
+
- Show unread icons
195
+
- Show encrypted sections
196
+
- Show recycle bin items
197
+
- Created coloured icons for notebook and sections
198
+
- Default number of recent pages
199
+
-**Customisable keywords!**
200
+
201
+
<!-- omit from toc -->
202
+
#### Changed
203
+
204
+
- Compressed all images
205
+
- Reduced the calls to create a OneNote COM object, this should lead to a overall smoother experience
206
+
- Updated to .NET 7 (update Flow Launcher if an error persists)
207
+
- Refactored most of the code.
208
+
209
+
<!-- omit from toc -->
210
+
#### Removed
211
+
212
+
-[Scipbe.Common.Office.OneNote](https://github.com/scipbe/ScipBe-Common-Office) package reference.
213
+
214
+
</details>
103
215
104
216
## Acknowledgements
105
217
106
-
- Made with [Odotocodot.OneNote.Linq](https://github.com/Odotocodot.OneNote.Linq) a library for exposing the OneNote API also made by me :smiley:.
107
-
- Inspired by the OneNote plugin for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote).
108
-
- Icons from [Icons8](https://icons8.com).
218
+
- Made with [Odotocodot.OneNote.Linq](https://github.com/Odotocodot.OneNote.Linq) a library for exposing the OneNote API also made by me :smiley:
219
+
- Inspired by the OneNote plugin for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote)
0 commit comments