يمكن للمسؤولين استيراد وثائق المنتج إلى قاعدة المعرفة من ملف ZIP واحد يضم مستندات Markdown وصورًا. وعند استيراد ملف ZIP نفسه لاحقًا تُحدَّث المقالات.
مكان العثور عليه: المحتوى ← قاعدة المعرفة، زر استيراد المستندات (للمسؤولين فقط).
قبل أن تبدأ
- تحقّق من حدود رفع PHP على خادمك. يجب أن تكون قيمتا
upload_max_filesizeوpost_max_sizeأكبر من ملف ZIP. تعرض لوحة نظرة عامة في الإعداد ← النظام ← الأدوات القيمتين. - خطّط لمسارات التصنيفات: منتج وأقسامه، مثل
Ticketix/Getting StartedوTicketix/FeaturesوTicketix/FAQ.
محتويات ملف ZIP
تستخدم الأمثلة في هذه الصفحة بنية هذه الوثائق، التي تُستورد بالطريقة نفسها:
categories.json
articles/
ticketix-introduction.md
ticketix-install.md
images/
ticketix-ai-connections-screenshot.webp
categories.json(اختياري) يسرد التصنيفات.- ملفات
.mdهي المقالات. يمكن وضعها في أي مجلد؛ ويتم تخطي الملفات التي يبدأ اسمها بـ_وملفاتREADME.md. - الصور يمكن وضعها في أي مجلد. تشير كل مقالة إليها بمسار نسبي إلى ملف
.mdالخاص بها.
إذا ضغطت مجلدًا وانتهى كل شيء داخل هذا المجلد الواحد، فإن Ticketix يقرأ الملفات الموجودة بداخله.
categories.json
قائمة بالتصنيفات. الحقل path مطلوب؛ وبقية الحقول اختيارية.
[
{"path": "Ticketix", "slug": "ticketix", "description": "Documentation for Ticketix.", "order": 100},
{"path": "Ticketix/Getting Started", "slug": "ticketix-getting-started", "description": "Install and set up Ticketix.", "order": 10}
]
pathهو منتج وقسمه، يفصل بينهما/. تُنشأ التصنيفات الأم المفقودة تلقائيًا.- تنطبق
slugوdescriptionوorderعلى الجزء الأخير من المسار. تأتي قيمorderالأقل أولًا.
البيانات الأمامية للمقالة
يبدأ كل ملف .md ببيانات أمامية بين سطرين ---، يليها نص Markdown:
---
title: Install Ticketix
slug: ticketix-install
category: Ticketix/Getting Started
order: 30
excerpt: Upload the installation package and run the setup.
tags: install, setup
status: published
visibility: public
---
The body of the article starts here.
| الحقل | مطلوب | المعنى |
|---|---|---|
| title | نعم | عنوان المقالة |
| category | نعم | مسار التصنيف، مثل Ticketix/Getting Started؛ يُنشأ إن لم يكن موجودًا |
| slug | لا | عنوان المقالة (الرابط)؛ يُؤخذ من اسم الملف إذا كان فارغًا |
| order | لا | الترتيب داخل التصنيف |
| excerpt | لا | ملخص بنص عادي |
| tags | لا | وسوم مفصولة بفواصل |
| status | لا | published (افتراضي) أو draft |
| visibility | لا | public (افتراضي) أو internal |
| lang | لا | لغة المقالة، مثل en أو tr أو de (انظر "استيراد الترجمات" أدناه) |
صيغ Markdown المتاحة
- العناوين باستخدام
#. عنوان المقالة هو عنوان الصفحة، لذا يصبح كل من#و##عناوين أقسام. - الفقرات و
**bold**و*italic*والشيفرة المضمّنة. - كتل الشيفرة بين ثلاث علامات اقتباس مائلة (backticks).
- القوائم النقطية ذات المستوى الواحد والقوائم المرقّمة.
- الجداول بأعمدة
|. - الملاحظات باستخدام
>في بداية السطر. - الخطوط الأفقية.
- الروابط. اربط بمقالة أخرى باستخدام
kb:ثم الرابط المختصر (slug)، مثل[Write and publish Knowledge Base articles](kb:ticketix-knowledge-base). - الصور بمسار نسبي إلى ملف
.md، مثل.
يجب أن تكون الصور بصيغة PNG أو JPEG أو GIF أو WebP وبحجم 5 ميغابايت كحد أقصى لكل صورة. لا تُعرض في المقالات إلا الصور التي يخزّنها Ticketix، لذا أدرج كل صورة في ملف ZIP. تُخزَّن الصورة نفسها مرة واحدة، حتى لو استخدمتها عدة مقالات.
تشغيل الاستيراد
- افتح المحتوى ← قاعدة المعرفة وانقر على استيراد المستندات.
- تحقق من اللغة الافتراضية: لغة الملفات التي لا تحدد لغة (الإنجليزية ما لم تختر غيرها). أفلت ملف ZIP في النافذة أو اختره. لا يتغير شيء بعد.
- يفحص Ticketix ملف ZIP ويعرض ما سيحدث: عدد المقالات جديد وتاريخ التحديث ودون تغيير، والتصنيفات والصور، والأعداد نفسها لكل لغة، والمقالات التي سيتم إنشاؤها أو تحديثها، والملفات التي لا يمكن استيرادها مع السبب، مثل صورة مفقودة أو
titleمفقود. - انقر على استيراد … تغييرات لكتابتها، أو إلغاء.
- اقرأ النتيجة، مثل "اكتمل الاستيراد: إنشاء 19، تحديث 0، دون تغيير 0، تغيير 4 تصنيفات، 20 صورة جديدة."
لا يُوقف الخطأ في ملف واحد بقية الملفات. أصلح الملف واستورد ملف ZIP مرة أخرى. إذا انتظرت طويلًا بعد الفحص، يطلب منك Ticketix اختيار الملف مرة أخرى.
تحديث الوثائق
استورد الإصدار الجديد من ملف ZIP. تُطابَق المقالات حسب الاسم اللطيف واللغة:
- الرابط المختصر الجديد يُنشئ مقالة جديدة.
- الاسم اللطيف الموجود يحدّث مقالة اللغة نفسها. يبقى النص السابق في سجل المراجعات، مع ملاحظة التغيير "Imported from" واسم الملف.
- المقالة التي لم يتغيّر محتواها تُحتسب دون تغيير.
لا يحذف الاستيراد أي شيء. لإزالة مقالة، أرشفها من قائمة المقالات أو من صفحتها.
استيراد الترجمات
تحمل الترجمة نفس المعرّف (slug) الخاص بأصلها الإنجليزي ولكن بلغة أخرى. استورد الترجمات بملف ZIP خاص بها، بعد استيراد الوثائق الإنجليزية، على سبيل المثال:
de_DE/
categories.json
articles/
ticketix-install.md
images/
ticketix-ai-connections-screenshot.webp
- تُحدَّد لغة الملف من سطر
lang:فيه، مثلlang: de؛ وإلا فمن مجلد اللغة في المستوى الأعلى من ملف ZIP (المجلداتtr/وtr_TR/وde_DE/تعطيtrوde)؛ وإلا فمن اللغة الافتراضية للاستيراد. أي لغة غير الإنجليزية والعربية والتركية واليابانية والألمانية تجعل ذلك الملف خطأً. - تأخذ الترجمة تصنيف أصلها الإنجليزي وترتيبه؛ ولا يُستخدم سطرا
categoryوorderفي الملف. والترجمة التي لا تحتوي على سطرvisibilityتكون مخصصة للموظفين فقط إذا كان أصلها كذلك. ولا تتغير المقالة الإنجليزية. - تُستورد الترجمة التي ليس لها أصل إنجليزي كمقالة مستقلة، ويُدرجها الفحص كتحذير.
- ملف
categories.jsonالموجود في مجلد لغة، أو في المستوى الأعلى من ملف ZIP تكون جميع مقالاته بلغة واحدة غير الإنجليزية، يعثر على كل تصنيف من خلال مساره الإنجليزيpathويكتب فقط اسمه بتلك اللغة (title، اختياري) وdescription. ويبقى الاسم الإنجليزي والترتيب والتصنيف الأب كما هي. - أرفق الصور التي تستخدمها المقالات المترجمة. والصورة المخزّنة مسبقًا، من الوثائق الإنجليزية مثلًا، لا تُخزَّن مرة أخرى.
مثال على إدخال مترجم في categories.json:
[
{"path": "Ticketix/Getting Started", "slug": "ticketix-getting-started", "title": "Erste Schritte", "description": "Ticketix installieren und einrichten."}
]
راجع اللغات والمحتوى المترجم لمعرفة ما يراه الزوار.
الحدود
| الحد | القيمة |
|---|---|
| الملفات في ملف ZIP | حتى 2,000 |
| الحجم الإجمالي بعد فك الضغط | حتى 200 ميغابايت |
| حجم الصورة | حتى 5 ميغابايت لكل صورة |
| أنواع الصور | PNG وJPEG وGIF وWebP |
لدواعٍ أمنية، يرفض Ticketix ملف ZIP يحتوي على مسارات مطلقة أو مسارات تتضمن ...