diff --git a/website/site/content/docs/webapp/finding.md b/website/site/content/docs/webapp/finding.md index 42e36f82..88bc1fef 100644 --- a/website/site/content/docs/webapp/finding.md +++ b/website/site/content/docs/webapp/finding.md @@ -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: diff --git a/website/site/content/docs/webapp/itemcard-customize-01.png b/website/site/content/docs/webapp/itemcard-customize-01.png index a02744ea..c9598d15 100644 Binary files a/website/site/content/docs/webapp/itemcard-customize-01.png and b/website/site/content/docs/webapp/itemcard-customize-01.png differ diff --git a/website/site/content/docs/webapp/itemcard-customize-02.png b/website/site/content/docs/webapp/itemcard-customize-02.png index 40f0cbdd..2d8f3e2b 100644 Binary files a/website/site/content/docs/webapp/itemcard-customize-02.png and b/website/site/content/docs/webapp/itemcard-customize-02.png differ diff --git a/website/site/content/docs/webapp/itemcard-customize-03.png b/website/site/content/docs/webapp/itemcard-customize-03.png index 8faa2e6f..9511d670 100644 Binary files a/website/site/content/docs/webapp/itemcard-customize-03.png and b/website/site/content/docs/webapp/itemcard-customize-03.png differ diff --git a/website/site/content/docs/webapp/itemcard-customize-04.png b/website/site/content/docs/webapp/itemcard-customize-04.png index f4b4b73a..c2dcf80f 100644 Binary files a/website/site/content/docs/webapp/itemcard-customize-04.png and b/website/site/content/docs/webapp/itemcard-customize-04.png differ diff --git a/website/site/content/docs/webapp/mail-item-1.jpg b/website/site/content/docs/webapp/mail-item-1.jpg deleted file mode 100644 index cd40ab62..00000000 Binary files a/website/site/content/docs/webapp/mail-item-1.jpg and /dev/null differ diff --git a/website/site/content/docs/webapp/mail-item-1.png b/website/site/content/docs/webapp/mail-item-1.png index 8d019014..2f575c04 100644 Binary files a/website/site/content/docs/webapp/mail-item-1.png and b/website/site/content/docs/webapp/mail-item-1.png differ diff --git a/website/site/content/docs/webapp/mail-item-2.jpg b/website/site/content/docs/webapp/mail-item-2.jpg deleted file mode 100644 index 66945fcc..00000000 Binary files a/website/site/content/docs/webapp/mail-item-2.jpg and /dev/null differ diff --git a/website/site/content/docs/webapp/mail-item-2.png b/website/site/content/docs/webapp/mail-item-2.png new file mode 100644 index 00000000..4894a3e3 Binary files /dev/null and b/website/site/content/docs/webapp/mail-item-2.png differ diff --git a/website/site/content/docs/webapp/mail-item-3.jpg b/website/site/content/docs/webapp/mail-item-3.jpg deleted file mode 100644 index 4b0bae68..00000000 Binary files a/website/site/content/docs/webapp/mail-item-3.jpg and /dev/null differ diff --git a/website/site/content/docs/webapp/mail-item-4.jpg b/website/site/content/docs/webapp/mail-item-4.jpg deleted file mode 100644 index bfdeb868..00000000 Binary files a/website/site/content/docs/webapp/mail-item-4.jpg and /dev/null differ diff --git a/website/site/content/docs/webapp/mail-item-4.png b/website/site/content/docs/webapp/mail-item-4.png new file mode 100644 index 00000000..c161181a Binary files /dev/null and b/website/site/content/docs/webapp/mail-item-4.png differ diff --git a/website/site/content/docs/webapp/mail-settings-1.png b/website/site/content/docs/webapp/mail-settings-1.png index 8b4b8da6..1ea5d9bc 100644 Binary files a/website/site/content/docs/webapp/mail-settings-1.png and b/website/site/content/docs/webapp/mail-settings-1.png differ diff --git a/website/site/content/docs/webapp/mail-settings-2.png b/website/site/content/docs/webapp/mail-settings-2.png index 84498802..fd3f1f5d 100644 Binary files a/website/site/content/docs/webapp/mail-settings-2.png and b/website/site/content/docs/webapp/mail-settings-2.png differ diff --git a/website/site/content/docs/webapp/mailitem.md b/website/site/content/docs/webapp/mailitem.md index 1fa31e9a..51c24a9d 100644 --- a/website/site/content/docs/webapp/mailitem.md +++ b/website/site/content/docs/webapp/mailitem.md @@ -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 form: -{{ figure(file="mail-item-1.jpg") }} +{{ figure(file="mail-item-1.png") }} Then write the mail. Multiple recipients may be specified. The input 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 -If there is an e-mail for an item, a tab shows up at the right side, -next to the attachments. +If there is an e-mail for an item, another section is rendered below +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 -item. +Clicking on a the eye icon opens the mail. -{{ figure(file="mail-item-3.jpg") }} - -Clicking on a mail opens it in detail. - -{{ figure(file="mail-item-4.jpg") }} +{{ figure(file="mail-item-4.png") }} diff --git a/website/site/content/docs/webapp/notify-due-items.png b/website/site/content/docs/webapp/notify-due-items.png new file mode 100644 index 00000000..10130150 Binary files /dev/null and b/website/site/content/docs/webapp/notify-due-items.png differ diff --git a/website/site/content/docs/webapp/notifydueitems.md b/website/site/content/docs/webapp/notifydueitems.md index 143dd17f..146093ff 100644 --- a/website/site/content/docs/webapp/notifydueitems.md +++ b/website/site/content/docs/webapp/notifydueitems.md @@ -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 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. diff --git a/website/site/content/docs/webapp/processing-queue.jpg b/website/site/content/docs/webapp/processing-queue.jpg deleted file mode 100644 index aca9407c..00000000 Binary files a/website/site/content/docs/webapp/processing-queue.jpg and /dev/null differ diff --git a/website/site/content/docs/webapp/processing-queue.png b/website/site/content/docs/webapp/processing-queue.png new file mode 100644 index 00000000..079a525e Binary files /dev/null and b/website/site/content/docs/webapp/processing-queue.png differ diff --git a/website/site/content/docs/webapp/processing.md b/website/site/content/docs/webapp/processing.md index dfd3decf..e20ad5ba 100644 --- a/website/site/content/docs/webapp/processing.md +++ b/website/site/content/docs/webapp/processing.md @@ -17,7 +17,7 @@ page refreshes itself automatically to show the progress. 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 click on the small file symbol on finished jobs, you can inspect diff --git a/website/site/content/docs/webapp/scanmailbox-detail-01.png b/website/site/content/docs/webapp/scanmailbox-detail-01.png index 3594198b..14bb6488 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-detail-01.png and b/website/site/content/docs/webapp/scanmailbox-detail-01.png differ diff --git a/website/site/content/docs/webapp/scanmailbox-detail-02.png b/website/site/content/docs/webapp/scanmailbox-detail-02.png index 69176a40..fea0739d 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-detail-02.png and b/website/site/content/docs/webapp/scanmailbox-detail-02.png differ diff --git a/website/site/content/docs/webapp/scanmailbox-detail-03.png b/website/site/content/docs/webapp/scanmailbox-detail-03.png index 48a7f12e..db09e07e 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-detail-03.png and b/website/site/content/docs/webapp/scanmailbox-detail-03.png differ diff --git a/website/site/content/docs/webapp/scanmailbox-detail-04.png b/website/site/content/docs/webapp/scanmailbox-detail-04.png index 14cca316..1cca17c4 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-detail-04.png and b/website/site/content/docs/webapp/scanmailbox-detail-04.png differ diff --git a/website/site/content/docs/webapp/scanmailbox-detail-05.png b/website/site/content/docs/webapp/scanmailbox-detail-05.png index 79708b83..d45d41fe 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-detail-05.png and b/website/site/content/docs/webapp/scanmailbox-detail-05.png differ diff --git a/website/site/content/docs/webapp/scanmailbox-detail-06.png b/website/site/content/docs/webapp/scanmailbox-detail-06.png index da793e00..b1bdec97 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-detail-06.png and b/website/site/content/docs/webapp/scanmailbox-detail-06.png differ diff --git a/website/site/content/docs/webapp/scanmailbox-list.png b/website/site/content/docs/webapp/scanmailbox-list.png index f6c10d94..11c9804e 100644 Binary files a/website/site/content/docs/webapp/scanmailbox-list.png and b/website/site/content/docs/webapp/scanmailbox-list.png differ diff --git a/website/site/content/docs/webapp/search-bar.png b/website/site/content/docs/webapp/search-bar.png index de251309..a1dcec42 100644 Binary files a/website/site/content/docs/webapp/search-bar.png and b/website/site/content/docs/webapp/search-bar.png differ diff --git a/website/site/content/docs/webapp/search-menu.png b/website/site/content/docs/webapp/search-menu.png index 83bee85f..38204b3e 100644 Binary files a/website/site/content/docs/webapp/search-menu.png and b/website/site/content/docs/webapp/search-menu.png differ