From a0de8582e65880158b744466b43d13aad84530e9 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 9 Oct 2020 21:56:56 +0100 Subject: [PATCH] Update website --- docs/api/get_started/plugins/index.html | 7 +- docs/api/overview/index.html | 5 +- .../references/development_mode/index.html | 3 +- .../api/references/plugin_manifest/index.html | 3 +- docs/api/references/rest_api/index.html | 3 +- docs/api/tutorials/toc_plugin/index.html | 11 +- docs/blog/20180621-182112/index.html | 3 +- docs/blog/20180906-111039/index.html | 3 +- docs/blog/20180916-210431/index.html | 3 +- docs/blog/20180929-121053/index.html | 3 +- docs/blog/20181004-091123/index.html | 3 +- docs/blog/20181101-174335/index.html | 3 +- docs/blog/20181213-173459/index.html | 3 +- docs/blog/20190130-230218/index.html | 3 +- docs/blog/20190404-074157/index.html | 3 +- docs/blog/20190424-112410/index.html | 3 +- docs/blog/20190523-231026/index.html | 3 +- docs/blog/20190611-000711/index.html | 3 +- docs/blog/20190613-202613/index.html | 3 +- docs/blog/20190814-225957/index.html | 3 +- docs/blog/20190925-000254/index.html | 3 +- docs/blog/20190929-152834/index.html | 3 +- docs/blog/20191012-233121/index.html | 3 +- docs/blog/20191014-165136/index.html | 3 +- docs/blog/20191101-131852/index.html | 3 +- docs/blog/20191117-183855/index.html | 3 +- docs/blog/20191118-072700/index.html | 3 +- docs/blog/20200220-190804/index.html | 3 +- docs/blog/20200301-125055/index.html | 3 +- docs/blog/20200314-001555/index.html | 3 +- docs/blog/20200406-224254/index.html | 3 +- docs/build_troubleshooting/index.html | 3 +- docs/changelog/index.html | 3 +- docs/changelog_cli/index.html | 3 +- docs/clipper/index.html | 3 +- docs/conflict/index.html | 3 +- docs/debugging/index.html | 3 +- docs/desktop/index.html | 3 +- docs/donate/index.html | 3 +- docs/e2ee/index.html | 3 +- docs/faq/index.html | 3 +- docs/gsoc2020/ideas/index.html | 3 +- docs/gsoc2020/index/index.html | 3 +- docs/gsod2020/ideas/index.html | 3 +- docs/gsod2020/index/index.html | 3 +- docs/index.html | 35 +- docs/markdown/index.html | 3 +- docs/mobile/index.html | 3 +- docs/nextcloud_app/index.html | 3 +- docs/plugins/index.html | 3 +- docs/prereleases/index.html | 3 +- docs/spec/e2ee/index.html | 3 +- docs/spec/history/index.html | 3 +- docs/spec/plugins/index.html | 3 +- docs/spec/search_sorting/index.html | 428 ++++++++++++++++++ docs/spec/sync_lock/index.html | 3 +- docs/stats/index.html | 3 +- docs/terminal/index.html | 3 +- docs/welcome/1_welcome_to_joplin/index.html | 3 +- .../index.html | 3 +- .../3_synchronising_your_notes/index.html | 3 +- docs/welcome/4_tips/index.html | 3 +- docs/welcome/5_privacy/index.html | 3 +- 63 files changed, 575 insertions(+), 85 deletions(-) create mode 100644 docs/spec/search_sorting/index.html diff --git a/docs/api/get_started/plugins/index.html b/docs/api/get_started/plugins/index.html index d1cb10f2ff..a2a9428738 100644 --- a/docs/api/get_started/plugins/index.html +++ b/docs/api/get_started/plugins/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • @@ -379,7 +380,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m

    This will create the basic scafolding of the plugin. At the root of it, there is a number of configuration files which you normally won't need to change. Then the src/ directory will contain your code. By default, the project uses TypeScript, but you are free to use plain JavaScript too - eventually the project is compiled to plain JS in any case.

    The src/ directory also contains a manifest.json file, which you can edit to set various information about the plugin, such as its name, homepage URL, etc.

    Building the plugin🔗

    -

    The file src/index.ts already contain some basic code meant for testing the plugin. In particular it contains a call to joplin.plugins.register, which all plugins should call to register the plugin. And an onStart() event handler, which will be executed by Joplin when the plugin starts.

    +

    The file src/index.ts already contain some basic code meant for testing the plugin. In particular it contains a call to joplin.plugins.register, which all plugins should call to register the plugin. And an onStart() event handler, which will be executed by Joplin when the plugin starts.

    To try this basic plugin, compile the app by running the following from the root of the project:

    npm run dist
    @@ -391,7 +392,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.m

    Next steps🔗

    diff --git a/docs/api/overview/index.html b/docs/api/overview/index.html index 6da6bff20e..18826d31f6 100644 --- a/docs/api/overview/index.html +++ b/docs/api/overview/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • @@ -369,7 +370,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/overview.md

    The data API, which is a server that provides access to Joplin data to external applications. It is possible, using standard HTTP calls, to create, modify or delete notes, notebooks, tags, etc. as well as attach files to notes and retrieve these files. This is for example how the web clipper communicates with Joplin.

  • -

    The plugin API, which allows directly modifying Joplin by adding new features to the application. Using this API, you can:

    +

    The plugin API, which allows directly modifying Joplin by adding new features to the application. Using this API, you can:

    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/developmen
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/api/references/plugin_manifest/index.html b/docs/api/references/plugin_manifest/index.html index d7df3872b1..a3d969cb28 100644 --- a/docs/api/references/plugin_manifest/index.html +++ b/docs/api/references/plugin_manifest/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/plugin_man
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/api/references/rest_api/index.html b/docs/api/references/rest_api/index.html index b6719f99cd..6f2897bfc7 100644 --- a/docs/api/references/rest_api/index.html +++ b/docs/api/references/rest_api/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/references/rest_api.m
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/api/tutorials/toc_plugin/index.html b/docs/api/tutorials/toc_plugin/index.html index 929c59d1e1..afb57ee585 100644 --- a/docs/api/tutorials/toc_plugin/index.html +++ b/docs/api/tutorials/toc_plugin/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • @@ -372,7 +373,7 @@ https://github.com/laurent22/joplin/blob/master/readme/api/tutorials/toc_plugin.

    ## Setting up your environment

    Before getting any further, make sure your environment is setup correctly as described in the Get Started guide.

    Registering the plugin🔗

    -

    All plugins must register themselves and declare what events they can handle. To do so, open src/index.ts and register the plugin as below. We'll also need to run some initialisation code when the plugin starts, so add the onStart() event handler too:

    +

    All plugins must register themselves and declare what events they can handle. To do so, open src/index.ts and register the plugin as below. We'll also need to run some initialisation code when the plugin starts, so add the onStart() event handler too:

    // Import the Joplin API
 import joplin from 'api';
 
@@ -390,7 +391,7 @@ joplin.plugins.register({

    If you now build the plugin and try to run it in Joplin, you should see the message TOC plugin started! in the dev console.

    Getting the current note🔗

    -

    In order to create the table of content, you will need to access the content of the currently selected note, and you will need to refresh the TOC every time the note changes. All this can be done using the workspace API, which provides information about the active content being edited.

    +

    In order to create the table of content, you will need to access the content of the currently selected note, and you will need to refresh the TOC every time the note changes. All this can be done using the workspace API, which provides information about the active content being edited.

    So within the onStart() event handler, add the following:

    joplin.plugins.register({
 
@@ -493,7 +494,7 @@ function escapeHtml(unsafe:string) {

    Again try to run the plugin and if you select a note with multiple headers, you should see the header list in the console.

    Creating a webview🔗

    -

    In order to display the TOC in Joplin, you will need a webview panel. Panels are a simple way to add custom content to the UI using HTML/CSS and JavaScript. First you would create the panel object and get back a view handler. Using this handler, you can set various properties such as the HTML content.

    +

    In order to display the TOC in Joplin, you will need a webview panel. Panels are a simple way to add custom content to the UI using HTML/CSS and JavaScript. First you would create the panel object and get back a view handler. Using this handler, you can set various properties such as the HTML content.

    Here's how it could be done:

    joplin.plugins.register({
 
@@ -636,7 +637,7 @@ document.addEventListener('click', event => {

    And that's it! If you run this code you should now have a fully functional TOC. The full source code is available there:

    https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/toc/

    -

    Various improvements can be made such as improving the styling, making the header collapsible, etc. but that tutorial should provide the basic building blocks to do so. You might also want to check the plugin API for further information or head to the development forum for support.

    +

    Various improvements can be made such as improving the styling, making the header collapsible, etc. but that tutorial should provide the basic building blocks to do so. You might also want to check the plugin API for further information or head to the development forum for support.

    diff --git a/docs/blog/20180621-182112/index.html b/docs/blog/20180621-182112/index.html index dc825b2279..44f7cd8900 100644 --- a/docs/blog/20180621-182112/index.html +++ b/docs/blog/20180621-182112/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180621-182112.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20180906-111039/index.html b/docs/blog/20180906-111039/index.html index 1f7281a84d..82a6c309a8 100644 --- a/docs/blog/20180906-111039/index.html +++ b/docs/blog/20180906-111039/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180906-111039.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20180916-210431/index.html b/docs/blog/20180916-210431/index.html index e25d89480a..f5b58f6445 100644 --- a/docs/blog/20180916-210431/index.html +++ b/docs/blog/20180916-210431/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180916-210431.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20180929-121053/index.html b/docs/blog/20180929-121053/index.html index eefcfccd5a..4266735fda 100644 --- a/docs/blog/20180929-121053/index.html +++ b/docs/blog/20180929-121053/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20180929-121053.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20181004-091123/index.html b/docs/blog/20181004-091123/index.html index a20d62f49e..0446e1b48d 100644 --- a/docs/blog/20181004-091123/index.html +++ b/docs/blog/20181004-091123/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181004-091123.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20181101-174335/index.html b/docs/blog/20181101-174335/index.html index 79fd0538cb..f6543b892b 100644 --- a/docs/blog/20181101-174335/index.html +++ b/docs/blog/20181101-174335/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181101-174335.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20181213-173459/index.html b/docs/blog/20181213-173459/index.html index c74ec0ea35..00d6a822aa 100644 --- a/docs/blog/20181213-173459/index.html +++ b/docs/blog/20181213-173459/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20181213-173459.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190130-230218/index.html b/docs/blog/20190130-230218/index.html index 97f8baa772..019818f6ef 100644 --- a/docs/blog/20190130-230218/index.html +++ b/docs/blog/20190130-230218/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190130-230218.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190404-074157/index.html b/docs/blog/20190404-074157/index.html index 4625c3052e..fca48c5f16 100644 --- a/docs/blog/20190404-074157/index.html +++ b/docs/blog/20190404-074157/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190404-074157.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190404-074157.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190424-112410/index.html b/docs/blog/20190424-112410/index.html index 4b2e5503ab..3ec674cd82 100644 --- a/docs/blog/20190424-112410/index.html +++ b/docs/blog/20190424-112410/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190424-112410.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190424-112410.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190523-231026/index.html b/docs/blog/20190523-231026/index.html index 7a1f954872..20406fb2c0 100644 --- a/docs/blog/20190523-231026/index.html +++ b/docs/blog/20190523-231026/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190523-231026.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190523-231026.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190611-000711/index.html b/docs/blog/20190611-000711/index.html index 0ea7cff5a3..5c3f547d6b 100644 --- a/docs/blog/20190611-000711/index.html +++ b/docs/blog/20190611-000711/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190611-000711.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190611-000711.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190613-202613/index.html b/docs/blog/20190613-202613/index.html index 39f8fa5cc9..01770c4ca4 100644 --- a/docs/blog/20190613-202613/index.html +++ b/docs/blog/20190613-202613/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190613-202613.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190613-202613.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190814-225957/index.html b/docs/blog/20190814-225957/index.html index 398d41796e..08209d2974 100644 --- a/docs/blog/20190814-225957/index.html +++ b/docs/blog/20190814-225957/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190814-225957.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190814-225957.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190925-000254/index.html b/docs/blog/20190925-000254/index.html index 6622e0482d..bffc7d06f9 100644 --- a/docs/blog/20190925-000254/index.html +++ b/docs/blog/20190925-000254/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190925-000254.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190925-000254.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20190929-152834/index.html b/docs/blog/20190929-152834/index.html index 94b9e0bc38..7ec99e0f3e 100644 --- a/docs/blog/20190929-152834/index.html +++ b/docs/blog/20190929-152834/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190929-152834.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20190929-152834.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20191012-233121/index.html b/docs/blog/20191012-233121/index.html index c802230300..f3c4cb25f1 100644 --- a/docs/blog/20191012-233121/index.html +++ b/docs/blog/20191012-233121/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191012-233121.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191012-233121.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20191014-165136/index.html b/docs/blog/20191014-165136/index.html index 3f4487adfc..3006f4c1cc 100644 --- a/docs/blog/20191014-165136/index.html +++ b/docs/blog/20191014-165136/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191014-165136.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191014-165136.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20191101-131852/index.html b/docs/blog/20191101-131852/index.html index ea364017ca..b3dad1885a 100644 --- a/docs/blog/20191101-131852/index.html +++ b/docs/blog/20191101-131852/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191101-131852.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191101-131852.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20191117-183855/index.html b/docs/blog/20191117-183855/index.html index 3e634eb6aa..eb94b2f32e 100644 --- a/docs/blog/20191117-183855/index.html +++ b/docs/blog/20191117-183855/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191117-183855.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191117-183855.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20191118-072700/index.html b/docs/blog/20191118-072700/index.html index ebac1e1e3a..fde86dad56 100644 --- a/docs/blog/20191118-072700/index.html +++ b/docs/blog/20191118-072700/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191118-072700.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20191118-072700.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20200220-190804/index.html b/docs/blog/20200220-190804/index.html index 35a2f3f300..4ab22650ad 100644 --- a/docs/blog/20200220-190804/index.html +++ b/docs/blog/20200220-190804/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200220-190804.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200220-190804.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20200301-125055/index.html b/docs/blog/20200301-125055/index.html index d7fb8d6331..193fd6bcd7 100644 --- a/docs/blog/20200301-125055/index.html +++ b/docs/blog/20200301-125055/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200301-125055.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200301-125055.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20200314-001555/index.html b/docs/blog/20200314-001555/index.html index b5fb1c186a..1f60929a03 100644 --- a/docs/blog/20200314-001555/index.html +++ b/docs/blog/20200314-001555/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200314-001555.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200314-001555.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/blog/20200406-224254/index.html b/docs/blog/20200406-224254/index.html index d7fb912f9f..e5be695c58 100644 --- a/docs/blog/20200406-224254/index.html +++ b/docs/blog/20200406-224254/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200406-224254.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/blog/20200406-224254.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/build_troubleshooting/index.html b/docs/build_troubleshooting/index.html index 9452d1bc68..f018c46f21 100644 --- a/docs/build_troubleshooting/index.html +++ b/docs/build_troubleshooting/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/build_troubleshooting.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/build_troubleshooting.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/changelog/index.html b/docs/changelog/index.html index a362d9b931..0dd0b13575 100644 --- a/docs/changelog/index.html +++ b/docs/changelog/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/changelog.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/changelog.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/changelog_cli/index.html b/docs/changelog_cli/index.html index b6b91ce167..15baa7ad83 100644 --- a/docs/changelog_cli/index.html +++ b/docs/changelog_cli/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/changelog_cli.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/changelog_cli.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/clipper/index.html b/docs/clipper/index.html index 3ea00d9e93..07fd7d5996 100644 --- a/docs/clipper/index.html +++ b/docs/clipper/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/clipper.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/clipper.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/conflict/index.html b/docs/conflict/index.html index ac1245d619..0d056898c3 100644 --- a/docs/conflict/index.html +++ b/docs/conflict/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/conflict.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/conflict.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/debugging/index.html b/docs/debugging/index.html index 10dcca6ff0..913f91d9b0 100644 --- a/docs/debugging/index.html +++ b/docs/debugging/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/debugging.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/debugging.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/desktop/index.html b/docs/desktop/index.html index 7789689704..381ea6cf2d 100644 --- a/docs/desktop/index.html +++ b/docs/desktop/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/desktop.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/desktop.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/donate/index.html b/docs/donate/index.html index 097a35b1a2..5e78ec2450 100644 --- a/docs/donate/index.html +++ b/docs/donate/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/donate.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/donate.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/e2ee/index.html b/docs/e2ee/index.html index 5d4d330be8..0039ae318d 100644 --- a/docs/e2ee/index.html +++ b/docs/e2ee/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/e2ee.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/e2ee.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/faq/index.html b/docs/faq/index.html index b454caeb75..58f6fdab5a 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/faq.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/faq.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/gsoc2020/ideas/index.html b/docs/gsoc2020/ideas/index.html index e0ca9160a0..841898a63f 100644 --- a/docs/gsoc2020/ideas/index.html +++ b/docs/gsoc2020/ideas/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/ideas.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/ideas.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/gsoc2020/index/index.html b/docs/gsoc2020/index/index.html index 3325014f73..e5d0a6f26f 100644 --- a/docs/gsoc2020/index/index.html +++ b/docs/gsoc2020/index/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/index.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/index.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/gsod2020/ideas/index.html b/docs/gsod2020/ideas/index.html index fbe67fb998..9f27133052 100644 --- a/docs/gsod2020/ideas/index.html +++ b/docs/gsod2020/ideas/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsod2020/ideas.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsod2020/ideas.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/gsod2020/index/index.html b/docs/gsod2020/index/index.html index ae475ac9ac..63462a8228 100644 --- a/docs/gsod2020/index/index.html +++ b/docs/gsod2020/index/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsod2020/index.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/gsod2020/index.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/index.html b/docs/index.html index ec43755597..4860d64b3a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/README.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/README.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • @@ -847,7 +848,7 @@ Eg. :search -- "-tag:tag1".

    Basque eu juan.abasolo@ehu.eus -34% +33% @@ -868,14 +869,14 @@ Eg. :search -- "-tag:tag1".

    Catalan ca jmontane, 2019 -53% +96% Croatian hr_HR Hrvoje Mandić (trbuhom@net.hr) -28% +27% @@ -895,8 +896,8 @@ Eg. :search -- "-tag:tag1".

    Deutsch de_DE -Eike (ei-ke@users.noreply.github.com) -95% +Ettore Atalan (atalanttore@users.noreply.github.com) +98% @@ -938,7 +939,7 @@ Eg. :search -- "-tag:tag1".

    Français fr_FR Laurent Cozic -94% +98% @@ -966,7 +967,7 @@ Eg. :search -- "-tag:tag1".

    Nederlands nl_NL MetBril (metbril@users.noreply.github.com) -96% +95% @@ -987,14 +988,14 @@ Eg. :search -- "-tag:tag1".

    Persian fa Kourosh Firoozbakht (kourox@protonmail.com) -80% +83% Polski pl_PL -96% +98% @@ -1036,10 +1037,10 @@ Eg. :search -- "-tag:tag1".

    Thai th_TH -52% +53% - + Tiếng Việt vi @@ -1050,7 +1051,7 @@ Eg. :search -- "-tag:tag1".

    Türkçe tr_TR Arda Kılıçdağı (arda@kilicdagi.com) -96% +98% @@ -1071,7 +1072,7 @@ Eg. :search -- "-tag:tag1".

    српски језик sr_RS -72% +71% @@ -1092,14 +1093,14 @@ Eg. :search -- "-tag:tag1".

    日本語 ja_JP genneko (genneko217@gmail.com) -96% +98% 한국어 ko - -86% +Ji-Hyeon Gim (potatogim@potatogim.net) +98% diff --git a/docs/markdown/index.html b/docs/markdown/index.html index b6422f7f57..d8feb47b99 100644 --- a/docs/markdown/index.html +++ b/docs/markdown/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/markdown.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/markdown.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/mobile/index.html b/docs/mobile/index.html index 2bd22fe909..e6af31dc87 100644 --- a/docs/mobile/index.html +++ b/docs/mobile/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/mobile.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/mobile.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/nextcloud_app/index.html b/docs/nextcloud_app/index.html index 3e3edcf8b4..a7bf1d913a 100644 --- a/docs/nextcloud_app/index.html +++ b/docs/nextcloud_app/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/nextcloud_app.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/nextcloud_app.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/plugins/index.html b/docs/plugins/index.html index 7442da4639..1dea43d171 100644 --- a/docs/plugins/index.html +++ b/docs/plugins/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/plugins.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/plugins.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/prereleases/index.html b/docs/prereleases/index.html index 749e683409..031b968a17 100644 --- a/docs/prereleases/index.html +++ b/docs/prereleases/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/prereleases.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/prereleases.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/spec/e2ee/index.html b/docs/spec/e2ee/index.html index ea95ff81bd..2a0ae106b0 100644 --- a/docs/spec/e2ee/index.html +++ b/docs/spec/e2ee/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/e2ee.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/e2ee.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/spec/history/index.html b/docs/spec/history/index.html index 1fdafeffe8..58c58b6f58 100644 --- a/docs/spec/history/index.html +++ b/docs/spec/history/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/history.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/history.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/spec/plugins/index.html b/docs/spec/plugins/index.html index 2209e7344b..c09b1e1843 100644 --- a/docs/spec/plugins/index.html +++ b/docs/spec/plugins/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/plugins.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/plugins.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/spec/search_sorting/index.html b/docs/spec/search_sorting/index.html new file mode 100644 index 0000000000..c1db19cc39 --- /dev/null +++ b/docs/spec/search_sorting/index.html @@ -0,0 +1,428 @@ + + + + + + + Search Engine | Joplin + + + + + + + + + + + + + +
    + +
    + +

    Joplin

     +

    An open source note taking and to-do application with synchronisation capabilities

    +
    + +
    +
    + +
    + + +
    +
    +
    + +
    + +

    Search Engine🔗

    +

    The Search Engine powers the Search input in the note list and the Goto Anything dialog.

    +

    Search algorithm🔗

    +

    Discretely using only the most critical parameter in sorting🔗

    +

    Sorting occurs as the Search Engine processes results, after searching for and weighting these results.

    +

    Parameters include fuzziness, title matching, weight (based on BM25 and age), the completed status of to-dos, and the note's age.

    +

    The Search Engine uses only the first relevant parameter to determine the order, rather than a weighted average.
    +In effect, this means search results with note title matches will appear above all results that only matched the note body,
    +regardless of weight or other parameters.

    +

    Determining weight as a sorting parameter🔗

    +

    The Search Engine determines the weight parameter using both BM25
    +and the number of days since last user update.

    +

    BM25🔗

    +

    The Search Engine determines BM25 based on "term frequency-inverse document frequency."
    +The "TF–IDF" value increases proportionally to the number of times a word appears in the document
    +and is offset by the number of documents in the corpus that contain the word, which helps to adjust
    +for the fact that some words appear more frequently in general.

    +

    BM25 returns weight zero for a search term that occurs in more than half the notes.
    +So terms that are abundant in all notes to have zero relevance w.r.t. BM25.

    +

    Days since last user update🔗

    +

    Sorting increases the BM25 weight by the inverse number of days since the note was updated.
    +Recent notes will, therefore, be weighted highly in the search results.
    +This time-based weight decays logarithmically, becoming less of a factor than BM25 after months have passed.

    + +
    + + Improve this doc + +
    + + +
    +Copyright (c) 2016-2020 Laurent Cozic +
    + + diff --git a/docs/spec/sync_lock/index.html b/docs/spec/sync_lock/index.html index 8fcdac1507..657f2a015c 100644 --- a/docs/spec/sync_lock/index.html +++ b/docs/spec/sync_lock/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/sync_lock.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/spec/sync_lock.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/stats/index.html b/docs/stats/index.html index 95c0ab0863..5c93af483b 100644 --- a/docs/stats/index.html +++ b/docs/stats/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/stats.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/stats.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/terminal/index.html b/docs/terminal/index.html index 914ebfa299..c331729880 100644 --- a/docs/terminal/index.html +++ b/docs/terminal/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/terminal.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/terminal.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/welcome/1_welcome_to_joplin/index.html b/docs/welcome/1_welcome_to_joplin/index.html index 226204c1bb..6067d1bd5b 100644 --- a/docs/welcome/1_welcome_to_joplin/index.html +++ b/docs/welcome/1_welcome_to_joplin/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/1_welcome_to_jopl
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/1_welcome_to_jopl
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/welcome/2_importing_and_exporting_notes/index.html b/docs/welcome/2_importing_and_exporting_notes/index.html index dfdfeee0a0..54aba9f5ac 100644 --- a/docs/welcome/2_importing_and_exporting_notes/index.html +++ b/docs/welcome/2_importing_and_exporting_notes/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/2_importing_and_e
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/2_importing_and_e
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/welcome/3_synchronising_your_notes/index.html b/docs/welcome/3_synchronising_your_notes/index.html index a67cf22627..36ce9f011e 100644 --- a/docs/welcome/3_synchronising_your_notes/index.html +++ b/docs/welcome/3_synchronising_your_notes/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/3_synchronising_y
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/3_synchronising_y
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/welcome/4_tips/index.html b/docs/welcome/4_tips/index.html index ce40daf3f2..3053fe9e2b 100644 --- a/docs/welcome/4_tips/index.html +++ b/docs/welcome/4_tips/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/4_tips.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/4_tips.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec
  • diff --git a/docs/welcome/5_privacy/index.html b/docs/welcome/5_privacy/index.html index 89f18abe27..a77665f060 100644 --- a/docs/welcome/5_privacy/index.html +++ b/docs/welcome/5_privacy/index.html @@ -329,7 +329,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/5_privacy.md
  • Joplin API Overview
  • Plugin development
  • Plugin tutorial
    • -
  • Plugin API
    • +
  • Plugin API
  • Data API documentation
    • @@ -341,6 +341,7 @@ https://github.com/laurent22/joplin/blob/master/readme/welcome/5_privacy.md
  • Note History spec
  • Sync Lock spec
  • Plugin Architecture spec
    • +
  • Search Sorting spec