Kif Oħloq il-Plugin tiegħek għal ONLYOFFICE Docs

Qosor: F'dan l-artikolu, titgħallem kif toħloq il-plugin tiegħek għal ONLYOFFICE Docs u kif tippubblikah fis-suq uffiċjali tal-plugins li huwa disponibbli mill-verżjoni 7.2.

tibbrawżja u tikkonverti fajls PDF, eċċ.

Madankollu, hemm mod kif ONLYOFFICE isir saħansitra aktar qawwi. Dak li huwa mfisser hawnhekk huwa plugins ta 'partijiet terzi, jiġifieri għodod ta' softwer addizzjonali li jtejbu l-kapaċitajiet funzjonali standard tas-suite. Pereżempju, il-plugins jagħmluha possibbli li jiġu konnessi servizzi ta 'partijiet terzi jew li jiżdiedu elementi ġodda tal-interface tal-utent.

Kif toħloq Plugin għal ONLYOFFICE Docs

Qabel ma tibda toħloq il-plugin tiegħek għal ONLYOFFICE Docs, trid tiżgura li jkollok dokumentazzjoni GitHub.

Il-proċess tal-ħolqien tal-plugin jista 'jinqasam f'seba' passi li trid issegwi bir-reqqa:

  • Attivitajiet preliminari.
  • Kodifikazzjoni.
  • Aġġustament tal-istil tal-plugin.
  • Lokalizzazzjoni (mhux obbligatorja).
  • Tħejjija.
  • Ittestjar.
  • Pubblikazzjoni fis-suq tal-plugins.

Ejja ngħaddu aktar fil-fond fl-iżvilupp tal-plugin.

L-ewwelnett, trid tidħol fil-kont GitHub tiegħek jew toħloq wieħed jekk ma jkollokx wieħed. Wara dan, trid toħloq furketta tar-repożitorju tas-suq tal-plugins ONLYOFFICE li huwa disponibbli fl-indirizz URL li ġej:

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

Bħala riżultat, ser ikollok repożitorju ieħor, u l-indirizz URL tiegħu se jkun xi ħaġa bħal din:

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

Wara li tforkja b'suċċess ir-repo tas-suq tal-plugins, huwa meħtieġ li jinħoloq sit tal-Paġni GitHub minn dan ir-repożitorju għal skopijiet ta 'ttestjar. Jekk ma tafx kif tagħmel dan, jekk jogħġbok irreferi għall-gwida uffiċjali tal-GitHub.

Issa li għandek is-sit tiegħek tal-Paġni GitHub, wasal iż-żmien li tikklona l-furketta fil-kompjuter tiegħek.

Fl-aħħarnett, trid toħloq folder għall-plugin futur tiegħek fuq:

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

Dak hu. Għadek kif lestiet l-attivitajiet preliminari kollha meħtieġa u tista' tipproċedi bil-pass li jmiss.

M'għandekx għalfejn tkun estremament tajjeb fil-kodifikazzjoni iżda żgur li għandek bżonn xi għarfien bażiku tal-kodifikazzjoni biex toħloq il-plugin tiegħek għal ONLYOFFICE Docs.

Fil-qosor, plugin ONLYOFFICE huwa folder b'diversi fajls. Trid toħloq tliet fajls biex il-plugin tiegħek jaħdem b'mod korrett:

  • config.json – Dan huwa fajl tal-konfigurazzjoni tal-plugin li fih informazzjoni dwar id-dejta importanti kollha. F'dan il-fajl, hemm xi parametri li huma meħtieġa biex jirreġistraw il-plugin fl-edituri ONLYOFFICE. Ħares lejn din il-paġna fid-dokumentazzjoni uffiċjali tal-API biex taqra d-deskrizzjoni sħiħa ta' kull parametru.
  • kodiċi tal-plugin (fajl .js) – Dan huwa l-fajl tal-plugin innifsu li fih il-kodiċi JavaScript tal-plugin tiegħek. Dan il-fajl jiddeskrivi l-operazzjonijiet li jwettaq il-plugin u kif jitwettqu. Aqra din il-gwida tal-API biex tkun taf kif taħdem.
  • index.html – Dan huwa l-punt tad-dħul tal-plugin tiegħek li jgħaqqad il-fajls config.json u plugin.js. Agħti ħarsa lejn dan l-eżempju biex tifhem kif għandu jidher.

Minbarra dawn il-fajls obbligatorji, il-folder tal-plugin jista 'jkun fih fajls oħra. Pereżempju, ikoni, stili ta' plugins, fajls readme, servizzi ta' partijiet terzi, eċċ. Issib aktar informazzjoni dwar fajls bħal dawn hawn taħt.

Biex tikteb kodiċi tax-xogħol tajjeb għall-plugin tiegħek, trid tkun taf l-avvenimenti meħtieġa.

Il-kitba tal-kodiċi għall-plugin tiegħek mhix biżżejjed. Trid ukoll taġġusta l-istil tagħha sabiex tidher qisha parti integrali mill-edituri ta’ ONLYOFFICE. Biex tagħmel dan, żid biss il-folja tal-istil ONLYOFFICE mal-fajl index.html deskritt hawn fuq:

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

Tista 'żżid buttuni, kontrolli ta' input, kontrolli ta 'tikketta, loaders, u elementi oħra.

Pereżempju, biex iżżid kaxxa combo mal-plugin tiegħek, tista' tuża l-funzjoni 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' 
});

Il-kaxxa combo mdaħħla tidher bħal din:

Aktar informazzjoni dwar l-elementi tal-istil ONLYOFFICE tista’ ssibha hawn.

Tista' taqbeż dan il-pass jekk se toħloq plugin għall-utenti li jitkellmu bl-Ingliż biss. Madankollu, jekk trid li l-plugin tiegħek ikun disponibbli f'lingwi oħra, tista' toħloq il-folder tat-traduzzjonijiet fid-direttorju tal-plugin u tpoġġi l-fajls .json tagħhom għal-lingwi kollha li trid tuża.

Aqra d-dokumentazzjoni uffiċjali tal-API biex titgħallem kif hawn biex tiklokalizza l-plugin tiegħek b'mod korrett.

Biex illustra d-dehra tal-plugin tiegħek qabel ma jsir disponibbli fis-suq ONLYOFFICE, trid iżżid tieqa Dwar b'deskrizzjoni qasira tal-plugin tiegħek, il-verżjoni tiegħu, l-isem tal-iżviluppatur, eċċ.

Pereżempju, din hija t-tieqa Dwar tal-plugin tal-Editur tar-Ritratti:

Biex tkun tista' toħloq tali tieqa għall-plugin tiegħek, segwi dawn l-istruzzjonijiet.

Ukoll, għandek bżonn toħloq ikoni għall-plugin tiegħek u tpoġġihom fil-folder tar-riżorsi. B'mod ġenerali, għandek bżonn 8 ikoni sabiex il-plugin tiegħek jintwera b'mod korrett fis-suq tal-plugins ONLYOFFICE: 4 ikoni (125%, 150%, 175%, u 200% skala) għat-temi tal-interface Light u Dark.

Barra minn hekk, tista 'toħloq fajl readme u poġġih fil-folder prinċipali tal-plugin. Dan il-fajl jista 'jinkludi kwalunkwe informazzjoni li trid li utenti oħra jkunu jafu - deskrizzjoni tal-karatteristiċi ewlenin tal-plugin tiegħek, struzzjonijiet ta' installazzjoni, kwistjonijiet magħrufa, u bugs, eċċ.

Issa l-plugin tiegħek huwa lest, u tista 'tittestjah sew qabel ma tippubblikaha fis-suq.

Issa wasal iż-żmien li tpoġġi l-fajls kollha li diġà ħloqt skont l-istruzzjonijiet ta 'hawn fuq fil-folder tal-plugin. Imbagħad imbotta l-folder tal-plugin għar-repożitorju remot u ttestja l-plugin fl-Edituri tad-Desktop ONLYOFFICE. Għal dan il-għan, tista 'tħaddem l-app tad-desktop fil-mod ta' debugging.

Fuq Linux, tista 'tiftaħ it-terminal bi CTRL + ALT + T. Wara dan, daħħal it-triq għal ONLYOFFICE Desktop Editors, żid spazju u mbagħad speċifika --ascdesktop-support-debug-info:

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

Ittestja l-plugin tiegħek u l-karatteristiċi tiegħu.

Jekk kollox huwa OK, tista 'wkoll tittestja l-plugin tiegħek fil-verżjoni web tas-suite ONLYOFFICE, ONLYOFFICE Docs. Fi kliem ieħor, il-plugin tiegħek jista 'jiġi miżjud bħala estensjoni ġdida.

Biex toħloq l-estensjoni korrispondenti, trid tiftaħ il-fajl onlyoffice.github.io/store/plugin-dev/extension/inject.js u tispeċifika t-triq għall-plugin tiegħek fuq is-sit tal-Paġni GitHub fil-varjabbli URL_TO_PLUGIN:

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

Il-folder onlyoffice.github.io/store/plugin-dev/extension hija l-estensjoni li għandek bżonn. Ittellgħuha fil-web browser tiegħek, kif iżżid plugin ma' web browser.

Jekk il-plugin tiegħek jaħdem kif maħsub, tista 'tipproċedi bil-pass finali.

Prosit! Għaddejt mill-proċess tal-ħolqien tal-plugin u issa tista 'tagħmel il-plugin tiegħek disponibbli għal utenti oħra. Għal dan il-għan, tista' toħloq talba tal-ġibda mill-furketta tiegħek għal dan ir-repożitorju ta' ONLYOFFICE fuq:

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

Jekk il-plugin tiegħek jaħdem tajjeb, l-iżviluppaturi ONLYOFFICE japprovaw it-talba tal-ġibda tiegħek, u l-plugin tiegħek jidher fis-suq tal-plugins ONLYOFFICE. F'dan il-każ, oħrajn ikunu jistgħu jinstallawha mis-suq bi ftit klikks.

Nittamaw li ssib dan l-artikolu utli. Tinsiex taqsam dak li taħseb fil-kummenti hawn taħt.