Safak/SWE
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Update Fach und themendaten

Matthias Grief
2024-11-11 13:28:47 +01:00
parent 2e96f860eb
commit 8b9330766e
1 changed files with 38 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
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. Sämtliche Daten für die einzelnen Fächer sind im Ordner config hinterlegt.
- config - **config**
* subject * **subjects**
* weiter ordnerstruktur... * _\<subjectID\>_
* mathe
* **properties.json**
* **topics**
* _\<topicID\>_
* bruchrechnung
* **properties.json**
* **article.html**
* image1.png
* image2.png
* download1.pdf
* download2.pdf
_\<subjectID\>_ und _\<topicID\>_ 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 |