Hvernig á að búa til þitt eigið viðbót fyrir ONLYOFFICE skjöl

Stutt: Í þessari grein muntu læra hvernig á að búa til þitt eigið viðbót fyrir ONLYOFFICE Docs og hvernig á að birta það á opinbera viðbótamarkaðnum sem er fáanlegur frá og með útgáfu 7.2.

skoðar og umbreytir PDF skjölum og svo framvegis.

Hins vegar er leið til að gera ONLYOFFICE enn öflugri. Hér er átt við viðbætur frá þriðja aðila, þ. Til dæmis gera viðbætur það mögulegt að tengja þjónustu þriðja aðila eða bæta við nýjum notendaviðmótsþáttum.

Hvernig á að búa til viðbót fyrir ONLYOFFICE Docs

Áður en þú byrjar að búa til þitt eigið viðbót fyrir ONLYOFFICE Docs þarftu að ganga úr skugga um að þú sért með GitHub skjöl.

Hægt er að skipta ferlinu við að búa til viðbætur í sjö skref sem þú þarft að fylgja vandlega:

  • Bráðabirgðaaðgerðir.
  • Kóðun.
  • Leiðrétting á stíl viðbótarinnar.
  • Staðsetning (valfrjálst).
  • Undirbúningur.
  • Prófun.
  • Birtingu á viðbótamarkaðnum.

Við skulum kafa dýpra í þróun viðbótarinnar.

Fyrst af öllu þarftu að skrá þig inn á GitHub reikninginn þinn eða búa til einn ef þú ert ekki með einn. Eftir það þarftu að búa til gaffal af ONLYOFFICE viðbótamarkaðsgeymslunni sem er fáanleg á eftirfarandi vefslóð:

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

Fyrir vikið muntu hafa aðra geymslu og veffang hennar verður eitthvað á þessa leið:

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

Eftir að hafa tekist að punga upp viðbætingarmarkaðsversluninni er nauðsynlegt að búa til GitHub Pages síðu úr þessari geymslu í prófunarskyni. Ef þú veist ekki hvernig á að gera það, vinsamlegast skoðaðu opinberu GitHub handbókina.

Nú þegar þú ert með þína eigin GitHub Pages síðu er kominn tími til að klóna gaffalinn á tölvuna þína.

Að lokum þarftu að búa til möppu fyrir framtíðarviðbótina þína á:

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

Það er það. Þú hefur nýlokið öllum nauðsynlegum forathöfnum og getur haldið áfram með næsta skref.

Þú þarft ekki að vera einstaklega góður í kóðun en þú þarft örugglega grunnþekkingu á kóðun til að búa til þitt eigið viðbót fyrir ONLYOFFICE Docs.

Í hnotskurn, ONLYOFFICE viðbót er mappa með nokkrum skrám. Þú verður að búa til þrjár skrár til að viðbótin þín virki rétt:

  • config.json – Þetta er viðbætur stillingarskrá sem inniheldur upplýsingar um öll mikilvæg gögn. Í þessari skrá eru nokkrar færibreytur sem eru nauðsynlegar til að skrá viðbótina í ONLYOFFICE ritstjórana. Skoðaðu þessa síðu í opinberu API skjölunum til að lesa alla lýsingu á hverri færibreytu.
  • viðbótakóði (.js skrá) – Þetta er viðbótaskráin sjálf sem inniheldur JavaScript kóða viðbótarinnar þinnar. Þessi skrá lýsir aðgerðum sem viðbótin framkvæmir og hvernig þær eru framkvæmdar. Lestu þessa API handbók til að vita hvernig það virkar.
  • index.html – Þetta er inngangsstaður viðbótarinnar sem tengir config.json og plugin.js skrárnar. Skoðaðu þetta dæmi til að skilja hvernig það ætti að líta út.

Burtséð frá þessum skylduskrám getur viðbótamappan innihaldið aðrar skrár. Til dæmis, tákn, viðbætur, readme skrár, þjónustur þriðju aðila osfrv. Þú finnur frekari upplýsingar um slíkar skrár hér að neðan.

Til að skrifa góðan vinnukóða fyrir viðbótina þína þarftu að þekkja nauðsynlega atburði.

Það er ekki nóg að skrifa kóða fyrir viðbótina þína. Þú þarft líka að aðlaga stíl hans svo hann líti út eins og óaðskiljanlegur hluti af ONLYOFFICE ritstjórum. Til að gera það skaltu bara bæta ONLYOFFICE stílblaðinu við index.html skrána sem lýst er hér að ofan:

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

Þú getur bætt við hnöppum, inntaksstýringum, merkistýringum, hleðslutæki og öðrum þáttum.

Til dæmis, til að bæta combo box við viðbótina þína, geturðu notað select2 aðgerðina:

<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' 
});

Samsettur kassi mun líta svona út:

Nánari upplýsingar um ONLYOFFICE stílþættina má finna hér.

Þú getur sleppt þessu skrefi ef þú ætlar að búa til viðbót fyrir enskumælandi notendur. Hins vegar, ef þú vilt að viðbótin þín sé tiltæk á öðrum tungumálum geturðu búið til þýðingarmöppuna í viðbótaskránni og sett .json skrárnar fyrir öll tungumál sem þú vilt nota.

Lestu opinberu API skjölin til að læra hvernig hér á að staðfæra viðbótina þína á réttan hátt.

Til að fínpússa útlit viðbótarinnar áður en það verður fáanlegt á ONLYOFFICE markaðnum þarftu að bæta við About-glugga með stuttri lýsingu á viðbótinni þinni, útgáfu þess, nafni þróunaraðila o.s.frv.

Til dæmis er þetta About glugginn í Photo Editor viðbótinni:

Til að geta búið til slíkan glugga fyrir viðbótina þína skaltu fylgja þessum leiðbeiningum.

Einnig þarftu að búa til tákn fyrir viðbótina þína og setja þau í auðlindamöppuna. Almennt þarftu 8 tákn svo að viðbótin þín birtist rétt á ONLYOFFICE viðbótamarkaðnum: 4 tákn (125%, 150%, 175% og 200% mælikvarði) fyrir Light and Dark viðmótsþemu.

Að auki geturðu búið til readme skrá og sett hana í aðalviðbótarmöppuna. Þessi skrá getur innihaldið allar upplýsingar sem þú vilt að aðrir notendur viti - lýsing á helstu eiginleikum viðbótarinnar, uppsetningarleiðbeiningar, þekkt vandamál og villur o.s.frv.

Nú er viðbótin þín tilbúin og þú getur prófað það almennilega áður en þú birtir það á markaðnum.

Nú er kominn tími til að setja allar skrárnar sem þú hefur þegar búið til samkvæmt leiðbeiningunum hér að ofan í viðbótamöppunni. Ýttu síðan viðbótamöppunni að ytri geymslunni og prófaðu viðbótina í ONLYOFFICE Desktop Editors. Í þessu skyni geturðu keyrt skjáborðsforritið í villuleitarham.

Á Linux geturðu opnað flugstöðina með CTRL+ALT+T. Eftir það, sláðu inn slóðina að ONLYOFFICE Desktop Editors, bættu við bili og tilgreindu síðan --ascdesktop-support-debug-info:

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

Prófaðu viðbótina þína og eiginleika þess.

Ef allt er í lagi geturðu líka prófað viðbótina þína í vefútgáfu ONLYOFFICE svítunnar, ONLYOFFICE Docs. Með öðrum orðum, hægt er að bæta við viðbótinni þinni sem nýrri viðbót.

Til að búa til samsvarandi viðbót þarftu að opna onlyoffice.github.io/store/plugin-dev/extension/inject.js skrána og tilgreina slóðina að viðbótinni þinni á GitHub Pages síðunni í URL_TO_PLUGIN breytunni:

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

Onlyoffice.github.io/store/plugin-dev/extension mappan er viðbótin sem þú þarft. Hladdu því bara upp í vafrann þinn, hvernig á að bæta viðbót við vafra.

Ef viðbótin þín virkar eins og til er ætlast geturðu haldið áfram með síðasta skrefið.

Til hamingju! Þú hefur farið í gegnum ferlið við að búa til viðbætur og nú geturðu gert viðbótina þína aðgengilega fyrir aðra notendur. Í þessu skyni geturðu búið til dráttarbeiðni frá gafflinum þínum í þessa ONLYOFFICE geymslu á:

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

Ef viðbótin þín virkar vel, munu ONLYOFFICE verktaki samþykkja dráttarbeiðni þína og viðbótin þín mun birtast á ONLYOFFICE viðbótamarkaðnum. Í þessu tilviki munu aðrir geta sett það upp af markaðnum með nokkrum smellum.

Við vonum að þér finnist þessi grein gagnleg. Ekki gleyma að deila því sem þér finnst í athugasemdunum hér að neðan.