Categorie Metadata
1 min leestijd
Categorie metadata (naam, beschrijving, pictogram) bevindt zich in opencx.json onder de optionele categories-sleutel. Elke sleutel is het categoriepad relatief aan content_dir (bijv. getting-started, advanced/configuration). De waarde is een object met name (vereist), en optionele description en icon.
Formaat
In opencx.json:
json
{
"categories": {
"getting-started": { "name": "Aan de slag" },
"billing": {
"name": "Facturering & Betalingen",
"description": "Facturen, abonnementen en betaalmethoden",
"icon": "credit-card"
}
}
}
Velden (per categorie)
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
name | string | Ja | Weergavenaam voor de categorie |
description | string | Nee | Een korte samenvatting van de categorie |
icon | string | Nee | Pictogramidentificatie voor de categorie |
Terugvaloptie
Wanneer een categoriepad niet is vermeld in categories, wordt de weergavenaam afgeleid van de directorynaam: splits op koppeltekens en kapitaliseer elk woord.
| Directorynaam | Afgeleide naam |
|---|---|
getting-started | Aan de slag |
api-reference | Api-referentie |
billing | Facturering |
Categorieën bijwerken
Het uitvoeren van opencx content pull werkt categories in opencx.json bij vanuit het externe helpcentrum. Je kunt opencx.json ook handmatig bewerken.