From 8b9330766eb72b0ffac2d4a64ccd0b5ff07c7107 Mon Sep 17 00:00:00 2001 From: Matthias Grief Date: Mon, 11 Nov 2024 13:28:47 +0100 Subject: [PATCH] Update Fach und themendaten --- technische-dokumentation/fach-themendaten.md | 41 ++++++++++++++++++-- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/technische-dokumentation/fach-themendaten.md b/technische-dokumentation/fach-themendaten.md index a7dff1a..fd319d4 100644 --- a/technische-dokumentation/fach-themendaten.md +++ b/technische-dokumentation/fach-themendaten.md @@ -3,6 +3,41 @@ title: Fach- und themendaten --- Sämtliche Daten für die einzelnen Fächer sind im Ordner config hinterlegt. -- config - * subject - * weiter ordnerstruktur... \ No newline at end of file +- **config** + * **subjects** + * _\_ + * mathe + * **properties.json** + * **topics** + * _\_ + * bruchrechnung + * **properties.json** + * **article.html** + * image1.png + * image2.png + * download1.pdf + * download2.pdf + +_\_ und _\_ sind die eindeutigen Bezeichner, die nur A-Z, a-z, 0-9 sowie - und \_ enthalten dürfen. + +### Subject properties.json: + +| Key | Value | Typ | +|-----|-------|-----| +| displayName | Name mit dem das Fach für User angezeigt wird | Reiner Text | +| description | Kurzer Beschreibungstext für Übersichtsseiten | Darf HTML enthalten | +| color | Akzentfarbe | **_Noch unspezifiziert_** | +| buttonText | Text auf Button zur Fachseite | Reiner Text | +| icon | Symbol des Faches | FontAwesome-CSS-Klasse | + + +### Topic properties.json + +| Key | Value | Typ | +|-----|-------|-----| +| displayName | Name mit dem das Fach für User angezeigt wird | Reiner Text | +| icon | Symbol des Themas | Font-Awesome-CSS-Klasse | +| description | Kurzer Beschreibungstext für Übersichtsseiten | Darf HTML enthalten | +| relatedTopics | IDs der verwandten Themen | array | +| files | Downloadbare Dateien | array der Dateinamen | +