एकल स्रोत प्रलेखन उपकरण

Question

क्या OSS (या फ्री) उपकरण दस्तावेजों के लिए एक स्रोत तैयार करने के लिए उपलब्ध हैं जिनका उपयोग मैनुअल उत्पन्न करने के लिए किया जा सकता है? विशेष रूप से, निम्न स्वरूपों में:

• HTML वेबसाइट
• पीडीएफ दस्तावेज़
• एंबेडेड (एक आवेदन के भीतर; संभवतः एचटीएमएल)
• पाठ (वैकल्पिक)
• मैन पृष्ठों (वैकल्पिक)

अतिरिक्त आवश्यकताएं:

• उपकरण तकनीकी लेखकों के लिए उपयुक्त है (WYSIWYG नहीं होना चाहिए)।
• एक्सएमएल/SGML स्रोत
• उच्च गुणवत्ता पीडीएफ निर्गम (टेक्स की तुलना में)
• बहु मंच

विस्तारित आवश्यकता

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

ऐसा लगता है कि AsciiDoc में यह क्षमता नहीं है। क्या कोई और विकल्प है?

Answer 1

वह जो आपकी अधिकांश आवश्यकताओं को पूरा करता है, मैंने पहले उपयोग किया है, AsciiDoc है।

AsciiDoc एक XML स्रोत प्रारूप नहीं है, इसके बजाय यह एक साधारण पाठ प्रारूप का चयन करता है। यह एचटीएमएल और डॉकबुक आउटपुट कर सकता है, जिसे पीडीएफ या अन्य प्रारूपों में प्रस्तुत किया जा सकता है। स्रोत पाठ सादा पाठ प्रस्तुति के लिए भी काफी अच्छा है।

उसी लाइन के साथ एक और लोकप्रिय विकल्प reStructuredText है।

Answer 2

मैं अपने इंजीनियरिंग समूह में शब्द के प्रतिस्थापन के रूप में DocBook को सुसमाचार देने पर विचार कर रहा हूं। कई टूलचेन उपलब्ध हैं। इंजीनियरों के लिए सबसे आसान शायद DocBook XSL, Apache FOP, और या तो Ant या Make है। इस तरह मैं अपनी डॉकबुक सामग्री कर रहा हूं। यदि आप वास्तव में लाटेक्स में हैं, तो हो सकता है कि आप DBLaTeX को डॉटबुक के लिए लाटेक्स प्रकाशन वातावरण में देखना चाहें।

यदि आपको नि: शुल्क वातावरण के बाहर कदम उठाने में कोई फर्क नहीं पड़ता है, तो <oXygen/> XML Editor एक बहुत अच्छा WYSIWYG डॉकबुक संपादक प्रदान करता है। मैंने इसका इतना उपयोग नहीं किया है, लेकिन यह बहुत ही आशाजनक दिखता है।

Answer 3

Sphinx एक उपकरण है जो डॉकुटिल्स को कई विशेषताओं को जोड़ता है, जिससे "बुद्धिमान और सुंदर प्रलेखन" को पुन: संरचित पाठ में लिखा जा सकता है। यह मूल रूप से नए पायथन दस्तावेज का उत्पादन करने के लिए बनाया गया था लेकिन कई अन्य परियोजनाओं द्वारा अपनाया जा रहा है।

Answer 4

Doxygen दस्तावेज जनरेटर है जो काफी लोकप्रिय है और variety of formats में दस्तावेज़ आउटपुट कर सकता है। हालांकि स्रोत टिप्पणियों (कई भाषाओं से) से निकाले गए दस्तावेज बनाने का इसका प्राथमिक उद्देश्य, यह सामान्य मैन्युअल लेखन उपकरण के रूप में भी काफी उपयोगी है। वास्तव में, इस तरह से Doxygen वेबसाइट और मैनुअल उत्पन्न होते हैं।