add more documentation

docs/admin.md

@@ -0,0 +1,25 @@
+# Adminbereich
+
+Der Adminbereich ist nur freigeschaltet, wenn der angemeldete Nutzer die Rolle admin hat. Hier können neue Nutzer angelegt, bestehende Nutzer bearbeitet oder gelöscht werden. Züsätzlich können die Daten der ProffessorInnen bearbeitet werden.
+
+Die Verschiedenen Aktionen können über das Dropdown-Menü ausgewählt werden.
+
+## Nutzer anlegen
+![Nutzer anlegen](images/admin_create_user.png)
+
+Hier kann ein neuer Nutzer angelegt werden. Dazu müssen der Nutzername, das Password und die Rolle angegeben werden. Die Rolle kann frei vergeben, oder aus dem Dropdown ausgewählt werden.
+
+Über den Knopf **Anlegen** wird der Nutzer angelegt.
+
+## Nutzer bearbeiten
+![Nutzer bearbeiten](images/admin_edit_user.png)
+
+Hier können die Verschiedenen Nutzer bearbeitet oder gelöscht werden. Hat der ausgewählte Nutzer die Rolle admin, so kann dieser nicht gelöscht werden.
+Um einen Nutzer zu löschen, muss sowohl ein Haken bei **Löschen** gesetzt werden, als auch der Knopf **Löschen** gedrückt werden.
+
+## Lehrperson bearbeiten
+
+![Lehrperson bearbeiten](images/admin_edit_prof.png)
+Hier können die Daten der Lehrperson bearbeitet werden, oder die Lehrperson gelöscht werden. Um eine Lehrperson zu löschen, darf kein Aktiver Apparat vorhanden sein, sowie keine ELSA Aufträge vorhanden sein. 
+
+Um eine Lehperson zu bearbeiten, muss der Name im Dropdown bei "Alte Angaben" ausgewählt werden. Die Alten Daten werden nun in der Maske angezeigt. Die neuen Daten können nun im unteren Bereich eingegeben werden. Über den Knopf **Aktualisieren** werden die Daten gespeichert.

docs/citing.md

@@ -1,2 +1,30 @@
 # Zitieren
+## Oberfläche
+![Zitieroberfläche](images/generate_quote_emtpy.png)
 
+Die [ELSA](elsa.md) Oberfläche bietet die Möglichkeit, für Einträge automatisch Zitate zu erstellen. Hierfür wird der Stil `Deutsche Gesellschaft für Psychologie (DGPs)` verwendet. 
+
+Um ein Zitat zu erstellen, muss zuerst ein Eintrag in der Tabelle ausgewählt werden. Über den Knopf **Eintrag zitieren** wird ein Dialog geöffnet, in dem der Eintrag zitiert werden kann. 
+Sollte ein Eintrag mehrere Abschnitte beinhalten, muss nach der automatischen Suche die Seitenzahl angepasst werden. Ist die Seitenzahl in der Tabelle nur für einen Abschnitt, so wird diese automatisch übernommen.
+
+
+## Zitierdialog
+
+![Zitierdialog mit Ergebnis](images/quote_search_result.png)
+
+Nachdem auf den Knopf **Eintrag zitieren** geklickt wird, wird automatisch der Katalog angefragt und relevante Daten werden in die Felder eingetragen. Ist die Seitenzahl in der Tabelle nur für einen Abschnitt, so wird diese automatisch übernommen.
+
+!!! info "Erläuterung der Knöpfe"
+
+    - **Suchen** Sucht im Katalog nach dem eingegebenen Identifikator
+    - **Zitat erstellen** Stellt eine Verbindung zu Zotero her, erstellt ein entsprechendes Werk und erhält die Zitate als Ergebnis; wechselt zur Oberfläche der Zitate
+    - **Ok** Schließt den Dialog
+    - **Discard** Entfernt alle Eingaben
+    - **Abbrechen** Schließt den Dialog
+    - **Wiederholen** Geht zu den Eingabefeldern zurück, ermöglicht eine erneute Suche mit geänderten Eingaben
+
+## Zitate
+
+![Zitate](images/quote_generated.png)
+
+Über den Knopf **Zitat erstellen** wird eine Verbindung zu Zotero hergestellt und ein entsprechendes Werk erstellt. Die Zitate werden als Ergebnis angezeigt. Der Dialog wechselt automatisch zur Oberfläche der Zitate.

docs/config.md

@@ -1,5 +1,42 @@
 # Einstellungen
+![Einstellungen](images/settings.png)
+
+In den Einstellungen werden alle Informationen angezeigt, die in der config.yaml Datei hinterlegt sind. Diese Datei wird beim Start der Datei eingelesen und als globale Klasse `Config` gespeichert. Dadurch können Einstellungen sofort geändert werden und das Programm muss nicht für jede Änderung neu gestartet werden. 
+
+!!! Info
+    Die zuletzt geöffnete Seite wird automatisch beim nächsten Start geöffnet.
+
+## Seiten
+### Datenbank
+
+Hier sind alle Informationen zur Datenbank, sowie den Tempörären Daten hinterlegt.
+Der Speicherort der Datenbank kann über den Knopf `...`  neben dem Datenbanknamen geändert werden. Der Datenbankpfad passt sich automatisch an.
+
+!!! Warning "Hinweis - Mehrere Nutzer"
+    Sollte die Anwendung von mehreren Nutzern benutzt werden, sollte dieser Pfad nur in absprache geändert werden. Ansonsten kann es zu Problemen kommen.
+
+### Zotero
+![Zotero](images/settings_zotero.png)
+
+In diesem Bereich können die Zugangsdaten für Zotero hinterlegt werden. Diese werden benötigt, um die Zitate für die [ELSA](elsa.md#einträge-zitieren) Zitate zu erstellen.
 
 
+### e-Mail
+![e-Mail](images/settings_mail.png)
+Dieser Bereich ist zweigeteilt, einmal der Allgemeine Teil, und einmal der Teil für die Mailsignatur
+
+#### Allgemein
+Hier können die Zugangsdaten für den Mailversand hinterlegt werden. Diese werden benötigt, um die Nachrichten an die ProffessorInnen zu versenden. Mehr Infos: [Mailversand](mail.md)
+
+#### Signatur
+Hier kann die Signatur für die Mails hinterlegt werden. Diese wird automatisch an jede Mail angehängt.
+
+### Icons
+![Icons](images/settings_icons.png)
+Hier werden sowohl die aktuellen Icons, wie auch die verfügbaren Farben angezeigt.
+
+## Speichern
+
+Über den Knopf **Ok** werden die Einstellungen gespeichert. Sollte ein Neustart der Anwendung erforderlich sein, wird darüber informiert. Ansonsten werden die Einstellungen sofort übernommen.
+
 
-## Email

docs/elsa.md

@@ -5,21 +5,34 @@
 ## ELSA anlegen
 Um einen ELSA zu erstellen, muss der Knopf **Neuer Auftrag** gedrückt werden. Das Feld *Auftragsdaten* wird zum bearbeiten freigeschaltet, der Fokus wird automatisch auf das Feld **Prof.** gesetzt.
 
-Hier werden automatisch alle bereits vorhandenen Professoren der Semesterapparate eingetragen. Sollte der Professor noch keinen Apparat haben, so kann der Name manuell eingetragen werden. Die ELSA Profs werden in einer anderen Tabelle der Datenbank gespeichert, als die Professoren der Semesterapparate. Deshalb kann hier keine [Mail](mail.md) an den Professor geschickt werden.
+Hier werden automatisch alle bereits vorhandenen Professoren der Semesterapparate eingetragen. Sollte der Professor noch keinen Apparat haben, so kann der Name manuell eingetragen werden. Es wird nun ein neues Element angezeigt:
+
+![Kontaktdaten](images/new_prof_elsa_fields.png)
+
+Solange diese Felder nicht ausgefüllt sind, kann der Auftrag nicht gespeichert werden.
 
-### Dokumente hinzufügen
 
-![Dokumenttabelle](images/elsa_docs.png)
 
 Um den ELSA zu speichern, müssen alle Felder ausgefüllt sein. Nach dem Speichern wird der ELSA in der Tabelle angezeigt. Über das Icon ![Icon](images/icon_cal.png) können der aktuelle Tag und das aktuelle Semester eingetragen werden.
 
+### Dokumente hinzufügen
+![Dokumenttabelle](images/elsa_docs.png)
+
 Hat der Professor ein passendes Formular geliefert, so kann dieses über den Knopf **Dokument hinzufügen** hinzugefügt werden. Das Dokument wird in der Datenbank gespeichert und kann über den Knopf **Dokument öffnen** geöffnet werden. Über den Knopf **Medien aus Dokument hinzufügen** werden alle erkannten Medien aus dem Dokument in die Tabelle eingetragen und können zitiert werden.
 
-!!! Info
-    Durch den Klick auf den Knopf **Medien aus Dokument hinzufügen** wird der Auftrag automatisch gespeichert.
+Sollte der Professor mehrere Segmente aus einem Medium in einer Zeile gelistet haben, so können diese als seperate Einträge hinzugefügt werden. Dazu muss ein Haken bei **Abschnitte trennen** gesetzt sein. 
+
+!!! Warn "Hinweis: Datenformat im Dokument"
+    Um die Abschnitte erfolgreich zu trennen, müssen diese durch ein Semikolon getrennt sein. 
+    
+    Beispiel: `1-5; 18-25; 30-35`
+
+
+
+Durch den Klick auf den Knopf **Medien aus Dokument hinzufügen** wird der Auftrag automatisch gespeichert, die Medien, bzw Abschnitte werden in der Tabelle angezeigt.
 
 ### Einträge zitieren
 
-Da alle gescannten Dokumente später auf Illias hochgeladen werden, gibt es die Funktion **Eintrag zitieren**. Für diese Funktion muss ein Eintrag in der Tabelle ausgewählt werden. Über den Knopf **Eintrag zitieren** wird ein Dialog geöffnet, in dem der Eintrag zitiert werden kann. 
+Da alle gescannten Dokumente später auf Illias hochgeladen werden, gibt es die Funktion **Eintrag zitieren**. Für diese Funktion muss ein Eintrag in der Tabelle ausgewählt werden. Über den Knopf **Eintrag zitieren** wird ein Dialog geöffnet, in dem der Eintrag zitiert werden kann. Die Angegebene Seitenzahl wird automatisch übernommen.
 Genauere Beschreibung: [Zitieren](citing.md)