मैं एक मदद/प्रलेखन पीढ़ी उपकरण है जो इस तरह की आवश्यकताओं को संतुष्ट हैं के लिए देख रहा हूँ:सहायता पीढ़ी उपकरण
- यह xmlDoc टिप्पणी सी # संकलक या (और भी बेहतर) द्वारा उत्पादित का समर्थन करना चाहिए सीधे sandcastle
- का समर्थन करें, इसे एमएस वर्ड दस्तावेज़ों के आयात का समर्थन करना चाहिए।
- इसे स्रोत कोड से उत्पादित संदर्भ दस्तावेज के लिए वैचारिक दस्तावेज़ीकरण से लिंक बनाने का समर्थन करना चाहिए।
- यह अगर यह एमएस वर्ड
अधिक जानकारी में वैचारिक दस्तावेज़ संलेखन का समर्थन करता है अच्छा होगा। मेरी परियोजना .NET के लिए एक ढांचा/पुस्तकालय है। इसमें 50 से अधिक # परियोजनाओं के साथ कई वीएस समाधान हैं। सबसे पहले मैं अपनी परियोजनाओं के स्रोत कोड से सहायता उत्पन्न करना चाहता हूं (भविष्य में chm & help2 & help3)। मैं उस दस्तावेज़ को "संदर्भ दस्तावेज़" के रूप में संदर्भित करूंगा। Sandcastle (विशेष रूप से SCFB का उपयोग करने के साथ) यह बहुत अच्छा तरीके से कर सकते हैं। लेकिन (मुझे लगता है कि यह बहुत आम स्थिति है) मेरे पास ढांचे/पुस्तकालय के लिए कुछ अतिरिक्त दस्तावेज हैं। वह दस्तावेज एमएस वर्ड फाइलों में है (5-10 फाइलें)। मैं उस दस्तावेज को "वैचारिक दस्तावेज़" के रूप में संदर्भित करूंगा। मैं वैचारिक दस्तावेज़ और संदर्भ दस्तावेज़ (जैसे एमएसडीएन) के साथ एक ठोस सहायता प्रणाली का उत्पादन करना चाहता हूं। और मैं चाहता हूं कि सहायता के वैचारिक भाग में लिंक (यूआरएल) शामिल है जो ढांचे/पुस्तकालय से प्रत्येक .NET प्रकार के नाम के लिए सहायता के संदर्भ भाग को संदर्भित करता है। (जाहिर है कि कोई भी मदद प्रणाली अंततः एचटीएमएल है)।
समस्या यह है कि इन लिंक को कैसे बनाएं। एमएस वर्ड फाइलें सी # एक्सएमल्डोक के बारे में कुछ भी नहीं जानती हैं। Sandcastle वर्ड फ़ाइलों का समर्थन नहीं करता है। इसलिए मुझे कुछ सहायता लेखांकन उपकरण (एचएटी) लेना है। इस समय तक मुझे मेरे लिए कोई उचित उपकरण नहीं मिल रहा है। और मैं किसी भी मदद के लिए बहुत सराहना करता हूं!
सभी उपकरण के लिए एक ठोकर ब्लॉक लिंक ऑटोोक्रेशन है। मैं चाहता हूं कि लिंक स्वचालित रूप से ट्यूरिनिंग पीढ़ी (जो बिल्ड सर्वर पर हो सकता है) बनाया जाए। स्वचालित रूप से क्यों? क्योंकि यह प्रकारों के आसान नामकरण की अनुमति देता है। उदाहरण के लिए । मेरे पास वैचारिक दस्तावेज़ में कुछ पाठ है: "अनुरोध प्रसंस्करण संदर्भ तक पहुंचने के लिए स्थिर संपत्ति का उपयोग XOperationContext प्रकार का वर्तमान"। यहां XOperationContext एक प्रकार का नाम है। मैं चाहता हूं कि यह किसी भी महत्वपूर्ण प्रयास किए बिना परिणाम सहायता प्रणाली में XOperationContext क्लास के विनिर्देश के लिए एक लिंक (यूआरएल) बन गया। मैं इसे वर्ड में चिह्नित करना चाहता हूं (शायद कुछ एचएटी प्लगइन स्थापित है) या एचएटी के संपादक में "जैसे ही यह शब्द लिंक संभव हो" जैसा कुछ है। पीढ़ी के दौरान इस तरह के नाम के साथ एक प्रकार का नाम होने पर प्रत्येक ऐसा शब्द एक लिंक बन जाएगा।
मैं इन उपकरणों के बारे में पता:
- Toolsfactory Doc-o-Matic (अब का उपयोग कर)
- Innovasys DocumentX and HelpStudio
- ComponentOne Doc-to-Help
डॉक्टर-ओ-मैटिक समर्थन लिंक autocreation। वास्तव में स्वचालित रूप से। यह पास्कलकेस में प्रत्येक शब्द के लिए एक लिंक बनाने की कोशिश करता है - शानदार ढंग से। लेकिन यह एमएस वर्ड का समर्थन नहीं करता है। इनोवैसिस और घटक एक सॉफ्टवेयर स्वचालित रूप से लिंक बनाने का समर्थन नहीं करता है। Innovasys 'सॉफ्टवेयर एमएस वर्ड का समर्थन नहीं करता है (मुझे इस बारे में 100% के लिए यकीन नहीं है)।
मैंने इनोवैसिस और कंपोनेंटऑन के मंचों पर पूछने की कोशिश की। अब तक कोई भाग्य नहीं है। इनोवसिस के नरम समर्थन परिदृश्य जैसे मेरा: अलग-अलग टूल में वैचारिक दस्तावेज़ बनाना - हेल्पस्टूडियो और अन्य कोड के साथ स्रोत कोड से सहायता उत्पन्न करना - DocumentX। लेकिन स्वचालित रूप से लिंक बनाने और एमएस वर्ड फ़ाइलों को आयात करने की कोई क्षमता नहीं है।
तो, कृपया उस सामान्य कार्य के लिए अपना समापन साझा करें (मुझे यकीन है कि यह सामान्य होना चाहिए)।
पेज। अगर मुझे अंग्रेजी व्याकरण के दृष्टिकोण से सही ढंग से मेरे विचारों को समझाने में कामयाब नहीं रहा है, तो कृपया मुझे बताएं, मैं एक और कोशिश करूंगा।
प्रश्न अभी भी वास्तविक – Shrike
है, अब मैं कन्फ्लुएंशन विकी में अपने सभी सांद्रिक दस्तावेज (जो शब्द-फ़ाइलें हैं) माइग्रेशन पर विचार कर रहा हूं। यह एक समस्या नहीं है। इसे sandcastle के आउटपुट के साथ एकीकृत करने के लिए बहुत कठिन है। – Shrike
आयात शब्द दस्तावेज़ द्वारा आपका क्या मतलब है? ऐसा नहीं है कि वर्ड दस्तावेज़ आयात करने और स्वरूपण को संरक्षित करने का एक सामान्य तरीका है। –