فئات وثائق Discourse

||||\n-|-|-|\n:discourse2: | ملخص | يوفر Discourse Doc Categories القدرة على تخصيص فئات معينة للتوثيق، مما يتيح ميزات إضافية لها.\n:hammer_and_wrench: | رابط المستودع | \u003chttps://github.com/discourse/discourse-doc-categories\u003e\n:open_book: | دليل التثبيت | كيفية تثبيت الإضافات في Discourse\n\n[quote]\n\n:discourse2: نظرًا لأن هذه إضافة #رسمية تتم صيانتها بواسطة فريق Discourse، يمكن تقديم طلبات #الدعم و #الأخطاء و #تجربة المستخدم و #الميزات في الفئات المعنية هنا في Meta، ووضع علامة عليها بعلامة الإضافة المناسبة. انقر على رابط أدناه لبدء أحدها. :+1: \n\n\u003ckbd\u003e [:question:\u0026nbsp;الدعم](Discourse Meta "اطلب الدعم بشأن تكوين واستخدام Discourse Doc Categories") \u003c/kbd\u003e \u003ckbd\u003e [:bug:\u0026nbsp;خطأ](Discourse Meta "تقرير الخطأ يعني أن شيئًا ما معطل، مما يمنع الاستخدام العادي/النموذجي للإضافة") \u003c/kbd\u003e \u003ckbd\u003e [:eyes:\u0026nbsp;تجربة المستخدم](Discourse Meta "مناقشة حول واجهة المستخدم الخاصة بـ Discourse Doc Categories، وكيفية تقديم الميزات (بما في ذلك عناصر اللغة وواجهة المستخدم)") \u003c/kbd\u003e \u003ckbd\u003e [:bulb:\u0026nbsp;ميزة](Discourse Meta "مناقشة حول كيفية تحسين أو تعزيز ميزات Discourse Doc Categories الحالية، وكيف يمكن أن تعمل الميزات الجديدة المقترحة")\u003c/kbd\u003e\n\n[/quote]\n\n\u003e :warning: لاحظ أن هذه الإضافة قيد التطوير النشط ولم تكتمل بعد.\n \n## الميزات\n\nإضافة Discourse Doc Categories التي تتيح لك استضافة وثائق منظمة على منتدى Discourse موجود. تعمل عن طريق تخصيص فئات معينة للتوثيق، وتوفير ميزات لتسهيل العثور على مواضيع وثائق محددة.\n\nيمكنك رؤيتها أثناء العمل في فئة Documentation.\n\nعند تمييز فئة كموقع للتوثيق، يتم تمكين الميزات التالية لتلك الفئة:\n- موضوع محدد لاستخدامه كفهرس لجميع مواضيع التوثيق في الفئة\n- شريط جانبي جديد للتنقل بين المواضيع المختلفة في الفئة، بما في ذلك وظائف التصفية والبحث المدمجة\n- تقارير جديدة لمساعدتك في الحفاظ على سلامة مواضيع الفهرس\n\nبالإضافة إلى ذلك، تتعامل الإضافة مع عمليات إعادة التوجيه للمواقع التي تنتقل من إضافة Docs التي تم إيقافها. ستتم إعادة توجيه روابط التوثيق من تلك الإضافة إلى عناوين مواضيعها الحالية، وهناك إعداد لإعادة توجيه صفحة التوثيق الرئيسية السابقة إلى فئة التوثيق الرئيسية الخاصة بك.\n\n## التكوين\n\nإعدادات التكوين متاحة في example.discourse.com/admin/site_settings/category/doc_categories. ستجد هنا الإعدادات التالية:\n- doc categories enabled: حدد لتمكين إضافة Doc Categories.\n- doc categories docs legacy enabled: حدد هذا إذا كنت قد انتقلت من إضافة Docs التي تم إيقافها.\n- doc categories homepage: مع تمكين الإعداد السابق، ستتم إعادة توجيه الصفحة المقصودة من إضافة Docs التي تم إيقافها إلى هذا العنوان.\n\n

\n\nلتحديد الفئات التي سيتم استخدامها للتوثيق، قم بتعيين موضوع فهرس لها. للقيام بذلك، افتح إعدادات الفئة بالنقر على أيقونة :wrench: في صفحة الفئة. من هناك، انقر على رابط ‘Settings’ وقم بالتمرير لأسفل إلى قسم ‘Documentation mode’. استخدم حقل ‘Index topic’ لتحديد الموضوع الذي سيتم استخدامه كفهرس للفئة.\n\n\n\n## مواضيع الفهرس\n\nمواضيع الفهرس لفئة التوثيق تخدم غرضين:\n1. إنها قائمة مركزية بجميع المواضيع المدرجة في الفئة\n2. يتم ملء الشريط الجانبي المضمن مع هذه الإضافة بمحتوى موضوع الفهرس\n\n### تنسيق مواضيع الفهرس\n\nيمكن أن تتضمن مواضيع الفهرس أي محتوى تريده. لكي يعمل الشريط الجانبي بشكل صحيح، يجب أن تتضمن قائمة نقطية (أو قوائم نقطية متعددة) لمواضيع التوثيق. يمكن أن تكون هذه ببساطة عناوين URL للمواضيع في قائمة، وفي هذه الحالة سيعرض الشريط الجانبي العنوان الكامل لكل موضوع توثيق.\n\nقد لا يكون وجود العنوان الكامل في الشريط الجانبي عمليًا إذا كانت عناوينك أطول من بضع كلمات، لذلك لتعيين عناوين أقصر لموضوع معين، قم بسبق عنوان URL بعنوان مختصر متبوعًا بنقطتين رأسيتين (:). سيتم عرض كل النص قبل النقطتين الرأسيتين في الشريط الجانبي وسيرتبط بعنوان URL للموضوع.\n\nيمكنك تقسيم موضوع الفهرس الخاص بك إلى أقسام واستخدام قوائم متعددة مع عناوين (من أي مستوى) فوق كل منها - وسيتم عرضها بعد ذلك في الشريط الجانبي في هذه الأقسام.\n\nإليك مثال لموضوع فهرس لتبدأ به:\n\nmarkdown\nيمكنك البدء بوصف موجز اختياري للفئة.\n\n## القسم الأول\n* https://discourse.example.com/t/topic-title/12\n* https://discourse.example.com/t/another-topic-title/34\n* عنوان قصير: https://discourse.example.com/t/topic-with-a-long-title/56\n* عنوان آخر: https://discourse.example.com/t/another-topic-with-a-long-title/78\n\n## القسم الثاني\n* عنوان الموضوع: https://discourse.example.com/t/documentation-topic/98\n* https://discourse.example.com/t/new-topic/76\n\n\nسيؤدي هذا المثال إلى إنشاء شريط جانبي توثيق يبدو كالتالي:\n\n\n\n\u003e :eyes: انظر إلى موضوع الفهرس Documentation > Site Management كمثال لفهرس فئة توثيق أثناء العمل: \u003chttps://meta.discourse.org/t/site-management-index/308032\u003e\n\n### صيانة مواضيع الفهرس\n\nبينما لن يتم تحديث مواضيع الفهرس تلقائيًا مع إضافة المحتوى أو إزالته أو تحريره في الفئة، تتضمن الإضافة تقارير جديدة تسلط الضوء على التناقضات داخل مواضيع الفهرس.\n\n- المواضيع غير المفهرسة:\n example.discourse.com/admin/reports/doc_categories_missing_topics\n يعرض هذا التقرير أي مواضيع في فئات التوثيق لم تتم إضافتها إلى الفهرس.\n\n- العناصر الزائدة:\n example.discourse.com/admin/reports/doc_categories_extraneous_items\n يعرض هذا التقرير العناصر المدرجة في الفهرس التي تبدو وكأنها لا ينبغي أن تكون هناك. سيشير التقرير إلى سبب إدراج الموضوع في التقرير - على سبيل المثال، إذا تم حذفه أو كان في فئة مختلفة عن موضوع الفهرس الذي تم تضمينه فيه.\n\n## معلومات إضافية\n\nإضافة السلسلة النصية in:docs إلى مصطلح البحث ستبحث في جميع الفئات التي تم تمييزها للتوثيق (أي أنها تحتوي على موضوع فهرس معين).\n\nالحد الأقصى لعدد العناصر في الفهرس يتم تحديده بواسطة إعداد الموقع Max oneboxes per post، والذي يكون افتراضيًا 50. إذا كنت بحاجة إلى أكثر من 50 عنصر فهرس، قم بزيادة الرقم في هذا الإعداد.

33 إعجابًا

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