documentation configuration updated

docs/basic_config.rst

@@ -0,0 +1,67 @@
+Basiskonfiguration (DE)
+=======================
+
+1. Konfigurations-Datei
+-----------------------
+
+Im Basisverzeichnis von eMonitor wird eine Beispielkonfiguration mitgeliefert: emonitor.cfg.template
+In dieser Datei sind sämtliche möglichen Parameter angegeben, die angepasst werden können. Wichtig sind dabei die
+Parameter:
+
+* SQLALCHEMY_DATABASE_URI
+* PATH_DATA
+* PATH_INCOME
+* PATH_DONE
+* PATH_TMP
+* PATH_TILES
+
+Datenbank-Verbindung
+````````````````````
+
+eMonitor unterstützt eine Reihe unterschiedlicher Datenbanken, die je nach Einsatzzweck genutzt werden können.
+
+* MySQL: Im Live-Betrieb sollte auf diese Datenbank zugegriffen werden, da gerade bei der Nutzung mehrerer Monitore und
+  der Druckfunktion sehr viele gleichzeitige Zugriffe erfolgen, die andere Datenbanken verhindern.
+
+::
+
+ > SQLALCHEMY_DATABASE_URI = 'mysql://<benutzer>:<passwort>@<host>/<datenbankname>
+                                                        ?charset=utf8&use_unicode=0'
+
+z.B.
+::
+
+ > SQLALCHEMY_DATABASE_URI = 'mysql://emonitor:[email protected]/emonitor
+                                                        ?charset=utf8&use_unicode=0'
+
+Benutzer: emonitor
+Passwort: geheim
+Host: 127.0.0.1
+Datenbankname: emonitor
+
+* Sqlite: Einfache Datenbank, die ohne Installation eine Datei nutzt. Kann aber zu Problemen führen, wenn viele
+  Verbindungen bzw. Anfragen auf die Datenbank gestartet werden.
+
+::
+
+ > SQLALCHEMY_DATABASE_URI = 'sqlite:///<pfad>/<dateiname>'
+
+z.B.
+::
+
+ > SQLALCHEMY_DATABASE_URI = 'sqlite:///D:/data/emonitor/emonitor.db'
+
+
+Pfade
+`````
+
+eMonitor speichert Daten in verschiedenen Verzeichnissen
+
+* PATH_DATA: Basisverzeichnis der Daten
+* PATH_INCOME: Verzeichnis, das überwacht wird (für Fax-Empfang)
+* PATH_DONE: Faxablage nach der Bearbeitung - Darunter wird eine Struktur aufgebaut Jahr/Monat z.B. 2015/04
+* PATH_TMP: Verzeichnis für temporäre Dateien
+* PATH_Tiles: Pfad für den Kartenserver, unter dem die Tiles für die Offline-Kartendarstellung abgelegt werden.
+
+Die Pfade können jeweils absolut sein oder im UNC-Format angegeben werden, sollten aber immer mit */* enden. Unter
+Windows ist es ratsam, dass */* als Verzeichnistrenner verwendet wird.

docs/conf.py

@@ -15,6 +15,7 @@
 import sys
 import os
 import sphinx_rtd_theme
+from emonitor import __version__ as eversion
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -60,9 +61,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3'
+version = ".".join(eversion.split('.')[:-1])
 # The full version, including alpha/beta/rc tags.
-release = '0.3.2'
+release = eversion
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index_all.rst.template

@@ -3,13 +3,14 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to eMonitor's documentation!
-====================================
+eMonitor Documentation
+======================
 
 .. toctree::
    :maxdepth: 2
 
    /docs/install
+   /docs/basic_config
 
 Handbücher
 ==========

docs/index_dev.rst.template

@@ -3,14 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to eMonitor's developer documentation!
-==============================================
+eMonitor developer documentation
+================================
 
 .. toctree::
    :maxdepth: 3
    :glob:
 
-   /docs/install
+   docs/install
+   docs/basic_config
    docs/doc_devel
    docs/emonitor
 

docs/index_user.rst.template

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to eMonitor's documentation!
-====================================
+eMonitor documentation
+======================
 
 .. toctree::
    :maxdepth: 3

docs/install.rst

@@ -1,64 +1,100 @@
 Installation (DE)
 =================
 
-Hier kommt die Anleitung für die Installation
+Sämtliche Komponenten für eMonitor liegen für verschiedene Betriebssysteme vor und können somit auf nahezu jeder
+Platform installiert werden. Nachfolgend ist die Installation für Linux und Windows-Systeme beschrieben.
 
 Installation unter Linux
 ------------------------
 
-Nach der Installation von Python 2.x und pip sind folgende Schritte erforderlich:
+Nach der Installation von Python 2.x sind folgende Schritte erforderlich:
 
->>> git clone https://github.com/seiferta/eMonitor.git emonitorpip install -r requirements.txt
+1. Laden der Quellen von Github
+::
 
-Installation von ImageMagick (Wird zur Umwandlung von PDF-Dateien nach PNG benötigt)
+ > git clone https://github.com/seiferta/eMonitor.git emonitor
+ > cd emonitor
+ > pip install -r requirements.txt
 
->>> apt-get install imagemagick
+2. Installation von ImageMagick (Wird zur Umwandlung von PDF-Dateien nach PNG benötigt)
+::
 
-Installation von ghostview (wird zur Umwandlung der PDF-Dateien benötigt)
+ > apt-get install imagemagick
 
->>> apt-get install ghostview
+3. Installation von ghostview (wird zur Umwandlung der PDF-Dateien benötigt)
+::
 
-Installation von Ghostscript (gsprint wird zum Ausdruck der PDF-Alarmansicht benötigt)
+ > apt-get install ghostview
 
->>> apt-get install ghostscript
+4. Installation von Ghostscript (gsprint wird zum Ausdruck der PDF-Alarmansicht benötigt)
+::
 
-Installation von tesseract
+ > apt-get install ghostscript
+
+5. Installation von tesseract (OCR-Software)
+::
+
+ > apt-get install tesseract-ocr tesseract-ocr-deu
 
->>> apt-get install tesseract-ocr tesseract-ocr-deu
 
 Installation unter Windows
 --------------------------
 
-Nach der Installation von Python 2.x und pip sind folgende Schritte erforderlich:
+Nach der Installation von Python 2.x sind folgende Schritte erforderlich:
 (Falls pip nicht direkt installiert werden kann, unter https://bootstrap.pypa.io/get-pip.py liegt ein Script, mit dem man pip direkt mit python installieren kann, eine Anleitung ist unter https://pip.pypa.io/en/latest/installing.html zu finden)
 
->>> git clone https://github.com/seiferta/eMonitor.git emonitor
+1. Laden der Quellen von Github
+::
+
+ > git clone https://github.com/seiferta/eMonitor.git emonitor
+ > cd emonitor
 
 Unter Windows kann man mit pip einige Python-Pakete nicht direkt installieren:
 
 - Pillow: http://www.lfd.uci.edu/~gohlke/pythonlibs/#pillow
 - Reportlab: http://www.lfd.uci.edu/~gohlke/pythonlibs/#reportlab
 
-Anschließend folgt dann die Installation der restlichen Python-Abhängigkeiten mit pip
+2. Anschließend folgt dann die Installation der restlichen Python-Abhängigkeiten mit pip
+::
 
->>> pip install -r requirements.txt
-
-Folgende weitere Softwarepakete bzw. Teile davon werden noch benötigt:
+ > pip install -r requirements.txt
 
+3. Folgende weitere Softwarepakete bzw. Teile davon werden noch benötigt:
 - ImageMagick: convert.exe http://www.imagemagick.org/script/binary-releases.php
 - GhostView: gsprint.exe http://pages.cs.wisc.edu/~ghost/gsview/get50.htm
 - GhostScript: http://www.ghostscript.com/download/gsdnld.html
 - Tesseract: tesseract.exe http://tesseract-ocr.googlecode.com/files/tesseract-ocr-3.02-win32-portable.zip
 
+Installation als Windows-Service
+````````````````````````````````
+
+eMonitor kann unter Windows als Dienst installiert werden, der automatisch beim Starten des Rechners aktiviert wird.
+Dazu sind ein paar Dinge zu beachten:
+
+* Dateipfade dürfen keine Netzwerklaufwerke sein, die per Zuordnung einem Buchstaben zugeordnet sind. Es sind
+  ausschließlich UNC-Pfade zu verwenden.
+
+* Der Benutzer, unter dem der Dienst läuft, muss Zugriff auf die Verzeichnisse haben
+
+Installation:
+::
+
+ > cd emonitor
+ > python service.py install
+
+Anschließend kann der Dienst über die Dienste-Verwaltung konfiguriert werden.
+
 Konfiguration und Hilfe
 -----------------------
 
 Parameter für convert (PDF -> PNG)
+::
 
->>> 32-bit[basepath]/bin/convert/convert32.exe -depth 32 -density 250 [incomepath][filename] -quality 100 [tmppath]
->>> 64-bit[basepath]/bin/convert/convert64.exe -resize 200% -depth 32 -density 200 [incomepath][filename] -quality 100 [tmppath]
+ > 32-bit[basepath]/bin/convert/convert32.exe -depth 32 -density 250 [incomepath][filename] -quality 100 [tmppath]
+ > 64-bit[basepath]/bin/convert/convert64.exe -resize 200% -depth 32 -density 200 [incomepath][filename] -quality 100 [tmppath]
 
 Parameter für tesseract (OCR)
+::
 
->>> 32-bit[basepath]/bin/tesseract/tesseract.exe [incomepath][filename] [tmppath] -l deu -psm  6 quiet custom
->>> 64-bit[basepath]/bin/tesseract/tesseract.exe [incomepath][filename] [tmppath] -l deu -psm 6 quiet custom
+ > 32-bit[basepath]/bin/tesseract/tesseract.exe [incomepath][filename] [tmppath] -l deu -psm  6 quiet custom
+ > 64-bit[basepath]/bin/tesseract/tesseract.exe [incomepath][filename] [tmppath] -l deu -psm 6 quiet custom