DiscoTOC - فهرس محتويات تلقائي

[Discourse]

||||
-|-|
| الملخص | سيسمح لك DiscoTOC بإنشاء جدول محتويات تفاعلي لمواضيعك بنقرة واحدة!
| | معاينة | معاينة على منشئ مواضيع Discourse |
| رابط المستودع | https://github.com/discourse/DiscoTOC
| جديد في مواضيع Discourse؟ | دليل المبتدئين لاستخدام مواضيع Discourse

تثبيت مكون الموضوع هذا

نظرًا لأن هذا مكون موضوع official (رسمي) يحافظ عليه فريق Discourse، يمكن تقديم طلبات Support (الدعم)، و Contribute > Bug (الأخطاء)، و Contribute > UX (تجربة المستخدم)، و Contribute > Feature (الميزات) في الفئات ذات الصلة هنا في Meta، مع وسمها بوسم مكون الموضوع المناسب. انقر على أحد الروابط أدناه لبدء واحدة.

 الدعم  الخطأ  تجربة المستخدم  ميزة

عينات

سطح المكتب

الجوال

الميزات

toc = جدول المحتويات

• يولد جدول المحتويات بالكامل تلقائيًا عبر زر في قائمة ترس المحرر

• سيظل جدول المحتويات دائمًا على الشاشة - يتحرك مع المحتوى مثل ويدجت تقدم الموضوع

• أثناء التمرير عبر الأقسام في الموضوع، سيتم تعيين العنصر النشط في جدول المحتويات كعنصر نشط (تظليل أزرق)

• يضيف سمات id للعناوين (يمكنك ربط قسم معين من موضوع آخر / منشور)

• النقر على أي رابط في جدول المحتويات سيوجه المتصفح إلى القسم ذي الصلة (تمرير سلس)

• يضيف رابطًا قابلاً للنسخ بجانب كل عنوان (إذا أردت ربطه)

• دعم اتجاه النص من اليمين إلى اليسار (RTL)

• تعتمد الألوان على لوحة الألوان النشطة الحالية لديك

كيف يعمل؟

باختصار، يبحث عن العناوين في المواضيع التي تم تحديد علامتها ليكون لها جدول محتويات (عبر زر المحرر) وإذا اتضح أن الموضوع الحالي مُعلَّم، فإنه يأخذ جميع العناوين ويضعها في جدول المحتويات (مُتداخلة حسب مستوى العنوان) - وهذا يعني أن تنسيق Markdown الخاص بك يجب أن يكون صحيحًا من الناحية النحوية.

# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5
###### heading 6

يمكنك العودة للأمام والخلف في مستويات العناوين بحرية، ولكن يجب أن يكون الترتيب صحيحًا

# heading 2 
## heading 3
## heading 3
### heading 4
## heading 3
# heading 2

etc...

لكي تعمل الروابط في جدول المحتويات، يجب أن يكون للعناوين سمات id. سيتحقق المكون مما إذا كانت العناوين تحتوي بالفعل على معرفات وإذا كانت كذلك، فسيتم احترامها. هذا مفيد إذا قمت بإنشاء جدول محتويات يدويًا في أي وقت.

إذا لم تكن للعناوين معرفات، فسيتم إنشاء معرف لكل عنوان بناءً على نصه (يتم إزالة الأحرف غير المرغوب فيها)

بمجرد الانتهاء من ذلك، سيضيف أيضًا رابطًا بجانب كل زر يربط مباشرة بذلك القسم:

الإعدادات

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

الترجمات

الترجمة	الافتراضي
table_of_contents	جدول المحتويات
insert_table_of_contents	إدراج جدول المحتويات
jump_bottom	القفز إلى النهاية
toggle_toc.show_timeline	الجدول الزمني
toggle_toc.show_toc	المحتويات

يأتي الموضوع مع ثلاث سلاسل يمكنك ترجمتها أو تغييرها.

table_of_contents: "جدول المحتويات"

يُستخدم هذا للزر الذي يفتح جدول المحتويات على الجوال

insert_table_of_contents: "إدراج جدول المحتويات"

يُستخدم هذا كنص لزر جدول المحتويات في قائمة ترس المحرر

topic_will_contain_a_table_of_contents: "سيحتوي هذا الموضوع على جدول محتويات"

هذا هو النص الذي يظهر في معاينة المحرر للإشارة إلى أنه سيتم إنشاء جدول محتويات للموضوع

كيف أنشئ جدول محتويات؟

1. اكتب موضوعًا بعناوين صحيحة نحويًا
2. انقر على زر جدول المحتويات في قائمة الترس (يظهر فقط عند إنشاء موضوع عادي - يتم تجاهل الردود والرسائل الخاصة)
3. استمتع بالنتيجة.

ماذا يحدث لويدجت تقدم الموضوع عندما يحتوي الموضوع على جدول محتويات؟

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

في موضوع يحتوي على جدول محتويات، يتم إخفاء ويدجت تقدم الموضوع بينما يكون المنشور الأول على الشاشة، وترى جدول المحتويات بدلاً من ذلك.

بمجرد تمريرك فوق المنشور الأول، لن يتحرك جدول المحتويات معك وسيظهر تقدم الموضوع بدلاً من ذلك أثناء قراءة أي ردود.

لذا، تحصل المنشورات الأولى على جدول المحتويات، وتحصل المنشورات اللاحقة على ويدجت تقدم الموضوع العادي.

يحدث هذا على كل من سطح المكتب والجوال.

هل هناك أي عيوب لاستخدام هذا المكون؟

لا شيء على علم به، جميع التغييرات تتم على جانب العميل. لذا يمكنك بسهولة إزالة المكون وستعود منشوراتك إلى الطريقة التي كانت عليها قبل تثبيته.

القيود

يفترض هذا المكون التخطيط القياسي للموضوع. لذلك، لن يعمل مع المواضيع التي تعدل ذلك التخطيط مثل موضوع Vincent. سيتم دعم المواضيع الشائعة التي تعدل التخطيط في مرحلة لاحقة على شكل إعدادات مكون.

الاعتماد

بدأت مع مكتبة tocify.js الخاصة بـ Greg Franko. ومع ذلك، يبدو أنها لم يتم تحديثها منذ فترة طويلة، لذا فإن هذا هو أساسًا شوكة صعبة تزيل الكثير من الميزات غير الضرورية، وتدمج وتُنسق الباقي لـ Discourse.

لذا، لا توجد طلبات خارجية والحجم الإجمالي هو ~ 4 كيلو بايت مضغوط.

شكرًا كبيرًا لـ @erlend_sh على الكثير من التعليقات القيمة ولـ @david على مساعدته في الترجمات.

مُستضاف من قبلنا؟ مكونات الموضوع متاحة للاستخدام في خطط Pro و Business و Enterprise لدينا.

[mentalstring (Paulo)]

لا أعرف كيف يتم تنفيذ هذه المكونة ولا الكثير عن هيكل الواجهة الأمامية لـ Discourse، لذا يمكنني فقط تقديم تخمين.

@tobiaseigen

لذا فإن عرض كليهما في نفس الوقت غير عملي بعض الشيء.

ألا يمكن عرض شريط التقدم فقط أ) إذا كان هناك أكثر من مشاركة واحدة في الموضوع و ب) تعديل بدايته لتبدأ من المشاركة الثانية (بدلاً من الثالثة)، ولكن أيضًا ج) إضافة هامش سفلي/علوي مريح لأحد العنصرين للتأكد من أن الآخر يظل بعيدًا بما فيه الكفاية (مثل 1vh) حتى لا يبدو غريبًا؟

بعبارة أخرى، بدلاً من استخدام المشاركة الثانية بأكملها كفجوة، استخدم CSS للسماح ببعض المساحة بينهما (إذا كان هناك أكثر من مشاركة واحدة).

مرة أخرى، قد لا يكون لهذا أي معنى على الإطلاق لأنني لا أعرف الكثير عن الطريقة التي يعمل بها هذا في الوقت الحالي.

[AndyB (Andy Benditt)]

مرحباً! لقد قمنا مؤخراً بتثبيت DiscoTOC لمنتدياتنا وكنا نتساءل عما إذا كان من الممكن جعل المكون يقرأ النص البديل (alt text) في الصور؟ لقد استخدمنا صوراً لبعض رؤوس ملاحظات الإصدار…

على هذا النحو:

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

[simon]

@AndyB

لقد قمنا مؤخرًا بتثبيت DiscoTOC لمنتدياتنا وكنا نتساءل عما إذا كان من الممكن جعل المكون يقرأ النص البديل (alt text) في الصور؟

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

[AndyB (Andy Benditt)]

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

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

[TheOctopus]

تعمل وظيفة مرساة العنوان (heading anchor) في هذا المكون على التعارض قليلاً مع وظيفة روابط العنوان التلقائية (Automatic header links) المضافة في 2.7.0beta6، حيث تحصل العناوين على أيقونتين عند التمرير فوقها، واحدة من Discourse والأخرى من DiscoTOC. هل هناك طريقة لتجاوز هذا؟

[Don]

مرحباً،

يمكنك إخفاء مرساة Automatic header links باستخدام

.anchor {
  display: none;
}

[neo (R.Zhang)]

مرحباً dodesz،

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

شكراً!

[fkohrt]

على منتدى يعمل بإصدار Discourse 2.8.0.beta4 (90232af778)، يؤدي تضمين مكون DiscoTOC إلى ظهور رسالة خطأ:

تم تنشيط المكون سابقًا وأثار مشكلة مع إصدار Discourse المثبت مسبقًا أيضًا، على الرغم من أنني لا أستطيع تحديد الإصدار الذي كان عليه.

[simon]

هل يمكنك العثور على أي رسائل خطأ متعلقة بالمشكلة في سجلات أخطاء موقعك؟

[Falco]

رسالة الخطأ تلك هي خطأ في الواجهة الخلفية (backend)، بينما DiscoTOC هو مكون سمة للواجهة الأمامية (front-end)، لذا من الصعب أن يكونا مرتبطين. هل لديك أي إضافات (plugins) مثبتة؟

[fkohrt]

@simon

هل يمكنك العثور على أي رسائل خطأ متعلقة بالمشكلة في سجلات أخطاء موقعك؟

للأسف، لم أتمكن من العثور على أي شيء مفيد في /logs.

@Falco

هل لديك أي إضافات (plugins) مثبتة؟

لدي، إليك المقتطف ذي الصلة من app.yml:

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          - git clone https://github.com/discourse/docker_manager.git
          - git clone https://github.com/discourse/discourse-openid-connect.git
          - git clone https://github.com/discourse/discourse-checklist.git
          - git clone https://github.com/discourse/discourse-push-notifications.git
          - git clone https://github.com/discourse/discourse-characters-required.git
          - git clone https://github.com/angusmcleod/discourse-news.git
          - git clone https://github.com/discourse/discourse-data-explorer.git
          - git clone https://github.com/DNOeV/discourse-watch-category.git
          - git clone https://github.com/discourse/discourse-footnote.git
          - git clone https://github.com/discourse/discourse-knowledge-explorer.git

[debryc (Deborah Chang)]

عندما يكون العنوان داخل اقتباس، لا يظهر العنوان في جدول المحتويات. هل يمكن تغيير هذا السلوك؟

هذا العنوان لن يظهر في جدول المحتويات

محتوى مقتبس

هذا العنوان يظهر في جدول المحتويات

محتوى مقتبس

[Jagster (Jakke Flemming)]

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

[JammyDodger]

هل يمكنك المحاولة باستخدام وسم HTML <blockquote> بدلاً من ذلك؟ سيسمح ذلك للعنوان # بأن يكون في بداية السطر.

مثال:

<blockquote>

### عنوان المرساة
 
</blockquote>

عنوان المرساة

لم أجربه في جدول المحتويات (TOC)، ولكنه يبدو أنه يعمل مع العناوين ذاتية الربط في منشور عادي.

[tobiaseigen]

لماذا تريد أن تظهر العناوين داخل علامات الاقتباس في جدول المحتويات؟ ما هي حالة الاستخدام الخاصة بك؟

[debryc (Deborah Chang)]

@JammyDodger

هل يمكنك محاولة استخدام وسم HTML <blockquote> بدلاً من ذلك؟ سيسمح ذلك بظهور العنوان # في بداية السطر.

شكرًا لك على الفكرة. لكنها لم تنجح معي.

@tobiaseigen

لماذا تريد أن تظهر العناوين داخل الاقتباسات في جدول المحتويات (TOC)؟ ما هي حالة الاستخدام الخاصة بك؟

إليك مثال على متى أستخدم الاقتباسات لتنظيم المحتوى بصريًا بدءًا من منطقة المشكلة: العمر

A Progressive's Style Guide: Toward Harnessing Language in Support of...

[Jagster (Jakke Flemming)]

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

[Jagster (Jakke Flemming)]

هل هذه مشكلة (bug) أم مجرد مستخدم آخر، ولكن… كيف يجب أن أغلق جدول المحتويات (TOC)؟ كنت أبحث عن بعض التعليمات الأساسية حول كيفية استخدام الرسائل الخاصة من قبل المستخدم النهائي وبالطبع ذهبت إلى وثيقة المستخدمين الجدد وفتحت جدول المحتويات لمعرفة ما إذا كان هناك أي معلومات.

كنت أستخدم جهاز iPad وDiscourseHub.

لقد حصلت على هذا:

جدول المحتويات جيد تمامًا. لكنه يتداخل مع النص ولم أتمكن من إخفائه مرة أخرى. فما الخطأ الذي ارتكبته بحق الجحيم، أو لم أرتكب أي خطأ على الإطلاق