feat(docs): document quick search & jump to note

This commit is contained in:
Elian Doran 2025-04-04 22:46:19 +03:00
parent 18f812f568
commit 418da69b8a
No known key found for this signature in database
17 changed files with 402 additions and 95 deletions

View File

@ -1593,34 +1593,6 @@
}
]
},
{
"isClone": false,
"noteId": "Ms1nauBra7gq",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"Vc8PjrjAGuOp",
"Ms1nauBra7gq"
],
"title": "Quick search",
"notePosition": 110,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-search-alt-2",
"isInheritable": false,
"position": 10
}
],
"format": "markdown",
"dataFileName": "Quick search.md",
"attachments": []
},
{
"isClone": false,
"noteId": "8YBEPzcpUgxw",
@ -2629,6 +2601,137 @@
}
]
},
{
"isClone": false,
"noteId": "Ms1nauBra7gq",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"wArbEsdSae6g",
"Ms1nauBra7gq"
],
"title": "Quick search",
"notePosition": 40,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-search-alt-2",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "x0JgW8UqGXvq",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "xYmIYSP6wE3F",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "F1r9QtzQLZqm",
"isInheritable": false,
"position": 60
}
],
"format": "markdown",
"dataFileName": "Quick search.md",
"attachments": [
{
"attachmentId": "H0XlRahnnWbd",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Quick search_image.png"
}
]
},
{
"isClone": false,
"noteId": "F1r9QtzQLZqm",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"wArbEsdSae6g",
"F1r9QtzQLZqm"
],
"title": "Jump to Note",
"notePosition": 50,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-send",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "xYmIYSP6wE3F",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "MMiBEQljMQh2",
"isInheritable": false,
"position": 30
}
],
"format": "markdown",
"dataFileName": "Jump to Note.md",
"attachments": [
{
"attachmentId": "P9veX5eFZdPp",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Jump to Note_image.png"
},
{
"attachmentId": "y8yxomaf1Gkz",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Jump to Note_image.png"
}
]
},
{
"isClone": false,
"noteId": "eIg8jdvaoNNd",
@ -2639,7 +2742,7 @@
"eIg8jdvaoNNd"
],
"title": "Search",
"notePosition": 40,
"notePosition": 60,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2688,7 +2791,7 @@
"u3YFHC9tQlpm"
],
"title": "Bookmarks",
"notePosition": 50,
"notePosition": 70,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2737,7 +2840,7 @@
"OR8WJ7Iz9K4U"
],
"title": "Note Hoisting",
"notePosition": 60,
"notePosition": 80,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2793,7 +2896,7 @@
"9sRHySam5fXb"
],
"title": "Workspace",
"notePosition": 70,
"notePosition": 90,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2852,7 +2955,7 @@
"xWtq5NUHOwql"
],
"title": "Similar Notes",
"notePosition": 80,
"notePosition": 100,
"prefix": null,
"isExpanded": false,
"type": "text",

Binary file not shown.

After

Width:  |  Height:  |  Size: 729 B

View File

@ -0,0 +1,15 @@
# Jump to Note
![](Jump%20to%20Note_image.png)
The _Jump to Note_ function allows easy navigation between notes by searching for their title. In addition to that, it can also trigger a full search or create notes.
## Entering jump to note
* In the [Launch Bar](../UI%20Elements/Launch%20Bar.md), press ![](1_Jump%20to%20Note_image.png) button.
* Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.
## Interaction
* By default, when there is no text entered it will display the most recent notes (see [Note Navigation](Note%20Navigation.md)).
* Using the keyboard, use the up or down arrow keys to navigate between items. Press <kbd>Enter</kbd> to open the desired note.
* If the note doesn't exist, it's possible to create it by typing the desired note title and selecting the _Create and link child note_ option.

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

View File

@ -0,0 +1,15 @@
# Quick search
![](Quick%20search_image.png)
The _Quick search_ function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner.
The alternative to the quick search is the [Search](Search.md) function, which opens in a dedicated tab and has support for advanced queries.
For even faster navigation, it's possible to use [Jump to Note](Jump%20to%20Note.md) which will only search through the note titles instead of the content.
## Layout
Based on the [Vertical and horizontal layout](../UI%20Elements/Vertical%20and%20horizontal%20layout.md), the quick search is placed:
* On the vertical layout, it is displayed right above the [Note Tree](../UI%20Elements/Note%20Tree.md).
* On the horizontal layout, it is displayed in the [Launch Bar](../UI%20Elements/Launch%20Bar.md), where it can be positioned just like any other icon.

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

View File

@ -9,7 +9,7 @@ The vertical layout is Trilium's original layout:
* The [Launcher Bar](Launch%20Bar.md) is positioned on the left side of the screen, with buttons being laid out vertically.
* The tab bar is at the top, but to the right of the [Note Tree](Note%20Tree.md).
* The [Quick search](Quick%20search.md) is at the top of the [Note Tree](Note%20Tree.md).
* The [Quick search](../Navigation/Quick%20search.md) is at the top of the [Note Tree](Note%20Tree.md).
* The [Note Tree](Note%20Tree.md) can be collapsed by pressing the ![](5_Vertical%20and%20horizontal%20la.png) button at the bottom of the [Launcher Bar](Launch%20Bar.md).
* The [Global menu](Global%20menu.md) can be accessed via the ![](4_Vertical%20and%20horizontal%20la.png) icon at the top of the [Launcher Bar](Launch%20Bar.md).
@ -21,7 +21,7 @@ The horizontal layout is a more traditional layout, since it bears similarity wi
* The [Launcher Bar](Launch%20Bar.md) is at the top of the screen, with the buttons laid horizontally.
* The tab bar is at the top of the screen, but now covers the entirety of the width, allowing for more tabs to be displayed at once.
* The [Quick search](Quick%20search.md) is now part of the [Launcher Bar](Launch%20Bar.md). It can be moved around according to preference and even removed if needed.
* The [Quick search](../Navigation/Quick%20search.md) is now part of the [Launcher Bar](Launch%20Bar.md). It can be moved around according to preference and even removed if needed.
* The [Note Tree](Note%20Tree.md) can be collapsed by pressing the small ![](1_Vertical%20and%20horizontal%20la.png) button to the left of the first tab.
* The [Global menu](Global%20menu.md) can be accessed via the ![](Vertical%20and%20horizontal%20la.png) button at the end of the [Launcher Bar](Launch%20Bar.md).

View File

@ -1593,34 +1593,6 @@
}
]
},
{
"isClone": false,
"noteId": "Ms1nauBra7gq",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"Vc8PjrjAGuOp",
"Ms1nauBra7gq"
],
"title": "Quick search",
"notePosition": 110,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-search-alt-2",
"isInheritable": false,
"position": 10
}
],
"format": "html",
"dataFileName": "Quick search.html",
"attachments": []
},
{
"isClone": false,
"noteId": "8YBEPzcpUgxw",
@ -2629,6 +2601,137 @@
}
]
},
{
"isClone": false,
"noteId": "Ms1nauBra7gq",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"wArbEsdSae6g",
"Ms1nauBra7gq"
],
"title": "Quick search",
"notePosition": 40,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-search-alt-2",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "x0JgW8UqGXvq",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "xYmIYSP6wE3F",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "F1r9QtzQLZqm",
"isInheritable": false,
"position": 60
}
],
"format": "html",
"dataFileName": "Quick search.html",
"attachments": [
{
"attachmentId": "H0XlRahnnWbd",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Quick search_image.png"
}
]
},
{
"isClone": false,
"noteId": "F1r9QtzQLZqm",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"wArbEsdSae6g",
"F1r9QtzQLZqm"
],
"title": "Jump to Note",
"notePosition": 50,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-send",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "xYmIYSP6wE3F",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "MMiBEQljMQh2",
"isInheritable": false,
"position": 30
}
],
"format": "html",
"dataFileName": "Jump to Note.html",
"attachments": [
{
"attachmentId": "P9veX5eFZdPp",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Jump to Note_image.png"
},
{
"attachmentId": "y8yxomaf1Gkz",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "1_Jump to Note_image.png"
}
]
},
{
"isClone": false,
"noteId": "eIg8jdvaoNNd",
@ -2639,7 +2742,7 @@
"eIg8jdvaoNNd"
],
"title": "Search",
"notePosition": 40,
"notePosition": 60,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2688,7 +2791,7 @@
"u3YFHC9tQlpm"
],
"title": "Bookmarks",
"notePosition": 50,
"notePosition": 70,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2737,7 +2840,7 @@
"OR8WJ7Iz9K4U"
],
"title": "Note Hoisting",
"notePosition": 60,
"notePosition": 80,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2793,7 +2896,7 @@
"9sRHySam5fXb"
],
"title": "Workspace",
"notePosition": 70,
"notePosition": 90,
"prefix": null,
"isExpanded": false,
"type": "text",
@ -2852,7 +2955,7 @@
"xWtq5NUHOwql"
],
"title": "Similar Notes",
"notePosition": 80,
"notePosition": 100,
"prefix": null,
"isExpanded": false,
"type": "text",

Binary file not shown.

After

Width:  |  Height:  |  Size: 729 B

View File

@ -0,0 +1,43 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../style.css">
<base target="_parent">
<title data-trilium-title>Jump to Note</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Jump to Note</h1>
<div class="ck-content">
<figure class="image">
<img style="aspect-ratio:991/403;" src="Jump to Note_image.png" width="991"
height="403">
</figure>
<p>The <em>Jump to Note</em> function allows easy navigation between notes
by searching for their title. In addition to that, it can also trigger
a full search or create notes.</p>
<h2>Entering jump to note</h2>
<ul>
<li>In the&nbsp;<a class="reference-link" href="../UI%20Elements/Launch%20Bar.html">Launch Bar</a>,
press
<img src="1_Jump to Note_image.png" width="20" height="19">button.</li>
<li>Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.</li>
</ul>
<h2>Interaction</h2>
<ul>
<li>By default, when there is no text entered it will display the most recent
notes (see&nbsp;<a class="reference-link" href="Note%20Navigation.html">Note Navigation</a>).</li>
<li>Using the keyboard, use the up or down arrow keys to navigate between
items. Press <kbd>Enter</kbd> to open the desired note.</li>
<li>If the note doesn't exist, it's possible to create it by typing the desired
note title and selecting the <em>Create and link child note</em> option.</li>
</ul>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

View File

@ -0,0 +1,44 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../style.css">
<base target="_parent">
<title data-trilium-title>Quick search</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Quick search</h1>
<div class="ck-content">
<figure class="image">
<img style="aspect-ratio:659/256;" src="Quick search_image.png" width="659"
height="256">
</figure>
<p>The <em>Quick search</em> function does a full-text search (that is, it
searches through the content of notes and not just the title of a note)
and displays the result in an easy-to-access manner.</p>
<p>The alternative to the quick search is the&nbsp;<a class="reference-link"
href="Search.html">Search</a>&nbsp;function, which opens in a dedicated
tab and has support for advanced queries.</p>
<p>For even faster navigation, it's possible to use&nbsp;<a class="reference-link"
href="Jump%20to%20Note.html">Jump to Note</a>&nbsp;which will only search
through the note titles instead of the content.</p>
<h2>Layout</h2>
<p>Based on the&nbsp;<a class="reference-link" href="../UI%20Elements/Vertical%20and%20horizontal%20layout.html">Vertical and horizontal layout</a>,
the quick search is placed:</p>
<ul>
<li>On the vertical layout, it is displayed right above the&nbsp;<a class="reference-link"
href="../UI%20Elements/Note%20Tree.html">Note Tree</a>.</li>
<li>On the horizontal layout, it is displayed in the&nbsp;<a class="reference-link"
href="../UI%20Elements/Launch%20Bar.html">Launch Bar</a>, where it can
be positioned just like any other icon.</li>
</ul>
<p>&nbsp;</p>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

View File

@ -1,19 +0,0 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../style.css">
<base target="_parent">
<title data-trilium-title>Quick search</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Quick search</h1>
<div class="ck-content"></div>
</div>
</body>
</html>

View File

@ -21,8 +21,8 @@
<li>The&nbsp;<a href="Launch%20Bar.html">Launcher Bar</a>&nbsp;is positioned
on the left side of the screen, with buttons being laid out vertically.</li>
<li>The tab bar is at the top, but to the right of the&nbsp;<a href="Note%20Tree.html">Note Tree</a>.</li>
<li>The&nbsp;<a href="Quick%20search.html">Quick search</a>&nbsp;is at the
top of the&nbsp;<a href="Note%20Tree.html">Note Tree</a>.</li>
<li>The&nbsp;<a href="../Navigation/Quick%20search.html">Quick search</a>&nbsp;is
at the top of the&nbsp;<a href="Note%20Tree.html">Note Tree</a>.</li>
<li>The&nbsp;<a href="Note%20Tree.html">Note Tree</a>&nbsp;can be collapsed
by pressing the
<img src="5_Vertical and horizontal la.png">button at the bottom of the&nbsp;<a href="Launch%20Bar.html">Launcher Bar</a>.</li>
@ -41,9 +41,9 @@
of the screen, with the buttons laid horizontally.</li>
<li>The tab bar is at the top of the screen, but now covers the entirety of
the width, allowing for more tabs to be displayed at once.</li>
<li>The&nbsp;<a href="Quick%20search.html">Quick search</a>&nbsp;is now part
of the&nbsp;<a href="Launch%20Bar.html">Launcher Bar</a>. It can be moved
around according to preference and even removed if needed.</li>
<li>The&nbsp;<a href="../Navigation/Quick%20search.html">Quick search</a>&nbsp;is
now part of the&nbsp;<a href="Launch%20Bar.html">Launcher Bar</a>. It can
be moved around according to preference and even removed if needed.</li>
<li>The&nbsp;<a href="Note%20Tree.html">Note Tree</a>&nbsp;can be collapsed
by pressing the small
<img src="1_Vertical and horizontal la.png">button to the left of the first tab.</li>

View File

@ -97,9 +97,6 @@
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.html"
target="detail">Launch Bar</a>
</li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Quick%20search.html"
target="detail">Quick search</a>
</li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.html"
target="detail">Note buttons</a>
</li>
@ -153,6 +150,12 @@
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Note%20Navigation.html"
target="detail">Note Navigation</a>
</li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Quick%20search.html"
target="detail">Quick search</a>
</li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Jump%20to%20Note.html"
target="detail">Jump to Note</a>
</li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Search.html"
target="detail">Search</a>
</li>