تصنيفات وثائق Discourse

||||
-|-|
:discourse2: | الملخص | يوفر إضافة فئات وثائق Discourse القدرة على تخصيص فئات معينة للوثائق، مما يتيح ميزات إضافية لها.
:hammer_and_wrench: | رابط المستودع | https://github.com/discourse/discourse-doc-categories
:open_book: | دليل التثبيت | كيفية تثبيت الإضافات في Discourse

:warning: يرجى ملاحظة أن هذه الإضافة قيد التطوير النشط وليست مكتملة بالكامل بعد.

الميزات

تتيح لك إضافة فئات وثائق 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 هذا.

لتحديد الفئات التي سيتم استخدامها للوثائق، قم بتعيين موضوع فهرس لها. للقيام بذلك، افتح إعدادات الفئة بالنقر على أيقونة :wrench: في صفحة الفئة. من هناك، انقر على رابط ‘الإعدادات’ وانتقل لأسفل إلى قسم ‘وضع الوثائق’. استخدم حقل ‘موضوع الفهرس’ لتحديد الموضوع الذي سيتم استخدامه كفهرس للفئة.

مواضيع الفهرس

تخدم مواضيع الفهرس لفئة الوثائق غرضين:

  1. هي قائمة مركزية لجميع المواضيع المدرجة في الفئة
  2. يتم ملء الشريط الجانبي المضمن مع هذه الإضافة بمحتوى موضوع الفهرس

تنسيق مواضيع الفهرس

يمكن أن تتضمن مواضيع الفهرس أي محتوى تريده. لكي يعمل الشريط الجانبي بشكل صحيح، يجب أن تتضمن قائمة نقطية (أو قوائم نقطية متعددة) من مواضيع الوثائق. يمكن أن تكون هذه ببساطة عناوين 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

سيؤدي هذا المثال إلى إخراج شريط جانبي للوثائق يبدو هكذا:

:eyes: راجع موضوع فهرس فئة 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 عنصر فهرس، فقم بزيادة الرقم في هذا الإعداد.

38 إعجابًا
New documentation plugin in development
Discourse vs Skool
Discourse Docs
How to create a sidebar similar to meta documentation sidebar?
Using Discourse as Learning Platform
Sub-sections on the sidebar without sub-categories
I am very interested in the 'documentation' feature
Using Discourse as an enterprise wiki library
How to arrange sub categories as list items under a category
Sub-sections on the sidebar without sub-categories
Custom topic ordering
Collections
Bulk Export of Raw Post Sources with Markup
Bulk Export of Raw Post Sources with Markup
Discourse Doc Categories is now available on Business
Discourse Docs
Discourse as an LMS / Discourse integration with an LMS
Topics (with replies) bumped on title edit
Theme customize - sidebar content
Questions about subcategories displaying in wiki sidebar
Doc pages - Schema Article
Structuring an active support community migrating from Facebook
Introducing simple mode for Discourse Doc Categories
Sidebar activation issues after recent Doc Categories update
How to add this header, colored categories, and sidebar categories?
What is the best way to Publish a book with chapters?
Sidebar spacing change?
Is there a plugin that allows you to organize all the URLs of a category into one topic?
Use more often placeholder forms in documentation topics?
Published Pages for documentation?
Need Help on Category on left sidebar
Displaying "full topic" text on category page + access to subcategory from menu bar
Custom Platform
Click a category to open a subcategory page
Discourse Doc Categories links not rendering
A better way to manage indices for Doc Categories?
A better way to manage indices for Doc Categories?
Create index topic

هذا لطيف جدًا.. كنت أبحث عن حلول أخرى لاستضافة المستندات ذاتيًا (قد يكون هيكل المنتدى مربكًا بعض الشيء للقراء الجدد).
حظًا موفقًا لـ Discourse (مقابل Gitbook والآخرين :smiley:)

6 إعجابات

أعتقد أن المكون discourse-doc-sidebar (هل تذكرت الاسم بشكل صحيح؟) لم يعد مطلوبًا؟

3 إعجابات

نعم - تم نقل المكون الذي تم بناؤه في الأصل لشريط التنقل الجانبي للتوثيق الجديد إلى هذا المكون الإضافي.

4 إعجابات

أعتقد أن هذا لم يعد يعمل مع العلامات؟ :slight_smile:

4 إعجابات

أنا أحب النهج المدمج بسلاسة في التنقل الرئيسي للنقاش بدلاً من نهج جديد تمامًا كما في إضافة المستندات.
سنكون سعداء بالتبديل!

إعجابَين (2)

أقوم فقط بإسقاط هذا هنا، ليس طلب ميزة أصلي على الإطلاق. على الرغم من أنه قد لا يتم تطبيق هذه الميزات على هذا المكون الإضافي تحديدًا، إلا أنني أعتقد أنها ميزات ممتازة لأي بيئة وثائق - كفائدة، يمكن أن تكون إضافات أساسية رائعة أيضًا. :thinking:

5 إعجابات

شيء مثل ميزة الحاشية السفلية، ولكن يتم تشغيله عالميًا بواسطة الكلمات الرئيسية سيكون ملحميًا لمثل هذه الميزة.

3 إعجابات

إذا كان لدينا معاينات عند التحويم، والتي تظهر على أي رابط داخلي في منتداك، فلن تحتاج حتى إلى هذا، يمكن لاستبدال الكلمات/الروابط التعامل مع هذا، ويحتاج المرء ببساطة إلى التحويم على هذه الكلمة وقراءة المنشور بالكامل دون فتحه :smiley:

الميزات مثل هذه مريحة للغاية (نظرًا لأنه لا أحد يحب قراءة المستندات، أليس كذلك؟) ومع إصدار هذه الإضافة، في منتصف رحلتي لاختيار أفضل حل لاستضافة مستنداتي، يجعل الأمر أكثر صعوبة بالنسبة لي :stuck_out_tongue: كنت أستكشف نقل مستنداتي إلى Quartz مع إدارة المحتوى في Obsidian.

إعجابَين (2)

هل هناك أي فرصة لأن يكون متوافقًا مع الإصدار المستقر 3.3؟

3 إعجابات

نعم، هذا متوافق تمامًا مع Discourse 3.3 :slight_smile:

إعجابَين (2)

لا، ليس كذلك:

/var/www/discourse/plugins/discourse-doc-categories/lib/doc_categories/initializers/invalidate_cache_on_enabled_setting_change.rb:8:in `apply': undefined method `on_enabled_change' for an instance of Plugin::Instance (NoMethodError)

** INCOMPATIBLE PLUGIN **
You are unable to start Discourse due to errors in the plugin at
/var/www/discourse/plugins/discourse-doc-categories

انظر DEV: Add plugin API to perform actions when the plugin is turned on/o… · discourse/discourse@366dfec · GitHub

4 إعجابات

عرض الرموز التعبيرية في العناوين والعناصر في الشريط الجانبي سيكون رائعًا!

3 إعجابات

مرحباً يا رفاق!

عذراً، كان هذا خطئي.

لقد ارتكبت خطأ عندما سألني هيو عما إذا كانت الإضافة متوافقة وافترضت أن واجهات برمجة التطبيقات الجديدة التي قدمتها في النواة عند تطويرها، قد تم تضمينها في الإصدار المستقر 3.3.

للأسف، لم يكن هذا هو الحال حقًا، وأول إصدار مستقر ستكون الإضافة متوافقة معه هو 3.4.

مرة أخرى، أعتذر عن هذا الالتباس.

6 إعجابات

ماذا عن علامة المجموعة والعلامات؟

3 إعجابات

شكراً للتوضيح، @saquetim!

لست متأكدًا مما تقصده هنا - هل يمكنك التوضيح قليلاً؟

ملحق المستندات، يمكننا عرض العلامات حسب المجموعة في الشريط الجانبي للتصفية.
هل يمكننا فعل الشيء نفسه باستخدام الملحق الجديد؟

إعجابَين (2)

لا يمكن للمكون الإضافي الجديد القيام بذلك حاليًا. قد يكون شيئًا نستكشفه في المستقبل، ولكن في الوقت الحالي ليس شيئًا نضيفه إليه.

إعجابَين (2)

نعم، نعم
شكراً جزيلاً!

إعجاب واحد (1)

أعتقد أنني غبي حقًا، لكنني أعتقد أنني فعلت كل شيء بشكل صحيح، فقد سميت موضوعًا ليكون فهرسًا لفئة، وقمت بتعيين المكون الإضافي للمستندات للإشارة إلى هذا الموضوع، لكنني ما زلت لا أرى شريطًا جانبيًا. هل هناك عرض توضيحي خطوة بخطوة ربما مع لقطات شاشة؟ لقد تعثرت في محاولة إعداد فئة مستندات. شكرًا!

إعجاب واحد (1)