feat(docs): migrate to zensical, re-structure docs
This commit is contained in:
108
docs/allgemein/hauptoberflaeche.md
Normal file
108
docs/allgemein/hauptoberflaeche.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# Hauptoberfläche
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Die Hauptoberfläche des SemesterapparatsManager besteht aus drei Hauptbereichen, die über Tabs erreichbar sind:
|
||||
|
||||
## Navigation
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :lucide-book-plus:{ .lg .middle } **Anlegen**
|
||||
|
||||
---
|
||||
|
||||
Neue Semesterapparate erstellen, bestehende aktualisieren oder löschen.
|
||||
|
||||
[:octicons-arrow-right-24: Zum Anlegen](../semesterapparat/anlegen.md)
|
||||
|
||||
- :lucide-search:{ .lg .middle } **Suchen/Statistik**
|
||||
|
||||
---
|
||||
|
||||
Semesterapparate suchen, filtern und Statistiken einsehen.
|
||||
|
||||
[:octicons-arrow-right-24: Zur Suche](../semesterapparat/suche.md)
|
||||
|
||||
- :lucide-file-text:{ .lg .middle } **ELSA**
|
||||
|
||||
---
|
||||
|
||||
Elektronische Semesterapparate anlegen und Zitate erstellen.
|
||||
|
||||
[:octicons-arrow-right-24: Zu ELSA](../elsa/anlegen.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Übersichtstabelle
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
In diesem Bereich werden alle erstellten Semesterapparate angezeigt.
|
||||
|
||||
!!! tip "Tipp: Doppelklick"
|
||||
Über einen **Doppelklick** auf einen Apparat werden alle Details geladen und in den Apparatdetails angezeigt.
|
||||
|
||||
### Verfügbare Aktionen
|
||||
|
||||
| Knopf | Funktion |
|
||||
|-------|----------|
|
||||
| :lucide-printer: **Übersicht erstellen** | Erstellt eine druckbare Übersicht der angezeigten Apparate für das Regal |
|
||||
| :lucide-plus: **neu. App anlegen** | Schaltet die Apparatdetails frei für einen neuen Apparat |
|
||||
| :lucide-x: **Auswahl abbrechen** | Entfernt alle Daten und deaktiviert die Apparatdetails |
|
||||
|
||||
!!! note "Hinweis: Übersicht drucken"
|
||||
Die Übersicht wird per Mail an den konfigurierten Drucker geschickt. Vor dem Drucken erfolgt eine Bestätigungsabfrage.
|
||||
|
||||
---
|
||||
|
||||
## Einstellungen
|
||||
|
||||
Die Einstellungen erreichen Sie über das Menü oder das :lucide-settings: Icon.
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
!!! info "Automatisches Wiederherstellen"
|
||||
Die zuletzt geöffnete Seite wird automatisch beim nächsten Start geöffnet.
|
||||
|
||||
### Datenbank
|
||||
|
||||
Hier sind alle Informationen zur Datenbank sowie den temporären Daten hinterlegt.
|
||||
|
||||
!!! warning "Mehrere Nutzer"
|
||||
Sollte die Anwendung von mehreren Nutzern benutzt werden, sollte der Datenbankpfad nur in Absprache geändert werden. Ansonsten kann es zu Synchronisationsproblemen kommen.
|
||||
|
||||
### Zotero
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Konfigurieren Sie hier die Zugangsdaten für Zotero, die für die [ELSA-Zitate](../elsa/zitieren.md) benötigt werden.
|
||||
|
||||
### E-Mail
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
=== "Allgemein"
|
||||
|
||||
Zugangsdaten für den SMTP-Mailversand. Diese werden für Benachrichtigungen an Dozenten benötigt.
|
||||
|
||||
=== "Signatur"
|
||||
|
||||
Die Signatur wird automatisch an jede ausgehende Mail angehängt.
|
||||
|
||||
### Icons
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Übersicht der aktuellen Icons und verfügbaren Farbschemata.
|
||||
|
||||
---
|
||||
|
||||
## Speichern der Einstellungen
|
||||
|
||||
Über den Knopf **Ok** werden die Einstellungen gespeichert.
|
||||
|
||||
!!! success "Sofortige Übernahme"
|
||||
Die meisten Einstellungen werden sofort übernommen. Sollte ein Neustart erforderlich sein, werden Sie darüber informiert.
|
||||
31
docs/allgemein/index.md
Normal file
31
docs/allgemein/index.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Allgemein
|
||||
|
||||
Willkommen in der Dokumentation des **SemesterapparatsManager**! In diesem Abschnitt finden Sie alle grundlegenden Informationen zum Programm.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :lucide-info:{ .lg .middle } **Info**
|
||||
|
||||
---
|
||||
|
||||
Erfahren Sie mehr über den SemesterapparatsManager und seine Funktionen.
|
||||
|
||||
[:octicons-arrow-right-24: Mehr erfahren](info.md)
|
||||
|
||||
- :lucide-download:{ .lg .middle } **Installation**
|
||||
|
||||
---
|
||||
|
||||
Installieren Sie den SemesterapparatsManager in wenigen Schritten.
|
||||
|
||||
[:octicons-arrow-right-24: Zur Installation](installation.md)
|
||||
|
||||
- :lucide-layout-dashboard:{ .lg .middle } **Hauptoberfläche**
|
||||
|
||||
---
|
||||
|
||||
Lernen Sie die Benutzeroberfläche des Programms kennen.
|
||||
|
||||
[:octicons-arrow-right-24: Zur Übersicht](hauptoberflaeche.md)
|
||||
|
||||
</div>
|
||||
57
docs/allgemein/info.md
Normal file
57
docs/allgemein/info.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Info
|
||||
|
||||
## Über den SemesterapparatsManager
|
||||
|
||||
Der **SemesterapparatsManager** ist ein grafisches Werkzeug zur Verwaltung von Semesterapparaten an der Pädagogischen Hochschule Freiburg.
|
||||
|
||||
!!! abstract "Was ist ein Semesterapparat?"
|
||||
Ein Semesterapparat ist eine Sammlung von Literatur, die von Dozenten für ihre Lehrveranstaltungen zusammengestellt wird. Die Bücher werden in der Bibliothek bereitgestellt und können von Studierenden eingesehen werden.
|
||||
|
||||
## Funktionen
|
||||
|
||||
Die Anwendung ermöglicht eine benutzerfreundliche Verwaltung von physischen und digitalen Semesterapparaten:
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :lucide-book-plus:{ .lg .middle } **Anlegen**
|
||||
|
||||
---
|
||||
|
||||
Erstellen Sie neue Semesterapparate mit allen notwendigen Informationen zu Dozenten, Fächern und Literatur.
|
||||
|
||||
- :lucide-search:{ .lg .middle } **Suchen & Statistik**
|
||||
|
||||
---
|
||||
|
||||
Durchsuchen Sie bestehende Apparate und erhalten Sie statistische Auswertungen.
|
||||
|
||||
- :lucide-file-text:{ .lg .middle } **ELSA**
|
||||
|
||||
---
|
||||
|
||||
Verwalten Sie elektronische Semesterapparate (ELSA) mit automatischer Zitat-Erstellung via Zotero.
|
||||
|
||||
- :lucide-mail:{ .lg .middle } **Kommunikation**
|
||||
|
||||
---
|
||||
|
||||
Versenden Sie automatisierte E-Mails an Dozenten bei Erstellung oder Löschung von Apparaten.
|
||||
|
||||
</div>
|
||||
|
||||
## Technische Details
|
||||
|
||||
| Eigenschaft | Wert |
|
||||
|-------------|------|
|
||||
| **Programmiersprache** | Python 3.10+ |
|
||||
| **GUI-Framework** | PySide6 (Qt) |
|
||||
| **Datenbank** | SQLite |
|
||||
| **Zitat-System** | Zotero Integration |
|
||||
| **Stil** | DGPs (Deutsche Gesellschaft für Psychologie) |
|
||||
|
||||
## Entwicklung
|
||||
|
||||
Der SemesterapparatsManager wurde entwickelt von **Alexander Kirchner** für die Pädagogische Hochschule Freiburg.
|
||||
|
||||
!!! info "Open Source"
|
||||
Der Quellcode ist auf GitHub verfügbar und kann nach Absprache eingesehen werden.
|
||||
85
docs/allgemein/installation.md
Normal file
85
docs/allgemein/installation.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Installation
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
Bevor Sie den SemesterapparatsManager installieren können, stellen Sie sicher, dass folgende Voraussetzungen erfüllt sind:
|
||||
|
||||
- [x] Windows 10/11 oder höher
|
||||
- [x] Internetzugang für Katalog-Abfragen
|
||||
- [x] Optional: Zotero-Account für ELSA-Funktionen
|
||||
|
||||
## Installation
|
||||
|
||||
### Für Endanwender
|
||||
|
||||
=== "Portable Version"
|
||||
|
||||
1. Laden Sie die neueste Version von der Release-Seite herunter
|
||||
2. Entpacken Sie die ZIP-Datei in einen Ordner Ihrer Wahl
|
||||
3. Starten Sie `SemesterapparatsManager.exe`
|
||||
|
||||
=== "Installer"
|
||||
|
||||
1. Laden Sie den Installer herunter
|
||||
2. Führen Sie die Setup-Datei aus
|
||||
3. Folgen Sie den Anweisungen des Installationsassistenten
|
||||
4. Starten Sie das Programm über das Startmenü
|
||||
|
||||
### Für Entwickler
|
||||
|
||||
!!! note "Entwicklerinstallation"
|
||||
Diese Anleitung ist für Entwickler gedacht, die den Quellcode bearbeiten möchten.
|
||||
|
||||
#### Mit UV (empfohlen)
|
||||
|
||||
```bash
|
||||
# Repository klonen
|
||||
git clone https://github.com/IHR-REPO/SemesterapparatsManager.git
|
||||
cd SemesterapparatsManager
|
||||
|
||||
# Virtuelle Umgebung erstellen und Abhängigkeiten installieren
|
||||
uv sync
|
||||
|
||||
# Anwendung starten
|
||||
uv run python main.py
|
||||
```
|
||||
|
||||
#### Mit pip
|
||||
|
||||
```bash
|
||||
# Repository klonen
|
||||
git clone https://github.com/IHR-REPO/SemesterapparatsManager.git
|
||||
cd SemesterapparatsManager
|
||||
|
||||
# Virtuelle Umgebung erstellen
|
||||
python -m venv .venv
|
||||
.venv\Scripts\activate
|
||||
|
||||
# Abhängigkeiten installieren
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# Anwendung starten
|
||||
python main.py
|
||||
```
|
||||
|
||||
## Erster Start
|
||||
|
||||
Beim ersten Start werden Sie aufgefordert, sich anzumelden:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
!!! tip "Tipp"
|
||||
Ihre Anmeldedaten werden sicher gespeichert. Bei Fragen zur Einrichtung wenden Sie sich an den Administrator.
|
||||
|
||||
## Konfiguration
|
||||
|
||||
Nach der Installation sollten Sie die Einstellungen überprüfen:
|
||||
|
||||
1. Öffnen Sie das Programm
|
||||
2. Gehen Sie zu **Einstellungen** (über das Menü oder :lucide-settings:)
|
||||
3. Konfigurieren Sie:
|
||||
- **Datenbank-Pfad**: Speicherort der SQLite-Datenbank
|
||||
- **Zotero**: API-Schlüssel für Zitat-Funktionen
|
||||
- **E-Mail**: SMTP-Einstellungen für Benachrichtigungen
|
||||
|
||||
Weitere Informationen zur Konfiguration finden Sie unter [Hauptoberfläche](hauptoberflaeche.md).
|
||||
Reference in New Issue
Block a user