mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-27 18:12:29 +08:00
feat(docs): document search in note functionality
This commit is contained in:
Elian Doran
parent
475c3bdde8
commit
feb43193b1
@ -3527,7 +3527,16 @@
|
|||||||
],
|
],
|
||||||
"format": "markdown",
|
"format": "markdown",
|
||||||
"dataFileName": "Search.md",
|
"dataFileName": "Search.md",
|
||||||
"attachments": []
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "WkhcA4FN7sGX",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Search_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"isClone": false,
|
"isClone": false,
|
||||||
@ -3748,6 +3757,71 @@
|
|||||||
"dataFileName": "Similar Notes_image.png"
|
"dataFileName": "Similar Notes_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "McngOG2jbUWX",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"gh7bpGYxajRS",
|
||||||
|
"wArbEsdSae6g",
|
||||||
|
"McngOG2jbUWX"
|
||||||
|
],
|
||||||
|
"title": "Search in note",
|
||||||
|
"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
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "8YBEPzcpUgxw",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "6f9hih2hXXZk",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "MI26XDLSAlCD",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "markdown",
|
||||||
|
"dataFileName": "Search in note.md",
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "vEq0g2DHEh3O",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Search in note_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
@ -0,0 +1,29 @@
|
|||||||
|
# Search in note
|
||||||
|
<figure class="image image_resized" style="width:100%;"><img style="aspect-ratio:898/93;" src="Search in note_image.png" width="898" height="93"></figure>
|
||||||
|
|
||||||
|
Local search allows you to search within the currently displayed note.
|
||||||
|
|
||||||
|
## Alternatives
|
||||||
|
|
||||||
|
* Pressing Ctrl+F while in a browser while not focused in a <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> or a <a class="reference-link" href="../../Note%20Types/Code.md">Code</a> note will trigger the browser's native search. This will also find text that is part of Trilium's UI.
|
||||||
|
* Pressing Ctrl+F in a <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> note will reveal <a class="reference-link" href="../../Advanced%20Usage/Technologies%20used/CKEditor.md">CKEditor</a>'s search functionality.
|
||||||
|
|
||||||
|
## Accessing the search
|
||||||
|
|
||||||
|
* On desktop, press<kbd>Ctrl</kbd> + <kbd>F</kbd>
|
||||||
|
* From the <a class="reference-link" href="../UI%20Elements/Note%20buttons.md">Note buttons</a>, look for the context menu and select _Search in note_.
|
||||||
|
|
||||||
|
## Interaction
|
||||||
|
|
||||||
|
* Finding:
|
||||||
|
* Fill in the _Find in text…_ with the text to search for.
|
||||||
|
* The search will be executed automatically in the background.
|
||||||
|
* Use up and down arrows of the text box to navigate between results.
|
||||||
|
* Replacing:
|
||||||
|
* Fill in the _Find in text_… field with the text to replace.
|
||||||
|
* Fill in the _Replace with…_ field the text to replace it with.
|
||||||
|
* Press _Replace_ to replace only the current result.
|
||||||
|
* Press _Replace all_ to replace all of them at once.
|
||||||
|
* Options:
|
||||||
|
* _Case sensitive_ – the search will distinguish upper case characters from lower case (e.g. searching for Hello will not match `hello`).
|
||||||
|
* _Match words_ - the search will find only exact word matches (e.g. searching for `Java` will not match `JavaScript`).
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
@ -1,7 +1,5 @@
|
|||||||
# Search
|
# Search
|
||||||
## Local Search
|
<figure class="image"><img style="aspect-ratio:987/725;" src="Search_image.png" width="987" height="725"></figure>
|
||||||
|
|
||||||
Local search allows you to search within the currently displayed note. To initiate a local search, press <kbd>Ctrl</kbd> + <kbd>F</kbd>. If using a web browser, this will be handled by the browser's native search functionality. In the desktop (electron) version, a separate dialog will apear.
|
|
||||||
|
|
||||||
## Note Search
|
## Note Search
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
76
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
76
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
@ -3527,7 +3527,16 @@
|
|||||||
],
|
],
|
||||||
"format": "html",
|
"format": "html",
|
||||||
"dataFileName": "Search.html",
|
"dataFileName": "Search.html",
|
||||||
"attachments": []
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "WkhcA4FN7sGX",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Search_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"isClone": false,
|
"isClone": false,
|
||||||
@ -3748,6 +3757,71 @@
|
|||||||
"dataFileName": "Similar Notes_image.png"
|
"dataFileName": "Similar Notes_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "McngOG2jbUWX",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"gh7bpGYxajRS",
|
||||||
|
"wArbEsdSae6g",
|
||||||
|
"McngOG2jbUWX"
|
||||||
|
],
|
||||||
|
"title": "Search in note",
|
||||||
|
"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
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "8YBEPzcpUgxw",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "6f9hih2hXXZk",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "MI26XDLSAlCD",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "html",
|
||||||
|
"dataFileName": "Search in note.html",
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "vEq0g2DHEh3O",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "Search in note_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
@ -0,0 +1,69 @@
|
|||||||
|
<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>Search in note</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Search in note</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<figure class="image image_resized" style="width:100%;">
|
||||||
|
<img style="aspect-ratio:898/93;" src="Search in note_image.png" width="898"
|
||||||
|
height="93">
|
||||||
|
</figure>
|
||||||
|
<p>Local search allows you to search within the currently displayed note. </p>
|
||||||
|
<h2>Alternatives</h2>
|
||||||
|
<ul>
|
||||||
|
<li>Pressing Ctrl+F while in a browser while not focused in a <a class="reference-link"
|
||||||
|
href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> or
|
||||||
|
a <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_6f9hih2hXXZk">Code</a> note
|
||||||
|
will trigger the browser's native search. This will also find text that
|
||||||
|
is part of Trilium's UI.</li>
|
||||||
|
<li>Pressing Ctrl+F in a <a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_iPIMuisry3hd">Text</a> note
|
||||||
|
will reveal <a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/1YeN2MzFUluU/_help_MI26XDLSAlCD">CKEditor</a>'s
|
||||||
|
search functionality.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Accessing the search</h2>
|
||||||
|
<ul>
|
||||||
|
<li>On desktop, press<kbd>Ctrl</kbd> + <kbd>F</kbd>
|
||||||
|
</li>
|
||||||
|
<li>From the <a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_8YBEPzcpUgxw">Note buttons</a>,
|
||||||
|
look for the context menu and select <em>Search in note</em>.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Interaction</h2>
|
||||||
|
<ul>
|
||||||
|
<li>Finding:
|
||||||
|
<ul>
|
||||||
|
<li>Fill in the <em>Find in text…</em> with the text to search for.</li>
|
||||||
|
<li>The search will be executed automatically in the background.</li>
|
||||||
|
<li>Use up and down arrows of the text box to navigate between results.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Replacing:
|
||||||
|
<ul>
|
||||||
|
<li>Fill in the <em>Find in text</em>… field with the text to replace.</li>
|
||||||
|
<li>Fill in the <em>Replace with…</em> field the text to replace it with.</li>
|
||||||
|
<li>Press <em>Replace</em> to replace only the current result.</li>
|
||||||
|
<li>Press <em>Replace all</em> to replace all of them at once.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Options:
|
||||||
|
<ul>
|
||||||
|
<li><em>Case sensitive</em> – the search will distinguish upper case characters
|
||||||
|
from lower case (e.g. searching for Hello will not match <code>hello</code>).</li>
|
||||||
|
<li><em>Match words</em> - the search will find only exact word matches (e.g.
|
||||||
|
searching for <code>Java</code> will not match <code>JavaScript</code>).</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
@ -13,11 +13,10 @@
|
|||||||
<h1 data-trilium-h1>Search</h1>
|
<h1 data-trilium-h1>Search</h1>
|
||||||
|
|
||||||
<div class="ck-content">
|
<div class="ck-content">
|
||||||
<h2>Local Search</h2>
|
<figure class="image">
|
||||||
<p>Local search allows you to search within the currently displayed note.
|
<img style="aspect-ratio:987/725;" src="Search_image.png" width="987"
|
||||||
To initiate a local search, press <kbd>Ctrl</kbd> + <kbd>F</kbd>. If using
|
height="725">
|
||||||
a web browser, this will be handled by the browser's native search functionality.
|
</figure>
|
||||||
In the desktop (electron) version, a separate dialog will apear.</p>
|
|
||||||
<h2>Note Search</h2>
|
<h2>Note Search</h2>
|
||||||
<p>Note search enables you to find notes by searching for text in the title,
|
<p>Note search enables you to find notes by searching for text in the title,
|
||||||
content, or <a href="#root/_help_zEY4DaJG4YT5">attributes</a> of the notes.
|
content, or <a href="#root/_help_zEY4DaJG4YT5">attributes</a> of the notes.
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
@ -195,6 +195,9 @@
|
|||||||
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Similar%20Notes.html"
|
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Similar%20Notes.html"
|
||||||
target="detail">Similar Notes</a>
|
target="detail">Similar Notes</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Search%20in%20note.html"
|
||||||
|
target="detail">Search in note</a>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Keyboard%20Shortcuts.html"
|
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Keyboard%20Shortcuts.html"
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user