मैं डॉक्सिजन में मार्कडाउन दस्तावेज़ों के बीच कैसे लिंक करूं?

Question

मैं markdown पृष्ठों का एक सेट है कि इस तरह

[Go to this page](subdir/MyOtherPage.md) 

पृष्ठों सभी Doxygen द्वारा उठाया और उत्पादन में प्रदर्शित करने के रूप में लिंक के साथ आपस में जुड़े हैं के साथ एक परियोजना है, लेकिन लिंक को इंगित करने के लिए परिवर्तित नहीं कर रहे हैं उनके नया एचटीएमएल प्रस्तुतिकरण।

मैं एचटीएमएल पृष्ठों को इंगित करने के लिए लिंक बदल सकता हूं, लेकिन मेरी परियोजना को जिथब पर होस्ट किया गया है और फिर उन लिंक को तोड़ दिया जाएगा क्योंकि जिथब स्वचालित रूप से मार्कडाउन पृष्ठों के बीच लिंकिंग का समर्थन करता है।

मैं बाहरी लोगों के अलावा अन्य लिंक का समर्थन करने के बारे में डॉक्सिजन दस्तावेज़ में कुछ भी नहीं देख सकता। क्या डॉक्सिजन को एक मार्कडाउन से एचटीएमएल लिंक बनाने का कोई तरीका है?

Answer 1

यह सुविधा Doxygen 1.8.6 (दिसम्बर 2013) में जोड़ा गया

Allow @ref to unlabeled markdown page by name, i.e. @ref mypage.md 
Allow links to other markdown pages of the form [link text](page.md) 

आप इसे काम करने के लिए कड़ी में प्रलेखन निर्देशिका incldue की जरूरत हो सकती है, जैसे

[link text](docs/page.md) 

Answer 2

के अनुसार Doxygen 1.8.7 ऐसा करने के तीन तरीके हैं:

• अपने मूल प्रश्न में वर्णित मानक मार्कडाउन हाइपरलिंक का उपयोग करें।
• @ref का उपयोग करें और किसी भी उपनिर्देशिका के साथ md_ के साथ लक्ष्य को उपसर्ग करें।
• नाम का नाम देने के लिए पृष्ठ का नाम दें और @ref का उपयोग करें।

पहली विधि सीधी है और यह डॉक्सिजन के बिना भी काम करेगी (उदाहरण के लिए गिथब पर अपना कोड भंडार ब्राउज़ करते समय)।

[Go to this page](subdir/MyOtherPage.md) 

दूसरी विधि तो आप इसे इस लिंक करना होगा जबकि:

[Go to this page](@ref md_subdir_MyOtherPage) 

जाहिर है यह भी the way prescribed by the Doxygen's primary author है।

अंततः तीसरे विधि में आपको लक्ष्य पृष्ठ के लिए नाम होना होगा और फिर उस नाम से लिंक करना होगा। उदाहरण:

MyOtherPage.md में हेडर के रूप में इस राशि

# My Other Page Title {#MyOtherPageName} 

तो

[Go to this page](@ref MyOtherPageName) 

Answer 3

नियमित पुराने Markdown लिंक की तरह लिंक Doxygen 1.8.6, उदा के रूप में नियंत्रित किया जाता है [link text](docs/page.md)। यह थोड़ी सी भद्दा काम करता है, यद्यपि - यूआरएल डॉक्सिजन कार्यशील निर्देशिका से संबंधित होना चाहिए (यानी डॉक्सीफाइल या .एमडी फ़ाइल की निर्देशिका नहीं है, लेकिन निर्देशिका जिसमें डॉक्सिजन चलती है)। यदि आप देखते हैं कि लिंक पर क्लिक करने से HTML के बजाय कच्चे मार्कडाउन दिखाए जाते हैं, तो इसका मतलब है कि आपका यूआरएल डॉक्सिजन की कार्यशील निर्देशिका से संबंधित नहीं है।

Answer 4

निम्न चरणों को समस्या का समाधान हो सकता है,

• निर्देशिका Doxyfile को STRIP_FROM_PATH निर्धारित किया है। मार्कडाउन फ़ाइलों को लिंक करते समय सापेक्ष पथ में कोई समस्या है।

• कोड कोड pd = Doxygen::pageSDict->find(target); (यदि यह पहले से नहीं है) में 2438 लाइन नंबर पर डॉक्सिजन स्रोत फ़ाइल src/docparser.cpp में निम्न कोड संलग्न करें। यह पेज-सूची में खोज की गई मार्कडाउन फ़ाइल को ठीक करता है।

  अगर (पीडी == 0 & & लैंग == SrcLangExt_Markdown) {पीडी = Doxygen :: pageSDict-> लगता है (markdownFileNameToId (लक्ष्य));}

• अंत में Doxygen संकलन और फिर कोशिश करें।

यह मेरे लिए काम करता है।