diff --git a/modules/microsite/docs/doc/curate.md b/modules/microsite/docs/doc/curate.md index feb52c9e..2f1236f7 100644 --- a/modules/microsite/docs/doc/curate.md +++ b/modules/microsite/docs/doc/curate.md @@ -1,6 +1,6 @@ --- layout: docs -title: Curate Metadata +title: Curate Items permalink: doc/curate --- diff --git a/modules/microsite/docs/doc/finding.md b/modules/microsite/docs/doc/finding.md index 69e4985e..78b17c47 100644 --- a/modules/microsite/docs/doc/finding.md +++ b/modules/microsite/docs/doc/finding.md @@ -86,6 +86,12 @@ same as the search in the search bar (see above). The `Name` field only searches in the name property of an item. +### Folder + +Set a folder to only show items in that folder. If no folder is set, +all accessible items are shown. These are all items that either have +no folder set, or a folder where the current user is member. + ### Tags Specify a list of tags that the items must have. When adding tags to diff --git a/modules/microsite/docs/doc/metadata.md b/modules/microsite/docs/doc/metadata.md index 4b6a5a6f..881e346f 100644 --- a/modules/microsite/docs/doc/metadata.md +++ b/modules/microsite/docs/doc/metadata.md @@ -1,6 +1,6 @@ --- layout: docs -title: Adding Meta Data +title: Meta Data permalink: doc/metadata --- @@ -12,13 +12,13 @@ Docspell processes each uploaded file. Processing involves extracting archives, extracting text, anlyzing the extracted text and converting the file into a pdf. Text is analyzed to find metadata that can be set automatically. Docspell compares the extracted text against a set of -known meta data. The *Meta Data* page allows to manage this meta data. -You can create the following: +known meta data. The *Meta Data* page allows to manage this meta data: - Tags - Organizations - Persons - Equipments +- Folders ### Tags @@ -81,6 +81,31 @@ Equipments don't have contact information, so the only property that is used to find matches during document processing is its name. +### Folders + +Folders provide a way to divide all documents into disjoint subsets. +Unlike with tags, an item can have at most one folder or none. A +folder has an owner – the user who created the folder. Additionally, +it can have members: users of the collective that the owner can assign +to a folder. + +When searching for items, the results are restricted to items that +have either no folder assigned or a folder where the current user is +owner or member. It can be used to control visibility when searching. +However: there are no hard access checks. For example, if the item id +is known, any user of the collective can see it and modify its meta +data. + +One use case is, that you can hide items from other users, like bills +for birthday presents. In this case it is very unlikely that someone +can guess the item-id. + +While folders are *not* taken into account when processing documents, +they can be specified with the upload request or a [source +url](uploading#anonymous-upload) to have them automatically set when +they arrive. + + ## Document Language An important setting is the language of your documents. This helps OCR diff --git a/modules/microsite/docs/doc/scanmailbox.md b/modules/microsite/docs/doc/scanmailbox.md index 30fe8454..ea0d3dee 100644 --- a/modules/microsite/docs/doc/scanmailbox.md +++ b/modules/microsite/docs/doc/scanmailbox.md @@ -69,6 +69,11 @@ that belongs to a “concerning” person in your address book, then it is set to "outgoing". Otherwise it is set to "incoming". To support this, you need to add your own e-mail address(es) to your address book. +The *Item Folder* setting is used to put all items that are created +from mails into the specified [folder](metadata#folders). If you +define a folder here, where you are not a member, you won't find +resulting items. + The last field is the *Schedule* which defines when and how often this task should run. The syntax is similiar to a date-time string, like `2019-09-15 12:32`, where each part is a pattern to also match multple diff --git a/modules/microsite/docs/doc/uploading.md b/modules/microsite/docs/doc/uploading.md index bd2d45d9..d99222b6 100644 --- a/modules/microsite/docs/doc/uploading.md +++ b/modules/microsite/docs/doc/uploading.md @@ -49,10 +49,20 @@ your username is not visible. Example screenshot:
- +
-This example shows a source with name "test". It defines two urls: +This example shows a source with name "test". Besides a description +and a name that is only used for displaying purposes, a priority and a +[folder](metadata#folders) can be specified. + +The priority is used for the processing jobs that are submitted when +files are uploaded via this endpoint. + +The folder is used to place all items, that result from uploads to +this endpoint, into this folder. + +The source endpoint defines two urls: - `/app/upload/` - `/api/v1/open/upload/item/` diff --git a/modules/microsite/src/main/resources/microsite/data/menu.yml b/modules/microsite/src/main/resources/microsite/data/menu.yml index e56dc416..0b5e0108 100644 --- a/modules/microsite/src/main/resources/microsite/data/menu.yml +++ b/modules/microsite/src/main/resources/microsite/data/menu.yml @@ -27,13 +27,13 @@ options: - title: Reverse Proxy url: doc/reverseproxy - - title: Adding Meta Data + - title: Meta Data url: doc/metadata - title: Finding Items url: doc/finding - - title: Curate Metadata + - title: Curate Items url: doc/curate - title: Uploads diff --git a/modules/microsite/src/main/resources/microsite/img/scanmailbox-detail.png b/modules/microsite/src/main/resources/microsite/img/scanmailbox-detail.png index c1ddf69b..b5196912 100644 Binary files a/modules/microsite/src/main/resources/microsite/img/scanmailbox-detail.png and b/modules/microsite/src/main/resources/microsite/img/scanmailbox-detail.png differ diff --git a/modules/microsite/src/main/resources/microsite/img/search-menu.png b/modules/microsite/src/main/resources/microsite/img/search-menu.png index 3cab49cd..0100c7ab 100644 Binary files a/modules/microsite/src/main/resources/microsite/img/search-menu.png and b/modules/microsite/src/main/resources/microsite/img/search-menu.png differ diff --git a/modules/microsite/src/main/resources/microsite/img/sources-form.jpg b/modules/microsite/src/main/resources/microsite/img/sources-form.jpg deleted file mode 100644 index a4ab30ab..00000000 Binary files a/modules/microsite/src/main/resources/microsite/img/sources-form.jpg and /dev/null differ diff --git a/modules/microsite/src/main/resources/microsite/img/sources-form.png b/modules/microsite/src/main/resources/microsite/img/sources-form.png new file mode 100644 index 00000000..63b38e4a Binary files /dev/null and b/modules/microsite/src/main/resources/microsite/img/sources-form.png differ