एटलसियन कंफ्लुएंस में ब्लूप्रिंट संकेत विकास

ऐसा लगता है कि अभी हाल ही में कंफ्लुएंस 5 जारी किया गया था, जो उपयोगकर्ताओं के लिए कई नई सुविधाएँ लेकर आया: एक नया दृश्य प्रतिनिधित्व, विकी से सीधे अनुप्रयोगों के बीच स्विच करने की क्षमता, अधिसूचना कि किसी टिप्पणी को जोड़ा गया है या पृष्ठ की सामग्री को किसी के साथ बदल दिया गया है। फिर भी, एटलसियन कंफ्लुएंस के संस्करण 5.1 की सांस पहले से ही महसूस की जाती है, जिसका उद्देश्य ब्लूप्रिंट तकनीक की मदद से पेज बनाने की प्रक्रिया को सरल बनाना है। ब्लूप्रिंट्स उपयोगकर्ताओं को यह समझने में मदद करते हैं कि वे किस प्रकार की सामग्री बनाना चाहते हैं और यह दिखाते हैं कि उपयोगकर्ताओं को हाथ से पकड़कर यह कैसे करना है जब तक कि वे देखने के लिए एक विकी पृष्ठ तैयार न करें।

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

चरण 1 - एक परियोजना संरचना बनाना

प्रोजेक्ट संरचना बनाने के लिए, आप एटलसियन एसडीके से atlas-create-confluence-plugin कमांड का उपयोग कर सकते हैं और आवश्यक डेटा दर्ज कर सकते हैं:

• group-id : com.stiltsoft.confluence.plugins
• artifact-id : wiki-markup-blueprint-plugin
• version : 1.0.0-SNAPSHOT
• package : com.stiltsoft.confluence.plugins.blueprint.markup

चरण 2 - पोमा फ़ाइल में मेटाडेटा जोड़ना

अब आप अपनी पसंदीदा आईडीई में परियोजना को खोल सकते हैं और पीओएम फ़ाइल में मेटाडेटा को संपादित कर सकते हैं (ध्यान दें कि कॉन्फ्लुएंस के लिए प्लगइन्स का विकास मावेन की भागीदारी के साथ होता है)। उदाहरण में, हम पहले मील के पत्थर का उपयोग करेंगे कंफ्लुएंस 5.1 ( 5.1-आरसी 3 पहले से ही आज उपलब्ध है )।

 <dependencies> <dependency> <groupId>com.atlassian.confluence</groupId> <artifactId>confluence</artifactId> <version>${confluence.version}</version> <scope>provided</scope> </dependency> <dependency> <groupId>com.atlassian.confluence.plugins</groupId> <artifactId>confluence-create-content-plugin</artifactId> <version>${create-content.version}</version> <scope>provided</scope> </dependency> </dependencies> <properties> <confluence.version>5.1-m1</confluence.version> <create-content.version>1.3.8</create-content.version> <confluence.data.version>5.1-m1</confluence.data.version> <amps.version>4.1.5</amps.version> </properties> 

चरण 3 - प्लगइन डिस्क्रिप्टर में मॉड्यूल जोड़ना

इस चरण में, Blueprints साथ काम करने के लिए मॉड्यूल को डिस्क्रिप्टर atlassian-plugin.xml के प्लगइन में atlassian-plugin.xml ।

 <web-item key="wiki-markup-blueprint-item" i18n-name-key="wiki.markup.blueprint.name" section="system.create.dialog/content"> <description key="wiki.markup.blueprint.description"/> <resource name="icon" type="download" location="images/stiltsoft.png"/> <param name="blueprintKey" value="wiki-markup-blueprint"/> </web-item> 

web-item मॉड्यूल Create Dialog विंडो में Wiki Markup मेनू आइटम जोड़ता है और इसमें निम्नलिखित पैरामीटर हैं:

• विशेषता i18n-name-key - वह कुंजी जिसके द्वारा प्रदर्शित मेनू आइटम का नाम संसाधन फ़ाइल में है
• section विशेषता - यह निर्धारित करती है कि मेनू आइटम कहां दिखाई देता है (ताकि यह Create Dialog विंडो Create Dialog में दिखाई दे, system.create.dialog/content का मान निर्दिष्ट करें)
• resource टैग - प्रदर्शित आइकन के लिए पथ को इंगित करने के लिए उपयोग किया जाता है
• param टैग - blueprintKey नाम के साथ एक पैरामीटर को परिभाषित करता है और atlassian-plugin.xml में बाद में घोषित blueprint मॉड्यूल की कुंजी के बराबर मान होता है

अगला, blueprint मॉड्यूल को परिभाषित करें:

 <blueprint key="wiki-markup-blueprint" create-result="view" content-template-key="wiki-markup-blueprint-page" index-key="wiki-markup-blueprint-index"> <dialog-wizard key="blueprint-wizard"> <dialog-page id="insertMarkupForm" template-key="WikiMarkup.Blueprint.form" title-key="wiki.markup.blueprint.dialog.title" last="true"/> </dialog-wizard> </blueprint> 

blueprint मॉड्यूल डेवलपर्स के लिए मुख्य मूल्य blueprint है। इसमें निम्नलिखित पैरामीटर शामिल हैं:

• विशेषता key - विवरणक में मॉड्यूल कुंजी
• create-result विशेषता - Blueprints का उपयोग करके एक नया पेज बनाने के लिए सभी चरणों को पूरा करने के बाद अपेक्षित व्यवहार को परिभाषित करता है। यह edit गए मूल्यों को ले सकता है (सभी चरणों को पूरा करने के बाद हम पृष्ठ संपादन मोड में आते हैं) और view (सभी चरणों को पूरा करने के बाद हम पृष्ठ देखने के मोड में आते हैं, पृष्ठ स्वचालित रूप से बनाया जाता है)।
• atlassian-plugin.xml content-template-key विशेषता - content-template मॉड्यूल content-template कुंजी को संदर्भित करता है, जिसे बाद में atlassian-plugin.xml में घोषित किया गया है
• विशेषता index-key - लेबल के नाम को परिभाषित करता है, जिसे बनाए गए पृष्ठ पर चिपका दिया जाता है (यह ध्यान देने योग्य है कि index'a तंत्र काफी बहुमुखी है, लेकिन इस उदाहरण में हम इस पर विचार नहीं करते हैं)

blueprint मॉड्यूल के dialog-wizard पैरामीटर आपके Blueprint प्लग-इन का उपयोग करके सामग्री बनाते समय उपयोगकर्ता द्वारा देखे जाने के गतिशील व्यवहार को निर्धारित करता है। पैरामीटर में निम्नलिखित विशेषताएं हैं:

• id विशेषता - html सामग्री के निर्माण में भाग लेती है और इसका उपयोग वर्तमान सामग्री निर्माण विंडो में css वर्ग के भाग के रूप में किया जाता है जिसे उपयोगकर्ता देखता है
• template-key विशेषता - गतिशील रूप से विंडो सामग्री बनाने के लिए soy टेम्पलेट के नाम को परिभाषित करता है
• title-key विशेषता - वह कुंजी जिसके द्वारा संसाधन फ़ाइल में विंडो शीर्षक होता है

हमारे द्वारा उपयोग किया जाने वाला सोया टेम्प्लेट बाद में web-resource मॉड्यूल में परिभाषित होता है। निम्नलिखित templates.soy की सामग्री है। यह फ़ाइल है:

 {namespace WikiMarkup.Blueprint} /** * Wiki Markup form */ {template .form} <form id="wiki-markup-form" action="#" method="post" class="aui"> <div> {getText('wiki.markup.blueprint.dialog.form.label.page.title')} </div> <input id="page-title" type="text" name="title"> <div> {getText('wiki.markup.blueprint.dialog.form.label.markup')} </div> <textarea id="wiki-markup" name="wikiMarkup"></textarea> </form> {/template} 

इस मामले में, उपयोगकर्ता निम्नलिखित देखेंगे:

content-template मॉड्यूल पृष्ठ टेम्पलेट को परिभाषित करता है जिसका उपयोग पृष्ठ बनाने के लिए किया जाता है:

 <content-template key="wiki-markup-blueprint-page" i18n-name-key="wiki.markup.blueprint.page.name"> <resource name="template" type="download" location="xml/content-template.xml"/> <context-provider class="com.stiltsoft.confluence.plugins.blueprint.markup.WikiMarkupProvider"/> </content-template> 

content-template मॉड्यूल में निम्न पैरामीटर हैं:

• key विशेषता - विवरणक में मॉड्यूल कुंजी ( blueprint मॉड्यूल में प्रयुक्त)
• resource टैग - एक नया पृष्ठ बनाने में शामिल टेम्पलेट को परिभाषित करता है
• context-provider टैग एक वैकल्पिक पैरामीटर है जो पेज के निर्माण में भाग ले सकता है, जिससे अतिरिक्त चर उत्पन्न हो सकते हैं।

यह ध्यान दिया जाना चाहिए कि xml फ़ाइल से पृष्ठ टेम्पलेट में डायनेमिक चर हो सकते हैं, जो संदर्भ से लिए गए हैं। जिस प्लगइन को हम विकसित कर रहे हैं, वह इस प्रकार है:

 <at:var at:name="wikiInXhtml" at:rawXhtml='true'/> 

टेम्प्लेट में उपयोग किए जा सकने वाले वेरिएबल्स को उस फॉर्म से लिया जा सकता है, जिसे उपयोगकर्ता भरता है और "सीधे बिस्तर पर" context-provider साथ सीधे जाता है। हमारे उदाहरण में, हम context-provider उपयोग करते हैं, जो कि इनपुट फॉर्म पर उपयोगकर्ता द्वारा दर्ज किए गए विकी मार्कअप को एक्सफ्लेक मार्कअप में परिवर्तित करता है जो कि कंफ्लुएंस में उपयोग किया जाता है। context-provider 'एक कोड नीचे प्रस्तुत किया गया है:

 package com.stiltsoft.confluence.plugins.blueprint.markup; import com.atlassian.confluence.content.render.xhtml.DefaultConversionContext; import com.atlassian.confluence.content.render.xhtml.XhtmlException; import com.atlassian.confluence.renderer.PageContext; import com.atlassian.confluence.xhtml.api.EditorFormatService; import com.atlassian.plugin.PluginParseException; import com.atlassian.plugin.web.ContextProvider; import java.util.Map; public class WikiMarkupProvider implements ContextProvider { private EditorFormatService editorFormatService; public WikiMarkupProvider(EditorFormatService editorFormatService) { this.editorFormatService = editorFormatService; } @Override public void init(Map<String, String> params) throws PluginParseException { } @Override public Map<String, Object> getContextMap(Map<String, Object> ctx) { try { String wikiMarkup = (String) ctx.get("wikiMarkup"); String xhtml = editorFormatService.convertWikiToEdit(wikiMarkup, new DefaultConversionContext(new PageContext())); ctx.put("wikiInXhtml", xhtml); } catch (XhtmlException ignored) { } return ctx; } } 

और अंत में, web-resource मॉड्यूल को atlassian-plugin.xml में परिभाषित करें:

 <web-resource key="blueprint-resources" name="Blueprint Resources"> <transformation extension="js"> <transformer key="jsI18n"/> </transformation> <transformation extension="soy"> <transformer key="soyTransformer"> <functions>com.atlassian.confluence.plugins.soy:soy-core-functions</functions> </transformer> </transformation> <resource type="download" name="wiki-markup.css" location="css/wiki-markup.css"/> <resource type="download" name="templates-soy.js" location="soy/templates.soy"/> <resource type="download" name="wiki-markup.js" location="js/wiki-markup.js"/> <dependency>com.atlassian.confluence.plugins.confluence-create-content-plugin:resources</dependency> <context>atl.general</context> <context>atl.admin</context> </web-resource> 

आप दस्तावेज़ के साथ वेबसाइट पर web-resource मॉड्यूल में प्रयुक्त पैरामीटर मानों से खुद को परिचित कर सकते हैं।

ध्यान दें कि आपको com.atlassian.confluence.plugins.confluence-create-content-plugin:resources निर्भरता के com.atlassian.confluence.plugins.confluence-create-content-plugin:resources । इसके अलावा, wiki-markup.js अपना Blueprint प्लगइन निम्नानुसार दर्ज करना चाहिए:

 (function ($) { Confluence.Blueprint.setWizard('com.stiltsoft.confluence.plugins.wiki-markup-blueprint-plugin:wiki-markup-blueprint-item', function() { }); })(AJS.$); 

चरण 4 - विकी लेआउट से पेज बनाने के लिए प्लगइन का उपयोग करें

आप इसे नहीं मानते, लेकिन विकी मार्कअप से पेज बनाने के लिए Blueprint प्लग-इन बनाने की प्रक्रिया समाप्त होने वाली है। यदि आपने सब कुछ ठीक किया है, तो अब आप प्लगइन को स्थापित कर सकते हैं और इसे कार्रवाई में आज़मा सकते हैं।

इसके अलावा, आप प्लगइन का स्रोत कोड देख सकते हैं या इसे स्वयं बनाने के लिए सभी चरणों को दोहराने का प्रयास कर सकते हैं।