||||
-|-|
| الملخص | يوفر إضافة فئات وثائق Discourse القدرة على تخصيص فئات معينة للوثائق، مما يتيح ميزات إضافية لها.
| رابط المستودع | https://github.com/discourse/discourse-doc-categories
| دليل التثبيت | كيفية تثبيت الإضافات في Discourse
يرجى ملاحظة أن هذه الإضافة قيد التطوير النشط وليست مكتملة بالكامل بعد.
الميزات
تتيح لك إضافة فئات وثائق Discourse استضافة وثائق منظمة على منتدى Discourse موجود. تعمل الإضافة من خلال تخصيص فئات محددة للوثائق، وتوفير ميزات لتسهيل العثور على مواضيع الوثائق المحددة.
يمكنك رؤية الإضافة قيد العمل في فئة Documentation.
عند تحديد فئة كموقع للوثائق، يتم تمكين الميزات التالية لهذه الفئة:
- موضوع محدد لاستخدامه كمؤشر لجميع مواضيع الوثائق في الفئة
- شريط جانبي جديد للتنقل بين المواضيع المختلفة في الفئة، بما في ذلك وظائف التصفية والبحث المدمجة
- تقارير جديدة لمساعدتك في الحفاظ على سلامة مواضيع الفهرس
بالإضافة إلى ذلك، تتعامل الإضافة مع إعادة التوجيه للمواقع التي تنتقل من إضافة Docs المتقاعد. ستؤدي روابط الوثائق من تلك الإضافة إلى إعادة التوجيه إلى عناوين URL للمواضيع الموجودة، وهناك إعداد لإعادة التوجيه لصفحة الوثائق الرئيسية السابقة إلى فئة الوثائق الرئيسية.
التكوين
متاحة إعدادات التكوين في example.discourse.com/admin/site_settings/category/doc_categories. هنا ستجد الإعدادات التالية:
doc categories enabled: حدد لتمكين إضافة فئات الوثائق.doc categories docs legacy enabled: حدد هذا إذا قمت بالانتقال من إضافة Docs المتقادمة.doc categories homepage: مع تمكين الإعداد السابق، سيتم إعادة توجيه صفحة الهبوط من إضافة Docs المتقادمة إلى عنوان URL هذا.
لتحديد الفئات التي سيتم استخدامها للوثائق، قم بتعيين موضوع فهرس لها. للقيام بذلك، افتح إعدادات الفئة بالنقر على أيقونة
في صفحة الفئة. من هناك، انقر على رابط ‘الإعدادات’ وانتقل لأسفل إلى قسم ‘وضع الوثائق’. استخدم حقل ‘موضوع الفهرس’ لتحديد الموضوع الذي سيتم استخدامه كفهرس للفئة.
مواضيع الفهرس
تخدم مواضيع الفهرس لفئة الوثائق غرضين:
- هي قائمة مركزية لجميع المواضيع المدرجة في الفئة
- يتم ملء الشريط الجانبي المضمن مع هذه الإضافة بمحتوى موضوع الفهرس
تنسيق مواضيع الفهرس
يمكن أن تتضمن مواضيع الفهرس أي محتوى تريده. لكي يعمل الشريط الجانبي بشكل صحيح، يجب أن تتضمن قائمة نقطية (أو قوائم نقطية متعددة) من مواضيع الوثائق. يمكن أن تكون هذه ببساطة عناوين URL للمواضيع في قائمة، وفي هذه الحالة سيعرض الشريط الجانبي العنوان الكامل لكل موضوع وثائق.
قد لا يكون وجود العنوان الكامل في الشريط الجانبي عمليًا إذا كانت عناوينك أطول من بضع كلمات، لذا لتعيين عناوين أقصر لموضوع معين، اسبق عنوان URL بعنوان مختصر يتبعه نقطتان رأسيتان (:). سيتم عرض كل النص قبل النقطتين الرأسيتين في الشريط الجانبي وسيربط بموضوع عنوان URL.
يمكنك تقسيم موضوع الفهرس إلى أقسام واستخدام قوائم متعددة مع عناوين (من أي مستوى) فوق كل قسم - سيتم عرضها بعد ذلك في الشريط الجانبي في هذه الأقسام.
إليك مثال لموضوع فهرس للبدء:
يمكنك البدء بوصف موجز اختياري للفئة.
## القسم الأول
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* عنوان مختصر: https://discourse.example.com/t/topic-with-a-long-title/56
* عنوان آخر: https://discourse.example.com/t/another-topic-with-a-long-title/78
## القسم الثاني
* عنوان الموضوع: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
سيؤدي هذا المثال إلى إخراج شريط جانبي للوثائق يبدو هكذا:
راجع موضوع فهرس فئة Documentation > Site Management كمثال على فهرس فئة وثائق قيد العمل: https://meta.discourse.org/t/site-management-index/308032
الحفاظ على مواضيع الفهرس
بينما لن يتم تحديث مواضيع الفهرس تلقائيًا عند إضافة محتوى أو إزالته أو تعديله في الفئة، تتضمن الإضافة تقارير جديدة تسلط الضوء على حيث توجد عدم اتساق داخل مواضيع الفهرس.
-
المواضيع غير المدرجة في الفهرس:
example.discourse.com/admin/reports/doc_categories_missing_topics
يعرض هذا التقرير أي مواضيع في فئات الوثائق التي لم تتم إضافتها إلى الفهرس. -
عناصر زائدة:
example.discourse.com/admin/reports/doc_categories_extraneous_items
يعرض هذا التقرير العناصر المدرجة في الفهرس والتي تبدو وكأنها لا ينبغي أن تكون هناك. سيشير التقرير إلى السبب الذي جعل الموضوع مدرجًا في التقرير - على سبيل المثال، إذا تم حذفه أو إذا كان في فئة مختلفة عن موضوع الفهرس الذي تم تضمينه فيه.
معلومات إضافية
إضافة السلسلة in:docs إلى مصطلح بحث سيبحث في جميع الفئات التي تم تحديدها للوثائق (أي أنها تحتوي على موضوع فهرس معين).
الحد الأقصى لعدد العناصر في الفهرس يتم تحديده بواسطة إعداد الموقع Max oneboxes per post، والذي يكون افتراضيًا 50. إذا كنت بحاجة إلى أكثر من 50 عنصر فهرس، فقم بزيادة الرقم في هذا الإعداد.





