Website tweaks

website/elm/Feature.elm

@@ -62,6 +62,12 @@ files while using their own account with their own settings.
       , header = "Text Extraction with OCR"
       , description = """
 Text is extracted from all files. For scanned documents/images, OCR is used by utilising tesseract. The text is analysed and is available for full-text search.
+"""
+      }
+    , { image = "img/analyze-feature.png"
+      , header = "Text Analysis"
+      , description = """
+The extracted text is analyzed and is used to find properties that can be annotated to your documents automatically.
 """
       }
     , { image = "img/filetype-feature.svg"

website/elm/Main.elm

@@ -310,4 +310,14 @@ mainHero model =
                     ]
                 ]
             ]
+        , div [ class "hero-foot" ]
+            [ span [ class "unsplash-credit" ]
+                [ text "Photo by "
+                , a
+                    [ href "https://unsplash.com/@tersiusvanrhyn"
+                    ]
+                    [ text "Tersius van Rhyn"
+                    ]
+                ]
+            ]
         ]

website/site/content/docs/install/installing.md

@@ -219,7 +219,7 @@ The modules files are only applicable to the newest version of
 Docspell. If you really need an older version, checkout the
 appropriate commit.
 
-## NixOS Example
+### NixOS Example
 
 This is a example system configuration that installs docspell with a
 postgres database. This snippet can be used to create a vm (using

website/site/content/docs/install/reverseproxy.md

@@ -12,7 +12,7 @@ For the examples below, assume the following:
   `localhost:7880` instead.
 - The external domain/hostname is `docspell.example.com`
 
-## Configuring Docspell
+# Configuring Docspell
 
 These settings require a complement config part in the docspell
 configuration file:
@@ -51,7 +51,7 @@ server and web application.
 If you have examples for more servers, please let me know or add it to
 this site.
 
-## Nginx
+# Nginx
 
 This defines two servers: one listens for http traffic and redirects
 to the https variant. Additionally it defines the let's encrypt

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

@@ -79,7 +79,7 @@ explained.
 
 ## Item
 
-An **Item** is roughly your document, only that an item may span
+An *Item* is roughly your document, only that an item may span
 multiple files, which are called **attachments**. An item has **meta
 data** associated:
 

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

@@ -7,6 +7,8 @@ insert_anchor_links = "right"
 mktoc = true
 +++
 
+# Introduction
+
 Joex is short for *Job Executor* and it is the component managing long
 running tasks in docspell. One of these long running tasks is the file
 processing task.
@@ -28,7 +30,7 @@ compete on getting the next job from the queue. After a job finishes
 and no job is waiting in the queue, joex will sleep until notified
 again. It will also periodically notify itself as a fallback.
 
-## Task vs Job
+# Task vs Job
 
 Just for the sake of this document, a task denotes the code that has
 to be executed or the thing that has to be done. It emerges in a job,
@@ -37,7 +39,7 @@ up and executed eventually. A job maintains a state and other things,
 while a task is just code.
 
 
-## Scheduler and Queue
+# Scheduler and Queue
 
 The scheduler is the part that runs and monitors the long running
 jobs. It works together with the job queue, which defines what job to
@@ -60,7 +62,7 @@ logged in, jobs are more important that those submitted when not
 logged in.
 
 
-## Scheduler Config
+# Scheduler Config
 
 The relevant part of the config file regarding the scheduler is shown
 below with some explanations.
@@ -128,7 +130,7 @@ reach a joex component. This periodic wakup is just to ensure that
 jobs are eventually run.
 
 
-## Periodic Tasks
+# Periodic Tasks
 
 The job executor can execute tasks periodically. These tasks are
 stored in the database such that they can be submitted into the job
@@ -137,7 +139,7 @@ something with a task. So a periodic task is never submitted twice. It
 is also not submitted, if a previous task has not finished yet.
 
 
-## Starting on demand
+# Starting on demand
 
 The job executor and rest server can be started multiple times. This
 is especially useful for the job executor. For example, when
@@ -152,7 +154,7 @@ Once the files have been processced you can stop the additional
 executors.
 
 
-## Shutting down
+# Shutting down
 
 If a job executor is sleeping and not executing any jobs, you can just
 quit using SIGTERM or `Ctrl-C` when running in a terminal. But if

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

@@ -4,6 +4,8 @@ description = "A script to watch a directory for new files and upload them to do
 weight = 20
 +++
 
+# Introduction
+
 The `consumerdir.sh` is a bash script that works in two modes:
 
 - Go through all files in given directories (recursively, if `-r` is
@@ -90,7 +92,7 @@ about duplicates. This allows to keep your files organized using the
 file-system and have them mirrored into docspell as well.
 
 
-## Systemd
+# Systemd
 
 The script can be used with systemd to run as a service. This is an
 example unit file:
@@ -112,7 +114,7 @@ an existing user `someuser` that is used to run this service. The url
 url as described [here](@/docs/webapp/uploading.md#anonymous-upload).
 
 
-## Docker
+# Docker
 
 The provided docker image runs this script to watch a single
 directory, `./docs` in current directory, for new files. If a new file

website/site/content/docs/tools/ds.md

@@ -4,6 +4,8 @@ description = "A script to quickly upload files from the command line."
 weight = 10
 +++
 
+# Introduction
+
 A bash script to quickly upload files from the command line. It reads
 a configuration file containing the URLs to upload to. Then each file
 given to the script will be uploaded to al URLs in the config.
@@ -25,7 +27,7 @@ The key must start with `url`. The urls should be [anonymous upload
 urls](@/docs/webapp/uploading.md#anonymous-upload).
 
 
-## Usage
+# Usage
 
 - The `-c` option allows to specifiy a different config file.
 - The `-h` option shows a help overview.

website/site/content/docs/tools/smtpgateway.md

@@ -16,7 +16,7 @@ provide a minimal setup, you might want to add tls and spam protection
 when opening it to the public.
 
 
-## What you need
+# What you need
 
 You need to own a domain and add the appropriate MX records to point
 to your server. In this document, the domain `test.org` is used.
@@ -25,14 +25,14 @@ You need to enable the [integration
 endpoint](@/docs/webapp/uploading.md#integration-endpoint) in the
 docspell configuration.
 
-## Exim
+# Exim
 
 [Exim](http://exim.org/) is a popular smtp server (message transfer
 agent). It is used here only because of previous knowledge, but same
 can be achieved with other MTAs.
 
 
-## The Config File
+# The Config File
 
 Here is the example config file for exim:
 
@@ -83,7 +83,7 @@ notes about the used options (see `man curl`):
   `somename`.
 
 
-## Install with Docker
+# Install with Docker
 
 Go into the `tools/exim` directory and build the docker image:
 
@@ -116,7 +116,7 @@ docker-compose up
 ```
 
 
-## Test Run
+# Test Run
 
 Now it is possible to send mails to this MTA which will be immediatly
 uploaded to docspell for the collective corresponding to the

website/site/content/docs/webapp/curate.md

@@ -7,7 +7,7 @@ Curating the items meta data helps finding them later. This page
 describes how you can quickly go through those items and correct or
 amend with existing data.
 
-## Select New items
+# Select New items
 
 After files have been uploaded and the job executor created the
 corresponding items, they will show up on the main page. All items,
@@ -18,7 +18,7 @@ items:
 {{ figure(file="docspell-curate-1.jpg") }}
 
 
-## Check selected items
+# Check selected items
 
 Then you can go through all new items and check their metadata: Click
 on the first item to open the detail view. This shows the documents
@@ -27,7 +27,7 @@ and the meta data in the header.
 {{ figure(file="docspell-curate-2.jpg") }}
 
 
-## Modify if necessary
+# Modify if necessary
 
 To change something, click the *Edit* button in the menu above the
 document view. This will open a form next to your documents. You can
@@ -44,7 +44,7 @@ when changing text fields, a click on the *Save* symbol next to the
 field is required.
 
 
-## Confirm
+# Confirm
 
 If everything looks good, click the *Confirm* button to confirm the
 current data. The *New* status goes away and also the suggestions are
@@ -55,7 +55,7 @@ hidden in this state. You can always go back by clicking the
 {{ figure(file="docspell-curate-5.jpg") }}
 
 
-## Proceed with next item
+# Proceed with next item
 
 To look at the next item in the search results, click the *Next*
 button in the menu (next to the *Edit* button). Clicking next, will

website/site/content/docs/webapp/emailsettings.md

@@ -24,7 +24,7 @@ your e-mail account to send mails on behalf of you and receive your
 mails.*
 
 
-## SMTP Settings
+# SMTP Settings
 
 For sending mail, you need to provide information to connect to a SMTP
 server. Every e-mail provider has this information somewhere
@@ -61,7 +61,7 @@ possible to set up these settings for multiple providers, so you can
 choose from which account you want to send mails.
 
 
-## IMAP Settings
+# IMAP Settings
 
 For receiving e-mails, you need to provide information to connect to
 an IMAP server. Your e-mail provider should have this information
@@ -88,7 +88,7 @@ Here is an example for posteo.de:
 - SSL: use `StartTLS`
 
 
-## SSL / TLS / StartTLS
+# SSL / TLS / StartTLS
 
 *Please Note: If `SSL` is set to `None`, then mails will be sent
 unencrypted to your mail provider! If `Ignore certificate check` is
@@ -97,7 +97,7 @@ provider is wrongly configured for SSL/TLS. This flag should only be
 enabled if you know why.*
 
 
-## GMail
+# GMail
 
 Authenticating with GMail may be not so simple. GMail implements an
 authentication scheme called *XOAUTH2* (at least for Imap). It will

website/site/content/docs/webapp/finding.md

@@ -14,7 +14,7 @@ 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") }}
 
@@ -22,7 +22,7 @@ By default, the search bar is shown. It provides a refined view of the
 search menu. The dropdown contains different options to do a quick
 search.
 
-### *All Names* and *Contents*
+## *All Names* and *Contents*
 
 These two options correspond to the same named field in the search
 menu. If you switch between search menu and search bar (by clicking
@@ -54,7 +54,7 @@ restricted by the search term given in the search-bar, but also by
 what is specified in the search menu.
 
 
-### *Contents Only*
+## *Contents Only*
 
 This option has no corresponding part in the search menu. Searching
 with this option active, there is only a full text search done in the
@@ -65,33 +65,33 @@ respect to the search term. This ordering is returned from the full
 text search engine and is simply transfered unmodified.
 
 
-## Search Menu
+# Search Menu
 
 {{ imgright(file="search-menu.png") }}
 
 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
+## Show new items
 
 Clicking the checkbox "Only new" shows items that have not been
 "Confirmed". All items that have been created by docspell and not
 looked at are marked as "new" automatically.
 
-### Names
+## Names
 
 Searches in names of certain properties. The `All Names` field is the
 same as the search in the search bar (see above).
 
 The `Name` field only searches in the name property of an item.
 
-### Folder
+## 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
+## Tags
 
 Specify a list of tags that the items must have. When adding tags to
 the "Include" list, an item must have all these tags in order to be
@@ -100,15 +100,15 @@ included in the results.
 When adding tags to the "Exclude" list, then an item is removed from
 the results if it has at least one of these tags.
 
-### Correspondent
+## Correspondent
 
 Pick a correspondent to show only these items.
 
-### Concerned
+## Concerned
 
 Pick a concerned entity to show only these items.
 
-### Date
+## Date
 
 Specify a date range to show only items whose date property is within
 this range. If you want to see items of a specific day, choose the
@@ -117,18 +117,18 @@ same day for both fields.
 For items that don't have an explicitly date property set, the created
 date is used.
 
-### Due Date
+## Due Date
 
 Specify a date range to show only items whose due date property is
 within this range. Items without a due date are not shown.
 
 
-### Direction
+## Direction
 
 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
 customized in the following way: A wildcard `*` can be used at the
@@ -144,10 +144,10 @@ unless one of the following is true:
 - The term is enclosed in quotes `"`.
 
 
-## Full Text Search
+# Full Text Search
 
 
-### The Query
+## The Query
 
 The query string for full text search is very powerful. Docspell
 currently supports [Apache SOLR](https://lucene.apache.org/solr/) as
@@ -170,7 +170,7 @@ It will by default search all indexed fields, which are: attachment
 contents, attachment names, item name and item notes.
 
 
-### The Results
+## The Results
 
 When using full text search, each item in the result list is annotated
 with the highlighted occurrence of the match.

website/site/content/docs/webapp/mailitem.md

@@ -12,13 +12,13 @@ people outside docspell.
 All sent mails are stored attached to the item.
 
 
-## E-Mail Settings (SMTP)
+# E-Mail Settings (SMTP)
 
 To send mails, there are SMTP settings required. Please see the page
 about [e-mail settings](@/docs/webapp/emailsettings.md#smtp-settings).
 
 
-## Sending Mails
+# Sending Mails
 
 Currently, it is possible to send mails related to only one item. You
 can define the mail body and docspell will add the attachments of an
@@ -53,7 +53,7 @@ Once you click *Send*, the docspell server will send the mail using
 your connection settings. If that succeeds the mail is saved to the
 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,
 next to the attachments.

website/site/content/docs/webapp/metadata.md

@@ -5,6 +5,8 @@ weight = 10
 mktoc = true
 +++
 
+# Metadata
+
 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
@@ -17,8 +19,7 @@ known meta data. The *Meta Data* page allows to manage this meta data:
 - Equipments
 - Folders
 
-
+## Tags
-### Tags
 
 Items can be tagged with multiple custom tags (aka labels). This
 allows to describe many different workflows people may have with their
@@ -37,7 +38,7 @@ not automatically associate tags to your items. The tags are only
 meant to be used manually for now.
 
 
-### Organization and Person
+## Organization and Person
 
 The organization entity represents an non-personal (organization or
 company) correspondent of an item. Docspell will choose one or more
@@ -65,7 +66,7 @@ document processing. They might be useful when using this as a real
 address book.
 
 
-### Equipment
+## Equipment
 
 The equipment entity is almost like a tag. In fact, it could be
 replaced by a tag with a specific known category. The difference is
@@ -78,7 +79,7 @@ Equipments don't have contact information, so the only property that
 is used to find matches during document processing is its name.
 
 
-### Folders
+## 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
@@ -103,7 +104,7 @@ url](uploading#anonymous-upload) to have them automatically set when
 they arrive.
 
 
-## Document Language
+# Document Language
 
 An important setting is the language of your documents. This helps OCR
 and text analysis. You can select between English and German

website/site/content/docs/webapp/scanmailbox.md

@@ -19,7 +19,7 @@ multiple e-mail accounts you want to import periodically.
 {{ figure(file="scanmailbox-list.png") }}
 
 
-## Details
+# Details
 
 Creating a task requires the following information:
 
@@ -84,7 +84,7 @@ multiples of `7` added to it. In other words, it matches `1`, `1+7`,
 `1+7+7`, `1+7+7+7` and so on.
 
 
-## Reading Mails twice / Duplicates
+# Reading Mails twice / Duplicates
 
 Since users can move around mails in their mailboxes, it can happen
 that docspell unintentionally reads a mail multiple times. If docspell
@@ -104,7 +104,7 @@ In later versions, docspell may use the checksum of the generated eml
 file to look for duplicates, too.
 
 
-## How it works
+# How it works
 
 Docspell will go through all folders and download mails in “batches”.
 This size can be set by the admin in the [configuration

website/site/content/docs/webapp/uploading.md

@@ -7,7 +7,7 @@ This page describes, how files can get into docspell. Technically,
 there is just one way: via http multipart/form-data requests.
 
 
-## Authenticated Upload
+# Authenticated Upload
 
 From within the web application there is the "Upload Files"
 page. There you can select multiple files to upload. You can also
@@ -25,12 +25,12 @@ This obviously requires an authenticated user. While this is handy for
 ad-hoc uploads, it is very inconvenient for automating it by custom
 scripts. For this the next variant exists.
 
-## Anonymous Upload
+# Anonymous Upload
 
 It is also possible to upload files without authentication. This
 should make tools that interact with docspell much easier to write.
 
-### Creating Anonymous Uploads
+# Creating Anonymous Uploads
 
 Go to "Collective Settings" and then to the "Source" tab. A *Source*
 identifies an endpoint where files can be uploaded
@@ -88,7 +88,7 @@ docspell count the files uploaded through the web interface, just
 create a source (can be inactive) with that name (`webapp`).
 
 
-## Integration Endpoint
+# Integration Endpoint
 
 Another option for uploading files is the special *integration
 endpoint*. This endpoint allows an admin to upload files to any
@@ -125,7 +125,7 @@ checksum with:
 See the [SMTP gateway](@/docs/tools/smtpgateway.md) or the [consumedir
 script](@/docs/tools/consumedir.md) for examples to use this endpoint.
 
-## The Request
+# The Request
 
 This gives more details about the request for uploads. It is a http
 `multipart/form-data` request, with two possible fields:

website/site/sass/styles.sass

@@ -8,10 +8,16 @@ $dwhite: #f0f8ff
 $code: $dblue
 $pre: $dblue
 
-@import url('https://fonts.googleapis.com/css?family=Nunito:400,700')
+@import url('https://fonts.googleapis.com/css?family=Libre+Baskerville:400,700')
+@import url('https://fonts.googleapis.com/css?family=Montserrat:400,600')
+@import url('https://fonts.googleapis.com/css?family=Source+Code+Pro:400')
 
 // Update Bulma's global variables
-$family-sans-serif: "Nunito", sans-serif
+$family-serif: "Libre Baskerville",serif
+$family-sans-serif: "Montserrat", sans-serif
+$family-monospace: "Source Code Pro",monospace
+//$family-primary: $family-serif
+
 /* $grey-dark: $brown;
 /* $grey-light: $beige-light;
 $primary: $dred
@@ -20,6 +26,9 @@ $info: $infoblue
 //josh-rose-trYl7JYATH0-unsplash
 //tersius-van-rhyn-xcQWMPm9fG8-unsplash
 //cassie-boca-x-tbVqkfQCU-unsplash
+//jf-martin-Ofs3LjEUcrk-unsplash
+  //  background: linear-gradient(rgba(0, 0, 0, 0.5), rgba(0, 0, 0, 1)), url(img/jf-martin-Ofs3LjEUcrk-unsplash.jpg)
+//jesse-gardner-EqdpXeemf58-unsplash
 #hero-main
   background: url(img/tersius-van-rhyn-xcQWMPm9fG8-unsplash.jpg)
   background-size: 100% 100%
@@ -36,6 +45,13 @@ $info: $infoblue
   &:hover
     box-shadow: 1px 1px 3px $info;
 
+h1
+  font-family: $family-serif
+
+.doc
+  h1
+    border-bottom: 1px solid #ccc
+
 a.zola-anchor
   padding-left: 0.75rem
   display: none
@@ -62,6 +78,14 @@ nav.breadcrumb
     &:hover
       color: black
 
+span.unsplash-credit
+  color: #444
+  float: right
+  font-size: smaller
+  a
+    color: #444
+    &:hover
+      color: #666
 
 //import all of bulma
 @import "../../node_modules/bulma/bulma.sass"

website/site/templates/overview.html

@@ -23,6 +23,7 @@
         </section>
 
         <section class="section">
+            <div class="container">
             <div class="content is-size-5">
                 This is the documentation for Docspell, version {{ config.extra.version }}.
             </div>
@@ -51,6 +52,7 @@
                 </div>
                 {% endfor %}
             </div>
+            </div>
         </section>
 
 

website/site/templates/page.html

@@ -80,8 +80,10 @@
                 </div>
 
                 <div class="column is-9">
-                    <div class="content">
+                    <div class="container">
-                        {{ page.content | safe }}
+                        <div class="content doc">
+                            {{ page.content | safe }}
+                        </div>
                     </div>
                 </div>
             </div>

website/site/templates/section.html

@@ -61,8 +61,10 @@
                 </div>
 
                 <div class="column is-9">
-                    <div class="content">
+                    <div class="container">
-                        {{ section.content | safe }}
+                        <div class="content doc">
+                            {{ section.content | safe }}
+                        </div>
                     </div>
                 </div>
             </div>
@@ -71,8 +73,10 @@
 
         {% if not section.extra.mktoc %}
         <section class="section pt-2">
-            <div class="content">
+            <div class="container">
-                {{ section.content | safe }}
+                <div class="content doc">
+                    {{ section.content | safe }}
+                </div>
             </div>
         </section>
         {% endif %}