||||
-|-|
| الملخص | سيسمح لك DiscoTOC بإنشاء جدول محتويات تفاعلي لمواضيعك بنقرة واحدة!
| 
| معاينة | معاينة على منشئ مواضيع Discourse |
| رابط المستودع | https://github.com/discourse/DiscoTOC
| جديد في مواضيع Discourse؟ | دليل المبتدئين لاستخدام مواضيع Discourse
تثبيت مكون الموضوع هذا
عينات
سطح المكتب
الجوال
الميزات
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: "سيحتوي هذا الموضوع على جدول محتويات"
هذا هو النص الذي يظهر في معاينة المحرر للإشارة إلى أنه سيتم إنشاء جدول محتويات للموضوع
كيف أنشئ جدول محتويات؟
- اكتب موضوعًا بعناوين صحيحة نحويًا
- انقر على زر جدول المحتويات في قائمة الترس (يظهر فقط عند إنشاء موضوع عادي - يتم تجاهل الردود والرسائل الخاصة)
- استمتع بالنتيجة.
ماذا يحدث لويدجت تقدم الموضوع عندما يحتوي الموضوع على جدول محتويات؟
كما يمكنك أن تتخيل على الأرجح، لا يوجد مساحة لعرض كليهما في نفس الوقت، لذا فإن طريقة عمل هذا المكون هي كالتالي
في موضوع يحتوي على جدول محتويات، يتم إخفاء ويدجت تقدم الموضوع بينما يكون المنشور الأول على الشاشة، وترى جدول المحتويات بدلاً من ذلك.
بمجرد تمريرك فوق المنشور الأول، لن يتحرك جدول المحتويات معك وسيظهر تقدم الموضوع بدلاً من ذلك أثناء قراءة أي ردود.
لذا، تحصل المنشورات الأولى على جدول المحتويات، وتحصل المنشورات اللاحقة على ويدجت تقدم الموضوع العادي.
يحدث هذا على كل من سطح المكتب والجوال.
هل هناك أي عيوب لاستخدام هذا المكون؟
لا شيء على علم به، جميع التغييرات تتم على جانب العميل. لذا يمكنك بسهولة إزالة المكون وستعود منشوراتك إلى الطريقة التي كانت عليها قبل تثبيته.
القيود
يفترض هذا المكون التخطيط القياسي للموضوع. لذلك، لن يعمل مع المواضيع التي تعدل ذلك التخطيط مثل موضوع Vincent. سيتم دعم المواضيع الشائعة التي تعدل التخطيط في مرحلة لاحقة على شكل إعدادات مكون.
الاعتماد
بدأت مع مكتبة tocify.js الخاصة بـ Greg Franko. ومع ذلك، يبدو أنها لم يتم تحديثها منذ فترة طويلة، لذا فإن هذا هو أساسًا شوكة صعبة تزيل الكثير من الميزات غير الضرورية، وتدمج وتُنسق الباقي لـ Discourse.
لذا، لا توجد طلبات خارجية والحجم الإجمالي هو ~ 4 كيلو بايت مضغوط.
شكرًا كبيرًا لـ @erlend_sh على الكثير من التعليقات القيمة ولـ @david على مساعدته في الترجمات.
مُستضاف من قبلنا؟ مكونات الموضوع متاحة للاستخدام في خطط Pro و Business و Enterprise لدينا.