Wéi erstellt Dir Ären eegene Plugin fir ONLYOFFICE Docs
Kuerz: An dësem Artikel léiert Dir wéi Dir Ären eegene Plugin fir ONLYOFFICE Docs erstellt a wéi Dir et op der offizieller Plugin Maartplaz publizéiert, déi ab Versioun 7.2 verfügbar ass.
Browst a konvertéiert PDF Dateien, a sou weider.
Wéi och ëmmer, et gëtt e Wee fir ONLYOFFICE nach méi mächteg ze maachen. Wat hei gemengt ass ass Drëtt Partei Plugins, dh zousätzlech Software Tools déi d'Standard funktionell Fäegkeeten vun der Suite verbesseren. Zum Beispill, Plugins maachen et méiglech Drëtt Partei Servicer ze verbannen oder nei User Interface Elementer ze addéieren.
Wéi erstellt ee Plugin fir ONLYOFFICE Docs
Ier Dir ufänkt Ären eegene Plugin fir ONLYOFFICE Docs ze kreéieren, musst Dir sécher sinn datt Dir eng GitHub Dokumentatioun hutt.
De Plugin Kreatiounsprozess kann a siwe Schrëtt opgedeelt ginn, déi Dir suergfälteg verfollege musst:
- Virleefeg Aktivitéiten.
- Kodéierung.
- Upassung vum Pluginstil.
- Lokaliséierung (optional).
- Virbereedung.
- Test.
- Publikatioun op der Plugin Maartplaz.
Loosst eis méi déif an d'Plugin Entwécklung tauchen.
Als éischt musst Dir op Äre GitHub Kont aloggen oder een erstellen wann Dir keen hutt. Duerno musst Dir eng Gabel vum ONLYOFFICE Plugin Maartplaz Repository erstellen deen op der folgender URL Adress verfügbar ass:
https://github.com/ONLYOFFICE/onlyoffice.github.io.
Als Resultat hutt Dir en anert Repository, a seng URL Adress wäert esou sinn:
https://github.com/YOUR-USERNAME/ONLYOFFICE/onlyoffice.github.io
Nodeems Dir de Plugin Maartplaz Repo erfollegräich ofgeschaaft huet, ass et néideg fir e GitHub Pages Site vun dësem Repository fir Testzwecker ze kreéieren. Wann Dir net wësst wéi Dir et maacht, kuckt w.e.g. op den offiziellen GitHub Guide.
Elo datt Dir Ären eegene GitHub Pages Site hutt, ass et Zäit d'Gabel op Äre Computer ze klonen.
Schlussendlech musst Dir en Dossier fir Ären zukünftege Plugin erstellen op:
onlyoffice.github.io/sdkjs-plugins/content/.
Dat ass et. Dir hutt just all déi erfuerderlech virleefeg Aktivitéiten ofgeschloss a kënnt mam nächste Schrëtt weidergoen.
Dir musst net extrem gutt sinn am Kodéierung awer Dir braucht definitiv e puer Basis Kodéierungskenntnisser fir Ären eegene Plugin fir ONLYOFFICE Docs ze kreéieren.
An enger Nossschuel, en ONLYOFFICE Plugin ass en Dossier mat verschiddene Dateien. Dir musst dräi Dateien erstellen fir datt Äre Plugin richteg funktionnéiert:
- config.json - Dëst ass eng Plugin Konfiguratiounsdatei déi Informatioun iwwer all wichteg Donnéeën enthält. An dësem Fichier sinn et e puer Parameteren déi erfuerderlech sinn fir de Plugin an den ONLYOFFICE Redaktoren ze registréieren. Kuckt dës Säit an der offizieller API Dokumentatioun fir déi voll Beschreiwung vun all Parameter ze liesen.
- Plugincode (.js Datei) - Dëst ass d'Plugindatei selwer déi de JavaScript Code vun Ärem Plugin enthält. Dëse Fichier beschreift d'Operatiounen déi de Plugin ausféiert a wéi se ausgefouert ginn. Liest dësen API Guide fir ze wëssen wéi et funktionnéiert.
- index.html - Dëst ass den Entréespunkt vun Ärem Plugin deen d'config.json a plugin.js Dateien verbënnt. Kuckt dëst Beispill fir ze verstoen wéi et soll ausgesinn.
Nieft dësen obligatoresche Fichieren, kann de Plugin Dossier aner Fichieren enthalen. Zum Beispill, Symboler, Plugin Stiler, readme Fichieren, drëtt-Partei Servicer, etc.. Dir fannt méi Informatiounen iwwert esou Fichieren ënnert.
Fir e gudden Aarbechtscode fir Äre Plugin ze schreiwen, musst Dir déi néideg Eventer wëssen.
Code fir Äre Plugin ze schreiwen ass net genuch. Dir musst och säi Stil upassen sou datt et ausgesäit wéi en integralen Deel vun den ONLYOFFICE Redaktoren. Fir dat ze maachen, füügt just den ONLYOFFICE Style Sheet un d'index.html Datei uewen beschriwwen:
<link rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">
Dir kënnt Knäppercher, Input Kontrollen, Label Kontrollen, loaders, an aner Elementer derbäi.
Zum Beispill, fir eng Combobox op Äre Plugin ze addéieren, kënnt Dir d'Select2 Funktioun benotzen:
<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'
});
Déi agebaute Combobox gesäit esou aus:
Méi Informatioun iwwer d'ONLYOFFICE Stil Elementer fannt Dir hei.
Dir kënnt dëse Schrëtt iwwersprangen wann Dir e Plugin erstellt nëmme fir engleschsproocheg Benotzer. Wann Dir awer wëllt datt Äre Plugin an anere Sproochen verfügbar ass, kënnt Dir den Iwwersetzungsverzeechnes am Plugin-Verzeichnis erstellen an hir .json-Dateien fir all Sproochen déi Dir benotze wëllt.
Liest déi offiziell API Dokumentatioun fir ze léieren wéi Dir Äre Plugin richteg lokaliséiert.
Fir d'Erscheinung vun Ärem Plugin ze poléieren ier en an der ONLYOFFICE Maartplaz verfügbar ass, musst Dir eng Iwwer-Fënster mat enger kuerzer Beschreiwung vun Ärem Plugin, seng Versioun, den Entwécklernumm, etc.
Zum Beispill ass dëst d'About Fënster vum Photo Editor Plugin:
Fir esou eng Fënster fir Äre Plugin ze kreéieren, befollegt dës Instruktiounen.
Och musst Dir Ikonen fir Äre Plugin erstellen an se an de Ressourcen Dossier setzen. Am Allgemengen, braucht Dir 8 Symboler fir datt Äre Plugin korrekt an der ONLYOFFICE Plugin Maartplaz weist: 4 Symboler (125%, 150%, 175%, an 200% Skaléieren) fir Light an Dark Interface Themen.
Zousätzlech kënnt Dir eng Readme Datei erstellen an se an den Haapt Plugin Dossier setzen. Dës Datei kann all Informatioun enthalen, déi Dir wëllt datt aner Benotzer wëssen - eng Beschreiwung vun den Haaptfeatures vun Ärem Plugin, Installatiounsinstruktiounen, bekannte Probleemer a Bugs, asw.
Elo ass Äre Plugin prett, an Dir kënnt et richteg testen ier Dir et um Maart publizéiert.
Elo ass et Zäit all d'Fichier'en ze setzen déi Dir scho erstallt hutt no den Instruktiounen hei uewen am Plugin Dossier. Da dréckt de Plugin-Ordner op de Remote Repository a test de Plugin an ONLYOFFICE Desktop Editors. Fir dësen Zweck, kënnt Dir d'Desktop App am Debugging Modus lafen.
Op Linux kënnt Dir den Terminal mat CTRL + ALT + T opmaachen. Duerno gitt de Wee op ONLYOFFICE Desktop Editoren, füügt e Raum a gitt dann --ascdesktop-support-debug-info:
"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
Test Äre Plugin a seng Funktiounen.
Wann alles OK ass, kënnt Dir och Äre Plugin an der Webversioun vun der ONLYOFFICE Suite, ONLYOFFICE Docs testen. An anere Wierder, Äre Plugin kann als nei Extensioun bäigefüügt ginn.
Fir déi entspriechend Extensioun ze kreéieren, musst Dir d'Onlyoffice.github.io/store/plugin-dev/extension/inject.js Datei opmaachen an de Wee fir Äre Plugin op der GitHub Pages Site an der URL_TO_PLUGIN Variabel spezifizéieren:
var URL_TO_PLUGIN = "https://YOUR-USERNAME.github.io/onlyoffice.github.io/sdkjs-plugins/content/your-plugin/"
Den onlyoffice.github.io/store/plugin-dev/extension Dossier ass d'Extensioun déi Dir braucht. Luet et einfach op Äre Webbrowser erop, wéi Dir e Plugin an e Webbrowser addéiere kënnt.
Wann Äre Plugin funktionnéiert wéi virgesinn, kënnt Dir mam leschte Schrëtt weidergoen.
Gratulatioun! Dir sidd duerch de Plugin Kreatiounsprozess gaang an elo kënnt Dir Äre Plugin fir aner Benotzer verfügbar maachen. Fir dësen Zweck kënnt Dir eng Pull-Ufro vun Ärer Gabel an dësen ONLYOFFICE Repository erstellen op:
https://github.com/ONLYOFFICE/onlyoffice.github.io
Wann Äre Plugin gutt funktionnéiert, stëmmen d'ONLYOFFICE Entwéckler Är Pull-Ufro un, an Äre Plugin erschéngt an der ONLYOFFICE Plugin Maartplaz. An dësem Fall kënnen anerer et vun der Maartplaz mat e puer Mausklicken installéieren.
Mir hoffen Dir fannt dësen Artikel nëtzlech. Vergiesst net ze deelen wat Dir denkt an de Kommentaren hei drënner.