docs: add images and files (1)

docs/config.md

@@ -0,0 +1,5 @@
+# Einstellungen
+
+
+
+## Email

docs/create.md

@@ -0,0 +1,90 @@
+# Semesterapparat anlegen
+
+Um einen neuen Semesterapparat anzulegen, muss zuerst der Knopf "neu. App anlegen" gedrückt werden. Das Feld der Apparatdetails wird nun zum bearbeiten entsperrt, und die Daten können in die Felder eingetragen werden.
+
+![Anlegen](images/main_apparatdetails.png)
+
+## Apparatsdetails
+### Apparat anlegen
+Um einen Apparat erfolgreich anzulegen, müssen alle Felder, die ein Sternchen (*) haben, ausgefüllt werden. Ist eine Eingabe nicht valide, wird neben der Eingabe ein rotes X angezeigt (siehe Bild).
+Folgende Felder haben spezielle Formatierungsanforderungen:
+
+- Prof. Name: Der Name des Professors muss in der Form "Nachname, Vorname" eingegeben werden.
+- Mail: Die Mailadresse muss in der Form "irgend@etwas.xy" eingegeben werden.
+- Tel: Die Telefonnummer muss mindestens 3 Ziffern enthalten.
+- Semester: Das Semester wird wie folgt angegeben:
+  -  Wintersemester: Checkbox Winter + aktives Jahr wenn Monat zwischen Oktober und Dezember; ansosnsten aktives Jahr - 1
+  -  Sommersemester: Checkbox Sommer + aktives Jahr wenn Monat zwischen März und August
+
+
+Beim Versuch, den Apparat zu speichern, bevor alle Felder korrekt ausgefüllt sind, wird eine Fehlermeldung angezeigt, die auf die fehlerhaften Felder hinweist. Nachdem alle Felder korrekt ausgefüllt sind, kann der Apparat gespeichert werden.
+
+![Fehler](images/main_apparatdetails_error.png)
+
+Über einen Klick auf Ok oder Cancel wird die Meldung geschlossen und der Apparat kann weiter bearbeitet werden.
+
+### Dokumente hinzufügen
+
+Dem Apparat können Dokumente hinzugefügt werden. Besonders hilfreich ist das hinzufügen der Antragsformulare, da der SemesterapparatsManager diese Datei lesen und die Bücher automatisch dem Apparat hinzufügen kann.
+
+Dokumente werden über den Knopf "Dokumente hinzufügen" hinzugefügt werden. Es öffnet sich ein Auswahldialog, bei dem Sie dei Datei(en) auswählen können, die Sie hinzufügen möchten.
+
+Handelt es sich bei der Datei um den Antrag, so kann dieser mit dem Knopf "Medien aus Dokument hinzufügen" ausgelesen werden. 
+
+!!! Warning "ZU BEACHTEN"
+
+    Wird dieser Knopf gedrückt, wird der Apparat, wenn möglich, gespeichert und angelegt. Dies ist notwendig, da die Medien nur dann dem Apparat hinzugefügt werden können, wenn dieser bereits in der Datenbank existiert.
+
+Die erkannten Medien werden nun hinzugefügt. Über den Bereich "Medienliste" kann der Fortschritt eingesehen werden. Solange noch Medien hinzugefügt werden, ist es nicht möglich, den Apparat zu bearbeiten, die Auswahl zu beenden oder einen anderen Apparat auszuwählen.
+
+### Apparat speichern
+
+Nachdem alle Felder korrekt ausgefüllt sind, kann der Apparat gespeichert werden. Dazu muss der Knopf "Speichern" gedrückt werden. Der Apparat wird nun in der Datenbank gespeichert und wird in der Tabelle angezeigt. Wurde vor dem Speichern der Haken "Mail senden" gesetzt, öffnet sich ein Fenster, in dem einen Mail, basierend auf einem Template, an den Professor gesendet werden kann. (Erfordert Mail Zugangsdaten [siehe Konfiguration](config.md#email))
+
+## Medienliste
+
+In der Medienliste werden alle Medien angezeigt, die dem Apparat hinzugefügt wurden. Hier können die Medien bearbeitet, gelöscht oder hinzugefügt werden.
+
+Wurde ein Apparat ausgewählt, werden einige Felder unterhalb der Medienliste angezeigt:
+![Optionen der Medienliste](images/medialist_options.png)
+
+
+Standardmäßig werden nur Medien angezeigt, die nicht aus dem Apparat entfernt wurden. Über den Checkbox "gel. Medien anzeigen" werden auch gelöschte Medien angezeigt. 
+Der Knopf "im Apparat?" kann für ein einzelnes, oder mehrere Medien verwendet werden, um zu prüfen, ob die ausgewählten Medien inzwischen dem Apparat hinzugefügt wurden.
+
+Unter der Liste befindet sich ein Knopf "Medien hinzufügen", der es ermöglicht, Medien manuell hinzuzufügen. Hierbei wird ein Dialog geöffnet, in dem die Signaturen der Medien eingetragen werden können. Die Medien werden dann dem Apparat hinzugefügt.
+
+### Kontextmenü 
+
+Mit einem Rechtsklick auf ein Medium wird ein Kontextmenü geöffnet, das folgende Optionen enthält (Mehrfachauswahl der Medien mit Strg + Linksklick möglich):
+
+![Kontextmenü](images/media_context_menu_root.png)
+
+#### Subbereich Allgemeines
+
+![Kontextmenü](images/media_context_menu_general.png)
+- Bearbeiten: Öffnet ein Fenster, in dem die Metadaten des Mediums eingesehen bzw, bearbeitet werden können. (s. [Metadaten bearbeiten](edit_media.md))
+- Löschen: Löscht das Medium aus dem Apparat. Das Medium wird nicht gelöscht, sondern nur aus dem Apparat entfernt. (s. [Bild](images.md#Exemplar löschen))
+
+#### Subbereich Apparate
+
+![Kontextmenü](images/media_context_menu_apparats.png)
+
+
+- Zum Apparat hinzufügen: *Noch nicht implementiert* (derzeit deaktiviert)
+- In Apparat verschieben: Öffnet ein Fenster, in dem ein anderer Apparat ausgewählt werden kann, in den die ausgewählten Medien verschoben werden sollen.
+- In Apparat kopieren: Öffnet ein Fenster, in dem ein anderer Apparat ausgewählt werden kann, in den die ausgewählten Medien kopiert werden sollen.
+
+
+## Medien hinzufügen
+
+![Medien hinzufügen](images/add_media.png)
+
+Um Medien hinzuzufügen, müssen die Signaturen der Medien in das Textfeld eingetragen werden. Jede Signatur muss in die Zeile eingegeben werden und mit Enter bestätigt werden.
+Nachdem alle Signaturen hinzugefügt werden, können folgende Optionen gesetzt werden:
+
+- Modus: Gibt an, welche Metadaten verwendet werden. Die beiliegende Tabelle gibt an, welche Metadaten welche Angaben enthalten.
+- Jedes Buch verwenden: Diese Option ermöglicht es, Medien hinzuzufügen, die noch nicht im Apparat sind
+- Exakte Signatur: Diese Option teilt dem System mit, dass genau diese Signatur verwendet werden muss. Ist diese Option nicht gesetzt, wird nach der Signatur gesucht, die am ehesten der eingegebenen Signatur entspricht. (Das gefundene Buch ist das gleiche, nur evtl ein anderes Exemplar)
+
+Mit dem Knopf "Ok" werden die Medien gesucht und hinzugefügt. 

docs/edit_media.md

@@ -0,0 +1,7 @@
+# Metadaten bearbeiten
+
+![Metadaten bearbeiten](images/edit_book_metadata.png)
+
+In diesem Fenster können die Metadaten eines Mediums bearbeitet werden. Diese bearbeitung macht Sinn, wenn Angaben nicht direkt aus dem Katalog übernommen werden konnten, oder wenn die Angaben nicht korrekt sind.
+
+Über den Knopf "Ok" werden die geänderten Metadaten gespeichert und das Fenster geschlossen. Über den Knopf "Abbrechen" werden die Änderungen verworfen und das Fenster geschlossen.

docs/images.md

@@ -0,0 +1,14 @@
+# Bilder
+
+## Admin Aktionen
+![Bild](images/actions.png)
+
+## Apparatscheckliste
+![Bild](images/checklist.png)
+
+## Medien hinzufügen
+![Bild](images/add_media.png)
+
+## Kalendar
+![Bild](images/calendar.png)
+

docs/index.md

@@ -0,0 +1,3 @@
+# ToC
+
+>TBD

docs/mail.md

@@ -0,0 +1,47 @@
+# Mails
+
+Der SemesterapparatsManager hat die Option, den Dozenten beim erstellen eines Apparates eine Mail zu schicken. Diese Mail enthält die Information, dass der Apparat erstellt wurde und wie er aufgerufen werden kann. 
+
+Zusätzlich kann beim Löschen eines Apparates eine Mail an den Dozenten geschickt werden. Diese Mail enthält die Information, dass der Apparat gelöscht wurde. 
+
+Über eine neue Oberfläche können neue Mail Templates erstellt werden.
+
+
+## Mail
+
+Abhängig davon, ob ein Apparat erstellt oder gelöscht wird/wurde, wird automatisch ein Template geladen. Somit muss nur noch die Anrede und der Text angepasst werden.
+
+Bsp:
+
+![Mail](images/mail_delete.png)
+
+!!! Info
+    Die Felder **eMail** und **Prof** sind schreibgeschützt und können nicht verändert werden.
+
+Über das Dropdown Menü **Art** kann das entsprechende Template ausgewählt werden. Der Knopf recht danaben kann für das [erstellen](#neue-mail-templates) neuer Templates genutzt werden.
+
+Um die Mail abschicken zu können, muss die Anrede mithilfe der Knöpfe über dem Mailtext konfiguriert werden. Die Anrede passt sich automatisch an, basierend auf der angegebenen Anrede.
+
+Wird die Mail erfolgreich verschickt, schließt sich das Fenster automatisch, und es wird eine Kopie der Mail an die Mail semesterapparate@ph-freiburg.de geschickt.
+
+## Neue Mail Templates
+
+Über den Knopf rechts neben der Auswahl der Email Templates können neue Templates erstellt werden.
+
+![MailTemplate](images/mail_create_template.png)
+
+Diese Oberfläche bietet die Möglichkeit, ein neues Template zu erstellen. Mithilfe des Dropdowns **Platzhalter** können Platzhalter ausgewählt und eingefügt werden. Bevor das Template gespeichert werden kann, muss dieses getestet werden. Sollte der Test erfolgreich sein, kann ein Name vergeben werden, das Template wird nun in dem Dropdown angezeigt.
+
+### Template testen
+Sollten Angaben fehlen, wird eine Fehlermeldung angezeigt:
+
+![TemplateTest](images/mail_create_missing.png)
+
+!!! info
+    Die Fehlermeldung ist dynamisch und gibt immer die fehlenden Angaben an.
+
+
+### Template speichern
+Ist das Template fehlerfrei, wird folgender Dialog angezeigt:
+
+![TemplateSave](images/mail_set_template_name.png)

docs/mainUI.md

@@ -0,0 +1,14 @@
+# Hauptoberfläche
+
+![Hauptoberfläche](images/mainUI.png)
+
+Die Hauptoberfläche des SemesterapparatsManager besteht aus drei Hauptbereichen:
+
+- **Anlegen**: Auf dieser Seite können neue Semesterapparate angelegt werden, bestehende Apparate aktualisiert oder gelöscht werden.
+  
+- **Suchen/Statistik**: Hier können Semesterapparate gesucht, gefiltert, gelöscht und verlängert werden. Zudem werden Statistiken zum erstellen / löschen von Semesterapparaten angezeigt. Ein zweiter Tab ermöglicht die Suche der Medien in den Semesterapparaten.
+  
+- **ELSA**: Hier können ELSA Apparate angelegt werden, und entsprechende Dateinamen, Beschreibungen und Zitate erstellt werden.
+
+## Anlegen
+weitere Informationen siehe: [Anlegen](create.md)

docs/search.md

@@ -0,0 +1,93 @@
+# Suche und Statistik
+
+![Suche und Statistik](images/main_search_stat.png)
+
+Auf dieser Seite gibt es zwei Hauptfunktionen: die Suche und die Statistik. Standardmäßig wird die Statistik geöffnet.
+
+## Statistikbereich
+
+### Suche
+![Statistiksuche](images/ss_stat_search.png)
+
+In diesem Bereich kann die Suche nach Semesterapparaten durchgeführt werden. Suchoptionen sind:
+
+- **Appnr**: Die Nummer des Semesterapparates, die Auswahl zeigt alle belegten Semesterapparat an
+- **Person**: Der Name des Dozenten, der den Semesterapparat erstellt hat
+- **Fach**: Das Fach des Semesterapparates
+- **Erstell-** und **Endsemester**: Semester, in denen der Semesterapparat erstellt wurde, bzw enden soll
+- **Dauerapp**: Alle Apparate, die als Dauerapparat vermerkt sind
+- **Löschbar**: Überschreibt alle vorhergehenden Parameter und zeigt alle Semesterapparate an, die gelöscht werden können
+
+!!! Info 
+    Um alle Semesterapparate anzuzeigen, kann die Suche ohne Eingabe gestartet werden.
+
+Die Suche kann durch Klicken auf den Button **Suchen** gestartet werden. Die Ergebnisse werden in der Tabelle darunter angezeigt.
+
+### Suchergebnisse
+![Statistiksuchergebnisse](images/ss_stat_result.png)
+
+In diesem Bereich werden die Suchergebnisse angezeigt. Für jeden gefundenen Treffer wird eine Zeile angelegt:
+
+![Statistiksuchergebnisse](images/ss_search_entries.png)
+
+Angezeigt werden:
+
+- **Checkbox**
+- **Apparatsname**
+- **Apparatsnummer**
+- **Person**
+- **Fach**
+
+!!! failure "Info: Gelöschte Apparate"
+    Gelöschte Apparate werden in der Tabelle mit rotem Hintergrund angezeigt. (s. Ausgewählte Löschen)
+Über der Tabelle sind zwei Knöpfe: **Ausgewählte Löschen** und **Ausgewählte Benachrichtigen**
+
+Um diese Aktionen auszuführen, muss mindestens eine Checkbox bei einem Apparat angekreuzt sein.
+
+#### Ausgewählte Löschen
+![Statistiksuchergebnisse](images/ss_stat_delete.png)
+
+Nach dem Klicken auf den Button **Ausgewählte Löschen** wird jeder ausgewählte Apparat gelöscht. Die gelöschten Apparate werden in der Tabelle mit rotem Hintergrund angezeigt.
+
+#### Ausgewählte Benachrichtigen
+
+Mit dem Klick auf den Button wird ein neues Fenster geöffnet:
+
+![Statistiksuchergebnisse](images/mail_delete.png)
+
+Bevor die Mail abgeschickt werden kann, muss die Anrede konfiguriert werden. Weitere Infors finden Sie im Abschnitt [Mails](mail.md).
+
+### Apparatsstatistik
+Rechts neben der Tabelle wird die Statistik der gefundenen Apparate angezeigt:
+![Statistiksuchergebnisse](images/ss_stats_table.png)
+Hierbei werden die Angaben sowohl in einer Tabelle als auch in einem Diagramm dargestellt.
+#### Tabelle
+In der Tabelle werden alle Verwendeten Semester agegeben, in denen ein Apparat entweder erstellt oder gelöscht wurde.
+
+Über einen Doppelklick auf ein Semester werden die Apparate angezeigt, die in diesem Semester erstellt oder gelöscht wurden.
+
+![DetailedView](images/ss_stats_detailed.png)
+
+Ein Klick auf das `>` Symbol einer Person zeigt alle erstellten oder gelöschten Apparate der Person an. Ein Doppelklick auf den erstellten Apparat wechselt die Ansicht zur [Hauptoberfläche](mainUI.md) und zeigt alle Daten an.
+
+!!! Info "Info: Gelöschte Apparate"
+    Gelöschte Apparate können nicht angezeigt werden, die Doppelklick Funktion ist hier deaktiviert.
+
+#### Diagramm
+Das Diagramm zeigt die Anzahl der erstellten und gelöschten Apparate in einem Liniendiagramm an.
+
+![Diagramm](images/ss_stats_graph.png)
+
+## Suchbereich
+
+Der Suchbereich kann verwendet werden, um zu prüfen, ob ein Exemplar in einem Apparat vorhanden ist. Mögliche Suchkriterien sind:
+
+- **Titel**: Der Titel des Exemplars (Trunkierung wurd automaticsh durchgeführt)
+- **Signatur**: Die Signatur des Exemplars (Trunkierung wurd automaticsh durchgeführt)
+
+Über den Knopf **Suchen** wird die Suche gestartet. Die Ergebnisse werden in der Tabelle darunter angezeigt.
+
+!!! Info "Info: Exemplarsuche"
+    Im Vergleich zur Apparatssuche kann hier keine Leere Suche durchgeführt werden, da ggf. zu viele Ergebnisse angezeigt werden können.
+
+    

mkdocs.yml

@@ -1 +1,30 @@
 site_name: SemesterapparatsManager
+theme:
+  features:
+    - search.suggest
+    - search.highlight
+  name: material
+  icon:
+    admonition:
+      note: fontawesome/solid/note-sticky
+      abstract: fontawesome/solid/book
+      info: fontawesome/solid/circle-info
+      tip: fontawesome/solid/bullhorn
+      success: fontawesome/solid/check
+      question: fontawesome/solid/circle-question
+      warning: fontawesome/solid/triangle-exclamation
+      failure: fontawesome/solid/bomb
+      danger: fontawesome/solid/skull
+      bug: fontawesome/solid/robot
+      example: fontawesome/solid/flask
+      quote: fontawesome/solid/quote-left
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - tables
+extra_css:
+  - stylesheets/extra.css
+plugins:
+  - search