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-19 17:00:18 +01:00
parent 74e15f3d20
commit 219e3c4d12
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
technische-dokumentation/fach-themendaten.md

@@ -18,7 +18,7 @@ Sämtliche Daten für die einzelnen Fächer sind im Ordner config hinterlegt.
* download1.pdf * download1.pdf
* download2.pdf * download2.pdf
_\<subjectID\>_ und _\<topicID\>_ sind die eindeutigen Bezeichner, die nur A-Z, a-z, 0-9 sowie - und \_ enthalten dürfen. _\<subjectID\>_ und _\<topicID\>_ sind die eindeutigen Bezeichner, die nur A-Z, a-z, 0-9 sowie - und \_ enthalten dürfen, sonst aber frei wählbar sind.
### Subject properties.json ### Subject properties.json
@@ -26,16 +26,15 @@ _\<subjectID\>_ und _\<topicID\>_ sind die eindeutigen Bezeichner, die nur A-Z,
|-----|-------|-----| |-----|-------|-----|
| displayName | Name mit dem das Fach für User angezeigt wird | Reiner Text | | displayName | Name mit dem das Fach für User angezeigt wird | Reiner Text |
| description | Kurzer Beschreibungstext für Übersichtsseiten | Darf HTML enthalten | | description | Kurzer Beschreibungstext für Übersichtsseiten | Darf HTML enthalten |
| color | Akzentfarbe | **_Noch unspezifiziert_** | | color | Akzentfarbe | Hexcode, z.B. #FF0000 |
| buttonText | Text auf Button zur Fachseite | Reiner Text | | icon | Symbol des Faches | [FontAwesome-6-CSS-Klasse](https://fontawesome.com/icons) |
| icon | Symbol des Faches | FontAwesome-CSS-Klasse |
### Topic properties.json ### Topic properties.json
| Key | Value | Typ | | Key | Value | Typ |
|-----|-------|-----| |-----|-------|-----|
| displayName | Name mit dem das Fach für User angezeigt wird | Reiner Text | | displayName | Name mit dem das Fach für User angezeigt wird | Reiner Text |
| icon | Symbol des Themas | Font-Awesome-CSS-Klasse | | icon | Symbol des Themas | [Font-Awesome-6-CSS-Klasse](https://fontawesome.com/icons) |
| description | Kurzer Beschreibungstext für Übersichtsseiten | Darf HTML enthalten | | description | Kurzer Beschreibungstext für Übersichtsseiten | Darf HTML enthalten |
| relatedTopics | IDs der verwandten Themen | array | | relatedTopics | IDs der verwandten Themen | array |
| files | Downloadbare Dateien | array der Dateinamen | | files | Downloadbare Dateien | array der Dateinamen |