بيانات الفئة الوصفية
1 دقيقة للقراءة
تعيش بيانات الفئة الوصفية (الاسم، الوصف، الأيقونة) في opencx.json تحت المفتاح الاختياري categories. كل مفتاح هو مسار الفئة بالنسبة إلى content_dir (مثل getting-started, advanced/configuration). القيمة هي كائن يحتوي على name (مطلوب)، و description و icon اختياريين.
التنسيق
في opencx.json:
json
{
"categories": {
"getting-started": { "name": "البدء" },
"billing": {
"name": "الفوترة والمدفوعات",
"description": "الفواتير، الاشتراكات، وطرق الدفع",
"icon": "credit-card"
}
}
}
الحقول (لكل فئة)
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
name | string | نعم | اسم العرض للفئة |
description | string | لا | ملخص قصير للفئة |
icon | string | لا | معرف الأيقونة للفئة |
الاسترجاع
عندما لا يتم إدراج مسار الفئة في categories, يتم اشتقاق اسم العرض من اسم الدليل: يتم تقسيمه على الشرطات وتكبير كل كلمة.
| اسم الدليل | الاسم المشتق |
|---|---|
getting-started | البدء |
api-reference | مرجع API |
billing | الفوترة |
تحديث الفئات
تشغيل opencx content pull يقوم بتحديث categories في opencx.json من مركز المساعدة البعيد. يمكنك أيضًا تحرير opencx.json يدويًا.