Update documentation

Changelog.md

@@ -21,6 +21,7 @@
   item. If multiple due dates are found, the earliest one is used.
 - Allow to switch between viewerjs PDF viewer or the browser's builtin
   viewer.
+- Bug fixes related to handling text files.
 
 ### Configuration Changes
 
@@ -30,6 +31,8 @@ The configuration of the joex component has been changed.
   periodic scheduler
 - new section `docspell.joex.house-keeping` for configuring
   house-keeping tasks
+- The command for running `wkhtmltopdf` changed in that the encoding
+  is now added at runtime.
 
 ### REST Api Changes
 

README.md

@@ -3,8 +3,8 @@
 [![Build Status](https://travis-ci.org/eikek/docspell.svg?branch=master)](https://travis-ci.org/eikek/docspell)
 [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 
-# Docspell
 
+# Docspell
 
 Docspell is a personal document organizer. You'll need a scanner to
 convert your papers into PDF files. Docspell can then assist in
@@ -17,6 +17,8 @@ them later using the search feature. But adding this manually to each
 document is a tedious task. What if most of it could be done
 automatically?
 
+It is provided as a REST server and a web application.
+
 ## How it works
 
 Documents have two main properties: a correspondent (sender or
@@ -41,6 +43,7 @@ must be maintained manually. But usually, this data doesn't grow as
 fast as the documents. After a while there is a quite complete address
 book and only once in a while it has to be revisited.
 
+
 ## Documentation
 
 The [documentation site](https://eikek.github.io/docspell/) provides
@@ -51,8 +54,12 @@ Check the feature list and the quickstart guide to try it out:
 - [Features](https://eikek.github.io/docspell/features.html)
 - [Quickstart](https://eikek.github.io/docspell/getit)
 
+
 ## Screenshots
 
+Here are some (outdated) screenshots, for getting a first impression
+of the web ui.
+
 ![screenshot-1](https://raw.githubusercontent.com/eikek/docspell/master/modules/microsite/src/main/resources/microsite/img/docspell-curate-1.jpg)
 ![screenshot-2](https://raw.githubusercontent.com/eikek/docspell/master/modules/microsite/src/main/resources/microsite/img/docspell-curate-2.jpg)
 ![screenshot-3](https://raw.githubusercontent.com/eikek/docspell/master/modules/microsite/src/main/resources/microsite/img/processing-queue.jpg)

modules/microsite/docs/doc/tools.md

@@ -78,7 +78,7 @@ The config file is expected in
 `$XDG_CONFIG_HOME/docspell/ds.conf`. `$XDG_CONFIG_HOME` defaults to
 `~/.config`.
 
-The config file contains lines with key-value pairs, separated by an
+The config file contains lines with key-value pairs, separated by a
 `=` sign. Lines starting with `#` are ignored. Example:
 
 ```
@@ -87,17 +87,21 @@ url.1 = http://localhost:7880/api/v1/open/upload/item/5DxhjkvWf9S-CkWqF3Kr892-Wg
 url.2 = http://localhost:7880/api/v1/open/upload/item/6DxhjkvWf9S-CkWqF3Kr892-WgoCspFWDo7-XBykwCyAUxQ
 ```
 
-The key must start with `url`.
+The key must start with `url`. The urls should be [anonymous upload
+urls](./uploading.html).
+
 
 ### Usage
 
-The `-h` option shows a help overview.
+- The `-c` option allows to specifiy a different config file.
+- The `-h` option shows a help overview.
+- The `-d` option deletes files after upload was successful
+- The `-e` option can be used to check for file existence in docspell.
+  Instead of uploading, the script only checks whether the file is in
+  docspell or not.
 
-The script takes a list of files as arguments. It checks the file
+The script takes a list of files as arguments.
-types and will raise an error (and quit) if a file is included that is
-not a PDF. The `-s` option can be used to skip them instead.
 
-The `-c` option allows to specifiy a different config file.
 
 Example:
 
@@ -121,8 +125,8 @@ and the web extension. Both work together.
 
 #### Install `ds.sh`
 
-First install the `ds.sh` tool somewhere, maybe `/usr/local/bin` as
+First copy the `ds.sh` tool somewhere in your `PATH`, maybe
-described above.
+`/usr/local/bin` as described above.
 
 
 #### Install the native part

modules/microsite/docs/features.md

@@ -6,11 +6,13 @@ title: Features and Limitations
 # Features
 
 - Multi-account application
-- Multiple users per account
+- Multiple users per account (multiple users can access the same
+  account)
 - Handle multiple documents as one unit
 - OCR using [tesseract](https://github.com/tesseract-ocr/tesseract)
-- Conversion to PDF: all files are converted into a PDF file, while
+- Conversion to PDF: all files are converted into a PDF file
-  the original file is preserved
+- Non-destructive: all your uploaded files are never modified and can
+  always be downloaded untouched
 - Text is analysed to find and attach meta data automatically
 - Manage document processing (cancel jobs, set priorities)
 - Everything available via a documented [REST Api](api)
@@ -21,17 +23,19 @@ title: Features and Limitations
   can be scaled-out independently
 - Everything stored in a SQL database: PostgreSQL, MariaDB or H2
 - Files supported:
-  - PDF
+  - Documents:
-  - common MS Office (doc, docx, xls, xlsx)
+    - PDF
-  - OpenDocument (odt, ods)
+    - common MS Office (doc, docx, xls, xlsx)
-  - RichText (rtf)
+    - OpenDocument (odt, ods)
-  - Images (jpg, png, tiff)
+    - RichText (rtf)
-  - HTML
+    - Images (jpg, png, tiff)
-  - text/* (treated as Markdown)
+    - HTML
-  - zip
+    - text/* (treated as Markdown)
-  - [eml](https://en.wikipedia.org/wiki/Email#Filename_extensions)
+  - Archives (extracted automatically, can be nested)
-    (e-mail files in plain text MIME)
+    - zip
-- Tools:
+    - [eml](https://en.wikipedia.org/wiki/Email#Filename_extensions)
+      (e-mail files in plain text MIME)
+- Tooling:
   - Watch a folder: watch folders for changes and send files to docspell
   - Firefox plugin: right click on a link and send the file to docspell
   - Simple CLI for uploading files

modules/microsite/docs/getit.md

@@ -4,7 +4,7 @@ title: Quickstart
 permalink: getit/
 ---
 
-## Download
+## {{ page.title }}
 
 You can download pre-compiled binaries from the [Release
 Page](https://github.com/eikek/docspell/releases). There are `deb`

modules/microsite/src/main/resources/microsite/data/menu.yml

@@ -48,9 +48,6 @@ options:
      - title: Tools
        url: doc/tools.html
 
-  - title: Changelog
-    url : changelog
-
   - title: Development
     url: dev.html
 
@@ -67,3 +64,6 @@ options:
 
      - title: REST OpenApi Spec
        url: openapi/docspell-openapi.yml
+
+  - title: Changelog
+    url : changelog