मैवेन

Question

के साथ प्रलेखन बनाना मैं सिर्फ संशोधित मेवेन के बीच में हूं। जब हमने आखिरी बार देखा तो हमारी टीम का बुरा अनुभव था, क्योंकि यह उस समय के दौरान था जब मैवेन 1.x से 2.x तक पुनर्वितरण कर रहा था, इसलिए हमें आवश्यक कई निर्भरताओं को नए भंडारों में स्थानांतरित नहीं किया गया था । हालांकि, मेरे पास अब पुनर्विचार करने का समय है।

मैं Maven और या तो LaTeX या DocBook प्रलेखन बनाने के लिए उपयोग करने में रुचि हूँ, और मैं आदि अगर कोई साझा करने के लिए किसी भी अनुभव था, परियोजना/मॉड्यूल संरचना, अच्छा प्लगइन का उपयोग करने के लिए सोच रहा था, ...

कई धन्यवाद :-)

संपादित करें:

बस स्पष्ट करने के लिए, मैं एक तकनीकी लेख/किताब लिखने के लिए देख रहा था, और मेरे वांछित विरूपण साक्ष्य शायद एक पीडीएफ होगा।

Answer 1

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

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

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

चीयर्स कार्लोस

Answer 2

एमवीएन साइट कमांड का उपयोग करके आप आसानी से एक साइट (जिसमें दस्तावेज़ीकरण शामिल है) बना सकते हैं (यानी plugin site का उपयोग कर)।

यह प्लगइन तकनीकी रिपोर्ट (जैसे जावाडोक, यूनिट परीक्षण रिपोर्ट, कोड कवरेज ...) बनाता है लेकिन इसका उपयोग "असली साइट" बनाने के लिए भी किया जा सकता है। आपके पास this page में इसके बारे में अधिक जानकारी है।

मूल रूप से, आप अपने पृष्ठ APT (लगभग सादा पाठ जो काफी समझना सरल है), या एक XML- आधारित स्वरूप, Xdoc का उपयोग कर लिखें।

2 साल पहले, मैं XDoc प्रारूप और साइट मेवेन प्लगइन का उपयोग करके विकसित एक एप्लिकेशन के लिए एक संपूर्ण उपयोगकर्ता मार्गदर्शिका बनाउंगा। वैश्विक स्तर पर, यह बनाना आसान था!

मुझे उम्मीद है कि यह आपकी मदद करेगा!

Answer 3

AFAIK कोई आधिकारिक या अर्ध-आधिकारिक प्लगइन नहीं है जो लाटेक्स या डॉकबुक को संसाधित करेगा, लेकिन आप क्या कर सकते हैं (उपर्युक्त साइट प्लगइन का उपयोग करने के अलावा) साइट के दौरान अपने लाटेक्स/डॉकबुक स्रोतों को संसाधित करने के लिए निष्पादन प्लगइन को कॉन्फ़िगर करना है जीवन चक्र, यानी एक ही समय में परियोजना की वेबसाइट बनाई गई है।

जैसे, जैसे

<plugin> 
    <groupId>org.codehaus.mojo</groupId> 
    <artifactId>exec-maven-plugin</artifactId> 
    <executions> 
    <execution> 
    <id>latex</id> 
    <goals> 
     <goal>exec</goal> 
    </goals> 
    <phase>site</phase> 
     <configuration> 
      ... 
     </configuration> 
    </execution> 
    </executions> 
</plugin> 

Answer 4

DocBook कुछ Doxia, इंजन Maven द्वारा डॉक्स उत्पन्न करने के लिए प्रयोग किया जाता है के लिए कई समर्थित आदानों से एक है। यहाँ देखें: http://maven.apache.org/doxia/modules/index.html

वास्तव में, Doxia साइट अपने सटीक सवाल का जवाब: http://maven.apache.org/doxia/book/index.html

Answer 5

मैं सफलता Maven प्लगइन Docbkx के साथ प्रयोग किया गया है। आप इसे एक कोशिश

Docbkx

Answer 6

आप निश्चित रूप से Maven Docbkx Plugin पर एक नज़र रखना चाहिए देना चाहिए। यह शायद आपकी जरूरतों को फिट बैठता है। डॉक्सबुक का डॉक्सिया का समर्थन -हम-सबोपेटिमल है। असल में, आखिरी बार मैंने कोशिश की, यह कुछ नया उत्पन्न हुआ - जहां तक ​​मैं कह सकता था - डॉकबुक नहीं था।

मैवेन डॉकबैक्स प्लगइन जो मैं दुनिया के सभी अनुकूलन (प्लगइन पैरामीटर, या एक्सएसएलटी ओवरराइड के माध्यम से, यदि आप इसमें हैं) का समर्थन करने के लिए संदर्भित कर रहा हूं + इसमें मेवेन बिल्ड के साथ इसे एकीकृत करने के लिए कुछ तंत्र शामिल हैं। (जैसे आपके दस्तावेज़ों में मेवेन पोम गुणों को शामिल करने के लिए निर्देशों को संसाधित करना।)

ध्यान दें कि महत्वाकांक्षा एक प्लगइन है जो आपको मैन्युअल रूप से प्रसंस्करण श्रृंखला को एक साथ रखने से रोकती है। तो यह प्लगइन दोनों एफओ में परिवर्तन करेगा, और इसे पीडीएफ में बदल देगा।

Answer 7

हालांकि सवाल काफी पुराना है मैं इस पर एक अद्यतन देना चाहता हूँ। यदि आप अपने दस्तावेज़ के लिए लाटेक्स का उपयोग करना चाहते हैं तो आपको दस्तावेज उत्पन्न करने के लिए एक मेवेन प्लगइन का उपयोग करना चाहिए। ऐसा कुछ मैवेन-प्लगइन्स ऐसा कर रहे हैं लेकिन उनमें से बहुत से अब बनाए रखा नहीं जाता है। एक नया मेवेन-प्लगइन है जिसके लिए इसे काम करने के लिए कोई भी कम या कम कॉन्फ़िगरेशन की आवश्यकता नहीं है और जेनरेट किए गए पीडीएफ (या पीएस या डीवीआई) को आर्टिफैक्ट के रूप में प्रकाशित किया जा सकता है। mathan-latex-maven-plugin