Konfigurations-Handbuch¶

Diese Anleitung erklärt, wie Sie den Academic Document Generator mithilfe von JSON-Konfigurationsdateien anpassen.

📋 Übersicht¶

Das Tool unterstützt JSON-basierte Konfigurationen für drei Hauptanwendungsfälle: - Kolloquium-Protokolle (Thesis-Verteidigung) - Praxisprojekt- & WASP1-Benotung - Peer-Review Kommentare

🎯 Quick Start¶

1. Vorlage auswählen¶

# Verfügbare Vorlagen auflisten
academic-doc-generator --list-templates

2. Kopieren und Anpassen¶

# Vorlage in Ihren Thesis-Ordner kopieren
cp config_templates/config_colloquium_campus.json /pfad/zu/ihrer/thesis/

Passen Sie anschließend die config.json Datei an. Mindestens der Dateiname des zu analysierenden PDF-Dokuments (pdf -> filename) muss korrekt gesetzt sein.

3. Tool ausführen¶

Option A: Über die CLI

academic-doc-generator --config /pfad/zu/ihrer/thesis/config_colloquium_campus.json

Option B: Über main.py Sie können das Tool auch über die main.py im Projekt-Stammverzeichnis ausführen. Passen Sie dazu in der main.py den Pfad (folder) zu dem Ordner an, in dem Ihr PDF und die neue JSON-Datei liegen.

📝 Konfigurations-Struktur¶

Gemeinsame Felder¶

`output` (optional)¶

{
  "output": {
    "folder": null,              // null = gleicher Ordner wie PDF
    "compile_pdf": true,         // LaTeX zu PDF kompilieren
    "signature_file": "signature.png", // Pfad zur Unterschrift
    "create_feedback_mail": true // Feedback-Mail generieren (für Projekte)
  }
}

folder: Ausgabe-Verzeichnis (null = Ordner des PDFs)
compile_pdf: Ob .tex zu PDF kompiliert werden soll
signature_file: Pfad zur Unterschrift (Standard ist signature.png oder Suche in data/)
create_feedback_mail: Ob studentisches Feedback generiert werden soll

🎓 Kolloquium-Konfiguration¶

{
  "task": "colloquium",
  "colloquium": {
    "date": "20.01.2026",
    "time": "14:00",
    "location_type": "campus",
    "room": "3.217"
  }
}

Manuelle Metadaten (Optional): Falls die automatische Extraktion fehlschlägt, können Sie Felder manuell setzen: - course_of_study: z. B. "Informatik", "Medieninformatik" - author: Name des Studierenden

📂 Projekt-Konfiguration¶

{
  "task": "project",
  "project": {
    "mark": "1.3"
  },
  "output": {
    "create_feedback_mail": true
  }
}

🔑 API-Keys konfigurieren¶

Erstellen Sie eine secrets.env im Projekt-Stammverzeichnis:

OPENAI_API_KEY=sk-xxxxxxxx
GROQ_API_KEY=gsk-xxxxxxxx
GEMINI_API_KEY=AIzaSyxxxxxxxx

📝 Konfigurations-Vorlagen¶

Vorgefertigte JSON-Konfigurationen im Ordner config_templates/:

config_colloquium_campus.json - Thesis-Kolloquium auf dem Campus
config_colloquium_company.json - Thesis-Kolloquium im Unternehmen
config_colloquium_online.json - Online-Kolloquium (Zoom)
config_project_template.json - Praxisprojekt-Benotung
config_wasp1_template.json - WASP1-Projekt-Benotung
config_review_template.json - Peer-Review-Kommentare

⚙️ Globale Konfiguration (config.yaml)¶

Zusätzlich zu den projekt-spezifischen JSON-Dateien gibt es eine globale config.yaml im Projekt-Stammverzeichnis für allgemeine Einstellungen:

# Globaler Ordner für Web-Metadaten (*.md Steckbriefe)
web_metadata_folder: "/pfad/zu/ihrer/webseite/data/projects/"

# Standard-Prüfername (überschreibt Extraktion aus PDF)
first_examiner: "Prof. Dr. Vorname Nachname"

web_metadata_folder: Wenn gesetzt, werden die generierten Jekyll-kompatiblen Steckbriefe automatisch in diesen Ordner kopiert.
first_examiner: Hier kann ein Name hinterlegt werden, der global für alle Dokumente als Erstprüfer verwendet wird.