Kuinka luoda oma laajennus ONLYOFFICE Docsille


Lyhyesti: Tässä artikkelissa opit luomaan oman laajennuksen ONLYOFFICE Docsille ja julkaisemaan sen virallisella laajennusmarkkinapaikalla, joka on saatavilla versiosta 7.2 alkaen.

selaa ja muuntaa PDF-tiedostoja ja niin edelleen.

On kuitenkin olemassa tapa tehdä ONLYOFFICEsta entistä tehokkaampi. Tässä tarkoitetaan kolmannen osapuolen laajennuksia, eli lisäohjelmistotyökaluja, jotka parantavat sarjan vakiotoiminnallisia ominaisuuksia. Pluginit mahdollistavat esimerkiksi kolmansien osapuolten palvelujen yhdistämisen tai uusien käyttöliittymäelementtien lisäämisen.

Kuinka luoda laajennus ONLYOFFICE Docsille

Ennen kuin alat luoda oman laajennuksen ONLYOFFICE Docsille, sinun on varmistettava, että sinulla on GitHub-dokumentaatio.

Laajennuksen luontiprosessi voidaan jakaa seitsemään vaiheeseen, joita sinun on noudatettava huolellisesti:

  • Alustavat toimet.
  • Koodaus.
  • Laajennuksen tyylin säätö.
  • Lokalisointi (valinnainen).
  • Valmistelu.
  • Testaus.
  • Julkaisu laajennusmarkkinapaikalla.

Sukellaan syvemmälle laajennuksen kehittämiseen.

Ensinnäkin sinun on kirjauduttava sisään GitHub-tilillesi tai luotava sellainen, jos sinulla ei ole sellaista. Tämän jälkeen sinun on luotava haarukka ONLYOFFICE-laajennuksen markkinapaikkavarastosta, joka on saatavilla seuraavassa URL-osoitteessa:

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

Tämän seurauksena sinulla on toinen arkisto, ja sen URL-osoite on suunnilleen tällainen:

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

Kun laajennusmarkkinapaikan repo on haettu onnistuneesti, on välttämätöntä luoda GitHub Pages -sivusto tästä arkistosta testausta varten. Jos et tiedä, miten se tehdään, tutustu viralliseen GitHub-oppaaseen.

Nyt kun sinulla on oma GitHub Pages -sivustosi, on aika kloonata haarukka tietokoneellesi.

Lopuksi sinun on luotava kansio tulevaa laajennusta varten osoitteessa:

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

Se siitä. Olet juuri suorittanut kaikki vaaditut alustavat toiminnot ja voit jatkaa seuraavaan vaiheeseen.

Sinun ei tarvitse olla äärimmäisen hyvä koodaamassa, mutta tarvitset ehdottomasti koodauksen perustiedot luodaksesi oman laajennuksen ONLYOFFICE Docsille.

Lyhyesti sanottuna ONLYOFFICE-laajennus on kansio, jossa on useita tiedostoja. Sinun on luotava kolme tiedostoa, jotta laajennus toimisi oikein:

  • config.json – Tämä on laajennuksen määritystiedosto, joka sisältää tiedot kaikista tärkeistä tiedoista. Tässä tiedostossa on joitain parametreja, jotka vaaditaan liitännäisen rekisteröimiseksi ONLYOFFICE-editoreihin. Tältä virallisen API-dokumentaation sivulta voit lukea kunkin parametrin täydellisen kuvauksen.
  • laajennuskoodi (.js-tiedosto) – Tämä on itse laajennustiedosto, joka sisältää laajennuksen JavaScript-koodin. Tämä tiedosto kuvaa toiminnot, jotka laajennus suorittaa ja miten ne suoritetaan. Lue tämä API-opas tietääksesi, miten se toimii.
  • index.html – Tämä on liitännäispiste, joka yhdistää config.json- ja plugin.js-tiedostot. Katso tämä esimerkki ymmärtääksesi, miltä sen pitäisi näyttää.

Näiden pakollisten tiedostojen lisäksi plugin-kansio voi sisältää muita tiedostoja. Esimerkiksi kuvakkeet, liitännäistyylit, readme-tiedostot, kolmannen osapuolen palvelut jne. Löydät lisätietoja tällaisista tiedostoista alta.

Jotta voit kirjoittaa hyvin toimivan koodin lisäosallesi, sinun on tiedettävä vaadittavat tapahtumat.

Koodin kirjoittaminen laajennukselle ei riitä. Sinun on myös säädettävä sen tyyliä, jotta se näyttää olennaiselta osalta ONLYOFFICE-editoreja. Voit tehdä tämän lisäämällä ONLYOFFICE-tyylisivun yllä kuvattuun index.html-tiedostoon:

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

Voit lisätä painikkeita, syöttösäätimiä, tarrasäätimiä, lataajia ja muita elementtejä.

Voit esimerkiksi lisätä yhdistelmäruudun laajennukseen käyttämällä select2-toimintoa:

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

Lisätty yhdistelmälaatikko näyttää tältä:

Lisätietoja ONLYOFFICE-tyylielementeistä löytyy täältä.

Voit ohittaa tämän vaiheen, jos aiot luoda laajennuksen vain englanninkielisille käyttäjille. Jos kuitenkin haluat, että laajennus on saatavilla muilla kielillä, voit luoda käännöskansion laajennushakemistoon ja laittaa sen .json-tiedostot kaikille kielille, joita haluat käyttää.

Lue virallinen API-dokumentaatio saadaksesi lisätietoja siitä, kuinka voit lokalisoida laajennuksen oikein.

Jos haluat hioa laajennuksen ulkonäköä ennen kuin se tulee saataville ONLYOFFICE-markkinapaikalla, sinun on lisättävä Tietoja-ikkuna, jossa on lyhyt kuvaus laajennuksestasi, sen versiosta, kehittäjän nimestä jne.

Tämä on esimerkiksi Photo Editor -laajennuksen Tietoja-ikkuna:

Voit luoda tällaisen ikkunan laajennukselle seuraamalla näitä ohjeita.

Lisäksi sinun on luotava laajennukselle kuvakkeet ja asetettava ne resurssikansioon. Yleensä tarvitset 8 kuvaketta, jotta laajennus näkyy oikein ONLYOFFICE-laajennusten markkinoilla: 4 kuvaketta (125 %, 150 %, 175 % ja 200 % skaalaus) Light ja Dark käyttöliittymäteemoille.

Lisäksi voit luoda readme-tiedoston ja laittaa sen laajennusten pääkansioon. Tämä tiedosto voi sisältää mitä tahansa tietoja, jotka haluat muiden käyttäjien tietävän – kuvauksen laajennuksen pääominaisuuksista, asennusohjeet, tunnetut ongelmat ja bugit jne.

Nyt laajennuksesi on valmis, ja voit testata sitä kunnolla ennen kuin julkaiset sen markkinoilla.

Nyt on aika laittaa kaikki tiedostot, jotka olet jo luonut yllä olevien ohjeiden mukaisesti plugin-kansioon. Työnnä sitten laajennuskansio etävarastoon ja testaa laajennusta ONLYOFFICE Desktop Editorsissa. Tätä tarkoitusta varten voit käyttää työpöytäsovellusta virheenkorjaustilassa.

Linuxissa voit avata terminaalin näppäinyhdistelmällä CTRL+ALT+T. Kirjoita sen jälkeen polku ONLYOFFICE Desktop Editors -sovellukseen, lisää välilyönti ja määritä sitten --ascdesktop-support-debug-info:

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

Testaa laajennusta ja sen ominaisuuksia.

Jos kaikki on kunnossa, voit myös testata laajennusta ONLYOFFICE-ohjelmistopaketin verkkoversiossa, ONLYOFFICE Docsissa. Toisin sanoen liitännäsi voidaan lisätä uutena laajennuksena.

Jotta voit luoda vastaavan laajennuksen, sinun on avattava tiedosto onlyoffice.github.io/store/plugin-dev/extension/inject.js ja määritettävä laajennuksen polku GitHub Pages -sivustolla muuttujassa URL_TO_PLUGIN:

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

Vainoffice.github.io/store/plugin-dev/extension-kansio on tarvitsemasi laajennus. Lataa se selaimeesi, kuinka voit lisätä laajennuksen verkkoselaimeen.

Jos laajennus toimii tarkoitetulla tavalla, voit jatkaa viimeiseen vaiheeseen.

Onnittelut! Olet käynyt läpi laajennuksen luomisprosessin ja nyt voit asettaa laajennuksen muiden käyttäjien saataville. Tätä tarkoitusta varten voit luoda haarukasta vetopyynnön tähän ONLYOFFICE-tietovarastoon osoitteessa:

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

Jos laajennuksesi toimii hyvin, ONLYOFFICE-kehittäjät hyväksyvät vetopyyntösi ja laajennuksesi tulee näkyviin ONLYOFFICE-laajennusten markkinoille. Tässä tapauksessa muut voivat asentaa sen kauppapaikalta muutamalla napsautuksella.

Toivomme, että tämä artikkeli on sinulle hyödyllinen. Älä unohda jakaa mielipiteesi alla olevissa kommenteissa.