128 lines
4.1 KiB
Markdown
128 lines
4.1 KiB
Markdown
<!-- titel -->
|
|
Dokumente
|
|
----------------------------------------
|
|
<!-- art -->
|
|
kern
|
|
----------------------------------------
|
|
<!-- ziel -->
|
|
Organisiert Dokumente mit Versionierung und prüft deren Bereitschaft für den Wissensindex
|
|
----------------------------------------
|
|
<!-- regeln -->
|
|
- POST-Operationen erfordern CSRF-Token
|
|
- Versionen absteigend nach Versionsnummer sortiert
|
|
- Fehler bei API-Routen liefern ok=false mit Meldung
|
|
- Dateien im konfigurierten Upload-Verzeichnis gespeichert
|
|
- Index-Neuaufbau erfordert bewusste Auslösung
|
|
- Titelvorschläge erzeugen: Endpunkt fehlt
|
|
- Version ableiten: Endpunkt fehlt
|
|
- Version aktivieren: Endpunkt fehlt
|
|
- Version ingest: Endpunkt fehlt
|
|
- Formularansicht GET fehlt
|
|
- TagController mit Tag erstellen, Tag entfernen, Tag zuweisen fehlt
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Abschnitte laden
|
|
<!-- ziel -->
|
|
Markiert eine Dokumentversion für den nächsten Index-Neuaufbau
|
|
<!-- regeln -->
|
|
- Nur aktive Versionen sind zulässig
|
|
- CSRF-Token erforderlich
|
|
- Editor-Rolle erforderlich
|
|
<!-- testen -->
|
|
- Abschnitte über Admin-Endpunkt laden mit gültigem Token
|
|
- Aktive Version auswählen
|
|
- Erfolgsmeldung: Version für Index-Neuaufbau vorgemerkt
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Abschnittsqualität laden
|
|
<!-- ziel -->
|
|
Zeigt Qualitätskennzahlen der Textabschnitte einer Dokumentversion im Admin-Bereich
|
|
<!-- regeln -->
|
|
- Benötigt ROLE_EDITOR
|
|
- Liefert JSON mit Qualitätsdaten
|
|
- Fehler liefert ok=false mit Fehlermeldung
|
|
<!-- testen -->
|
|
- Admin-Endpunkt abrufen
|
|
- Valides CSRF und Version vorhanden
|
|
- JSON mit ok=true und quality-Daten
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Dokument anzeigen
|
|
<!-- ziel -->
|
|
Zeigt alle Details eines Dokuments mit Versionshistorie und Qualitätsindikatoren
|
|
<!-- regeln -->
|
|
- Nur Benutzer mit ROLE_EDITOR
|
|
- DocumentVersionPreviewService lädt Inhalt
|
|
- DocumentChunkInspectionService prüft Segmentierung
|
|
- DocumentMarkdownNormalizationInspector analysiert Markdown
|
|
- DocumentIndexReadinessService zeigt Indexbereitschaft
|
|
<!-- testen -->
|
|
- Admin-Dokumentenansicht öffnen
|
|
- Seite zeigt Dokument mit Versionen und Qualitätsdaten
|
|
- Chunk-Übersicht sichtbar
|
|
- Markdown-Normalisierungsstatus sichtbar
|
|
- Index-Bereitschaftsanzeige sichtbar
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Dokument entfernen
|
|
<!-- ziel -->
|
|
Entfernt ein Dokument dauerhaft aus dem System
|
|
<!-- regeln -->
|
|
- Entfernt alle Versionen des Dokuments
|
|
- Loescht verknuepfte Ingest-Jobs
|
|
- Bereinigt zugeordnete Dateien
|
|
<!-- testen -->
|
|
- Entfernen-Knopf betaetigen
|
|
- Bestaetigung bestaetigen
|
|
- Dokument nicht mehr in Uebersicht
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Dokument erstellen
|
|
<!-- ziel -->
|
|
Erstellt ein neues Dokument aus einer hochgeladenen Datei
|
|
<!-- regeln -->
|
|
- Erfordert Rolle ROLE_EDITOR
|
|
- Nur POST-Requests erzeugen ein Dokument
|
|
- CSRF-Token Pflicht
|
|
- Hochgeladene Datei Pflicht
|
|
- Titel Pflicht
|
|
- Titel maximal 255 Zeichen
|
|
- Dateiname normiert
|
|
- Datei gespeichert im konfigurierten Upload-Verzeichnis
|
|
<!-- testen -->
|
|
- Admin-Dokumente-Neu aufrufen
|
|
- Formular mit Datei und Titel absenden
|
|
- Erfolgsmeldung und Weiterleitung zur Dokumentdetailseite
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Dokumente auflisten
|
|
<!-- ziel -->
|
|
Zeigt alle Dokumente mit Statistiken und Filtern an
|
|
<!-- regeln -->
|
|
- Filter werden aus URL-Parametern geladen
|
|
- Aktive Filter werden hervorgehoben
|
|
- Zeigt Statistiken zur Dokumentenübersicht
|
|
- Index-Bereitschaft wird angezeigt
|
|
<!-- testen -->
|
|
- admin/documents öffnet die Übersicht
|
|
- Dokumente werden mit Titeln angezeigt
|
|
- LMB auf Filterfeld
|
|
- Filterkriterium auswählen
|
|
- Ergebnis zeigt gefilterte Dokumente
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Markdown bereinigen
|
|
<!-- ziel -->
|
|
Erstellt eine normalisierte Markdown-Version aus dem Original
|
|
<!-- regeln -->
|
|
- CSRF-Token erforderlich
|
|
- Neue Version ist inaktiv
|
|
- Abgeleitet von ausgewaehlter Version
|
|
<!-- testen -->
|
|
- Seite der Dokumentversion öffnen
|
|
- POST an markdown-normalize-Endpunkt senden
|
|
- Neue inaktive Version erzeugt
|
|
----------------------------------------
|
|
<!-- funktion -->
|
|
Version-Chunks abrufen
|