دعم تنبيهات AsciiDoc

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

أنواع التنبيهات 🔗

يحدد AsciiDoc خمسة أنواع من التنبيهات، لكل منها غرض مختلف.

Note
استخدم الملاحظات لتقديم سياق إضافي أو معلومات تكميلية تدعم النص الرئيسي.
Tip
استخدم النصائح لمشاركة أفضل الممارسات أو الاختصارات أو التوصيات التي تساعد القارئ.
Warning
استخدم التحذيرات لتنبيه القارئ إلى المشكلات أو المخاطر المحتملة التي يجب أن يكون على علم بها.
Caution
استخدم تنبيهات الحذر للإشارة إلى الإجراءات التي قد تسبب ضررًا أو فقدانًا للبيانات أو عواقب غير مقصودة إذا تم تنفيذها بلا حذر.
Important
استخدم التنبيهات المهمة لإبراز المعلومات الحاسمة التي يجب ألا يتجاهلها القارئ.

التنبيهات الكتلية 🔗

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

Note

تستخدم التنبيهات الكتلية صيغة المحدد بأربع علامات يساوي. يمكن أن تحتوي على عدة فقرات وقوائم وعناصر AsciiDoc أخرى.

هذه فقرة ثانية داخل نفس كتلة التنبيه.

Tip

عند كتابة التوثيق، ضع في اعتبارك أي نوع من التنبيهات يناسب رسالتك بشكل أفضل.

  • NOTE للسياق التكميلي

  • TIP للنصائح العملية

  • WARNING للمخاطر المحتملة

  • CAUTION لخطر الضرر أو فقدان البيانات

  • IMPORTANT للمعلومات الحاسمة

Warning

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

الصيغة 🔗

هناك طريقتان لكتابة التنبيهات في AsciiDoc.

الصيغة المضمنة 🔗

يضع الشكل الأبسط تسمية التنبيه في بداية الفقرة:

NOTE: هذه ملاحظة مضمنة.

TIP: هذه نصيحة مضمنة.

صيغة الكتلة 🔗

للتنبيهات متعددة الفقرات، استخدم محدد الكتلة:

[NOTE]
====
الفقرة الأولى من التنبيه.

الفقرة الثانية من التنبيه.
====

لمعرفة المزيد 🔗