NOTE: यह एक इनलाइन नोट एडमोनिशन है।
TIP: यह एक इनलाइन टिप एडमोनिशन है।AsciiDoc विशिष्ट सामग्री की ओर ध्यान आकर्षित करने के लिए पांच अंतर्निहित एडमोनिशन प्रकार प्रदान करता है। Toph प्रत्येक प्रकार को रंग-कोडित बाईं सीमा, हल्के रंग की पृष्ठभूमि और आइकन के साथ एक परिष्कृत कॉलआउट कार्ड के रूप में स्टाइल करता है।
एडमोनिशन प्रकार 🔗
AsciiDoc पांच एडमोनिशन प्रकार परिभाषित करता है, प्रत्येक अलग उद्देश्य के लिए।
Note | मुख्य पाठ का समर्थन करने वाली अतिरिक्त जानकारी या पूरक संदर्भ प्रदान करने के लिए नोट्स का उपयोग करें। |
Tip | पाठक की सहायता करने वाली सर्वोत्तम प्रथाओं, शॉर्टकट या सिफारिशों को साझा करने के लिए टिप्स का उपयोग करें। |
Warning | संभावित समस्याओं या नुकसानों के बारे में पाठक को सचेत करने के लिए चेतावनियों का उपयोग करें जिनके बारे में उन्हें पता होना चाहिए। |
Caution | उन कार्यों को चिह्नित करने के लिए सावधानियों का उपयोग करें जो लापरवाही से किए जाने पर नुकसान, डेटा हानि या अनपेक्षित परिणाम पैदा कर सकते हैं। |
Important | महत्वपूर्ण जानकारी को उजागर करने के लिए इम्पॉर्टेंट एडमोनिशन का उपयोग करें जिसे पाठक को नजरअंदाज नहीं करना चाहिए। |
ब्लॉक एडमोनिशन 🔗
एडमोनिशन AsciiDoc के ब्लॉक सिंटैक्स का उपयोग करके कई पैराग्राफ तक भी फैल सकते हैं। यह तब उपयोगी होता है जब संदेश को एक वाक्य से अधिक की आवश्यकता हो।
Note | ब्लॉक एडमोनिशन चार बराबर चिह्नों के साथ डिलिमिटर सिंटैक्स का उपयोग करते हैं। इनमें कई पैराग्राफ, सूचियां और अन्य AsciiDoc तत्व हो सकते हैं। यह उसी एडमोनिशन ब्लॉक के अंदर दूसरा पैराग्राफ है। |
Tip | दस्तावेज़ लिखते समय, विचार करें कि कौन सा एडमोनिशन प्रकार आपके संदेश के लिए सबसे उपयुक्त है।
|
Warning | एडमोनिशन का उपयोग सीमित मात्रा में किया जाना चाहिए। अत्यधिक उपयोग उनके प्रभाव को कम करता है और सामग्री को स्कैन करना कठिन बनाता है। |
सिंटैक्स 🔗
AsciiDoc में एडमोनिशन लिखने के दो तरीके हैं।
इनलाइन सिंटैक्स 🔗
सबसे सरल रूप एडमोनिशन लेबल को पैराग्राफ की शुरुआत में रखता है:
ब्लॉक सिंटैक्स 🔗
बहु-पैराग्राफ एडमोनिशन के लिए, ब्लॉक डिलिमिटर का उपयोग करें:
[NOTE]
====
एडमोनिशन का पहला पैराग्राफ।
एडमोनिशन का दूसरा पैराग्राफ।
====