self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-24 08:12:24 +02:00
Code Issues Releases Activity

Doc: Added search engine doc

Browse Source
This commit is contained in:
Laurent Cozic 2018-12-15 01:46:06 +01:00
parent fa0572de77
commit a6716d55c5
3 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -285,6 +285,20 @@ It is generally recommended to enter the notes as Markdown as it makes the notes
Rendered markdown can be customized by placing a userstyle file in the profile directory `~/.config/joplin-desktop/userstyle.css` (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax.
# Searching
Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both [Simple FTS Queries](https://www.sqlite.org/fts3.html#simple_fts_queries) and [Full-Text Index Queries](https://www.sqlite.org/fts3.html#full_text_index_queries) are supported. See below for the list of supported queries:
Search type | Description | Example
------------|-------------|---------
Single word | Returns all the notes that contain this term. | `dog`, `cat`
Multiples words | Returns all the notes that contain **all** these words, but not necessarily next to each other. | `dog cat` - will return any notes that contain the words "dog" and "cat" anywhere in the note, no necessarily in that order nor next to each others. It will **not** return results that contain "dog" or "cat" only.
Phrase query | Add double quotes to return the notes that contain exactly this phrase. | `"shopping list"` - will return the notes that contain these **exact terms** next to each others and in this order. It will **not** return for example a note that contain "going shopping with my list".
Prefix | Add a wildmark to return all the notes that contain a term with a specified prefix. | `swim*` - will return all the notes that contain eg. "swim", but also "swimming", "swimsuit", etc. IMPORTANT: The wildcard **can only be at the end** - it will be ignored at the beginning of a word (eg. `*swim`) and will be treated as a literal asterisk in the middle of a word (eg. `ast*rix`)
Field restricted | Add either `title:` or `body:` before a note to restrict your search to just the title, or just the body. | `title:shopping`, `body:egg`
Notes are sorted by "relevance". Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matter how close to each others are the terms. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as much details as possible to replicate the issue.
# Donations
Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.

19
docs/faq/index.html
View File

@ -250,6 +250,25 @@
</li>
</ul>
</div>
<h1 id="clicking-edit-in-external-editor-does-nothing-i-want-to-change-the-editor-">Clicking &#39;Edit in External Editor&#39; does nothing! / I want to change the editor!</h1>
<p>The editor command (may include arguments) defines which editor will be used to open a note. If none is provided it will try to auto-detect the default editor. If this does nothing or you want to change it for Joplin, you need to configure it in Settings -&gt; Text editor command.</p>
<p>Some example configurations are: (comments after #)</p>
<p>Linux/Mac:</p>
<pre><code class="lang-bash">subl -n # Opens Sublime (subl) in a new window (-n)
code -n # Opens Visual Studio Code (code) in a new window (-n)
gedit --new-window # Opens gedit (Gnome Text Editor) in a new window
xterm -e vim # Opens a new terminal and opens vim. Can be replaced with an
# alternative terminal (gnome-terminal, terminator, etc.)
# or terminal text-editor (emacs, nano, etc.)
open -a &lt;application&gt; # Mac only: opens a GUI application
</code></pre>
<p>Windows:</p>
<pre><code class="lang-bash">subl.exe -n # Opens Sublime (subl) in a new window (-n)
code.exe -n # Opens Visual Studio Code in a new window (-n)
notepad.exe # Opens Notepad in a new window
notepad++.exe --openSession # Opens Notepad ++ in new window
</code></pre>
<p>Note that the path to directory with your editor executable must exist in your PATH variable (<a href="https://www.computerhope.com/issues/ch000549.htm">Windows</a>, <a href="https://opensource.com/article/17/6/set-path-linux">Linux/Mac</a>) If not, the full path to the executable must be provided.</p>
<h1 id="when-i-open-a-note-in-vim-the-cursor-is-not-visible">When I open a note in vim, the cursor is not visible</h1>
<p>It seems to be due to the setting <code>set term=ansi</code> in .vimrc. Removing it should fix the issue. See <a href="https://github.com/laurent22/joplin/issues/147">https://github.com/laurent22/joplin/issues/147</a> for more information.</p>
<h1 id="all-my-notes-got-deleted-after-changing-the-webdav-url-">All my notes got deleted after changing the WebDAV URL!</h1>

40
docs/index.html
View File

@ -356,6 +356,7 @@
<li>Search functionality.</li>
<li>Geo-location support.</li>
<li>Supports multiple languages</li>
<li>External editor support - open notes in your favorite external editor with one click in Joplin.</li>
</ul>
<h1 id="importing">Importing</h1>
<h2 id="importing-from-evernote">Importing from Evernote</h2>
@ -475,6 +476,45 @@ $$
<pre><code>This is &lt;s&gt;strikethrough text&lt;/s&gt; mixed with regular **Markdown**.
</code></pre><h2 id="custom-css">Custom CSS</h2>
<p>Rendered markdown can be customized by placing a userstyle file in the profile directory <code>~/.config/joplin-desktop/userstyle.css</code> (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax.</p>
<h1 id="searching">Searching</h1>
<p>Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both <a href="https://www.sqlite.org/fts3.html#simple_fts_queries">Simple FTS Queries</a> and <a href="https://www.sqlite.org/fts3.html#full_text_index_queries">Full-Text Index Queries</a> are supported. See below for the list of supported queries:</p>
<table>
<thead>
<tr>
<th>Search type</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>Single word</td>
<td>Returns all the notes that contain this term.</td>
<td><code>dog</code>, <code>cat</code></td>
</tr>
<tr>
<td>Multiples words</td>
<td>Returns all the notes that contain <strong>all</strong> these words, but not necessarily next to each other.</td>
<td><code>dog cat</code> - will return any notes that contain the words &quot;dog&quot; and &quot;cat&quot; anywhere in the note, no necessarily in that order nor next to each others. It will <strong>not</strong> return results that contain &quot;dog&quot; or &quot;cat&quot; only.</td>
</tr>
<tr>
<td>Phrase query</td>
<td>Add double quotes to return the notes that contain exactly this phrase.</td>
<td><code>&quot;shopping list&quot;</code> - will return the notes that contain these <strong>exact terms</strong> next to each others and in this order. It will <strong>not</strong> return for example a note that contain &quot;going shopping with my list&quot;.</td>
</tr>
<tr>
<td>Prefix</td>
<td>Add a wildmark to return all the notes that contain a term with a specified prefix.</td>
<td><code>swim*</code> - will return all the notes that contain eg. &quot;swim&quot;, but also &quot;swimming&quot;, &quot;swimsuit&quot;, etc. IMPORTANT: The wildcard <strong>can only be at the end</strong> - it will be ignored at the beginning of a word (eg. <code>*swim</code>) and will be treated as a literal asterisk in the middle of a word (eg. <code>ast*rix</code>)</td>
</tr>
<tr>
<td>Field restricted</td>
<td>Add either <code>title:</code> or <code>body:</code> before a note to restrict your search to just the title, or just the body.</td>
<td><code>title:shopping</code>, <code>body:egg</code></td>
</tr>
</tbody>
</table>
<p>Notes are sorted by &quot;relevance&quot;. Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matter how close to each others are the terms. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as much details as possible to replicate the issue.</p>
<h1 id="donations">Donations</h1>
<p>Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.</p>
<p>Please see the <a href="https://joplin.cozic.net/donate/">donation page</a> for information on how to support the development of Joplin.</p>