feat: add documentation for ELSA and extend functionality, include new icons and update semester logic

This commit is contained in:
2024-12-10 11:24:04 +01:00
parent 7d78c09480
commit f84c030eea
17 changed files with 149 additions and 39 deletions

2
docs/citing.md Normal file
View File

@@ -0,0 +1,2 @@
# Zitieren

25
docs/elsa.md Normal file
View File

@@ -0,0 +1,25 @@
# ELSA
![ELSA](images/elsa_main.png)
## 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.
### 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.
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.
### 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.
Genauere Beschreibung: [Zitieren](citing.md)

12
docs/extend.md Normal file
View File

@@ -0,0 +1,12 @@
# Verlängerung
Ein Dialog zum Verlängern eines Apparates.
![Verlängerung](images/extend.png)
Zum Verlängern muss ein Semester ausgewählt, und ein Jahr eingetragen sein. Die Checkbox für den Dauerapparat kann angekreuzt werden, um den Apparat als Dauerapparat zu markieren.
!!! Info "Info Dauerapparat"
Damit der Apparat als Dauerapparat verlängert werden kann, muss ein Semester angegeben werden.
Nach dem Speichern wird das Semester automatisch angepasst und in den entsprechenden Tabellen angezeigt.

BIN
docs/images/elsa_data.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/images/elsa_docs.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

BIN
docs/images/elsa_main.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

BIN
docs/images/extend.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 KiB

BIN
docs/images/icon_cal.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 382 B

View File

@@ -57,6 +57,17 @@ Mit dem Klick auf den Button wird ein neues Fenster geöffnet:
Bevor die Mail abgeschickt werden kann, muss die Anrede konfiguriert werden. Weitere Infors finden Sie im Abschnitt [Mails](mail.md).
#### Kontextmenü
Diese Tabelle bietet auch ein Rechtsklickmenu mit folgenden Optionen:
- **Verlängern**: Öffnet den [Verlängerungsdialog](extend.md)
- **Wiederherstellen**: Stellt einen gelöschten Apparat wieder her
!!! Info "Info: Wiederherstellen"
Diese Option kann für einen oder mehrere gelöschte Apparate verwendet werden. Für mehrere Apprate müssen die entsprechenden Zeilen mit Strg+Klick auf die Zeilennummer markiert werden.
### Apparatsstatistik
Rechts neben der Tabelle wird die Statistik der gefundenen Apparate angezeigt:
![Statistiksuchergebnisse](images/ss_stats_table.png)
@@ -90,4 +101,3 @@ Der Suchbereich kann verwendet werden, um zu prüfen, ob ein Exemplar in einem A
!!! Info "Info: Exemplarsuche"
Im Vergleich zur Apparatssuche kann hier keine Leere Suche durchgeführt werden, da ggf. zu viele Ergebnisse angezeigt werden können.