Merge pull request #409 from eikek/doc-updates

Doc updates

Changelog.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## v0.14.0
+
+*Soon*
+
+This release contains many bug fixes, thank you all so much for
+helping out! There is also a new feature and some more scripts in
+tools.
+
+- Show/hide side menus via ui settings (#351)
+- Extend docker image to use newest ocrmypdf version (#393, thanks
+  @totti4ever)
+- Adds two more scripts to the `tools/` section (thanks to
+  @totti4ever):
+  - one script to import data from paperless, and
+  - a script to check clean a directory from files that are already in
+    docspell
+- Fix bug that would stop processing when pdf conversion fails (#392,
+  #387)
+- Fix bug to have a separate, configurable source identifier for the
+  integration upload endpoint (#389)
+- Edit/delete multiple items at once (#253)
+- Fixes ui bug to not highlight the last viewed item when searching
+  again. (#373)
+- Fixes bug when saving multiple changes to the ui settings (#368)
+- Fixes uniqueness check for equipments (#370)
+- Fixes a bug when doing document classification where user input was
+  not correctly escaped for regexes (#356)
+- Add an import script for paperless! (#358, #359, thanks @totti4ever)
+- Fixes debian packages to have both (joex + restserver) the same user
+  to make H2 work (#336)
+- Fixes a bug when searching with multiple tags using MariaDB (#404)
+
+### REST Api Changes
+
+- Routes for managing multiple items:
+  - `/sec/items/deleteAll`
+  - `/sec/items/tags`
+  - `/sec/items/name`
+  - `/sec/items/folder`
+  - `/sec/items/direction`
+  - `/sec/items/date`
+  - `/sec/items/duedate`
+  - `/sec/items/corrOrg`
+  - `/sec/items/corrPerson`
+  - `/sec/items/concPerson`
+  - `/sec/items/concEquipment`
+  - `/sec/items/confirm`
+  - `/sec/items/unconfirm`
+  - `/sec/items/reprocess`
+- Adds another parameter to `ItemSearch` structure to enable searching
+  in a subset of items giving their ids.
+
+### Configuration Changes
+
+- new setting `….integration-endpoint.source-name` to define the
+  source name for files uploaded through this endpoint
+
 ## v0.13.0
 
 *Oct 19, 2020*

website/elm/GetStarted.elm

@@ -87,6 +87,13 @@ The directory contains a file `docspell.conf` that you can
                             ]
                         , text "."
                         ]
+                    , li []
+                        [ text "Chat on "
+                        , a [ href "https://gitter.im/eikek/docspell" ]
+                            [ text "Gitter"
+                            ]
+                        , text " for questions and feedback."
+                        ]
                     ]
                 ]
             ]

website/elm/Main.elm

@@ -173,13 +173,12 @@ footHero model =
                 [ text " • "
                 ]
             , span []
-                [ text "© 2020 "
-                ]
-            , a
-                [ href "https://github.com/eikek"
-                , target "_blank"
-                ]
-                [ text "@eikek"
+                [ a
+                    [ href "https://gitter.im/eikek/docspell"
+                    , target "_blank"
+                    ]
+                    [ text "Chat on Gitter"
+                    ]
                 ]
             ]
         ]

website/elm/Search.elm

@@ -104,8 +104,8 @@ view model =
         [ class "form"
         , onSubmit SubmitSearch
         ]
-        [ div [ class "dropdown field is-active is-fullwidth" ]
-            [ div [ class "control has-icons-right is-fullwidth" ]
+        [ div [ class "dropdown field is-active is-fullwidth has-addons" ]
+            [ div [ class "control is-fullwidth" ]
                 [ input
                     [ class "input"
                     , type_ "text"
@@ -114,7 +114,13 @@ view model =
                     , value model.searchInput
                     ]
                     []
-                , span [ class "icon is-right is-small" ]
+                ]
+            , div [ class "control" ]
+                [ button
+                    [ class "button is-primary"
+                    , href "#"
+                    , onClick SubmitSearch
+                    ]
                     [ img [ src "/icons/search-20.svg" ] []
                     ]
                 ]

website/site/content/docs/features/_index.md

@@ -38,6 +38,7 @@ description = "A list of features and limitations."
   with due dates
 - [Read your mailboxes](@/docs/webapp/scanmailbox.md) via IMAP to
   import mails into docspell
+- [Edit multiple items](@/docs/webapp/multiedit.md) at once
 - REST server and document processing are separate applications which
   can be scaled-out independently
 - Everything stored in a SQL database: PostgreSQL, MariaDB or H2

website/site/content/docs/tools/consumedir-cleaner.md

@@ -0,0 +1,52 @@
++++
+title = "Directory Cleaner"
+description = "Clean directories from files in docspell"
+weight = 32
++++
+
+# Introduction
+
+This script is made for cleaning up the consumption directory used for
+the consumedir service (as it is provided as docker container)which
+are copied or moved there.
+
+<https://github.com/eikek/docspell/tree/master/tools/consumedir-cleaner>
+
+## How it works
+
+- Checks for every file (in the collective's folder of the given user
+  name) if it already exists in the collective (using Docspell's API).
+- If so, by default those files are moved to an archive folder just
+  besides the collective's consumption folders named _archive. The
+  archive's files are organized into monthly subfolders by the date
+  they've been added to Docspell
+  - If set, those files can also be deleted instead of being moved to
+    the archive. There is no undo function provided for this, so be
+    careful.
+- If a file is found which does not exist in the collective, by
+  default nothing happens, so that file would be found in every run
+  and just ignored
+  - If set, those files can also be uploaded to Docspell. Depending on
+    the setting for files already existing these files would either be
+    deleted or moved to the archive in the next run.
+
+## Usage (parameters / settings)
+
+Copy the script to your machine and run it with the following
+parameters:
+
+1. URL of Docspell, including http(s)
+2. Username for Docspell, possibly including Collective (if other name
+   as user)
+3. Password for Docspell
+4. Path to the directory which files shall be checked against
+   existence in Docspell
+
+Additionally, environment variables can be used to alter the behavior:
+
+- `DS_CC_REMOVE`
+  - `true` – delete files which already exist in the collective
+  - `false` (default) - move them to the archive (see above)
+- `DS_CC_UPLOAD_MISSING`
+  - `true` - uploads files which do not exist in the collective
+  - `false` (default) - ignore them and do nothing

website/site/content/docs/tools/paperless-import.md

@@ -0,0 +1,43 @@
++++
+title = "Paperless Import"
+description = "Import your data from paperless."
+weight = 35
++++
+
+# Introduction
+
+Coming from
+[paperless](https://github.com/the-paperless-project/paperless/), the
+script in `tools/import-paperless` can be used to get started by
+importing your data from paperless into docspell.
+
+<https://github.com/eikek/docspell/tree/master/tools/import-paperless>
+
+The script imports the files and also tags and correspondents.
+
+# Usage
+
+Copy the script to the machine where paperless is running. Run it with
+the following arguments:
+
+1. URL of Docspell, including http(s)
+2. Username for Docspell, possibly including Collective (if other name as user)
+3. Password for Docspell
+4. Path to Paperless' database file (`db.sqlite3`). When using Paperless with docker, it is in the mapped directory `/usr/src/paperless/data`
+5. Path to Paperless' document base directory. When using Paperless with docker, it is the mapped directory `/usr/src/paperless/media/documents/origin/`
+
+Some settings can be changed inside the script, right at the top:
+
+* `LIMIT="LIMIT 0"` (default: inactive): For testing purposes, limits
+  the number of tags and correspondents read from Paperless (this will
+  most likely lead to warnings when processing the documents)
+* `LIMIT_DOC="LIMIT 5"` (default: inactive): For testing purposes,
+  limits the number of documents and document-to-tag relations read
+  from Paperless
+* `SKIP_EXISTING_DOCS=true` (default: true): Won't touch already
+  existing documents. If set to `false` documents, which exist
+  already, won't be uploaded again, but the tags, correspondent, date
+  and title from Paperless will be applied.
+
+  **Warning** In case you already had set these information in Docspell,
+  they will be overwritten!

website/site/templates/footer.html

@@ -12,10 +12,7 @@
             </a>
             <span class="ml-1 mr-1">•</span>
             <span>
-                © 2020
-                <a href="https://github.com/eikek" target="_blank">
-                    @eikek
-                </a>
+                <a href="https://gitter.im/eikek/docspell">Chat on Gitter</a>
             </span>
         </div>
     </div>