feat(docs): migrate to zensical, re-structure docs
This commit is contained in:
86
docs/elsa/anlegen.md
Normal file
86
docs/elsa/anlegen.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# ELSA anlegen
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
---
|
||||
|
||||
## Neuen ELSA erstellen
|
||||
|
||||
### Schritte
|
||||
|
||||
1. Klicken Sie auf **Neuer Auftrag**
|
||||
2. Das Feld *Auftragsdaten* wird freigeschaltet
|
||||
3. Der Fokus wechselt automatisch auf das Feld **Prof.**
|
||||
|
||||
### Professorenauswahl
|
||||
|
||||
Im Feld **Prof.** werden automatisch alle bereits vorhandenen Dozenten aus den Semesterapparaten angezeigt.
|
||||
|
||||
!!! info "Neuer Professor"
|
||||
Wenn der Professor noch keinen Apparat hat, kann der Name manuell eingetragen werden. Es erscheinen zusätzliche Felder:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
| Feld | Beschreibung | Pflicht |
|
||||
|------|--------------|---------|
|
||||
| **Name** | Name des Dozenten | :material-check: |
|
||||
| **E-Mail** | Kontakt-E-Mail | :material-check: |
|
||||
| **Telefon** | Telefonnummer | :material-check: |
|
||||
|
||||
!!! warning "Pflichtfelder"
|
||||
Solange diese Felder nicht ausgefüllt sind, kann der Auftrag **nicht** gespeichert werden.
|
||||
|
||||
---
|
||||
|
||||
## Schnelleingabe
|
||||
|
||||
Über das Kalender-Icon { .twemoji } können automatisch eingetragen werden:
|
||||
|
||||
- [x] Aktuelles Datum
|
||||
- [x] Aktuelles Semester
|
||||
|
||||
---
|
||||
|
||||
## Dokumente hinzufügen
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
### Formular hinzufügen
|
||||
|
||||
1. Klicken Sie auf **Dokument hinzufügen**
|
||||
2. Wählen Sie die Datei aus
|
||||
3. Das Dokument wird in der Datenbank gespeichert
|
||||
|
||||
### Medien extrahieren
|
||||
|
||||
Über **Medien aus Dokument hinzufügen** werden alle erkannten Medien automatisch in die Tabelle eingetragen.
|
||||
|
||||
!!! tip "Abschnitte trennen"
|
||||
Hat der Professor mehrere Abschnitte in einer Zeile gelistet, aktivieren Sie **Abschnitte trennen** – diese werden dann als separate Einträge hinzugefügt.
|
||||
|
||||
!!! warning "Formatierung im Dokument"
|
||||
Die Abschnitte müssen durch **Semikolon** getrennt sein:
|
||||
|
||||
```
|
||||
1-5; 18-25; 30-35
|
||||
```
|
||||
|
||||
### Automatisches Speichern
|
||||
|
||||
Beim Klicken auf **Medien aus Dokument hinzufügen** wird der Auftrag automatisch gespeichert.
|
||||
|
||||
---
|
||||
|
||||
## Einträge bearbeiten
|
||||
|
||||
Die erkannten Medien erscheinen in der Tabelle und können:
|
||||
|
||||
- :lucide-edit: Bearbeitet werden
|
||||
- :lucide-quote: Zitiert werden → [Zum Zitieren](zitieren.md)
|
||||
- :lucide-trash: Gelöscht werden
|
||||
|
||||
---
|
||||
|
||||
## Dokument öffnen
|
||||
|
||||
Über **Dokument öffnen** kann das hinzugefügte Formular jederzeit eingesehen werden.
|
||||
46
docs/elsa/index.md
Normal file
46
docs/elsa/index.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# ELSA
|
||||
|
||||
**ELSA** steht für **E**lektronischer **L**ehr-**S**emester**a**pparat und ermöglicht die Verwaltung digitaler Literatur für Lehrveranstaltungen.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :lucide-file-plus:{ .lg .middle } **ELSA anlegen**
|
||||
|
||||
---
|
||||
|
||||
Erstellen Sie einen neuen elektronischen Semesterapparat.
|
||||
|
||||
[:octicons-arrow-right-24: ELSA anlegen](anlegen.md)
|
||||
|
||||
- :lucide-quote:{ .lg .middle } **Zitieren**
|
||||
|
||||
---
|
||||
|
||||
Erstellen Sie automatische Zitate für Ihre digitalen Medien.
|
||||
|
||||
[:octicons-arrow-right-24: Zum Zitieren](zitieren.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Was ist ELSA?
|
||||
|
||||
!!! abstract "Definition"
|
||||
Ein elektronischer Semesterapparat (ELSA) ist eine digitale Sammlung von Literatur, die auf Illias bereitgestellt wird. Die Dokumente werden gescannt und mit korrekten Zitationen versehen.
|
||||
|
||||
### Workflow
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[ELSA anlegen] --> B[Dokumente hinzufügen]
|
||||
B --> C[Medien aus Dokument extrahieren]
|
||||
C --> D[Einträge zitieren]
|
||||
D --> E[Dateien auf Illias hochladen]
|
||||
```
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- [x] Konfigurierter Zotero-Account
|
||||
- [x] Eingescannte Dokumente oder Formulare
|
||||
- [x] Informationen zum Dozenten und zur Veranstaltung
|
||||
95
docs/elsa/zitieren.md
Normal file
95
docs/elsa/zitieren.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# Zitieren
|
||||
|
||||
Da alle gescannten Dokumente später auf **Illias** hochgeladen werden, bietet der SemesterapparatsManager eine automatische Zitierfunktion.
|
||||
|
||||
---
|
||||
|
||||
## Zitierstil
|
||||
|
||||
!!! abstract "Verwendeter Stil"
|
||||
Es wird der Zitierstil der **Deutschen Gesellschaft für Psychologie (DGPs)** verwendet.
|
||||
|
||||
---
|
||||
|
||||
## Oberfläche
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
### Zitat erstellen
|
||||
|
||||
1. Wählen Sie einen Eintrag in der ELSA-Tabelle aus
|
||||
2. Klicken Sie auf **Eintrag zitieren**
|
||||
3. Der Dialog öffnet sich und sucht automatisch im Katalog
|
||||
|
||||
!!! tip "Seitenzahlen"
|
||||
Die angegebene Seitenzahl aus der Tabelle wird automatisch übernommen. Bei mehreren Abschnitten muss die Seitenzahl ggf. angepasst werden.
|
||||
|
||||
---
|
||||
|
||||
## Zitierdialog
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Nach dem Öffnen werden automatisch relevante Daten aus dem Katalog abgefragt und in die Felder eingetragen.
|
||||
|
||||
### Aktionen
|
||||
|
||||
| Knopf | Funktion |
|
||||
|-------|----------|
|
||||
| :lucide-search: **Suchen** | Sucht im Katalog nach dem Identifikator |
|
||||
| :lucide-quote: **Zitat erstellen** | Verbindet mit Zotero und erstellt das Zitat |
|
||||
| :lucide-check: **Ok** | Schließt den Dialog |
|
||||
| :lucide-trash: **Discard** | Entfernt alle Eingaben |
|
||||
| :lucide-x: **Abbrechen** | Schließt den Dialog |
|
||||
| :lucide-rotate-ccw: **Wiederholen** | Zurück zur Eingabe für erneute Suche |
|
||||
|
||||
---
|
||||
|
||||
## Zitat-Erstellung
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant U as Benutzer
|
||||
participant S as SemesterapparatsManager
|
||||
participant Z as Zotero
|
||||
|
||||
U->>S: Klick "Zitat erstellen"
|
||||
S->>Z: Werk anlegen
|
||||
Z-->>S: Werk-ID
|
||||
S->>Z: Zitat abrufen
|
||||
Z-->>S: Formatiertes Zitat
|
||||
S->>U: Zitat anzeigen
|
||||
```
|
||||
|
||||
### Ablauf
|
||||
|
||||
1. Klicken Sie auf **Zitat erstellen**
|
||||
2. Eine Verbindung zu Zotero wird hergestellt
|
||||
3. Das Werk wird in Ihrer Zotero-Bibliothek angelegt
|
||||
4. Das formatierte Zitat wird zurückgegeben
|
||||
|
||||
---
|
||||
|
||||
## Generierte Zitate
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
Nach erfolgreicher Erstellung wechselt der Dialog automatisch zur Zitat-Ansicht.
|
||||
|
||||
### Verwendung
|
||||
|
||||
Die generierten Zitate können:
|
||||
|
||||
- :lucide-copy: In die Zwischenablage kopiert werden
|
||||
- :lucide-file-text: Als Dateiname für das gescannte Dokument verwendet werden
|
||||
- :lucide-upload: Zusammen mit dem Dokument auf Illias hochgeladen werden
|
||||
|
||||
---
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
!!! warning "Zotero-Konfiguration erforderlich"
|
||||
Für die Zitierfunktion muss Zotero konfiguriert sein:
|
||||
|
||||
1. Erstellen Sie einen API-Key in Ihrem Zotero-Account
|
||||
2. Tragen Sie den Key in den [Einstellungen](../allgemein/hauptoberflaeche.md#zotero) ein
|
||||
Reference in New Issue
Block a user