feat: add documentation, changeable shortcuts

docs/Ausleihhistorie.md

@@ -0,0 +1,15 @@
+# Ausleihhistorie
+![Oberfläche](images/loanhistory.png)
+
+!!! info
+
+    Die Ausleihhistorie kann vom Ausleihsystem immer aufgerufen werden. Dazu kann man entweder das  Menu öffnen (Fenster -> Ausleihhistorie) oder den festgelegten Shortcut verwenden.
+
+# Bedienung
+Hier werden alle Medien angezeigt.
+Über die Filter kann man gezielt 
+    - alle Ausleihen
+    - aktuell entliehene Medien
+    - überzogene Medien 
+anzeigen. 
+Zudem kann man mithilfe der Eingabezeile unter den Filteroptionen gezielt nach einem Titel, Nutzer oder einer Signatur gesucht werden.

docs/Ausleihsystem.md

@@ -0,0 +1,47 @@
+# Ausleihsystem
+
+
+
+## Oberfläche
+
+![Nutzeroberfläche ohne Bewerkungen](images/main_marked%20areas.png)
+
+Die Oberfläche kann generell in drei Bereiche unterteilt werden:
+ - Konto und Ausleihe
+ - Nutzerdaten
+ - Historie
+
+### Konto und Ausleihe
+
+Hier werden die Kontodaten und die Ausleihen angezeigt.
+Der Bereich beschränkt sich auf folgende Inhalte:
+![Kontobereich](images/main_ktoarea.png)
+
+Hier werden folgende Daten angezeigt
+
+- Modus: entweder "Ausleihe" oder "Rückgabe" (1)
+- Matrikelnummer: die Matrikelnummer des Nutzers, um das Konto zu öffnen (3)
+- Benutzername: der Benutzername des Nutzers (3)
+- Signatur: die Signatur des Mediums, welches entliehen oder zurückgegeben wird (4)
+- Ausleihe bis: bis wann das Medium ausgeliehen wird, Zeitraum wird in den Einstellungen angepasst
+- Nutzer anlegen: ein Knopf, um einen neuen Nutzer anzulegen (2)
+
+### Nutzerdaten
+Hier werden die Nutzerdaten angezeigt. Vorraussetzung ist, dass ein Nutzer angelegt und geöffnet wurde, oder dass ein Medium zurückgegeben wurde.
+Dieser Bereich beschränkt sich auf folgende Inhalte:
+
+![Nutzerdaten](images/main_userdata.png)
+
+- Das Feld Nutzerdaten (6)beinhaltet
+  - Namen
+  - Matrikelnummer
+  - E-Mail
+- Das Feld Ausleihdaten beinhaltet:
+    - Anzahl Ausleihen (5) : ein klickbares Feld, welches die Anzahl der Ausleihen anzeigt. Beim Klick wird die Übersicht des aktiven Nutzers angezeigt.
+    - Nächstes Rückgabedatum (wird angezeigt wenn ein Nutzer (mehr als) eine Ausleihe hat und ein Medium zurückgegeben wurde oder ein Nutzer geöffnet wird)
+  
+### Historie (7)
+Das Feld der Historie listet alle Medien auf, die im aktiven Prozess ausgeliehen oder zurückgegeben wurden. 
+
+
+

docs/Bericht erstellen.md

@@ -0,0 +1,27 @@
+# Bericht erstellen
+
+![Bericht erstellen](images/generateReport.png)
+
+## Information
+Diese Oberfläche kann immer von der [Hauptoberfläche](Ausleihsystem.md) geöffnet werden. Hierzu entweder 
+`Fenster -> Bericht erstellen` oder den Shortcut F7 verwenden
+
+
+## Bericht generieren
+
+Um einen Bericht zu erstellen, müssen folgende Kriterien erfüllt sein:
+
+- Zeitspanne festgelegt (Entweder über den Slider, oder über die Woche / Monat / Jahr Knöpfe)
+- Datenformat ausgewählt
+
+Nachdem diese Kriterien erfüllt sind, kann der Bericht über den Knopf `Bericht erstellen` erstellt werden. Der Bericht wird erstellt, bei größeren Datensätzen kann es länger dauern, eine Fortschrittsanzeige gibt an, wie weit der Prozess ist. 
+
+Wurde der Bericht erfolgreich erstellt, sieht die Oberfläche wie folgt aus:
+
+![Bericht erstellt](images/generatedReport.png)
+
+Über einen Klick auf `Report` wird die entsprechende Datei geöffnet. 
+
+!!! info
+
+    Text öffnet das Notepad, Excel öffnet Excel

docs/Einstellungen.md

@@ -0,0 +1,21 @@
+# Einstellungen
+![Einstellungen](images/settings.png)
+
+## Bedienung
+Hier werden die Einstellungen geändert. Sobald ein Wert geändert wird, ist es möglich die Einstellungen rückgängig zu machen, oder die Änderungen zu speichern.
+
+## Besonderheiten
+Der Knopf neben Speicherort, Datenbankname, Sicherungspfad und Speicherpfad kann verwendet werden, um den Pfad gezielt zu setzen. 
+
+Beim Datenbanknamen wird allerdings nur der Name der Datenbank übernommen
+
+## Hinweis
+
+Einige Aktionen (bspw. Änderungen der Shortcuts) erfordern einen Neustart der Anwendung. Dies wird beim Speichern der Einstellungen mit folgendem Dialog dargestelt:
+
+![restart](images/restart.png)
+
+Im Anschluss an diesen Dialog erscheint ein neuer Dialog:
+
+![restart Application](images/settings_changed_restart.png)
+

docs/Nutzer anlegen.md

@@ -0,0 +1,18 @@
+# Nutzer anlegen
+
+![Nutzer erstellen](images/add_user.png)
+
+## Information
+Diese Oberfläche kann nur geöffnet werden, wenn die [Hauptoberfläche](Ausleihsystem.md) geöffnet ist. Hierzu muss bei dieser auf folgenden Knopf gedrückt werden:
+![create user](images/createUser.png)
+
+## Bedienung
+Um einen Nutzer anzulegen, müssen alle Angaben korrekt ausgefüllt sein.
+### Limitierungen
+Folgende Regeln sind zwingend einzuhalten:
+- Nachname, Vorname muss mit `, `  getrennt sein
+- Matrikelnummer darf nicht länger als 20 Zeichen sein und nur Nummern enthalten
+- Mail muss einem validen Schema entsprechen (s. Bild)
+
+Nachdem alle Kriterien erfüllt sind, kann der Knopf `Save` angeklickt werden. Der Nutzer wird gespeichert und in der [Hauptoberfläche](Ausleihsystem.md) geöffnet.
+

docs/Nutzeroberfläche.md

@@ -0,0 +1,31 @@
+# Nutzerdatenfenster
+![alt text](images/user_main.png)
+
+!!! info
+  Die Nutzeroberfläche kann nur geöffnet werden, wenn ein Nutzer offen ist. Ansonsten wird ein Fehler angezeigt. (s. unten)
+
+![Error](images/err_nouser.png)
+
+# Bedeutung der Felder
+- (1) Nutzerdaten:
+
+    Name des Nutzers, Matrikelnummer, E-Mail
+    Wird eine Angabe geändert, erscheint Feld (3) um diese Angaben entweder zu speichern oder um die Änderungen rückgängig zu machen.
+
+- (2) Nutzer Löschen:
+
+    Mit dem Klick auf den Mülleimer wird der Nutzer gelöscht. Alle zugewiesenen Ausleihen werden in der [Ausleihhistorie](Ausleihhistorie.md) mit den Nutzerkonto `gelöscht` angezeigt.
+
+- (4) Medien: 
+  
+  Umfasst unter anderem Feld (5), welches ein neues Fenster zum [verlängern](ausleihe verlängern.md) der Ausleihe öffnet. 
+  Mit einem Klick auf 
+  - Alle Ausleihen
+  - Aktuell entliehen
+  - Überzogen 
+werden die Einträge der Tabelle gefiltert. Zusätzlich kann mithilfe der Eingabezeile unter den Filteroptionen gezielt nach einem Titel oder einer Signatur gesucht werden.
+
+- (5) Verlängern:
+  
+  Um Medien zu verlängern, müssen diese in der Tabelle angeklickt werden. Mit Strg können mehrere Medien gleichzeitig ausgewählt und verlängert werden. Hierzu wird ein neues Fenster geöffnet, siehe [Ausleihe verlängern](ausleihe verlängern.md).
+

docs/ausleihe verlängern.md

@@ -0,0 +1,9 @@
+# Medien verlängern
+![Oberfläche](images/extend.png)
+
+## Information
+Die Ausleihe verlängern kann nur geöffnet werden, wenn ein Nutzer offen ist.
+
+Diese Oberfläche erlaubt es, eine oder mehrere Medien zu verlängern. Hierzu muss ein neues, in der Zukunft liegendes Datum ausgewählt und mit OK bestätigt werden.
+
+In der Datenbank wird nun das neue Datum gespeichert und die Einträge in der Tabelle werden aktualisiert.

docs/index.md

@@ -0,0 +1,20 @@
+# Übersicht
+
+!!! info
+    
+    Einige Knöpfe sind auf Englisch. Diese Einstellung kann ich leider nicht ändern, da diese Übersetzung von der Anwendung automatisch ausgeführt werden
+
+
+## [Hauptoberfläche](Ausleihsystem.md)
+Die Hauptoberfläche wird angezeigt, wenn die Anwendung gestartet wird.
+Von hier aus können Nutzer angelegt und bearbeitet werden, Medien ausgeliehen und zurückgegeben werden, sowie verschiedene Unterbereiche anzeigen.
+
+Unterbereiche umfassen:
+
+- [Nutzerdaten](Nutzeroberfläche.md) - Daten für den aktuellen Nutzer anzeigen und bearbeiten
+- [Nutzer anlegen](Nutzer anlegen.md) - Neuen Nutzer anlegen
+- [Ausleihhistorie](Ausleihhistorie.md) - Historie der Ausleihen
+- [Bericht erstellen](Bericht erstellen.md) - Bericht für einen festgelegten Zeitrahmen erstellen
+- [Einstellungen](Einstellungen.md)
+
+## Navigation

docs/shortcuts.md

@@ -0,0 +1,16 @@
+# Shortcuts
+
+!!! info
+
+    Die Shortcuts können für die Anwendung manuell festgelegt werden.
+    Dafür in den [Einstellungen](Einstellungen.md) unter Shortcuts den neuen Shortcut eingeben und speichern
+
+Standardmäßig sind die Shortcuts wie folgt festgelegt:
+
+| Shortcut | Standard |
+| -------  | -------- |
+| Ausleihhistorie | F7 |
+| Bericht erstellen | F6 |
+| Hilfe | F1 |
+| Nutzer | F5 |
+| Rückgabemodus | F8 |

docs/stylesheets/extra.css

@@ -0,0 +1,5 @@
+.md-typeset .admonition,
+.md-typeset details {
+  border-width: 0;
+  border-left-width: 4px;
+}