updated readme with export doc

This commit is contained in:
s5260822 2025-03-23 19:50:10 +01:00
parent e47186f685
commit 89ca422661

View file

@ -1,6 +1,9 @@
# Multimodal Parliament Explorer (Gruppe_05_1)
## Umgebung - wichtiger Hinweis!
### Docker und NLP
Damit der Zugriff auf die Docker-Treiber funktioniert, muss man in IntelliJ folgendes tun:
Edit Run Environment --> Modify Option --> Add VM options
@ -9,6 +12,26 @@ Dann im neu erscheinenden "VM options"-Feld folgendes schreiben:
--add-opens java.base/java.util=ALL-UNNAMED
### LaTex Export
Damit der LaTeX Export funktioniert, muss der LaTeX Compiler installiert sein.
Unter Ubuntu (Linux) kann das Paket mit dem folgenden Befehl installiert werden:
```shell
sudo apt install texlive-latex-extra
```
Unter Windows ist die Installation über MikTex möglich.
Ist kein Compiler installiert, wird beim Start des Programms eine Warnung ausgegeben:
```shell
-------------------------------------------------o
TeX SDK not installed. PDF export will not work.
-------------------------------------------------o
```
## Aufruf
Der Nutzer führt die **Main.java** Datei aus.
@ -36,11 +59,14 @@ Die Planung beinhaltet:
### Classdiagram puml generator
Das Classdiagram wird durch den puml generator generiert:
```shell
python puml_generator.py
```
Die aktuelle Version des Klassen-/Package-Diagramms ist bei der Abgabe unter `generated_class_diagram.puml` zu finden. Außerdem gibt es das Diagram auch als LaTe, PDF und Bild (png) Version im `/doc` Ordner zu funden.
## Datenbank
@ -127,7 +153,15 @@ Ein "Zurück"-Button ist auf den Seiten implementiert. Er führt erwartungsgemä
Gleiche Struktur wie die Charts für die einzelnen reden, hier nur auf alle in der Datenbank vorhandenen Reden angewendet. Die sammlung der Daten passiert hier dynamisch ab Abruf der Seite.
### Export-Seite
Wie auch auf den einzelnen Seiten, gibt es hier die Option Reden zu exportieren. Es kann zwischen PDF und XML gewählt werden. Die verschiedenen Export-Optionen sind:
- Export einer einzelnen Rede (mit Reden-ID)
- Export aller Reden eines Parlamentariers (mit Parlamentarier-ID)
- Export aller Reden eines NLP-Topics (mit Topic-String)
- Export aller Reden (ohne Parameter)
Achtung: Der Export kann je nach Anzahl der Reden und der gewählten Option einige Zeit in Anspruch nehmen. Meist wird der Nutzer darüber informiert, dass der Prozess länger dauern kann.
## Verschiedenes