Update docs: finding, mail-item, processing
@ -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
|
using full text search. The landing page shows a list of current
|
||||||
items. Items are displayed sorted by their date, newest first.
|
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
|
# Search Bar
|
||||||
|
|
||||||
{{ imgright(file="search-bar.png") }}
|
{{ imgright(file="search-bar.png") }}
|
||||||
|
|
||||||
By default, the search bar is shown. It provides a shortcut to search
|
The search bar let's you search in item and attachment names names and
|
||||||
for names and a mode for fulltext-only search. The dropdown contains
|
do fulltext search. The icon next to the search field can switch
|
||||||
the different options.
|
between these modes.
|
||||||
|
|
||||||
## The *Names* option {#names}
|
## The *Names* option {#names}
|
||||||
|
|
||||||
This option corresponds to the same named field in the search menu. If
|
This searches in the item name, names of correspondent organization
|
||||||
you switch between search menu and search bar (by clicking the icon on
|
and person, and names of concering person and equipment. It uses a
|
||||||
the left), you'll see that they are the same fields. Typing in the
|
simple substring search. When searching with this option active, it
|
||||||
search bar also fills the corresponding field in the search menu (and
|
simply submits the (maybe hidden) search menu. So if the menu has
|
||||||
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
|
|
||||||
other fields filled out, they will affect the result, too.
|
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
|
If no other fields are selected, the results are not ordered by item
|
||||||
with this option active, there is a full text search done in:
|
date, but by relevance with respect to the search term. This ordering
|
||||||
attachments contents, attachment names, item name and item notes.
|
is returned from the full text search engine and is simply transfered
|
||||||
|
unmodified.
|
||||||
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
|
# 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
|
The search menu can be opened by clicking the left icon in the top
|
||||||
bar. It shows some options to constrain the item list:
|
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
|
"Confirmed". All items that have been created by docspell and not
|
||||||
looked at are marked as "new" automatically.
|
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
|
## Tags & Tag Categories
|
||||||
|
|
||||||
Click on a tag to show only items with this tag, the tag is marked
|
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
|
Specify a date range to show only items whose due date property is
|
||||||
within this range. Items without a due date are not shown.
|
within this range. Items without a due date are not shown.
|
||||||
|
|
||||||
|
## Source
|
||||||
|
|
||||||
|
This field allows to search by source id. Wildcards are supported.
|
||||||
|
|
||||||
## Direction
|
## Direction
|
||||||
|
|
||||||
@ -164,12 +137,12 @@ Specify whether to show only incoming, only outgoing or all items.
|
|||||||
|
|
||||||
# Customize Substring Search
|
# Customize Substring Search
|
||||||
|
|
||||||
The substring search of the *All Names* and *Name* field can be
|
The substring search of *Search in names* field can be customized in
|
||||||
customized in the following way: A wildcard `*` can be used at the
|
the following way: A wildcard `*` can be used at the start or end of a
|
||||||
start or end of a search term to do a substring match. A `*` means
|
search term to do a substring match. A `*` means "everything". So a
|
||||||
"everything". So a term `*company` matches all names ending in
|
term `*company` matches all names ending in `company` and `*company*`
|
||||||
`company` and `*company*` matches all names containing the word
|
matches all names containing the word `company`. The matching is case
|
||||||
`company`. The matching is case insensitive.
|
insensitive.
|
||||||
|
|
||||||
Docspell adds a `*` to the front and end of a term automatically,
|
Docspell adds a `*` to the front and end of a term automatically,
|
||||||
unless one of the following is true:
|
unless one of the following is true:
|
||||||
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 99 KiB |
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 84 KiB |
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 65 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 64 KiB |
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 267 KiB |
Before Width: | Height: | Size: 177 KiB |
BIN
website/site/content/docs/webapp/mail-item-2.png
Normal file
After Width: | Height: | Size: 138 KiB |
Before Width: | Height: | Size: 130 KiB |
Before Width: | Height: | Size: 150 KiB |
BIN
website/site/content/docs/webapp/mail-item-4.png
Normal file
After Width: | Height: | Size: 169 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 113 KiB |
@ -27,7 +27,7 @@ item, or you may choose to send the mail without any attachments.
|
|||||||
In the item detail view, click on the envelope icon to open the mail
|
In the item detail view, click on the envelope icon to open the mail
|
||||||
form:
|
form:
|
||||||
|
|
||||||
{{ figure(file="mail-item-1.jpg") }}
|
{{ figure(file="mail-item-1.png") }}
|
||||||
|
|
||||||
Then write the mail. Multiple recipients may be specified. The input
|
Then write the mail. Multiple recipients may be specified. The input
|
||||||
field shows completion proposals from all contacts in your address
|
field shows completion proposals from all contacts in your address
|
||||||
@ -55,16 +55,11 @@ database and you'll see a message in the form.
|
|||||||
|
|
||||||
# Accessing Sent Mails
|
# Accessing Sent Mails
|
||||||
|
|
||||||
If there is an e-mail for an item, a tab shows up at the right side,
|
If there is an e-mail for an item, another section is rendered below
|
||||||
next to the attachments.
|
the item notes.
|
||||||
|
|
||||||
{{ figure(file="mail-item-2.jpg") }}
|
{{ figure(file="mail-item-2.png") }}
|
||||||
|
|
||||||
This tab shows a list of all mails that have been sent related to this
|
Clicking on a the eye icon opens the mail.
|
||||||
item.
|
|
||||||
|
|
||||||
{{ figure(file="mail-item-3.jpg") }}
|
{{ figure(file="mail-item-4.png") }}
|
||||||
|
|
||||||
Clicking on a mail opens it in detail.
|
|
||||||
|
|
||||||
{{ figure(file="mail-item-4.jpg") }}
|
|
||||||
|
BIN
website/site/content/docs/webapp/notify-due-items.png
Normal file
After Width: | Height: | Size: 182 KiB |
@ -19,7 +19,7 @@ will be submitted to the job queue and is picked up by an available
|
|||||||
[job executor](@/docs/joex/_index.md) eventually. This can be setup in
|
[job executor](@/docs/joex/_index.md) eventually. This can be setup in
|
||||||
the user settings page.
|
the user settings page.
|
||||||
|
|
||||||
{{ figure(file="notify-due-items.jpg") }}
|
{{ figure(file="notify-due-items.png") }}
|
||||||
|
|
||||||
At first, the task can be disabled/enabled any time.
|
At first, the task can be disabled/enabled any time.
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 105 KiB |
BIN
website/site/content/docs/webapp/processing-queue.png
Normal file
After Width: | Height: | Size: 211 KiB |
@ -17,7 +17,7 @@ page refreshes itself automatically to show the progress.
|
|||||||
|
|
||||||
Example screenshot:
|
Example screenshot:
|
||||||
|
|
||||||
{{ figure(file="processing-queue.jpg") }}
|
{{ figure(file="processing-queue.png") }}
|
||||||
|
|
||||||
You can cancel running jobs or remove waiting ones from the queue. If
|
You can cancel running jobs or remove waiting ones from the queue. If
|
||||||
you click on the small file symbol on finished jobs, you can inspect
|
you click on the small file symbol on finished jobs, you can inspect
|
||||||
|
Before Width: | Height: | Size: 142 KiB After Width: | Height: | Size: 204 KiB |
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 190 KiB |
Before Width: | Height: | Size: 187 KiB After Width: | Height: | Size: 228 KiB |
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 242 KiB |
Before Width: | Height: | Size: 196 KiB After Width: | Height: | Size: 197 KiB |
Before Width: | Height: | Size: 184 KiB After Width: | Height: | Size: 226 KiB |
Before Width: | Height: | Size: 116 KiB After Width: | Height: | Size: 99 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 3.5 KiB |
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 76 KiB |