Update doc and readme

Author: Odotocodot

Odotocodot.OneNote.Linq/OneNoteApplication.cs

@@ -64,19 +64,19 @@ public static void Init()
         public static void CreateQuickNote() => OneNoteParser.CreateQuickNote(OneNote, true);
 
         /// <inheritdoc cref="OneNoteParser.CreatePage(IApplication, OneNoteSection, string, bool)"/>
-        public static void CreatePage(OneNoteSection section, string pageTitle) => OneNoteParser.CreatePage(OneNote, section, pageTitle, true);
+        public static void CreatePage(OneNoteSection section, string name) => OneNoteParser.CreatePage(OneNote, section, name, true);
 
         /// <inheritdoc cref="OneNoteParser.CreateSection(IApplication, OneNoteSectionGroup, string, bool)"/>
-        public static void CreateSection(OneNoteSectionGroup parent, string sectionName) => OneNoteParser.CreateSection(OneNote, parent, sectionName, true);
+        public static void CreateSection(OneNoteSectionGroup parent, string name) => OneNoteParser.CreateSection(OneNote, parent, name, true);
 
         /// <inheritdoc cref="OneNoteParser.CreateSection(IApplication, OneNoteNotebook, string, bool)"/>
-        public static void CreateSection(OneNoteNotebook parent, string sectionName) => OneNoteParser.CreateSection(OneNote, parent, sectionName, true);
+        public static void CreateSection(OneNoteNotebook parent, string name) => OneNoteParser.CreateSection(OneNote, parent, name, true);
 
         /// <inheritdoc cref="OneNoteParser.CreateSectionGroup(IApplication, OneNoteSectionGroup, string, bool)"/>
-        public static void CreateSectionGroup(OneNoteSectionGroup parent, string sectionGroupName) => OneNoteParser.CreateSectionGroup(OneNote, parent, sectionGroupName, true);
+        public static void CreateSectionGroup(OneNoteSectionGroup parent, string name) => OneNoteParser.CreateSectionGroup(OneNote, parent, name, true);
 
         /// <inheritdoc cref="OneNoteParser.CreateSectionGroup(IApplication, OneNoteNotebook, string, bool)"/>
-        public static void CreateSectionGroup(OneNoteNotebook parent, string sectionGroupName) => OneNoteParser.CreateSectionGroup(OneNote, parent, sectionGroupName, true);
+        public static void CreateSectionGroup(OneNoteNotebook parent, string name) => OneNoteParser.CreateSectionGroup(OneNote, parent, name, true);
 
         /// <inheritdoc cref="OneNoteParser.CreateNotebook(IApplication, string, bool)"/>
         public static void CreateNotebook(string notebookName) => OneNoteParser.CreateNotebook(OneNote, notebookName, true);

Odotocodot.OneNote.Linq/OneNoteParser.cs

@@ -21,23 +21,23 @@ public static class OneNoteParser
         public const char RelativePathSeparator = '\\';
 
         /// <summary>
-        /// An array containing the characters that are not allowed in a <see cref="OneNoteNotebook">notebook</see> <see cref="OneNoteNotebook.Name">name</see>.<br/>
+        /// An array containing the characters that are not allowed in a <see cref="OneNoteNotebook">notebook</see> <see cref="OneNoteNotebook.Name"> name</see>.<br/>
         /// These are:&#009;<b>\ / * ? " | &lt; &gt; : % # .</b>
         /// </summary>
         /// <seealso cref="IsNotebookNameValid(string)"/>
         /// <seealso cref="InvalidSectionChars"/>
         /// <seealso cref="InvalidSectionGroupChars"/>
         public static readonly ImmutableArray<char> InvalidNotebookChars = """\/*?"|<>:%#.""".ToImmutableArray();
         /// <summary>
-        /// An array containing the characters that are not allowed in a <see cref="OneNoteSection">section</see> <see cref="OneNoteSection.Name">name</see>.<br/>
+        /// An array containing the characters that are not allowed in a <see cref="OneNoteSection">section</see> <see cref="OneNoteSection.Name"> name</see>.<br/>
         /// These are:&#009;<b>\ / * ? " | &lt; &gt; : % # &amp;</b>
         /// </summary>
         /// <seealso cref="IsSectionNameValid(string)"/>
         /// <seealso cref="InvalidNotebookChars"/>
         /// <seealso cref="InvalidSectionGroupChars"/>
         public static readonly ImmutableArray<char> InvalidSectionChars = """\/*?"|<>:%#&""".ToImmutableArray();
         /// <summary>
-        /// An array containing the characters that are not allowed in a <see cref="OneNoteSectionGroup">section group</see> <see cref="OneNoteSectionGroup.Name">name</see>.<br/>
+        /// An array containing the characters that are not allowed in a <see cref="OneNoteSectionGroup">section group</see> <see cref="OneNoteSectionGroup.Name"> name</see>.<br/>
         /// These are:&#009;<b>\ / * ? " | &lt; &gt; : % # &amp;</b>
         /// </summary>
         /// <seealso cref="IsSectionGroupNameValid(string)"/>
@@ -257,7 +257,7 @@ public static IEnumerable<OneNotePage> FindPages(IApplication oneNote, string se
         /// <param name="scope">The hierarchy item to search within.</param>
         /// <returns><inheritdoc cref="FindPages(IApplication, string)" path="/returns"/></returns>
         /// <seealso cref="FindPages(IApplication, string)"/>
-        /// <exception cref="ArgumentException"><inheritdoc cref="ValidateSearch(string)" path="/param[@cref='ArgumentException'"/></exception>
+        /// <exception cref="ArgumentException"><inheritdoc cref="ValidateSearch(string)" path="/exception[@cref='ArgumentException']"/></exception>
         /// <exception cref="ArgumentNullException">Thrown if <paramref name="search"/> or <paramref name="scope"/> is <see langword="null"/>.</exception>
         public static IEnumerable<OneNotePage> FindPages(IApplication oneNote, string search, IOneNoteItem scope)
         {
@@ -452,8 +452,7 @@ private static void CreateItemBase<T>(IApplication oneNote, IOneNoteItem parent,
         }
 
         /// <summary>
-        /// Creates a <see cref="OneNoteSection">section</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> 
-        /// <see cref="OneNoteSectionGroup">section group</see>.
+        /// Creates a <see cref="OneNoteSection">section</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> <see cref="OneNoteSectionGroup"> section group</see>.
         /// </summary>
         /// <param name="oneNote"><inheritdoc cref="GetNotebooks(IApplication)" path="/param[@name='oneNote']"/></param>
         /// <param name="parent">The hierarchy item to create the section in.</param>
@@ -465,8 +464,7 @@ public static void CreateSection(IApplication oneNote, OneNoteSectionGroup paren
             => CreateItemBase<OneNoteSection>(oneNote, parent, name, openImmediately);
 
         /// <summary>
-        /// Creates a <see cref="OneNoteSection">section</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> 
-        /// <see cref="OneNoteNotebook">notebook</see>.
+        /// Creates a <see cref="OneNoteSection">section</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> <see cref="OneNoteNotebook"> notebook</see>.
         /// </summary>
         /// <param name="oneNote"><inheritdoc cref="GetNotebooks(IApplication)" path="/param[@name='oneNote']"/></param>
         /// <param name="parent">The hierarchy item to create the section in.</param>
@@ -478,8 +476,7 @@ public static void CreateSection(IApplication oneNote, OneNoteNotebook parent, s
             => CreateItemBase<OneNoteSection>(oneNote, parent, name, openImmediately);
 
         /// <summary>
-        /// Creates a <see cref="OneNoteSectionGroup">section group</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> 
-        /// <see cref="OneNoteSectionGroup">section group</see>.
+        /// Creates a <see cref="OneNoteSectionGroup">section group</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> <see cref="OneNoteSectionGroup"> section group</see>.
         /// </summary>
         /// <param name="oneNote"><inheritdoc cref="GetNotebooks(IApplication)" path="/param[@name='oneNote']"/></param>
         /// <param name="parent">The hierarchy item to create the section group in.</param>
@@ -491,8 +488,7 @@ public static void CreateSectionGroup(IApplication oneNote, OneNoteSectionGroup
             => CreateItemBase<OneNoteSectionGroup>(oneNote, parent, name, openImmediately);
 
         /// <summary>
-        /// Creates a <see cref="OneNoteSectionGroup">section group</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> 
-        /// <see cref="OneNoteNotebook">notebook</see>.
+        /// Creates a <see cref="OneNoteSectionGroup">section group</see> with a title equal to <paramref name="name"/> located in the specified <paramref name="parent"/> <see cref="OneNoteNotebook"> notebook</see>.
         /// </summary>
         /// <param name="oneNote"><inheritdoc cref="GetNotebooks(IApplication)" path="/param[@name='oneNote']"/></param>
         /// <param name="parent">The hierarchy item to create the section group in.</param>

Readme.md

@@ -24,7 +24,7 @@ A [OneNote](https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-t
   - [Title Search](#title-search)
 - [Settings](#settings)
   - [Keywords](#keywords)
-- [Changelog](#changelog)
+- [Changelog](#200---2023-mm-dd)
 - [Acknowledgements](#acknowledgements)
 
 ## Installation
@@ -36,25 +36,25 @@ pm install OneNote
 ```
 
 > [!IMPORTANT]
-> For [version 2.0+](#changelog) requires at least Flow Launcher version 1.16.
+> For [version 2.0+](#200---2023-mm-dd) requires at Flow Launcher version 1.16+.
 
 ## Features
 
 ### At a glance
 
-| Keyword                      | Name                                    | Description                  |
-| ---------------------------- | --------------------------------------- | ---------------------------- |
-| `` on {your search query} `` | [Default Search](#default-search)       | Search OneNote pages         |
-| `` on nb:\ ``                | [Notebook Explorer](#notebook-explorer) | Navigate notebooks hierarchy |
-| `` on rcntpgs: ``            | [Recent Pages](#recent-pages)           | View recently modified pages |
+| Keyword                    | Name                                    | Description                  |
+| -------------------------- | --------------------------------------- | ---------------------------- |
+| ` on {your search query} ` | [Default Search](#default-search)       | Search OneNote pages         |
+| ` on nb:\ `                | [Notebook Explorer](#notebook-explorer) | Navigate notebooks hierarchy |
+| ` on rcntpgs: `            | [Recent Pages](#recent-pages)           | View recently modified pages |
 
 <!-- omit from toc -->
 #### Modifiers
 
 | Keyword | Name                            | Notes                                        |
 | ------- | ------------------------------- | -------------------------------------------- |
-| `` > `` | [Scoped Search](#scoped-search) | Search only within a specific hierarchy item |
-| `` * `` | [Title Search](#title-search)   | Search only the title of hierarchy items     |
+| ` > `   | [Scoped Search](#scoped-search) | Search only within a specific hierarchy item |
+| ` * `   | [Title Search](#title-search)   | Search only the title of hierarchy items     |
 
 > [!NOTE]
 > Hierarchy items are notebooks, section groups, sections and pages.
@@ -67,6 +67,8 @@ on {your search query}
 
 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.
 
+- Press <kbd>⏎ Enter</kbd> or left-click on a search result to open in OneNote.
+
 > [!NOTE]
 > You can include bitwise operators like `AND` or `OR` (they must be uppercase) in your search. E.g. `on hello there AND general kenobi`.
 
@@ -163,7 +165,7 @@ The plugin has a number of settings such as the ability items in the recycle bin
 
 <details>
   <summary>Screenshot of settings</summary>
-  <img src= "doc/settings.png" width="820" height="598" alt="settings">
+  <img src= "doc/settings.png" width="823" height="598" alt="settings">
 </details>
 
 ### Keywords
@@ -172,7 +174,7 @@ All the keywords used can be changed according to user preference.
 
 <details>
   <summary>Screenshot of keywords</summary>
-  <img src= "doc/keywords.png" alt="keywords">
+  <img src= "doc/keywords.png" width="823" height="276" alt="keywords">
 </details>
 
 <details>