Initial commit: added Markdown to IHK Chemnitz PDF converter with core structure and features, including YAML config, Goldmark parser, and PDF renderer.
This commit is contained in:
84
report.md
Normal file
84
report.md
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
student:
|
||||
name: "Max Mustermann"
|
||||
profession: "Fachinformatiker Fachrichtung Anwendungsentwicklung"
|
||||
company: "Musterfirma GmbH"
|
||||
supervisor: "Sabine Supervisor"
|
||||
project:
|
||||
title: "Entwicklung eines Markdown-zu-IHK-Konverters"
|
||||
subtitle: "Projektdokumentation zur Abschlussprüfung"
|
||||
period: "Frühjahr 2026"
|
||||
---
|
||||
|
||||
# Vorwort
|
||||
|
||||
Dieses Projekt entstand im Rahmen der Abschlussprüfung...
|
||||
|
||||
# 1. Problemstellung
|
||||
|
||||
## 1.1 Ausgangslage
|
||||
Aktuell müssen IHK-Dokumentationen mühsam in Word formatiert werden, was fehleranfällig ist und viel Zeit kostet. Besonders schwierig ist die Einhaltung der Formvorgaben für Umlaute wie Ä, Ö, Ü und das Eszett ß.
|
||||
|
||||
## 1.2 Zielsetzung
|
||||
Ziel ist ein Go-Tool, das Markdown in PDF umwandelt und dabei alle formalen Anforderungen der IHK Chemnitz erfüllt. Es soll die Prüfungsvorbereitung erleichtern und die Qualität der Dokumente erhöhen.
|
||||
|
||||
# 2. Projektablauf
|
||||
|
||||
## 2.1 Planung
|
||||
Die Planung umfasst die Analyse der IHK-Vorgaben und das Design der Software-Architektur.
|
||||
|
||||
### Architektur-Übersicht (Mermaid)
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Markdown] --> B(Go Parser)
|
||||
B --> C{Metadata?}
|
||||
C -->|Ja| D[Config]
|
||||
C -->|Nein| E[Default]
|
||||
D --> F[PDF Renderer]
|
||||
E --> F
|
||||
F --> G[IHK PDF]
|
||||
```
|
||||
|
||||
### Klassen-Diagramm (PlantUML)
|
||||
```puml
|
||||
@startuml
|
||||
class IHKRenderer {
|
||||
+RenderTOC()
|
||||
+RenderBibliography()
|
||||
+RenderAppendices()
|
||||
}
|
||||
IHKRenderer o-- TOCItem
|
||||
IHKRenderer o-- Appendix
|
||||
@enduml
|
||||
```
|
||||
|
||||
## 2.2 Realisierung
|
||||
Die Realisierung erfolgt in Go unter Verwendung von `goldmark` und `fpdf`.
|
||||
|
||||
| Tool | Zweck |
|
||||
|------|-------|
|
||||
| Go | Programmiersprache |
|
||||
| Goldmark | Markdown Parser |
|
||||
| FPDF | PDF Renderer |
|
||||
|
||||
@Quelle: Goldmark Documentation, https://github.com/yuin/goldmark, 2024
|
||||
> Quelle: Go-PDF/Fpdf Documentation, https://github.com/go-pdf/fpdf, 2025
|
||||
|
||||
# 3. Zusammenfassung
|
||||
|
||||
Das Tool ermöglicht eine effiziente Erstellung von Dokumentationen unter Einhaltung aller Formatvorgaben.
|
||||
|
||||
@Quelle: IHK Chemnitz, Hinweise zur Erarbeitung der Dokumentation, 2020
|
||||
|
||||
@Anhang: Architektur Diagramm | test.png
|
||||
@Anhang: Datenbank Schema | test.png
|
||||
|
||||
@AnhangUML: Sequenzdiagramm Generierung
|
||||
```puml
|
||||
@startuml
|
||||
User -> Generator: Markdown
|
||||
Generator -> Kroki: Code
|
||||
Kroki -> Generator: PNG
|
||||
Generator -> PDF: Embed
|
||||
@enduml
|
||||
```
|
||||
Reference in New Issue
Block a user