feat(docs): migrate to zensical, re-structure docs
This commit is contained in:
143
docs/semesterapparat/anlegen.md
Normal file
143
docs/semesterapparat/anlegen.md
Normal file
@@ -0,0 +1,143 @@
|
||||
# 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.
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
---
|
||||
|
||||
## Apparatdetails
|
||||
|
||||
### Pflichtfelder
|
||||
|
||||
Um einen Apparat erfolgreich anzulegen, müssen alle Felder mit einem **Sternchen (*)** ausgefüllt werden. Ist eine Eingabe nicht valide, wird neben der Eingabe ein :material-close-circle:{ style="color: red" } angezeigt.
|
||||
|
||||
!!! warning "Formatierungsanforderungen"
|
||||
Folgende Felder haben spezielle Formatierungsanforderungen:
|
||||
|
||||
| Feld | Format | Beispiel |
|
||||
|------|--------|----------|
|
||||
| **Prof. Name** | Nachname, Vorname | `Müller, Hans` |
|
||||
| **Mail** | Gültige E-Mail-Adresse | `mueller@ph-freiburg.de` |
|
||||
| **Tel** | Mindestens 3 Ziffern | `0761-12345` |
|
||||
| **Semester** | Automatisch berechnet | siehe unten |
|
||||
|
||||
### Semester-Logik
|
||||
|
||||
Das Semester wird automatisch wie folgt berechnet:
|
||||
|
||||
=== "Wintersemester"
|
||||
|
||||
- Checkbox **Winter** aktivieren
|
||||
- **Jahr**:
|
||||
- Oktober–Dezember → aktuelles Jahr
|
||||
- Januar–September → aktuelles Jahr - 1
|
||||
|
||||
=== "Sommersemester"
|
||||
|
||||
- Checkbox **Sommer** aktivieren
|
||||
- **Jahr**: aktuelles Jahr (März–August)
|
||||
|
||||
### Fehlermeldungen
|
||||
|
||||
Beim Versuch, den Apparat zu speichern, bevor alle Felder korrekt ausgefüllt sind, erscheint eine Fehlermeldung:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
!!! tip "Tipp"
|
||||
Über **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 automatisch auslesen kann.
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Dokument hinzufügen] --> B{Antragsformular?}
|
||||
B -->|Ja| C[Medien aus Dokument hinzufügen]
|
||||
B -->|Nein| D[Als Referenz speichern]
|
||||
C --> E[Medien werden automatisch erkannt]
|
||||
```
|
||||
|
||||
1. Klicken Sie auf **Dokumente hinzufügen**
|
||||
2. Wählen Sie die gewünschte(n) Datei(en) aus
|
||||
3. Bei Antragsformularen: Klicken Sie auf **Medien aus Dokument hinzufügen**
|
||||
|
||||
!!! warning "Wichtig: Automatisches Speichern"
|
||||
Beim Klicken auf **Medien aus Dokument hinzufügen** wird der Apparat automatisch gespeichert. Dies ist erforderlich, da Medien nur einem existierenden Apparat hinzugefügt werden können.
|
||||
|
||||
---
|
||||
|
||||
## Medienliste
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
In der Medienliste werden alle dem Apparat zugeordneten Medien angezeigt.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Beschreibung |
|
||||
|--------|--------------|
|
||||
| :lucide-eye: **gel. Medien anzeigen** | Zeigt auch gelöschte Medien an |
|
||||
| :lucide-check-circle: **im Apparat?** | Prüft, ob ausgewählte Medien dem Apparat hinzugefügt wurden |
|
||||
| :lucide-plus: **Medien hinzufügen** | Manuelle Eingabe von Signaturen |
|
||||
|
||||
### Kontextmenü
|
||||
|
||||
Mit einem **Rechtsklick** auf ein Medium öffnet sich das Kontextmenü:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
=== "Allgemeines"
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
- **Bearbeiten**: Metadaten einsehen/bearbeiten
|
||||
- **Löschen**: Medium aus dem Apparat entfernen (nicht physisch löschen)
|
||||
|
||||
=== "Apparate"
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
- **Zum Apparat hinzufügen**: *(derzeit deaktiviert)*
|
||||
- **In Apparat verschieben**: Medium in anderen Apparat verschieben
|
||||
- **In Apparat kopieren**: Medium in anderen Apparat kopieren
|
||||
|
||||
!!! tip "Mehrfachauswahl"
|
||||
Mit ++ctrl+left-button++ können mehrere Medien ausgewählt werden.
|
||||
|
||||
---
|
||||
|
||||
## Medien manuell hinzufügen
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
### Eingabe
|
||||
|
||||
Geben Sie jede Signatur in eine neue Zeile ein und bestätigen Sie mit ++enter++.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Beschreibung |
|
||||
|--------|--------------|
|
||||
| **Modus** | Wählt die Metadatenquelle |
|
||||
| **Jedes Buch verwenden** | Erlaubt das Hinzufügen von Medien, die noch nicht im Apparat sind |
|
||||
| **Exakte Signatur** | Nur diese spezifische Signatur verwenden (kein alternatives Exemplar) |
|
||||
|
||||
!!! info "Signatursuche"
|
||||
Ohne **Exakte Signatur** wird nach der ähnlichsten Signatur gesucht – das gefundene Buch ist dasselbe, aber möglicherweise ein anderes Exemplar.
|
||||
|
||||
---
|
||||
|
||||
## Apparat speichern
|
||||
|
||||
Nach dem Ausfüllen aller Pflichtfelder:
|
||||
|
||||
1. Klicken Sie auf **Speichern**
|
||||
2. Der Apparat wird in der Datenbank gespeichert
|
||||
3. Optional: Bei aktiviertem **Mail senden** öffnet sich der Mail-Dialog
|
||||
|
||||
!!! note "E-Mail-Versand"
|
||||
Der E-Mail-Versand erfordert konfigurierte [Mail-Zugangsdaten](../allgemein/hauptoberflaeche.md#e-mail).
|
||||
47
docs/semesterapparat/index.md
Normal file
47
docs/semesterapparat/index.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Semesterapparat
|
||||
|
||||
In diesem Abschnitt finden Sie alle Informationen zur Verwaltung von Semesterapparaten.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :lucide-book-plus:{ .lg .middle } **Anlegen**
|
||||
|
||||
---
|
||||
|
||||
Erstellen Sie neue Semesterapparate mit allen erforderlichen Informationen.
|
||||
|
||||
[:octicons-arrow-right-24: Apparat anlegen](anlegen.md)
|
||||
|
||||
- :lucide-calendar-plus:{ .lg .middle } **Verlängern**
|
||||
|
||||
---
|
||||
|
||||
Verlängern Sie bestehende Apparate für ein weiteres Semester.
|
||||
|
||||
[:octicons-arrow-right-24: Apparat verlängern](verlaengern.md)
|
||||
|
||||
- :lucide-trash-2:{ .lg .middle } **Löschen**
|
||||
|
||||
---
|
||||
|
||||
Entfernen Sie nicht mehr benötigte Semesterapparate.
|
||||
|
||||
[:octicons-arrow-right-24: Apparat löschen](loeschen.md)
|
||||
|
||||
- :lucide-bar-chart-2:{ .lg .middle } **Statistik**
|
||||
|
||||
---
|
||||
|
||||
Erhalten Sie Einblicke in die Nutzung der Semesterapparate.
|
||||
|
||||
[:octicons-arrow-right-24: Zur Statistik](statistik.md)
|
||||
|
||||
- :lucide-search:{ .lg .middle } **Suche**
|
||||
|
||||
---
|
||||
|
||||
Durchsuchen Sie bestehende Apparate und Medien.
|
||||
|
||||
[:octicons-arrow-right-24: Zur Suche](suche.md)
|
||||
|
||||
</div>
|
||||
63
docs/semesterapparat/loeschen.md
Normal file
63
docs/semesterapparat/loeschen.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# Semesterapparat löschen
|
||||
|
||||
Das Löschen von Semesterapparaten erfolgt über die [Suche & Statistik](suche.md) Seite.
|
||||
|
||||
---
|
||||
|
||||
## Löschvorgang
|
||||
|
||||
### Einzelnen Apparat löschen
|
||||
|
||||
1. Navigieren Sie zu **Suchen/Statistik**
|
||||
2. Suchen Sie den gewünschten Apparat
|
||||
3. Aktivieren Sie die Checkbox des Apparats
|
||||
4. Klicken Sie auf **Ausgewählte Löschen**
|
||||
|
||||
### Mehrere Apparate löschen
|
||||
|
||||
1. Verwenden Sie die Suche mit dem Filter **Löschbar**
|
||||
2. Wählen Sie alle zu löschenden Apparate aus
|
||||
3. Klicken Sie auf **Ausgewählte Löschen**
|
||||
|
||||
!!! tip "Filter: Löschbar"
|
||||
Der Filter **Löschbar** zeigt alle Apparate an, deren Endsemester abgelaufen ist und die zur Löschung vorgemerkt werden können.
|
||||
|
||||
---
|
||||
|
||||
## Bestätigung
|
||||
|
||||
Nach dem Klicken auf **Ausgewählte Löschen**:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Die gelöschten Apparate werden in der Tabelle mit **rotem Hintergrund** angezeigt.
|
||||
|
||||
!!! failure "Gelöschte Apparate"
|
||||
Gelöschte Apparate verbleiben in der Datenbank, werden aber als inaktiv markiert. Sie können bei Bedarf wiederhergestellt werden.
|
||||
|
||||
---
|
||||
|
||||
## Dozenten benachrichtigen
|
||||
|
||||
Bei der Löschung kann eine Benachrichtigung an den Dozenten versendet werden:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
1. Wählen Sie die zu löschenden Apparate aus
|
||||
2. Klicken Sie auf **Ausgewählte Benachrichtigen**
|
||||
3. Konfigurieren Sie die Anrede
|
||||
4. Versenden Sie die Mail
|
||||
|
||||
Weitere Informationen: [Mails](../allgemein/hauptoberflaeche.md#e-mail)
|
||||
|
||||
---
|
||||
|
||||
## Wiederherstellen
|
||||
|
||||
Gelöschte Apparate können wiederhergestellt werden:
|
||||
|
||||
1. Suchen Sie den gelöschten Apparat (rot markiert)
|
||||
2. Rechtsklick → **Wiederherstellen**
|
||||
|
||||
!!! success "Mehrfachwiederherstellung"
|
||||
Mit ++ctrl+left-button++ können mehrere Apparate gleichzeitig ausgewählt und wiederhergestellt werden.
|
||||
86
docs/semesterapparat/statistik.md
Normal file
86
docs/semesterapparat/statistik.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Statistik
|
||||
|
||||
Die Statistikfunktion bietet einen Überblick über alle Semesterapparate und deren Entwicklung über die Zeit.
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
---
|
||||
|
||||
## Apparatsstatistik
|
||||
|
||||
Die Statistik zeigt alle Semester an, in denen Apparate erstellt oder gelöscht wurden.
|
||||
|
||||
### Tabellenansicht
|
||||
|
||||
| Spalte | Beschreibung |
|
||||
|--------|--------------|
|
||||
| **Semester** | Das betroffene Semester |
|
||||
| **Erstellt** | Anzahl erstellter Apparate |
|
||||
| **Gelöscht** | Anzahl gelöschter Apparate |
|
||||
|
||||
!!! tip "Detailansicht"
|
||||
Mit einem **Doppelklick** auf ein Semester werden die einzelnen Apparate angezeigt.
|
||||
|
||||
### Detaillierte Ansicht
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Die Detailansicht zeigt:
|
||||
|
||||
- Alle Personen, die in diesem Semester Apparate erstellt/gelöscht haben
|
||||
- Pro Person: Liste aller erstellten oder gelöschten Apparate
|
||||
|
||||
??? info "Navigation"
|
||||
- Klick auf :material-chevron-right: zeigt die Apparate einer Person
|
||||
- Doppelklick auf einen Apparat wechselt zur [Hauptoberfläche](../allgemein/hauptoberflaeche.md)
|
||||
|
||||
!!! warning "Gelöschte Apparate"
|
||||
Gelöschte Apparate können nicht angezeigt werden – die Doppelklick-Funktion ist dort deaktiviert.
|
||||
|
||||
---
|
||||
|
||||
## Diagramm
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Das Liniendiagramm visualisiert:
|
||||
|
||||
- :material-chart-line:{ style="color: green" } **Grün**: Erstellte Apparate
|
||||
- :material-chart-line:{ style="color: red" } **Rot**: Gelöschte Apparate
|
||||
|
||||
!!! tip "Interaktivität"
|
||||
Hovern Sie über Datenpunkte für genaue Werte.
|
||||
|
||||
---
|
||||
|
||||
## Auswertungen
|
||||
|
||||
### Typische Fragestellungen
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :lucide-trending-up: **Wachstum**
|
||||
|
||||
---
|
||||
|
||||
Wie viele Apparate wurden pro Semester erstellt?
|
||||
|
||||
- :lucide-users: **Nutzung**
|
||||
|
||||
---
|
||||
|
||||
Welche Dozenten nutzen den Service am meisten?
|
||||
|
||||
- :lucide-calendar: **Saisonalität**
|
||||
|
||||
---
|
||||
|
||||
Gibt es Unterschiede zwischen Sommer- und Wintersemester?
|
||||
|
||||
- :lucide-archive: **Bereinigung**
|
||||
|
||||
---
|
||||
|
||||
Wie viele Apparate werden regelmäßig gelöscht?
|
||||
|
||||
</div>
|
||||
109
docs/semesterapparat/suche.md
Normal file
109
docs/semesterapparat/suche.md
Normal file
@@ -0,0 +1,109 @@
|
||||
# Suche
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Die Suchseite bietet zwei Hauptfunktionen: die **Apparatsuche** und die **Mediensuche**.
|
||||
|
||||
---
|
||||
|
||||
## Apparatsuche
|
||||
|
||||
### Suchfilter
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
| Filter | Beschreibung |
|
||||
|--------|--------------|
|
||||
| **AppNr** | Nummer des Semesterapparates (Dropdown mit allen belegten Nummern) |
|
||||
| **Person** | Name des Dozenten |
|
||||
| **Fach** | Fachrichtung des Apparates |
|
||||
| **Erstell-Semester** | Semester der Erstellung |
|
||||
| **End-Semester** | Geplantes Ende des Apparates |
|
||||
| **Dauerapp** | Nur Dauerapparate anzeigen |
|
||||
| **Löschbar** | Alle löschbaren Apparate (überschreibt andere Filter) |
|
||||
|
||||
!!! tip "Alle anzeigen"
|
||||
Starten Sie die Suche ohne Eingabe, um **alle** Semesterapparate anzuzeigen.
|
||||
|
||||
---
|
||||
|
||||
## Suchergebnisse
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
### Ergebnistabelle
|
||||
|
||||
Für jeden Treffer wird angezeigt:
|
||||
|
||||
- :material-checkbox-marked-outline: Checkbox zur Auswahl
|
||||
- **Apparatsname**
|
||||
- **Apparatsnummer**
|
||||
- **Person**
|
||||
- **Fach**
|
||||
|
||||
!!! failure "Gelöschte Apparate"
|
||||
Gelöschte Apparate werden mit **rotem Hintergrund** angezeigt.
|
||||
|
||||
### Slider
|
||||
|
||||
!!! info "Layout anpassen"
|
||||
Der vertikale Slider zwischen Tabelle und Graph kann verschoben werden, um mehr Platz für einen der Bereiche zu schaffen.
|
||||
|
||||
---
|
||||
|
||||
## Aktionen
|
||||
|
||||
### Ausgewählte Löschen
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
1. Aktivieren Sie die Checkboxen der zu löschenden Apparate
|
||||
2. Klicken Sie auf **Ausgewählte Löschen**
|
||||
3. Gelöschte Apparate werden rot markiert
|
||||
|
||||
Weitere Informationen: [Apparat löschen](loeschen.md)
|
||||
|
||||
### Ausgewählte Benachrichtigen
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Versendet eine E-Mail an die Dozenten der ausgewählten Apparate.
|
||||
|
||||
1. Wählen Sie die Apparate aus
|
||||
2. Klicken Sie auf **Ausgewählte Benachrichtigen**
|
||||
3. Konfigurieren Sie die Anrede
|
||||
4. Versenden Sie die Mail
|
||||
|
||||
---
|
||||
|
||||
## Kontextmenü
|
||||
|
||||
Rechtsklick auf einen Apparat öffnet das Kontextmenü:
|
||||
|
||||
| Option | Beschreibung |
|
||||
|--------|--------------|
|
||||
| :lucide-calendar-plus: **Verlängern** | Öffnet den [Verlängerungsdialog](verlaengern.md) |
|
||||
| :lucide-undo: **Wiederherstellen** | Stellt gelöschte Apparate wieder her |
|
||||
|
||||
!!! tip "Mehrfachauswahl"
|
||||
Mit ++ctrl+left-button++ auf die Zeilennummer können mehrere Apparate für die Wiederherstellung ausgewählt werden.
|
||||
|
||||
---
|
||||
|
||||
## Mediensuche
|
||||
|
||||
Der **Suchbereich** prüft, ob ein Exemplar in einem Apparat vorhanden ist.
|
||||
|
||||
### Suchkriterien
|
||||
|
||||
| Kriterium | Beschreibung |
|
||||
|-----------|--------------|
|
||||
| **Titel** | Titel des Exemplars (automatische Trunkierung) |
|
||||
| **Signatur** | Signatur des Exemplars (automatische Trunkierung) |
|
||||
|
||||
!!! warning "Pflichtfelder"
|
||||
Im Gegensatz zur Apparatsuche kann hier **keine** leere Suche durchgeführt werden, da zu viele Ergebnisse möglich wären.
|
||||
|
||||
### Ergebnisse
|
||||
|
||||
Die gefundenen Exemplare werden mit den zugehörigen Apparaten angezeigt.
|
||||
44
docs/semesterapparat/verlaengern.md
Normal file
44
docs/semesterapparat/verlaengern.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Semesterapparat verlängern
|
||||
|
||||
Ein Dialog zum Verlängern eines Semesterapparates für ein weiteres Semester.
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
---
|
||||
|
||||
## Verlängerung durchführen
|
||||
|
||||
### Schritte
|
||||
|
||||
1. Wählen Sie den zu verlängernden Apparat in der [Suche](suche.md) oder [Statistik](statistik.md) aus
|
||||
2. Öffnen Sie den Verlängerungsdialog via Rechtsklick → **Verlängern**
|
||||
3. Wählen Sie das Zielsemester aus
|
||||
4. Klicken Sie auf **Speichern**
|
||||
|
||||
### Eingabefelder
|
||||
|
||||
| Feld | Beschreibung |
|
||||
|------|--------------|
|
||||
| **Semester** | Sommer- oder Wintersemester auswählen |
|
||||
| **Jahr** | Das Jahr des neuen Semesters |
|
||||
| **Dauerapparat** | :lucide-check: Markiert den Apparat als Dauerapparat |
|
||||
|
||||
---
|
||||
|
||||
## Dauerapparat
|
||||
|
||||
!!! info "Was ist ein Dauerapparat?"
|
||||
Ein Dauerapparat wird nicht automatisch zur Löschung vorgemerkt und bleibt aktiv, bis er manuell gelöscht wird.
|
||||
|
||||
!!! warning "Hinweis"
|
||||
Damit der Apparat als Dauerapparat verlängert werden kann, **muss** trotzdem ein Semester angegeben werden.
|
||||
|
||||
---
|
||||
|
||||
## Nach der Verlängerung
|
||||
|
||||
Nach dem Speichern:
|
||||
|
||||
- [x] Das Endsemester wird automatisch aktualisiert
|
||||
- [x] Die Änderung erscheint in allen relevanten Tabellen
|
||||
- [x] Optional: Benachrichtigung an den Dozenten versenden
|
||||
Reference in New Issue
Block a user