पृष्ठों की तुलना करें। एटलसियन संगम के लिए सरल प्लगइन

Atlassian Confluence में महान पेज संस्करण तुलनात्मक कार्यक्षमता है। यह उपयोग करने के लिए सुविधाजनक है, लेकिन आप परिवर्तनों के इतिहास से आगे नहीं जा पाएंगे। कैसे हो सकता है? मार्केटप्लेस में समाप्त प्लगइन की खोज ने कोई परिणाम नहीं दिया और अपना खुद का लिखने का निर्णय लिया गया।

उपकरण

हमें आवश्यकता होगी:

• Oracle JDK या AdoptOpenJDK 1.8, OpenJDK के साथ काम करना आधिकारिक रूप से समर्थित नहीं है;
• एटलसियन एसडीके - बिना एसएमएस और पंजीकरण के विंडोज और लिनक्स / मैक के लिए आधिकारिक साइट से डाउनलोड किया जा सकता है;
• अपाचे मावेन
• पसंदीदा विकास का माहौल, मेरे पास इंटेलीज आईडिया है।

एक प्रोजेक्ट बनाएं

एसडीके स्थापित करें और atlas-create-confluence-plugin स्क्रिप्ट निष्पादित करें।

दर्ज करें:

• group-id: com.kshch.confluence.plugins
• कलाकृति-आईडी: अंतर-पृष्ठ
• संस्करण: 1.0.0-SNAPSHOT
• पैकेज: com.kshch.confluence.plugins.diff.page

असेंबली के लिए, आप एसडीके से मावेन और निर्भरता का उपयोग कर सकते हैं, लेकिन आपकी सेटिंग्स में अतिरिक्त रिपॉजिटरी कनेक्ट करना आसान है। xml।

 <repository> <id>atlassian-public</id> <url>https://packages.atlassian.com/maven/repository/public</url> <snapshots> <enabled>true</enabled> <updatePolicy>never</updatePolicy> <checksumPolicy>warn</checksumPolicy> </snapshots> <releases> <enabled>true</enabled> <checksumPolicy>warn</checksumPolicy> </releases> </repository> <pluginRepository> <id>atlassian-public</id> <url>https://maven.atlassian.com/repository/public</url> <releases> <enabled>true</enabled> <checksumPolicy>warn</checksumPolicy> </releases> <snapshots> <updatePolicy>never</updatePolicy> <checksumPolicy>warn</checksumPolicy> </snapshots> </pluginRepository> 

आईडीई में परिणामी परियोजना खोलें, डीबग मोड confluence:debug में कॉन्फ्लुएंस चलाएं confluence:debug



और http: // localhost: 1990 / संगम / पर स्थानीय स्थापना के संचालन की जाँच करें। लॉगिन व्यवस्थापक, पासवर्ड व्यवस्थापक। डेटाबेस ने पहले ही एक प्रदर्शन स्थान और कई लेख बनाए हैं।

थोड़ी कार्यक्षमता

मेनू से शुरू करते हैं। वेब-आइटम मॉड्यूल को एटलसियन-प्लगइन।एक्सएलएम प्लगइन डिस्क्रिप्टर में जोड़ें।

 <web-item key="diff-page-menu" name="Diff Page" section="system.content.action/secondary" weight="300"> <description>Add diff item to drop-down menu</description> <label key="diff.page.menu.name"/> <link linkId="diff-page">/plugins/diffPage/diffPagePopup.action?spaceKey=${space.key}&sourcePageId=${page.id}</link> <condition class="com.atlassian.confluence.plugin.descriptor.web.conditions.HasPageCondition"/> </web-item> 

जहां:

• अनुभाग विशेषता - मेनू आइटम के स्थान को परिभाषित करता है;
• विशेषता वजन - छँटाई क्रम के लिए जिम्मेदार है;
• लेबल टैग की मुख्य विशेषता वह कुंजी है जिसके द्वारा प्रदर्शित मेनू आइटम का नाम संसाधन फ़ाइलों में स्थित है;
• लिंक टैग - इसमें लिंक शामिल है, और लिंकआईडी विशेषता इसकी आईडी है;
• हालत - केवल पृष्ठ पर, हमारे मामले में, उपस्थिति के लिए स्थिति को परिभाषित करता है।

Diff-page.properties में लाइन जोड़ें:
diff.page.menu.name=Diff page

यदि आपको अनुवाद सहायता की आवश्यकता है, तो हम अतिरिक्त गुण बनाएंगे, उदाहरण के लिए, रूसी स्थानीयकरण के लिए फ़ाइल को diff-page_ru_RU.properties कहा जाएगा।

maven package चलाएं। प्लगइन स्वचालित रूप से पुनरारंभ होगा और हमारा मेनू आइटम दिखाई देगा।

मोडल खिड़की

पृष्ठ का चयन करने के लिए एक मोडल विंडो का उपयोग करना सुविधाजनक है। Atlassian-plugin.xml को संपादित करना जारी रखें

कुछ संसाधन जोड़ें:

 <web-resource key="diff-page-popup-resources" name="diff-page Popup Web Resources"> <dependency>com.atlassian.auiplugin:ajs</dependency> <dependency>com.atlassian.auiplugin:dialog2</dependency> <resource type="download" name="diff-page-popup.js" location="/js/diff-page-popup.js"/> <context>page</context> </web-resource> 

जहां:

• निर्भरता टैग - निर्भरता;
• संसाधन विशेषताएँ फ़ाइल सिस्टम पर संसाधन, नाम और स्थान के प्रकार को इंगित करती हैं;
• संदर्भ टैग - संदर्भ के आधार पर दृश्यता निर्धारित करता है।

हमारे यूआरएल के लिए हैंडलर्स को परिभाषित करें:

 <xwork name="Diff Page Action" key="diff-page-action"> <description>Diff page action</description> <package name="diff-page-package" extends="default" namespace="/plugins/diffPage"> <default-interceptor-ref name="defaultStack"/> <action name="diffPage" class="com.kshch.confluence.plugins.diff.page.action.DiffPageAction"> <result name="success" type="velocity">/templates/diff-page.vm</result> </action> <action name="diffPagePopup" class="com.kshch.confluence.plugins.diff.page.action.DiffPagePopupAction"> <result name="success" type="velocity">/templates/diff-page-popup.vm</result> </action> </package> </xwork> 

जहां:

• कार्रवाई टैग का नाम विशेषता - लिंक के नाम को परिभाषित करता है, और वर्ग - इसे संसाधित करने के लिए जावा वर्ग;
• टैग परिणाम - हमारे मामले के वेग में टेम्पलेट का लिंक होता है।

एक नया पैकेज com.kshch.confluence.plugins.diff.page.action बनाएं और इसमें DiffPagePopupAction क्लास जोड़ें, जो 2 क्षेत्रों के साथ ConfluenceActionSupport तक फैली हुई है।

 private String spaceKey; private Long sourcePageId; 

हम उनके लिए गेटर्स और सेटर जनरेट करते हैं। SpaceKey फ़ील्ड में वर्तमान स्थान की कुंजी होगी, और sourcePageId में वर्तमान पृष्ठ की आईडी होगी।

चलो सामने चलते हैं। पॉप-अप विंडो बनाने के लिए, AUI ढांचे से डायलॉग 2 तत्व का उपयोग करें।

एक फ़ॉर्म, एक सबमिट बटन और सीएसएस कक्षाओं के साथ इनपुट और स्वत: पूर्ण-स्थान और संवाद के लिए स्वत: पृष्ठ जोड़ें, जो आपको अतिरिक्त प्रयासों के बिना अंतरिक्ष और पृष्ठ की पसंद को व्यवस्थित करने की अनुमति देगा। परिणाम /templates/diff-page-popup.vm में सहेजें।

 <section role="dialog" id="diff-page-popup" class="aui-layer aui-dialog2 aui-dialog2-medium" aria-hidden="true" data-aui-remove-on-hide="true"> <form action="$action.getBootstrapManager().getWebAppContextPath()/plugins/diffPage/diffPage.action" method="get" class="aui"> ... <input type="hidden" name="sourcePageId" value="$action.getSourcePageId()"> <input class="text autocomplete-space" type="text" id="diff-page-space" name="spaceKey" data-max="10" data-none-message="$action.getText("diff.page.popup.no.result")" placeholder="$action.getText("diff.page.popup.select.space")" value="$action.getSpaceKey()" data-template="{key}"> <input type="text" class="text autocomplete-page" name="destinationPageName" data-max="10" placeholder="$action.getText("diff.page.popup.select.page")" data-none-message="$action.getText("diff.page.popup.no.result")"> <button id="dialog-diff-button" class="aui-button aui-button-primary">$action.getText("diff.page.popup.diff")</button> ... </form> </section> 

विंडो प्रदर्शित करने के लिए, निम्नलिखित सामग्री के साथ संसाधनों में /js/diff-page-popup.js बनाएं:

 (function ($) { $(function () { AJS.$('#diff-page').unbind('click'); AJS.$('#diff-page').bind("click", function (e) { e.preventDefault(); var link = AJS.$(this); AJS.$.get(link.attr('href'), function (response) { AJS.$('.aui-page-panel').after(response); AJS.dialog2("#diff-page-popup").show(); Confluence.Binder.autocompletePage(AJS.$("#diff-page-popup-binder")); }); return false; }); }); })(AJS.$); 

इसका कार्य मानक क्लिक घटना को ओवरराइड करना और लिंक के माध्यम से नेविगेट करने के बजाय हमें एक पॉप-अप विंडो दिखाना है।

maven package चलाएं और पृष्ठ और स्थान का चयन करने का प्रयास करें। टूलटिप 2 वर्णों के सेट के बाद सक्रिय होता है।

मुख्य कार्यक्षमता

हम बुनियादी कार्यक्षमता के कार्यान्वयन के लिए आगे बढ़ते हैं। Com.kshch.confluence.plugins.diff.page.action पैकेज में एक और DiffPageAction क्लास जोड़ें जो ConfluenceActionSupport तक फैली हुई है और निम्नलिखित क्षेत्रों के साथ PageAware इंटरफ़ेस को लागू करती है।

 private Long sourcePageId; private Long destinationPageId; private String spaceKey; private String destinationPageName; private String sourcePageTitle; private String destinationPageTitle; private String diff; private Page sourcePage; private Differ differ; private final PageManager pageManager; 

जहां:

• sourcePageId - स्रोत पृष्ठ की आईडी;
• डेस्टिनेशन आईडीडी - पृष्ठ की आईडी की तुलना की जा रही है;
• spaceKey - अंतरिक्ष कुंजी;
• डेस्टिनेशननाम - तुलना किए जा रहे पृष्ठ का नाम;
• sourcePageTitle - स्रोत पृष्ठ का शीर्षक;
• डेस्टिनेशनटाइटल - तुलना किए गए पृष्ठ का शीर्षक;
• तुलना का परिणाम भिन्न है।

हम गेटअप को छोड़कर, गेटअप के अलावा सभी तरीकों को लागू करते हैं। फ़ील्ड sourcePageId, spaceKey और डेस्टिनेशननाम में वह डेटा शामिल होगा जो डायलॉग 2 के अंदर फ़ॉर्म से आया था।

 @Override public AbstractPage getPage() { return this.sourcePage; } 

हम अपने स्वयं के लिए निष्पादन विधि को फिर से परिभाषित करते हैं। यह उस में है कि प्लगइन का मुख्य तर्क समाप्त हो गया है।

 @Override public String execute() throws Exception { if (this.sourcePageId != null && this.spaceKey != null && this.destinationPageName != null) { this.sourcePage = this.pageManager.getPage(this.sourcePageId); Page destinationPage = this.pageManager.getPage(this.spaceKey, this.destinationPageName); if (this.sourcePage != null && destinationPage != null) { this.destinationPageId = destinationPage.getId(); this.sourcePageTitle = this.sourcePage.getTitle(); this.destinationPageTitle = destinationPage.getTitle(); this.diff = this.differ.diff(this.sourcePage, destinationPage); } } return super.execute(); } 

यह 2 पृष्ठों के सामने की तुलना को लागू करने के लिए बनी हुई है। यह एक पॉपअप की तुलना में बहुत सरल है।

संसाधनों में बनाएं /templates/diff-page.vm। इसमें, लेआउट के अलावा, हम सबसे सरल त्रुटि जांच को लागू करते हैं।

 #if ($action.getDiff()) #diffBody() #else <div class="aui-message aui-message-error"> <p class="title"> <strong>$action.getText("diff.page.error")</strong> </p> <p>$action.getText("diff.page.error.message")</p> </div> #end 

प्लगइन का लेखन पूरा हो गया है। एक बार फिर, maven package चलाएं, पृष्ठ का चयन करें और परिणाम का आनंद लें।



पूरा प्रोजेक्ट कोड GitHub पर उपलब्ध है ।