वर्तमान में हम AsciiDoc नामक एक प्रणाली का उपयोग करते हैं जो हमें एक साधारण पाठ मार्कअप में प्रलेखन बनाने की अनुमति देता है। उससे हम कई आउटपुट स्वरूप उत्पन्न कर सकते हैं। हम केवल पीडीएफ आउटपुट और chm आउटपुट फॉर्मेट का उपयोग करते हैं।
मैं सोच रहा था कि क्या कोई विकल्प था? मैं जिस चीज की तलाश कर रहा हूं, वह ऐसी चीज है जिसका उपयोग ऑफ-लाइन किया जा सकता है (यह महत्वपूर्ण है क्योंकि हमारे कुछ उपयोगकर्ता हमारे सॉफ्टवेयर के साथ बहुत दूरस्थ स्थानों पर हैं)। इसमें एक सूचकांक होना चाहिए (यह हाइपरलिंक की शर्तों के साथ एक html पृष्ठ जितना सरल हो सकता है), यह खोज योग्य होना चाहिए और इसमें एक तंत्र होना चाहिए जो विशिष्ट प्रविष्टियों को कोड से बुलाया जा सकता है (संदर्भ संवेदनशील मदद के समान)।
इस मामले में पीडीएफ के खिलाफ दो चीजें हैं:
- संवेदनशील संवेदनशील मदद एक विकल्प नहीं है
- आम तौर पर दस्तावेज़ बल्कि बड़ा होता है
- पीडीएफ संदर्भ संवेदनशील मदद की तुलना में मुद्रित प्रलेखन के लिए अधिक उपयुक्त है
क्या मैं html का उपयोग करना चाहूंगा। Html के साथ एकमात्र समस्या यह है कि मुझे यह पता नहीं लग सकता है कि किसी कीवर्ड खोज को स्वचालित रूप से कैसे प्रदान किया जाए (ब्राउज़र ctrl + f कार्यक्षमता के अलावा - मैं कुछ और स्पष्ट करना चाहूंगा)। मुझे कुंजी शब्दों के हाइपरलिंक किए गए अनुक्रमणिका को स्वचालित रूप से जनरेट करने के लिए कोई विधि नहीं मिल रही है। अनुभाग टैग की वजह से संवेदनशील संवेदनशील मदद सरल होगी - मैं बस उस पृष्ठ और अनुभाग के URL को पारित कर सकता हूं जिसे मैं डिफ़ॉल्ट ब्राउज़र में रुचि रखता हूं और उस पृष्ठ को सही अनुभाग तक लोड करना चाहिए।
मेरी आवश्यकताएं एक भयानक ध्वनि की तरह हैं जैसे कि chm - वे करते हैं। मैंने अपनी आवश्यकताओं को chm से दूर किया। एकमात्र कारण जो मुझे पसंद नहीं है, वह यह है कि जिस तरह से कोड मैप्स और इस तरह का उपयोग करके इसके साथ इंटरैक्ट करता है। मैं बहुत अधिक उपयोग करने के लिए एक सादा पाठ सूची (जो स्वचालित रूप से मेरे लिए उत्पन्न होती है) का उपयोग कर सकता हूं जो मेरे कोड प्रलेखन के संदर्भ संवेदनशील हिस्से तक पहुंचने के लिए उपयोग कर सकते हैं।
मैं एक स्क्रिप्ट की कल्पना कर रहा हूं जो html आउटपुट फाइलों के माध्यम से जाएगी और एक इंडेक्स पेज उत्पन्न करेगी जिसमें बस कीवर्ड की एक सूची होती है जो इसे मिली। स्पष्ट रूप से शब्दों को नजरअंदाज करने के लिए शब्द बहिष्करण तंत्र होना चाहिए: जैसे, यह, है, आदि। यह हिस्सा लिखना अपेक्षाकृत आसान होगा। दूसरे भाग को HTML पाठ के भीतर खोजशब्दों और उनके स्थान के डेटाबेस को एक साथ रखने के लिए किसी प्रकार की स्क्रिप्ट की आवश्यकता होगी। मुझे लगता है कि यह ब्राउजर के भीतर सर्च मेकेनिज्म मुहैया कराने के साथ ही मुश्किल हिस्सा होगा।
विकल्पों पर किसी भी विचार की सराहना की जाएगी। मुझे एक वेबसर्वर पर होस्ट किए गए स्थिर html पृष्ठों के विकी या सेट का उपयोग करना पसंद होगा, लेकिन हमारे पास एक महत्वपूर्ण ऑफ़लाइन उपयोग की आवश्यकता है। बस HTML को स्थानीय ड्राइव पर रखने से हमें वह खोज आवश्यकताएं नहीं मिलती हैं जिनकी हमें आवश्यकता होती है।
संपादित करें:
मैं सॉफ्टवेयर डिजाइन करता हूं जिसका उपयोग खनन उद्योग द्वारा किया जाता है। बहुत सारी खदानें बहुत दूरस्थ हैं और किसी भी सार्थक तरीके से इंटरनेट तक पहुंच नहीं है। Pdf या html या chm में कुछ भी गलत नहीं है (सिवाय इसके कि यह पुराना हो रहा है)। अगर मैं एक पीडीएफ फाइल को सही स्थान पर प्रदर्शित कर सकता हूं (यानी संदर्भ संवेदनशील मदद) तो मैं इसका उपयोग करूंगा। मुझे अपना लिखने का लगभग मोह है - मूल रूप से यह एक पोर्टेबल विकी होगा। उस पर बोलते हुए, यदि आप पोर्टेबल विकी का सुझाव देते हैं - तो आपको अंतिम उपयोगकर्ता के बारे में सोचना होगा जिसे इस तरह के टूल का उपयोग करने का कोई अनुभव नहीं हो सकता है। यह आसान मृत होना है। यह chm की सुंदरता थी, यह काम करने के लिए एक दर्द है लेकिन अंत उपयोगकर्ताओं को यह पसंद है।