.net - क्या सैंडकास्टल द्वारा बनाए गए दो पृष्ठों को एक मुख्य पृष्ठ में मर्ज करना संभव है?



sandcastle code-documentation (1)

प्रोजेक्ट में प्रत्येक वर्ग के लिए, सैंडकास्टल दो पृष्ठों के साथ (दूसरों के बीच) बनाता है:

  • मुख्य पृष्ठ, जिसे T_class_full_name कहा जाता है, वर्णन के साथ, सिंटेक्स, विरासत पदानुक्रम और यह भी देखें
  • सदस्य पृष्ठ, जिसे AllMembers_T_class_full_name कहा जाता है, कन्स्ट्रक्टर्स, तरीके, फ़ील्ड इत्यादि के साथ।

क्या इन दोनों को एक साथ विलय करने का कोई तरीका है - members page को मुख्य पृष्ठ में जोड़ा जा रहा है?


मैं इसके लिए एक कामकाजी उत्तर नहीं दे सकता, लेकिन मैं कुछ विचारों की पेशकश कर सकता हूं जो काम कर सकते हैं यदि कोई इसके साथ हैक करने के इच्छुक है:

1. कॉन्फ़िगरेशन htmlBody.xsl सदस्यों के लिए परीक्षण वाले अनुभाग सहित कुछ संरचना को परिभाषित करता है: <xsl:if test="$subgroup='members'"> यदि यह कक्षा स्तर पर चालू था (या बस सेट करें सच है कि यह आपको एक विचार दे सकता है कि आउटपुट कैसे बनाया जाता है। (मुझे नहीं लगता कि यहां एक जादू बुलेट सेटिंग होगी)।

2. यहां है (मुझे लगता है) जहां सदस्य उपसमूहों के लिंक जोड़े गए हैं, मैं इसके साथ भी खेलूँगा:

<!-- add a link to the member list section for this subgroup -->
<a href="#{$elementVisibility}Toggle" onclick="OpenSection({$elementVisibility}Toggle)">

3. मेरे पास अन्य विचार संरचना के साथ खेलने की कोशिश कर रहे हैं, लेकिन मुझे कोई स्पष्ट उत्तर देने के लिए इसे हैक करना होगा। मैं यह सुनिश्चित करने के करीब भी नहीं हूं कि htmlBody.xsl ऐसा करने का स्थान है। अगर मुझे वास्तव में आवश्यकता थी तो मुझे लगता है कि मैं निम्नलिखित करके अपना लक्ष्य प्राप्त कर सकता हूं:

  • मानक तरीके से दस्तावेज उत्पन्न करें
  • जेनरेट किए गए प्रलेखन को पार्स करें और दो को एक डीओएम / एक्सएमएल पार्सर का उपयोग करके मर्ज करें (यानी कोड में दो को मर्ज करें और वर्तमान पृष्ठ पर एंकरों को अपडेट किए गए यूआरएल के साथ एक नया एकल पेज एचटीएमएल दस्तावेज़ आउटपुट करें)

अच्छी बात यह है कि जेनरेट की गई फाइलों और लिंक में उपयोग की जाने वाली एक सतत नामकरण योजना है, इसलिए मुझे लगता है कि इस प्रक्रिया को लिखना आसान होगा और सभी लिंक को एंकर होने के लिए अद्यतन करना होगा, इससे टेम्पलेट्स के साथ बहुत गड़बड़ होगी । मुझे लगता है कि इस तरह के दस्तावेज़ मैनिपुलेशन के साथ अनुभवी किसी के लिए इसे पूरा करना बहुत आसान होगा।

चेतावनी: मैं एक सैंडकास्टल विशेषज्ञ के करीब भी नहीं हूं, केवल इसे कम से कम और एक साल पहले इस्तेमाल किया था। मैंने आज भी इस बात पर विचार करने से पहले कभी भी बिताया नहीं है कि मैं इसे कैसे हुकूंगा, केवल इसे बॉक्स से बाहर कर रहा हूं। अन्य प्रतिक्रियाओं की कमी के अलावा मैंने इसका जवाब भी नहीं दिया होगा। इसे पूरा करने के लिए एक समर्थित कॉन्फ़िगरेशन तरीका हो सकता है, लेकिन मैं एक आरामदायक उपयोगकर्ता के रूप में यह भी सोच नहीं सकता कि इसे कैसे पहुंचाया जाए।

मैं यहां कुछ मान्यताओं को भी बना रहा हूं कि एसएचएफबी के साथ अपने अनुभव के आधार पर एचटीएमएल आउटपुट कैसा दिखता है। मैं वहां भी पहुंच सकता हूं। मेरे पास अब एक प्रोजेक्ट नहीं है जिसे मैं sandcastle दस्तावेज उत्पन्न कर सकता हूं, लेकिन अगर कोई SandCastle से कुछ HTML आउटपुट के लिए एक लिंक पोस्ट कर सकता है और इस दृष्टिकोण में रूचि रखता है तो मुझे और मदद करने में खुशी होगी।





code-documentation