smokephil/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-12-06 14:55:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

Feature: global search, keyboard shortcuts / hotkey support (#6449)

Browse source
This commit is contained in:
shamoon 2024-05-02 09:15:56 -07:00 • committed by GitHub
parent 40289cd714
commit c6e7d06bb7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
51 changed files with 2970 additions and 683 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/usage.md
View file

@ -550,6 +550,16 @@ collection.
## Searching {#basic-usage_searching}
### Global search
The top search bar in the web UI performs a "global" search of the various
objects Paperless-ngx uses, including documents, tags, workflows, etc. Only
objects for which the user has appropriate permissions are returned. For
documents, if there are < 3 results, "advanced" search results (which use
the document index) will also be included. This can be disabled under settings.
### Document searches
Paperless offers an extensive searching mechanism that is designed to
allow you to quickly find a document you're looking for (for example,
that thing that just broke and you bought a couple months ago, that
@ -605,6 +615,12 @@ language](https://whoosh.readthedocs.io/en/latest/querylang.html). For
details on what date parsing utilities are available, see [Date
parsing](https://whoosh.readthedocs.io/en/latest/dates.html#parsing-date-queries).
## Keyboard shortcuts / hotkeys
A list of available hotkeys can be shown on any page using <kbd>Shift</kbd> +
<kbd>?</kbd>. The help dialog shows only the keys that are currently available
based on which area of Paperless-ngx you are using.
## The recommended workflow {#usage-recommended-workflow}
Once you have familiarized yourself with paperless and are ready to use