Kā izveidot savu spraudni ONLYOFFICE dokumentiem

Īsumā: šajā rakstā jūs uzzināsit, kā izveidot savu spraudni pakalpojumam ONLYOFFICE dokumenti un kā to publicēt oficiālajā spraudņu tirgū, kas ir pieejams, sākot ar versiju 7.2.

pārlūko un konvertē PDF failus utt.

Tomēr ir veids, kā padarīt ONLYOFFICE vēl jaudīgāku. Šeit ir domāti trešo pušu spraudņi, t.i., papildu programmatūras rīki, kas uzlabo komplekta standarta funkcionālās iespējas. Piemēram, spraudņi ļauj savienot trešo pušu pakalpojumus vai pievienot jaunus lietotāja interfeisa elementus.

Kā izveidot spraudni ONLYOFFICE dokumentiem

Pirms sākat izveidot savu ONLYOFFICE dokumentu spraudni, jums ir jāpārliecinās, vai jums ir GitHub dokumentācija.

Spraudņa izveides procesu var iedalīt septiņos posmos, kas jums rūpīgi jāievēro:

  • Iepriekšējās darbības.
  • Kodēšana.
  • Spraudņa stila pielāgošana.
  • Lokalizācija (neobligāti).
  • Sagatavošana.
  • Pārbaude.
  • Publikācija spraudņu tirgū.

Iedziļināsimies spraudņa izstrādē.

Pirmkārt, jums ir jāpiesakās savā GitHub kontā vai jāizveido tas, ja jums tāda nav. Pēc tam jums ir jāizveido ONLYOFFICE spraudņa tirgus vietas repozitorija dakša, kas ir pieejama šajā URL adresē:

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

Tā rezultātā jums būs vēl viens repozitorijs, un tā URL adrese būs aptuveni šāda:

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

Pēc veiksmīgas spraudņu tirgus repo izmantošanas no šīs krātuves ir jāizveido GitHub Pages vietne testēšanas nolūkos. Ja nezināt, kā to izdarīt, lūdzu, skatiet oficiālo GitHub rokasgrāmatu.

Tagad, kad jums ir sava GitHub Pages vietne, ir pienācis laiks klonēt dakšiņu savā datorā.

Visbeidzot, jums ir jāizveido mape savam nākotnes spraudnim vietnē:

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

Tieši tā. Jūs tikko esat pabeidzis visas nepieciešamās sākotnējās darbības un varat turpināt nākamo darbību.

Jums nav jābūt ļoti labiem kodēšanas jomā, taču jums noteikti ir nepieciešamas dažas pamata kodēšanas zināšanas, lai izveidotu savu spraudni ONLYOFFICE dokumentiem.

Īsumā, spraudnis ONLYOFFICE ir mape ar vairākiem failiem. Lai spraudnis darbotos pareizi, ir jāizveido trīs faili:

  • config.json — šis ir spraudņa konfigurācijas fails, kurā ir informācija par visiem svarīgajiem datiem. Šajā failā ir daži parametri, kas nepieciešami, lai reģistrētu spraudni ONLYOFFICE redaktoros. Apskatiet šo oficiālās API dokumentācijas lapu, lai izlasītu katra parametra pilnu aprakstu.
  • spraudņa kods (.js fails) — šis ir pats spraudņa fails, kas satur jūsu spraudņa JavaScript kodu. Šajā failā ir aprakstītas darbības, kuras veic spraudnis un kā tās tiek veiktas. Izlasiet šo API rokasgrāmatu, lai uzzinātu, kā tas darbojas.
  • index.html — tas ir spraudņa ievades punkts, kas savieno failus config.json un plugin.js. Apskatiet šo piemēru, lai saprastu, kā tam vajadzētu izskatīties.

Papildus šiem obligātajiem failiem spraudņa mapē var būt arī citi faili. Piemēram, ikonas, spraudņu stili, readme faili, trešo pušu pakalpojumi utt. Plašāku informāciju par šādiem failiem atradīsit tālāk.

Lai savam spraudnim uzrakstītu labi funkcionējošu kodu, jums jāzina nepieciešamie notikumi.

Nepietiek ar spraudņa koda rakstīšanu. Jums arī jāpielāgo tā stils, lai tas izskatītos kā ONLYOFFICE redaktoru neatņemama sastāvdaļa. Lai to izdarītu, vienkārši pievienojiet stila lapu ONLYOFFICE iepriekš aprakstītajam failam index.html:

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

Varat pievienot pogas, ievades vadīklas, etiķešu vadīklas, iekrāvējus un citus elementus.

Piemēram, lai spraudnim pievienotu kombinēto lodziņu, varat izmantot funkciju 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' 
});

Ievietotais kombinētais lodziņš izskatīsies šādi:

Vairāk informācijas par ONLYOFFICE stila elementiem var atrast šeit.

Varat izlaist šo darbību, ja plānojat izveidot spraudni tikai angliski runājošiem lietotājiem. Tomēr, ja vēlaties, lai jūsu spraudnis būtu pieejams citās valodās, varat izveidot tulkojumu mapi spraudņa direktorijā un ievietot to .json failus visām valodām, kuras vēlaties izmantot.

Izlasiet oficiālo API dokumentāciju, lai uzzinātu, kā šeit pareizi lokalizēt spraudni.

Lai uzlabotu spraudņa izskatu, pirms tas kļūst pieejams ONLYOFFICE tirgū, jums jāpievieno logs Par ar īsu spraudņa aprakstu, tā versiju, izstrādātāja nosaukumu utt.

Piemēram, šis ir fotoattēlu redaktora spraudņa logs Par:

Lai savam spraudnim varētu izveidot šādu logu, izpildiet šos norādījumus.

Turklāt jums ir jāizveido spraudņa ikonas un jāievieto tās resursu mapē. Parasti jums ir nepieciešamas 8 ikonas, lai spraudnis tiktu pareizi parādīts spraudņu tirgū ONLYOFFICE: 4 ikonas (125%, 150%, 175% un 200% mērogošana) interfeisa motīviem Light un Dark.

Turklāt varat izveidot Readme failu un ievietot to galvenajā spraudņa mapē. Šajā failā var būt ietverta visa informācija, ko vēlaties zināt citiem lietotājiem — jūsu spraudņa galveno funkciju apraksts, instalēšanas instrukcijas, zināmās problēmas un kļūdas utt.

Tagad jūsu spraudnis ir gatavs, un jūs varat to pareizi pārbaudīt pirms tā publicēšanas tirgū.

Tagad ir pienācis laiks ievietot visus failus, ko esat jau izveidojis saskaņā ar iepriekš sniegtajiem norādījumiem, spraudņa mapē. Pēc tam nosūtiet spraudņa mapi uz attālo repozitoriju un pārbaudiet spraudni programmā ONLYOFFICE Desktop Editors. Šim nolūkam varat palaist darbvirsmas lietotni atkļūdošanas režīmā.

Operētājsistēmā Linux termināli var atvērt, izmantojot taustiņu kombināciju CTRL+ALT+T. Pēc tam ievadiet ceļu uz ONLYOFFICE Desktop Editors, pievienojiet atstarpi un pēc tam norādiet --ascdesktop-support-debug-info:

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

Pārbaudiet savu spraudni un tā funkcijas.

Ja viss ir kārtībā, varat arī pārbaudīt savu spraudni ONLYOFFICE komplekta tīmekļa versijā ONLYOFFICE Docs. Citiem vārdiem sakot, jūsu spraudni var pievienot kā jaunu paplašinājumu.

Lai izveidotu atbilstošo paplašinājumu, ir jāatver fails onlyoffice.github.io/store/plugin-dev/extension/inject.js un mainīgajā URL_TO_PLUGIN ir jānorāda ceļš uz spraudni vietnē GitHub Pages:

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

Mape onlyoffice.github.io/store/plugin-dev/extension ir jums nepieciešamais paplašinājums. Vienkārši augšupielādējiet to savā tīmekļa pārlūkprogrammā, kā tīmekļa pārlūkprogrammai pievienot spraudni.

Ja jūsu spraudnis darbojas, kā paredzēts, varat turpināt pēdējo darbību.

Apsveicam! Jūs esat izgājis cauri spraudņa izveides procesam, un tagad varat padarīt savu spraudni pieejamu citiem lietotājiem. Šim nolūkam varat izveidot izvilkšanas pieprasījumu no dakšas uz šo ONLYOFFICE repozitoriju vietnē:

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

Ja jūsu spraudnis darbojas labi, ONLYOFFICE izstrādātāji apstiprinās jūsu izvilkšanas pieprasījumu, un jūsu spraudnis parādīsies ONLYOFFICE spraudņu tirgū. Šajā gadījumā citi varēs to instalēt no tirgus ar dažiem klikšķiem.

Mēs ceram, ka šis raksts jums noderēs. Neaizmirstiet dalīties ar savu viedokli tālāk sniegtajos komentāros.