Mac पर Obsidian में Mermaid स्टेट डायग्राम को सरल बनाने के लिए, हर मान्य संक्रमण को स्पष्ट रखें, लेबल छोटे करें और पढ़ने की दिशा जाँचें। परिणाम स्वीकार करने से पहले स्रोत, गंतव्य और संक्रमण-पाठ की तुलना करें।
इस चरण-दर-चरण मार्गदर्शिका में चार कृत्रिम अवस्थाओं, A से D तक, का उपयोग किया गया है। उद्देश्य एक डायग्राम को पढ़ने में आसान बनाना है, जबकि उसके सीधे संक्रमण, वापसी-पथ और आरंभ तथा अंत के चिह्न सुरक्षित रहें। संक्रमण तालिका यह जाँचने का ठोस तरीका देती है कि तीरों को रेंडरर कैसे भी व्यवस्थित करे, उनका मूल ढाँचा बरकरार है।
डायग्राम को सरल बनाते समय क्या अपरिवर्तित रहना चाहिए?
शुरुआत में प्रस्तुति में होने वाले बदलावों को मॉडल में होने वाले बदलावों से अलग रखें। छोटे प्रदर्शन-लेबल और पढ़ने की अलग दिशा पठनीयता बेहतर कर सकते हैं। कोई तीर हटाने से सीधे संक्रमणों का समुच्चय बदल जाता है, भले ही किसी दूसरे मार्ग से अंततः वही गंतव्य मिल जाए।
उदाहरण के लिए, मान लें कि A से C तक सीधा संक्रमण भी है और B से होकर जाने वाला मार्ग भी। सीधा संक्रमण हटाने से पाठक को B पर बीच में जाने का अनुमान लगाना पड़ेगा। गंतव्य तक पहुँचना संभव रहेगा, लेकिन एक चरण वाले मान्य संक्रमण की जानकारी खो जाएगी। इस काम में अंततः उसी गंतव्य तक पहुँचना पर्याप्त नहीं है।
नीचे दी गई संक्रमण सूची को मूल विनिर्देश मानें। लेबल कृत्रिम घटना-नाम हैं; इस उदाहरण में उनका अर्थ है और उन्हें अपने मूल तीरों से जुड़ा रहना चाहिए।
| स्रोत | गंतव्य | संक्रमण-पाठ |
|---|---|---|
| आरंभ | A |
कोई नहीं |
A |
B |
step |
A |
C |
alternate |
B |
C |
next |
B |
A |
reset |
C |
B |
back |
C |
A |
reset |
C |
D |
finish |
D |
अंत | कोई नहीं |
आरंभ और अंत सहित कुल नौ संक्रमण हैं। दो तीरों का लेबल reset एक जैसा है, लेकिन वे अलग-अलग अवस्थाओं से शुरू होते हैं। दोनों रखें। इसी तरह, B और C के बीच के तीरों की दिशाएँ और लेबल अलग हैं; वे अलग संक्रमण हैं।
बड़े डायग्राम के लिए संपादन से पहले हर संक्रमण को स्रोत, गंतव्य और पाठ के संयोजन के रूप में दर्ज करें। यदि आपके मूल पाठ में शर्तें या क्रियाएँ हैं, तो उन्हें भी सुरक्षित रखें। केवल तीरों की कुल संख्या मिलाने से यह पता नहीं चलता कि किसी तीर का गंतव्य या लेबल बदल गया है।
जाँचें कि आपके इंस्टॉल किए हुए Obsidian में कौन-सा रेंडरर है
अपने Mac पर साइडबार के गियर से Settings खोलें, फिर General चुनें। ऊपर दिखाई गई मौजूदा ऐप्लिकेशन और इंस्टॉलर की संस्करण-संख्या दर्ज करें। संबंधित रिलीज़ नोट खोजते समय ऐप्लिकेशन संस्करण का उपयोग करें। इन स्थानों का विवरण Obsidian की Settings सहायता में है।
रेंडरर की सीमा मायने रखती है। Obsidian की 1.15.0 Desktop early-access रिलीज़, दिनांक 22 अक्टूबर, 2026, डायग्राम रेंडरिंग को Pele पर ले जाती है और Mermaid 12.1.0 सिंटैक्स के साथ अनुकूलता बताती है। रिलीज़ नोट्स यह भी कहते हैं कि इस संस्करण में Mermaid लाइब्रेरी अब शामिल नहीं है। यह कथन बताई गई रिलीज़ पर लागू होता है; इससे हर इंस्टॉल किए गए Obsidian संस्करण का रेंडरर ज्ञात नहीं होता। Obsidian 1.15.0 Desktop रिलीज़ नोट्स देखें।
सिंटैक्स की अनुकूलता और दृश्य रूप को अलग-अलग जाँचें। किसी दूसरे संपादक में स्वीकार किया गया डायग्राम उपयोगी तुलना हो सकता है, लेकिन अंतिम परिणाम की पुष्टि अपने इंस्टॉल किए गए ऐप्लिकेशन में करें। यह न मानें कि किसी अपस्ट्रीम लेआउट सेटिंग या नए दस्तावेज़ीकरण उदाहरण का व्यवहार आपके स्थानीय रेंडरर में भी वैसा ही होगा।
नीचे दिया गया उदाहरण जान-बूझकर रेंडरर कॉन्फ़िगरेशन, थीम सेटिंग और स्टाइलिंग का उपयोग नहीं करता। यदि आपके पास पहले से काम करने वाला डायग्राम है, तो उसकी मौजूदा डायग्राम घोषणा से शुरू करें और प्रस्तुति का एक पहलू एक बार में बदलें। यहाँ बताए गए संक्रमणों की सूची और लेबल-संपादन करने के लिए अपग्रेड आवश्यक नहीं है।
स्पष्ट संक्रमणों वाला संक्षिप्त संस्करण बनाएँ
नीचे दिया गया पूरा उदाहरण सूची की सभी नौ पंक्तियों को लागू करता है। इसके दिखने वाले अवस्था-नाम जान-बूझकर छोटे रखे गए हैं। अवस्था A आरंभ-बिंदु है, B और C के वापसी-पथ हैं, और केवल D में अंत के चिह्न तक जाने वाला संक्रमण है।
Mermaid अपने स्टेट डायग्राम संदर्भ में अवस्था उपनाम, लेबल वाले संक्रमण, आरंभ और अंत के चिह्न तथा दिशा-विवरण का दस्तावेज़ देता है। Obsidian में इसे डालने का दस्तावेज़ीकृत तरीका mermaid भाषा पहचानकर्ता वाला फ़ेंस्ड कोड ब्लॉक है, जैसा कि Advanced formatting syntax में बताया गया है।
```mermaid
stateDiagram-v2
direction LR
state "Stage A" as A
state "Stage B" as B
state "Stage C" as C
state "Stage D" as D
[*] --> A
A --> B : step
A --> C : alternate
B --> A : reset
B --> C : next
C --> A : reset
C --> B : back
C --> D : finish
D --> [*]
```
इस पूरे Markdown उदाहरण को, उसकी खुलने वाली और बंद होने वाली तीन बैकटिक वाली पंक्तियों सहित, किसी नोट में पेस्ट करें। यहाँ दिखाया गया बाहरी चार-बैकटिक फ़ेंस इस लेख में उदाहरण को प्रदर्शित करने के लिए है; यह नोट की सामग्री का हिस्सा नहीं है।
सटीक पाठ देखने के लिए Source mode का उपयोग करें। रेंडर किया हुआ परिणाम देखने के लिए Reading view पर जाएँ; macOS पर Cmd+E पढ़ने और संपादन दृश्य के बीच टॉगल करता है। Obsidian इन नियंत्रणों को Views and editing mode में समझाता है।
संक्रमण कथनों को उनके स्रोत अवस्था के अनुसार समूहित किया गया है, ताकि हर अवस्था के आगे जाने वाले विकल्पों की एक साथ समीक्षा की जा सके। यह व्यवस्था स्रोत-पाठ को सँभालने में मदद करती है; इसे इस बात की गारंटी न मानें कि रेंडरर हर अवस्था को कहाँ रखेगा।
उदाहरण को नोट की उस चौड़ाई पर आज़माएँ जिसका आप आम तौर पर उपयोग करते हैं। फिर केवल direction LR पंक्ति हटाकर परिणाम की तुलना करें। जिस प्रस्तुति में शाखाओं और वापसी-पथों का अनुसरण करना आसान हो, उसे रखें। बाएँ-से-दाएँ डायग्राम को अधिक क्षैतिज जगह चाहिए हो सकती है, इसलिए परिणाम को वास्तविक नोट पैन में देखकर परखें।
लेबल को केवल उतना ही छोटा करें जितना उनका अर्थ अनुमति देता है। इस कृत्रिम उदाहरण में Stage B को और समझाने की ज़रूरत नहीं है। अपने डायग्राम में ऐसे शब्द रखें जो दो अवस्थाओं में अंतर स्पष्ट करते हों। यदि लंबी व्याख्या ज़रूरी हो, तो उसे पास के गद्य अनुच्छेद में रखें और अवस्था पहचानकर्ता से स्पष्ट संबंध बनाए रखें।
कौन-से शॉर्टकट मॉडल बदल सकते हैं?
दोहराए गए तीर आपको एक साझा मध्यवर्ती नोड बनाने के लिए प्रेरित कर सकते हैं। ऐसा करने से पहले पूछें कि वह नोड किस चीज़ को दर्शाता है और क्या मूल सीधे संक्रमण अब भी मौजूद हैं।
साझा रीसेट नोड सीधे मार्गों को बदल देता है
सूची में, B और C दोनों reset पर सीधे A में संक्रमण करते हैं। उन तीरों को R नाम की नई अवस्था से होकर जाने वाले मार्गों से बदलने पर एक मध्यवर्ती अवस्था जुड़ जाती है और मूल सीधे किनारे हट जाते हैं। पाठक अब भी A तक का मार्ग खोज सकता है, लेकिन डायग्राम अब अलग-अलग चरण बताता है।
इस लेख में बताए गए सटीक परिणाम के लिए दोनों रीसेट तीर रखें। उनका दोहराव एक ही घटना के लिए दो मान्य आरंभिक स्थितियाँ दर्ज करता है। उनका दृश्य आकार घटाना तभी उपयोगी है जब उनका अर्थ बना रहे।
किसी विकल्प या फोर्क के लिए मॉडल में कारण होना चाहिए
Mermaid रास्तों में शाखाएँ बनाने के लिए <<choice>> और फोर्क तथा जॉइन संरचनाओं के लिए <<fork>> और <<join>> का दस्तावेज़ देता है। स्टेट डायग्राम संदर्भ में ये अलग-अलग डायग्राम संरचनाएँ हैं।
केवल बेतरतीब तीरों को एक साझा जोड़ पर इकट्ठा करने के लिए इनमें से कोई संरचना न जोड़ें। इस उदाहरण का उद्देश्य अवस्था-से-अवस्था के सीधे संक्रमण सुरक्षित रखना है। कोई मध्यवर्ती संरचना जोड़ने के लिए अलग से समझाना होगा कि उसके रास्ते मूल मॉडल से कैसे मेल खाते हैं। स्पष्ट तीर यह संबंध तुरंत दिखाते हैं।
कंपोज़िट अवस्थाओं की एक दस्तावेज़ीकृत सीमा है
Mermaid कंपोज़िट अवस्थाओं का समर्थन करता है, लेकिन उसके दस्तावेज़ों के अनुसार अलग-अलग कंपोज़िट अवस्थाओं से संबंधित आंतरिक अवस्थाओं के बीच संक्रमण की अनुमति नहीं है। Composite states देखें।
यदि आपके नोड समूहित करने से ऐसी स्थिति बनती है, तो इस काम के लिए जुड़े हुए नोड समतल ही रखें। किसी तीर को बाहरी कंपोज़िट पर ले जाने से उसका अंतिम बिंदु बदल जाता है; यह अपने-आप में समतुल्य बदलाव नहीं है। पदानुक्रम तभी उपयोग करें जब वह मॉडल की वास्तविक संरचना दर्शाता हो और आप उसके प्रवेश तथा निकास व्यवहार को समझा सकें।
चार अवस्थाओं वाले इस उदाहरण में नेस्टिंग से बहुत कम लाभ मिलता है। उपयोगी सरलीकरण यह है कि संक्रमण संरचना को जस का तस रखते हुए लेबल छोटे और प्रस्तुति स्पष्ट करें।
संक्रमणों और रेंडर किए गए परिणाम—दोनों की पुष्टि करें
मूल डायग्राम बदलने से पहले दो चरणों में जाँचें। पहला मॉडल की जाँच करता है; दूसरा देखता है कि चुनी हुई प्रस्तुति उपयोगी है या नहीं।
- सूची की हर पंक्ति की संक्रमण कथन से तुलना करें। दोनों अंतिम बिंदुओं और पूरे लेबल की पुष्टि करें।
- हर संक्रमण कथन की सूची से वापस तुलना करें। इससे अतिरिक्त तीरों के साथ-साथ छूटे हुए तीर भी पकड़ में आते हैं।
- आरंभ और अंत को अलग-अलग जाँचें। यहाँ आरंभ केवल
Aतक जाता है और केवलDअंत तक जाता है। - रेंडर किए गए डायग्राम में देखें कि लेबल पढ़ने योग्य हैं और तीरों के सिरे अलग-अलग पहचान में आते हैं।
BऔरCसे लौटने वाले रास्तों का अनुसरण करें, क्योंकि केवल आगे बढ़ने की दिशा की समीक्षा करते समय इन्हें आसानी से अनदेखा किया जा सकता है।
इस उदाहरण के लिए पढ़ने की तीन जाँचें करें: आरंभ से A, फिर C, फिर D, और उसके बाद अंत तक; आरंभ से A, फिर B, और रीसेट होकर A तक; और आरंभ से A, फिर C, और वापस B तक। ये जाँचें वैकल्पिक मार्ग, रीसेट और उलटे संबंध को परखती हैं। ये पंक्ति-दर-पंक्ति तुलना का पूरक हैं, उसका विकल्प नहीं।
एक नियतात्मक पाठ तुलना ने पुष्टि की कि उदाहरण के नौ संक्रमण कथन उनके लेबल सहित सूची से मेल खाते हैं। तैयारी के दौरान उदाहरण को किसी इंस्टॉल किए गए Obsidian ऐप्लिकेशन में रेंडर नहीं किया गया था, इसलिए अंतिम दूरी और तीरों की दिशा की पुष्टि आपके स्थानीय संस्करण में करनी होगी।
यदि नोट में कोड ज्यों का त्यों दिखता है, तो पहले पुष्टि करें कि आप इसे Reading view में देख रहे हैं और खुलने वाले फ़ेंस में mermaid लिखा है। यदि संपादन के बाद पार्सिंग त्रुटि आए, तो पूरे उदाहरण पर लौटें और एक बार में एक बदलाव फिर से लागू करें। यदि केवल लेआउट अटपटा लगे, तो संक्रमण सुरक्षित रखते हुए लेबल की लंबाई, दिशा और उपलब्ध पैन की चौड़ाई की तुलना करें।
सूची से तुलना सफल होने के बाद वही संस्करण रखें जिसके लेबल और रास्ते पढ़ने में सबसे आसान हों। सफल सरलीकरण पाठक को उन्हीं मान्य संक्रमणों का कम प्रयास में अनुसरण करने देता है, जबकि स्रोत-पाठ को देखना और सँभालना आसान बना रहता है।
स्रोत
- State diagrams — Mermaid
- Settings — Obsidian
- Obsidian 1.15.0 Desktop (Early access) — Obsidian
- Advanced formatting syntax — Obsidian
- Views and editing mode — Obsidian