ONLYOFFICE डॉक्स के लिए अपना खुद का प्लगइन कैसे बनाएं


संक्षिप्त: इस लेख में, आप सीखेंगे कि ONLYOFFICE डॉक्स के लिए अपना खुद का प्लगइन कैसे बनाया जाए और इसे आधिकारिक प्लगइन मार्केटप्लेस में कैसे प्रकाशित किया जाए जो कि संस्करण 7.2 से उपलब्ध है।

पीडीएफ फाइलों को ब्राउज़ और कनवर्ट करता है, और इसी तरह।

हालांकि, ONLYOFFICE को और भी अधिक शक्तिशाली बनाने का एक तरीका है। यहाँ जो अर्थ है वह तृतीय-पक्ष प्लगइन्स है, अर्थात अतिरिक्त सॉफ़्टवेयर उपकरण जो सूट की मानक कार्यात्मक क्षमताओं को बढ़ाते हैं। उदाहरण के लिए, प्लगइन्स तृतीय-पक्ष सेवाओं को कनेक्ट करना या नए उपयोगकर्ता इंटरफ़ेस तत्व जोड़ना संभव बनाता है।

ONLYOFFICE डॉक्स के लिए एक प्लगइन कैसे बनाएं

इससे पहले कि आप ONLYOFFICE डॉक्स के लिए अपना खुद का प्लगइन बनाना शुरू करें, आपको यह सुनिश्चित करना होगा कि आपके पास GitHub दस्तावेज़ीकरण है।

प्लगइन निर्माण प्रक्रिया को सात चरणों में विभाजित किया जा सकता है जिनका आपको सावधानीपूर्वक पालन करने की आवश्यकता है:

  • प्रारंभिक गतिविधियां.
  • कोडिंग.
  • प्लगइन शैली का समायोजन।
  • स्थानीयकरण (वैकल्पिक)।
  • तैयारी।
  • परीक्षण.
  • प्लगइन बाज़ार में प्रकाशन।

आइए प्लगइन विकास में गहराई से गोता लगाएँ।

सबसे पहले, आपको अपने GitHub खाते में लॉग इन करना होगा या यदि आपके पास एक नहीं है तो एक बनाना होगा। उसके बाद, आपको ONLYOFFICE प्लगइन मार्केटप्लेस रिपॉजिटरी का एक फोर्क बनाना होगा जो निम्न URL पते पर उपलब्ध है:

https://github.com/ONLYOFFICE/onlyoffice.github.io.

नतीजतन, आपके पास एक और भंडार होगा, और इसका यूआरएल पता कुछ ऐसा होगा:

https://github.com/YOUR-USERNAME/ONLYOFFICE/onlyoffice.github.io

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

अब जब आपके पास अपनी गिटहब पेज साइट है, तो यह आपके कंप्यूटर पर कांटा क्लोन करने का समय है।

अंत में, आपको अपने भविष्य के प्लगइन के लिए एक फ़ोल्डर बनाने की आवश्यकता है:

onlyoffice.github.io/sdkjs-plugins/content/.

इतना ही। आपने अभी-अभी सभी आवश्यक प्रारंभिक गतिविधियाँ पूरी की हैं और अगले चरण पर आगे बढ़ सकते हैं।

आपको कोडिंग में बहुत अच्छा होने की आवश्यकता नहीं है, लेकिन ONLYOFFICE डॉक्स के लिए अपना खुद का प्लगइन बनाने के लिए आपको निश्चित रूप से कुछ बुनियादी कोडिंग ज्ञान की आवश्यकता है।

संक्षेप में, ONLYOFFICE प्लगइन कई फाइलों वाला एक फ़ोल्डर है। अपने प्लगइन के ठीक से काम करने के लिए आपको तीन फाइलें बनानी होंगी:

  • config.json - यह एक प्लगइन कॉन्फ़िगरेशन फ़ाइल है जिसमें सभी महत्वपूर्ण डेटा के बारे में जानकारी होती है। इस फ़ाइल में, कुछ पैरामीटर हैं जो ONLYOFFICE संपादकों में प्लगइन को पंजीकृत करने के लिए आवश्यक हैं। प्रत्येक पैरामीटर का पूरा विवरण पढ़ने के लिए आधिकारिक API दस्तावेज़ में इस पृष्ठ को देखें।
  • प्लगइन कोड (.js फ़ाइल) - यह प्लगइन फ़ाइल ही है जिसमें आपके प्लगइन का जावास्क्रिप्ट कोड होता है। यह फ़ाइल उन कार्यों का वर्णन करती है जो प्लगइन करता है और उन्हें कैसे किया जाता है। यह कैसे काम करता है, यह जानने के लिए यह एपीआई गाइड पढ़ें।
  • index.html – यह आपके प्लगइन का प्रवेश बिंदु है जो config.json और plugin.js फाइलों को जोड़ता है। यह कैसा दिखना चाहिए, यह समझने के लिए इस उदाहरण को देखें।

इन अनिवार्य फाइलों के अलावा, प्लगइन फ़ोल्डर में अन्य फाइलें हो सकती हैं। उदाहरण के लिए, आइकन, प्लगइन शैलियाँ, रीडमी फ़ाइलें, तृतीय-पक्ष सेवाएँ, आदि। आपको ऐसी फ़ाइलों के बारे में अधिक जानकारी नीचे मिलेगी।

अपने प्लगइन के लिए एक अच्छा काम करने वाला कोड लिखने के लिए, आपको आवश्यक घटनाओं को जानना होगा।

आपके प्लगइन के लिए कोड लिखना पर्याप्त नहीं है। आपको इसकी शैली को भी समायोजित करने की आवश्यकता है ताकि यह ONLYOFFICE संपादकों के एक अभिन्न अंग की तरह दिखे। ऐसा करने के लिए, बस ऊपर वर्णित index.html फ़ाइल में ONLYOFFICE स्टाइल शीट जोड़ें:

<link rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">

आप बटन, इनपुट नियंत्रण, लेबल नियंत्रण, लोडर और अन्य तत्व जोड़ सकते हैं।

उदाहरण के लिए, अपने प्लगइन में कॉम्बो बॉक्स जोड़ने के लिए, आप Select2 फ़ंक्शन का उपयोग कर सकते हैं:

<select id="select_example" class="" ></select> 
$('#select_example').select2({     
data : [{id:0, text:'Item 1'}, {id:1, text:'Item 2'}, {id:2, text:'Item 3'}],     
minimumResultsForSearch: Infinity,     
width : '120px' 
});

डाला गया कॉम्बो बॉक्स इस तरह दिखेगा:

ONLYOFFICE शैली के तत्वों के बारे में अधिक जानकारी यहाँ पाई जा सकती है।

यदि आप केवल अंग्रेजी बोलने वाले उपयोगकर्ताओं के लिए एक प्लगइन बनाने जा रहे हैं तो आप इस चरण को छोड़ सकते हैं। हालांकि, यदि आप चाहते हैं कि आपका प्लगइन अन्य भाषाओं में उपलब्ध हो, तो आप प्लगइन निर्देशिका में अनुवाद फ़ोल्डर बना सकते हैं और उन सभी भाषाओं के लिए उनकी .json फाइलें डाल सकते हैं, जिनका आप उपयोग करना चाहते हैं।

अपने प्लगइन को सही तरीके से स्थानीयकृत करने का तरीका जानने के लिए आधिकारिक API दस्तावेज़ पढ़ें।

ONLYOFFICE बाज़ार में अपने प्लगइन के उपलब्ध होने से पहले उसकी उपस्थिति को चमकाने के लिए, आपको अपने प्लगइन, उसके संस्करण, डेवलपर नाम आदि के संक्षिप्त विवरण के साथ एक संक्षिप्त विवरण विंडो जोड़ने की आवश्यकता है।

उदाहरण के लिए, यह फोटो संपादक प्लगइन की विंडो के बारे में है:

अपने प्लगइन के लिए ऐसी विंडो बनाने में सक्षम होने के लिए, इन निर्देशों का पालन करें।

इसके अलावा, आपको अपने प्लगइन के लिए आइकन बनाने और उन्हें संसाधन फ़ोल्डर में डालने की आवश्यकता है। सामान्य तौर पर, आपको 8 आइकन की आवश्यकता होती है ताकि आपका प्लगइन ONLYOFFICE प्लगइन बाज़ार में सही ढंग से प्रदर्शित हो: लाइट और डार्क इंटरफ़ेस थीम के लिए 4 आइकन (125%, 150%, 175%, और 200% स्केलिंग)।

इसके अतिरिक्त, आप एक रीडमी फ़ाइल बना सकते हैं और इसे मुख्य प्लगइन फ़ोल्डर में डाल सकते हैं। इस फ़ाइल में कोई भी जानकारी शामिल हो सकती है जिसे आप अन्य उपयोगकर्ताओं को जानना चाहते हैं - आपके प्लगइन की मुख्य विशेषताओं का विवरण, स्थापना निर्देश, ज्ञात समस्याएं, और बग इत्यादि।

अब आपका प्लगइन तैयार है, और आप इसे बाज़ार में प्रकाशित करने से पहले ठीक से परीक्षण कर सकते हैं।

अब आपके द्वारा पहले से बनाई गई सभी फाइलों को प्लगइन फ़ोल्डर में ऊपर दिए गए निर्देशों के अनुसार डालने का समय आ गया है। फिर प्लगइन फ़ोल्डर को दूरस्थ रिपॉजिटरी में धकेलें और ONLYOFFICE डेस्कटॉप संपादकों में प्लगइन का परीक्षण करें। इस उद्देश्य के लिए, आप डेस्कटॉप ऐप को डिबगिंग मोड में चला सकते हैं।

लिनक्स पर, आप टर्मिनल को CTRL+ALT+T से खोल सकते हैं। उसके बाद, ONLYOFFICE डेस्कटॉप संपादकों के लिए पथ दर्ज करें, एक स्थान जोड़ें और फिर --ascdesktop-support-debug-info निर्दिष्ट करें:

"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info

अपने प्लगइन और इसकी विशेषताओं का परीक्षण करें।

यदि सब कुछ ठीक है, तो आप ONLYOFFICE सुइट, ONLYOFFICE डॉक्स के वेब संस्करण में भी अपने प्लगइन का परीक्षण कर सकते हैं। दूसरे शब्दों में, आपका प्लगइन एक नए एक्सटेंशन के रूप में जोड़ा जा सकता है।

संबंधित एक्सटेंशन बनाने के लिए, आपको onlyoffice.github.io/store/plugin-dev/extension/inject.js फ़ाइल खोलनी होगी और URL_TO_PLUGIN वैरिएबल में GitHub पेज साइट पर अपने प्लगइन का पथ निर्दिष्ट करना होगा:

var URL_TO_PLUGIN = "https://YOUR-USERNAME.github.io/onlyoffice.github.io/sdkjs-plugins/content/your-plugin/"

onlyoffice.github.io/store/plugin-dev/extension फ़ोल्डर वह एक्सटेंशन है जिसकी आपको आवश्यकता है। बस इसे अपने वेब ब्राउजर पर अपलोड करें, वेब ब्राउजर में प्लगइन कैसे जोड़ें।

यदि आपका प्लगइन इरादा के अनुसार काम करता है, तो आप अंतिम चरण के साथ आगे बढ़ सकते हैं।

बधाई हो! आप प्लगइन निर्माण प्रक्रिया से गुजर चुके हैं और अब आप अपने प्लगइन को अन्य उपयोगकर्ताओं के लिए उपलब्ध करा सकते हैं। इस उद्देश्य के लिए, आप अपने कांटे से इस ONLYOFFICE रिपॉजिटरी में एक पुल अनुरोध बना सकते हैं:

https://github.com/ONLYOFFICE/onlyoffice.github.io

यदि आपका प्लगइन अच्छा काम करता है, तो ONLYOFFICE डेवलपर्स आपके पुल अनुरोध को स्वीकार करेंगे, और आपका प्लगइन ONLYOFFICE प्लगइन मार्केटप्लेस में दिखाई देगा। इस मामले में, अन्य कुछ ही क्लिक के साथ इसे बाज़ार से स्थापित करने में सक्षम होंगे।

हमें उम्मीद है कि आपको यह लेख उपयोगी लगा होगा। आप जो सोचते हैं उसे नीचे टिप्पणी में साझा करना न भूलें।