1. घर
  2. सवाल और जवाब
  3. डोक्सिया एप प्रारूप में प्रारूप कोड

डोक्सिया एप प्रारूप में प्रारूप कोड

2011-09-22 21 views
9

मैं वर्तमान में हमारी परियोजनाओं में से किसी एक के लिए एक दस्तावेज़ लिखना शुरू कर रहा हूं। के बाद से यह एक न्यूनतम सिंटैक्स का उपयोग करता है और इसलिए यह बना सकते हैं और बनाने के लिए बहुत आसान है, http://maven.apache.org/doxia/references/apt-format.htmlडोक्सिया एप प्रारूप में प्रारूप कोड

अपार्ट महान प्रलेखन प्रारूप है: सादगी के कारणों से हम लगभग सादा टेक्स्ट (अपार्ट) स्वरूप का उपयोग करने के लिए यहाँ और अधिक जानकारी देखते हैं, चुना एपीटी के बारे में बहुत कुछ जानने के बिना प्रलेखन में परिवर्तन।

हालांकि, मुझे कोड को एक अच्छे तरीके से प्रारूपित करने का कोई तरीका नहीं मिला। क्या कोई कोड टैग या समान है, जिसका उपयोग कुछ स्रोत कोड को शामिल करने के लिए किया जा सकता है? मुझे पता है कि मैं एफएमएल का उपयोग कर सकता हूं, लेकिन यह कम वांछनीय होगा।

धन्यवाद

स्रोत

2011-09-22 evgeni

+0

बस इस प्लगइन को देखा: http://code.google.com/p/m2-site-tools/wiki/UserGuide हालांकि, हाइटलाइट सुविधा जावा के लिए नेटर और एक्सएमएल के लिए काम नहीं कर रहा है। – evgeni

+0

इस प्रोजेक्ट भी है: http://doxia-include.sourceforge.net/usageAndReference.html। हालांकि, मैं अपनी pom.xml का निर्माण नहीं कर सका क्योंकि निर्भरता गायब थी: परियोजना निर्माण त्रुटि: अविश्वसनीय बिल्ड एक्सटेंशन: प्लगइन org.apache.maven.plugins: maven-site-plugin: 3.0-बीटा -3 या इसकी निर्भरताओं में से एक हल नहीं किया जा सकता: आर्टिफैक्ट नहीं मिला org.tinyjee: डॉक्सिया-इन-मैक्रो: जार: 1.0 केंद्रीय (http://repo1.maven.org/maven2) – evgeni

+0

इस प्रोजेक्ट के साथ एक ही समस्या: http: // वाक्यविन्यास- highlighted-snippet.googlecode.com/svn/site/index।एचटीएमएल – evgeni

उत्तर

2

मैं Doxia मैक्रो गाइड के स्निपेट मैक्रो का उपयोग समाप्त हो गया: http://maven.apache.org/doxia/macros/index.html#Snippet_Macro

यह एक शब्दशः बॉक्स में टुकड़ा फ़ाइल से कोड डालता है। हालांकि यह एक वाक्यविन्यास हाइलाइटिंग प्रदान नहीं करता है।

स्रोत

2011-09-23 08:51:34 evgeni

+0

जो अभी भी सोच रहे हैं कि एपीटी में कोड स्निपेट कैसे बनाएं: + --------------------- – JoshC13

3

Apache Maven Fluido त्वचा बॉक्स से बाहर वाक्यविन्यास पर प्रकाश डाला गया। Here आप एक उदाहरण पा सकते हैं। फ़्लूडो में हाइलाइटिंग सिंटैक्स के बारे में जानकारी: "स्रोत कोड अनुभाग Google Code Prettify द्वारा बढ़ाए जाते हैं, उपयोगकर्ता वैकल्पिक रूप से फ़्लूडो वेबसाइट से लाइन नंबर प्रतिपादन (डिफ़ॉल्ट रूप से अक्षम) को सक्षम कर सकते हैं।

स्रोत

2013-03-22 12:35:06 Marcin

+0

आपके द्वारा प्रदान किए गए लिंक का पृष्ठ आपका उदाहरण xdoc के साथ बनाया गया प्रतीत होता है, एपीटी के साथ नहीं (https://svn.apache.org/repos/asf/logging/log4j/log4j2/trunk/src/site/xdoc/manual/markers.xml देखें)। क्या आपको फ्लूडो/Google कोड एपीटी के साथ सुंदरता का उपयोग करने का एक उदाहरण पता है? (ऐसा लगता है कि यह मेरे प्रोजेक्ट के साथ ऐसा नहीं हो सकता है ... शायद मुझे xdoc का सहारा लेना चाहिए) – evandor

+0

@evandor Maven Fluido Skin Project स्वयं एपीटी का उपयोग करता है; [मेवेन-फ्लूडो-त्वचा] (http://maven.apache.org/skins/maven-fluido-skin/) साइट एपीटी ([स्रोत] (http://svn.apache.org/viewvc/maven का उपयोग करके बनाई गई है) /skins/tags/maven-fluido-skin-1.3.0/src/site/apt/index.apt.vm?view=markup))। – Marcin

11

उन सोच कैसे एक कोड अपार्ट में कतरना बनाने के लिए जो अभी भी कर रहे हैं के लिए:

 This is regular text 
+--------------------- 
This is a code snippet 
+--------------------- 
     More regular text

स्रोत

2013-07-22 16:09:21 JoshC13

3 

+--------------------- 
code 
+---------------------

वाक्य रचना सही है। और फ्लूडो ने बॉक्स के बाहर Prettify का उपयोग करके हाइलाइट किया है जैसा कि अन्य ने उल्लेख किया है।

हालांकि, साइट प्लगइन 3.3 में एक डॉक्सिया परिवर्तन फ्लूडो तोड़ दिया। MSKINS-86 इसे हल करता है, लेकिन अभी तक जारी नहीं किया गया है।

समाधान

  1. site.xml workaround <body> <head> <script type="text/javascript"> $(document).ready(function() { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
  2. उपयोग साइट प्लगइन 3.2
  3. का प्रयोग करें अप्रकाशित Fluido 1.4 जिसमें MSKINS -86 ठीक निर्माण और 1.3.1
    4. के बजाय इसका उपयोग

स्रोत

2015-05-06 19:07:47 Keegan

संबंधित मुद्दे
नवीनतम प्रश्न

 संबंधित मुद्दे