जावाडॉक (ओवरव्यू और पैकेज सारांश सहित) से पीडीएफ कैसे उत्पन्न करें

Question

मैंने अपने आवेदन पर व्यापक जावाडॉक दस्तावेज लिखा है, और overview.html और package.html फाइलों पर बहुत सारी उपयोगी जानकारी शामिल की है (doc-files/ में चित्रों के पूर्व में लिंक सहित)। मेवेन की जावाडोक प्लगइन क्लासिक जावाडॉक फ्रेमसेट उत्पन्न करने के लिए मानक जैवडोक टूल का अच्छी तरह से उपयोग करता है, लेकिन अब मुझे पूरे दस्तावेज़ के साथ एक पीडीएफ उत्पन्न करने की आवश्यकता है।

AurigaDoclet बहुत सुंदर पीडीएफ उत्पन्न करता है, और मैं DocFlex भी काम करने में सक्षम था। हालांकि, दोनों मेरी overview.html और package.html फ़ाइलों को अनदेखा करते हैं (मेवेन के अंदर और बाहर दोनों की कोशिश की - पीडीएफ एकमात्र चीज होगी, क्योंकि मेरे पास लंबे समय तक एचटीएमएल होगा)।

क्या कोई जानता है कि AurigaDoclet को मेरी गैर-जावा फ़ाइलों को दोबारा कैसे बनाया जाए? या, वैकल्पिक रूप से, कोई अन्य स्रोत कोड या जावाडोक-जेनरेट किए गए HTML से सभ्य दिखने वाले पीडीएफ उत्पन्न करने के लिए?

धन्यवाद!

Answer 1

इसे नेल किया गया। स्रोत से सीधे उत्पन्न करने के लिए सभी संभव औजारों को आजमाने के बाद, मैं HTMLDOC पर लौट आया। यह जावाडोक-जागरूक नहीं है, लेकिन यह इतना अच्छी तरह से बनाया गया है कि कुछ बदलाव एक सुंदर उपयोग करने योग्य पीडीएफ उत्पन्न करने के लिए पर्याप्त हैं।

यहाँ कैसे मैंने किया की एक कदम-दर-कदम विवरण जाता है:

1. डाउनलोड सॉफ्टवेयर का एक नि: शुल्क निर्माण (आधिकारिक साइट संस्करण किसी लाइसेंस की आवश्यकता है, लेकिन यह जीपीएल-एड है, ताकि आप this one जैसी निःशुल्क बाइनरी पा सकते हैं, जो विंडोज के लिए एक सरल और कार्यात्मक इंस्टॉलर है);

2. अपने पारंपरिक HTML दस्तावेज़ों को अपने पसंदीदा तरीके से बनाएं (चींटी, मेवेन, कमांड लाइन जावाडोक - आपकी पसंद);

3. जीयूआई अच्छा है, लेकिन सभी फाइलें मैन्युअल रूप से बोझिल हो सकती हैं, इसलिए बस "वेब पेज" पर दस्तावेज़ प्रकार सेट के साथ एक .book फ़ाइल बनाएं, अपने जेनरेट किए गए जावाडॉक के रूट फ़ोल्डर से HTML फ़ाइलों में से एक जोड़ें (उदा। , सिंहावलोकन-सारांश.html, कोई भी करेगा, यह सिर्फ चरण 5 पर संदर्भ के लिए है)। आउटपुट टैब पर पीडीएफ प्रारूप का चयन करें और इसके लिए एक नाम सेट करें, और अपने दिल की सामग्री में अन्य विकल्प जोड़ें (लोगो, रंग, यहां बहुत अच्छी चीजें हैं)। इस प्रोजेक्ट को सहेजें (कहें, myjavadocpdf.book) और जीयूआई

4. अपने जावाडोक में सभी HTML फ़ाइलों की एक सूची बनाएं। मैंने इसे Cygwin के कमांड कमांड के साथ किया (मेरा डॉस/सेमीडी शैल दिन लंबा हो गया है), लेकिन जब तक आप फ़ाइल सूची प्राप्त करते हैं, तब तक आप जो भी चाहें कर सकते हैं। मेरे मामले में find . | grep html$ | sort -r > files.txt चाल चल रही थी; विंडोज उपयोगकर्ताओं के लिए, dir /s/b *.html > files.txt वही करना चाहिए (लेकिन ध्यान रखें कि आपको \ एस / एस के साथ प्रतिस्थापित करना होगा यदि वे अगले चरण में ऐसा दिखाई देते हैं)।

5. अपने पसंदीदा शुद्ध टेक्स्ट एडिटर में चरण 3 पर जेनरेट की गई .book फ़ाइल खोलें (एक प्रोग्रामर के रूप में आपको उस पर मजबूत राय होनी चाहिए, इसलिए मेरी राय मेरे पास रखेगी - NOT ;-)) और जेनरेट की गई सूची को संलग्न करें इस चरण 4 पर .book फ़ाइल (यह अंत में फ़ाइलों की सूची रखती है, जिससे जीवन वास्तव में आसान हो जाता है)।वैश्विक खोज/प्रतिस्थापन के साथ आवश्यक होने पर सापेक्ष पथ को ठीक करना न भूलें (यही कारण है कि आपको चरण 3 पर कम से कम एक फ़ाइल की आवश्यकता होती है - यह देखने के लिए कि कौन सी फ़ाइल पथ पैटर्न htmldoc अपेक्षा करता है);

6. अब आपको फ़ाइलों को सुविधाजनक क्रम में सॉर्ट करना चाहिए। मैंने अपना अवलोकन पहले रखा, फिर पैकेज विवरण और प्रत्येक वर्ग, फिर पूर्ण अनुक्रमणिका, और अंत में बाकी सब कुछ। याद रखें कि आपके द्वारा हटाई गई कोई भी फ़ाइल बाहरी (इसलिए टूटी हुई) लिंक बन जाएगी, इसलिए बुद्धिमानी से चुनें;

7. अपनी .book फ़ाइल सहेजें और इसे HTMLDOC पर फिर से खोलें। वोला: सभी फाइलें जोड़ी गयीं और क्रमबद्ध की गईं। जेनरेट पर क्लिक करें। बस!

आप छवियों के साथ झुकाव करना चाहते हैं (संकेत: HTML चौड़ाई/ऊंचाई, शैली/सीएसएस का उपयोग नहीं करें)। अंत में, परिणामस्वरूप फ़ाइल आश्चर्यजनक रूप से अच्छी है: आंतरिक और बाहरी लिंक के लिए अच्छी लग रही और पूरी तरह से नेविगेशन योग्य। प्रभावशाली जब आप मानते हैं कि उपकरण जावा (डॉक) बिल्कुल नहीं है ...

Answer 2

सन जावाडॉक अकसर किये गए सवाल के मुताबिक, कुछ विकल्प हैं - अधिकांशतः मुफ्त, एक या दो व्यावसायिक पेशकशों के साथ भी। इसे http://java.sun.com/j2se/javadoc/faq/index.html#print पर देखें।

Answer 3

AurigaDoclet package.html को संसाधित करने में विफल रहता है। एक फिक्स के लिए मेरी टिप्पणी https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1

Answer 4

यदि यह प्रश्न किसी भी तरह से बंप किया गया था, तो मैं इसका उपयोग ltxdoclet प्रोजेक्ट को जोड़ने के लिए कर सकता हूं।

यह लाटेक्स प्रारूप में स्रोत (जावाडॉक प्लगइन होने के द्वारा) प्रलेखन से बनाता है, जिसे आप पीडीएफएलएटीएक्स के माध्यम से पीडीएफ बनाने के लिए पारित कर सकते हैं।

वैकल्पिक रूप से इसमें सुंदर मुद्रित स्रोत कोड भी शामिल हो सकता है।