TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-24 11:28:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs: finding, mail-item, processing

Browse Source
This commit is contained in:
Eike Kettner
2021-02-19 16:05:35 +01:00
parent e3da40380c
commit ca2713934e
29 changed files with 33 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
website/site/content/docs/webapp/finding.md
View File

@ -9,49 +9,33 @@ Items can be searched by their annotated meta data and their contents
using full text search. The landing page shows a list of current
items. Items are displayed sorted by their date, newest first.
Docspell has two modes for searching: a simple search bar and a search
menu with many options. Both are active at the same time, but only one
is visible. You can switch between them without affecting the results.
# Search Bar
{{ imgright(file="search-bar.png") }}
By default, the search bar is shown. It provides a shortcut to search
for names and a mode for fulltext-only search. The dropdown contains
the different options.
The search bar let's you search in item and attachment names names and
do fulltext search. The icon next to the search field can switch
between these modes.
## The *Names* option {#names}
This option corresponds to the same named field in the search menu. If
you switch between search menu and search bar (by clicking the icon on
the left), you'll see that they are the same fields. Typing in the
search bar also fills the corresponding field in the search menu (and
vice versa).
The *Names* searches in the item name, names of correspondent
organization and person, and names of concering person and equipment.
It uses a simple substring search. When searching with this option
active, it simply submits the (hidden) search menu. So if the menu has
This searches in the item name, names of correspondent organization
and person, and names of concering person and equipment. It uses a
simple substring search. When searching with this option active, it
simply submits the (maybe hidden) search menu. So if the menu has
other fields filled out, they will affect the result, too.
If the left button in the search bar shows a little blue bubble, it
means that there are more search fields filled out in the search menu
that you currently can't see. In this case the results are not only
restricted by the search term given in the search-bar, but also by
what is specified in the search menu.
## The *Contents* option {#contents-only}
## The *Contents Only* option {#contents-only}
Searching with this option active, there is a full text search done
in: attachments contents, attachment names, item name and item notes.
This option has no corresponding part in the search menu. Searching
with this option active, there is a full text search done in:
attachments contents, attachment names, item name and item notes.
The results are not ordered by item date, but by relevance with
respect to the search term. This ordering is returned from the full
text search engine and is simply transfered unmodified.
If no other fields are selected, the results are not ordered by item
date, but by relevance with respect to the search term. This ordering
is returned from the full text search engine and is simply transfered
unmodified.
# Search Menu
@ -61,26 +45,12 @@ text search engine and is simply transfered unmodified.
The search menu can be opened by clicking the left icon in the top
bar. It shows some options to constrain the item list:
## Show new items
## Inbox
Clicking the checkbox "Only new" shows items that have not been
Clicking the checkbox "Inbox" shows items that have not been
"Confirmed". All items that have been created by docspell and not
looked at are marked as "new" automatically.
## Fulltext and Name Search
You can choose tags or correspondents in the search menu and further
restrict the results using full text search with the *content* field.
If this is the only filled field, then a normal fulltext search is
done. It is exactly the same as filling out the *Contents Only* search
bar. However, if some other fields are also set, then first a search
using all other fields is done and these results are then further
constraint by a fulltext search.
You can switch to "Name Search" using the little icon on the right.
This will then only search in item names and notes.
## Tags & Tag Categories
Click on a tag to show only items with this tag, the tag is marked
@ -156,6 +126,9 @@ date is used.
Specify a date range to show only items whose due date property is
within this range. Items without a due date are not shown.
## Source
This field allows to search by source id. Wildcards are supported.
## Direction
@ -164,12 +137,12 @@ Specify whether to show only incoming, only outgoing or all items.
# Customize Substring Search
The substring search of the *All Names* and *Name* field can be
customized in the following way: A wildcard `*` can be used at the
start or end of a search term to do a substring match. A `*` means
"everything". So a term `*company` matches all names ending in
`company` and `*company*` matches all names containing the word
`company`. The matching is case insensitive.
The substring search of *Search in names* field can be customized in
the following way: A wildcard `*` can be used at the start or end of a
search term to do a substring match. A `*` means "everything". So a
term `*company` matches all names ending in `company` and `*company*`
matches all names containing the word `company`. The matching is case
insensitive.
Docspell adds a `*` to the front and end of a term automatically,
unless one of the following is true: