Acasă
» Sfaturi pentru PC
»
Activează dezvoltarea și depanarea pluginurilor ONLYOFFICE pentru desktop
Activează dezvoltarea și depanarea pluginurilor ONLYOFFICE pentru desktop
Nu este nevoie să activați un comutator separat pentru dezvoltarea de pluginuri în ONLYOFFICE Desktop Editors. Creați un plugin, instalați .pluginpachetul său prin Plugin Manager și lansați aplicația desktop cu --ascdesktop-support-debug-infoinstrumentele de depanare atunci când aveți nevoie. Editorii desktop și web utilizează proceduri de încărcare diferite, așa că începeți cu fluxul de lucru specific desktopului de mai jos.
Pregătiți un mic proiect de plugin
Aceste instrucțiuni se aplică editorilor desktop ONLYOFFICE pe Windows, macOS și Linux. Folosiți o instalare desktop actualizată și un editor de cod pentru fișiere text simplu. Documentația oficială tratează instalarea manuală a pluginurilor și depanarea dezvoltatorilor ca funcții separate; Plugin Marketplace nu este necesar pentru a dezvolta și testa un plugin local. Un exemplu Hello World este o primă verificare utilă, deoarece izolează încărcarea pluginurilor de servicii mai complexe.
1. Creați folderul sursă
Creați un folder numit hello-world-plugin. Adăugați un config.jsonmanifest și un index.htmlpunct de intrare. Opțional, adăugați o icon.pngimagine dacă manifestul dvs. face referire la una. Păstrați folderul în afara directorului aplicației instalate, astfel încât actualizările de software să nu suprascrie fișierele de lucru.
Păstrați manifestul pluginului și fișierul HTML cu punctul său de intrare împreună într-un singur folder de dezvoltare; o pictogramă locală este opțională.
2. Definiți manifestul și generați propriul GUID
Manifestul indică ONLYOFFICE ce fișier HTML să încarce și ce editori pot rula pluginul. Următorul exemplu este compatibil cu editorul de documente. Înlocuiți GUID-ul eșantion cu un UUID nou generat înainte de instalare: rulați New-Guidîn Windows PowerShell sau uuidgenpe macOS sau Linux, apoi formatați valoarea ca asc.{YOUR-UUID}. Fiecare plugin distinct are nevoie de propriul identificator.
Folosește JSON valid: fără virgule la sfârșit, acolade potrivite și un fișier real pentru fiecare punct de intrare sau pictogramă la care se face referire. Pentru un plugin de foi de calcul sau de prezentare, folosește valorile corespunzătoare în EditorsSupportloc să presupui că un plugin doar pentru documente apare peste tot. Compară structura cu ghidul oficial de pornire rapidă Hello World .
Manifestul config.json identifică pluginul și îl restricționează la editorii pe care îi acceptă.
3. Implementați punctul de intrare
În index.html, încărcați biblioteca API a pluginului ONLYOFFICE, adăugați un buton și apelați butonul . Exemplul de pornire rapidăwindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"]) al producătorului oferă codul HTML funcțional complet și adresa URL a bibliotecii; copierea acestui exemplu este mai sigură decât ghicirea inițializării sau a sintaxei API. Salvați fișierul ca UTF-8. Dacă intenționați să lucrați offline, rețineți că o pagină care importă biblioteca sa de pluginuri sau alte resurse de pe o adresă URL online are nevoie în continuare de aceste resurse pentru a se încărca.
Fișierul punct de intrare conține interfața și apelul JavaScript pe care editorul le folosește atunci când pluginul rulează.
Instalați și rulați pluginul de dezvoltare
4. Construiți arhiva .plugin
Selectați fișierele din folderul sursă, comprimați-le într-o arhivă ZIP și redenumiți extensia ZIP din .zipîn .plugin. Directorul rădăcină al arhivei ar trebui să conțină config.jsonși index.html, nu un al doilea hello-world-plugindirector care să îl încapă. Pe Windows, activați extensiile de nume de fișier în File Explorer pentru a nu crea accidental hello-world.plugin.zip. Instrucțiunile oficiale de instalare a editorilor desktop acceptă în mod explicit instalarea manuală fără o conexiune la Marketplace.
Arhivați conținutul folderului pluginului, nu folderul care îl încadrează, înainte de a redenumi fișierul ZIP cu extensia .plugin.
5. Importați pachetul din Managerul de pluginuri
Deschideți un document editabil în Editorii desktop ONLYOFFICE. Selectați Pluginuri > Manager pluginuri > Pluginurile mele > Instalați pluginul manual . Aspectul exact al managerului poate diferi în funcție de versiune, dar această acțiune este calea documentată de instalare manuală. Nu este setarea separată a adresei URL pentru dezvoltatori din Marketplace.
Într-un document, deschideți Plugins, apoi Plugin Manager și comutați la My plugins pentru a accesa instalarea manuală.
6. Selectați fișierul și verificați intrarea din meniu
Selectați hello-world.pluginarhiva în caseta de dialog pentru fișiere și deschideți-o. Pluginul instalat ar trebui să devină disponibil în fila Pluginuri. Dacă lipsește, verificați manifestul, GUID-ul, tipul de editor acceptat și rădăcina arhivei înainte de a modifica setările aplicației. Încercați să redeschideți un document după instalare dacă meniul nu se actualizează imediat.
Alegeți arhiva .plugin din caseta de selectare a fișierelor; nu selectați folderul sursă original.
7. Testați pluginul într-un document de unică folosință
Deschideți un document de test gol, lansați Hello World din fila Plugins și utilizați butonul corespunzător. Confirmați că în document apar cuvintele Hello World!. Aceasta verifică mai mult decât simpla instalare: confirmă că interfața pluginului s-a încărcat și apelul API al editorului său a ajuns la document. Nu testați pluginurile care modifică conținutul pe un fișier neînlocuit.
Rulați pluginul instalat într-un document de unică folosință și verificați conținutul documentului rezultat.
Activează depanarea pentru dezvoltarea pluginurilor
8. Relansați editorii desktop cu semnalizatorul de depanare
Închideți complet editorii desktop ONLYOFFICE, apoi porniți aplicația dintr-un terminal cu semnalizatorul oficial de depanare. Folosiți comanda corespunzătoare sistemului dvs. de operare și locației de instalare:
Linie de comandă Windows:"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
Linux (locația standard a pachetului):"/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
Comanda Windows de mai sus folosește extinderea variabilelor din promptul de comandă, nu sintaxa PowerShell; în PowerShell, apelați executabilul cu calea completă rezolvată. Dacă aplicația a fost instalată într-o locație nestandard, înlocuiți-o cu calea executabilului reală. De asemenea, puteți adăuga semnalizatorul la câmpul Target al unei comenzi rapide de pe desktopul Windows. Consultați comenzile ONLYOFFICE pentru modul de depanare desktop pentru detalii despre platformă.
După ce documentul este deschis, faceți clic în zona sa de editare și apăsați F1 sau faceți clic dreapta pe un câmp editabil din bara de instrumente și alegeți Inspectare element . În DevTools, alegeți iframe-ul pluginului pentru a inspecta codul și jurnalele interfeței pluginului. Codul transmis callCommandexecuțiilor în frameEditorcontext este în schimb transmis, așadar schimbați cadrele atunci când este necesar. Referința de depanare a pluginului explică această distincție și cum se utilizează punctele de întrerupere. Depanarea poate expune conținutul documentului și detaliile din timpul execuției; nu partajați jurnalele brute fără a le verifica.
După activarea depanării, inspectați iframe-ul pluginului relevant în DevTools; mesajele consolei de aici sunt ilustrative.
Scurtează ciclul de editare-testare fără a modifica pluginurile încorporate
După instalarea manuală, ONLYOFFICE copiază un plugin într-un director denumit GUID din profilul dvs. de utilizator. Locațiile documentate sunt %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\pe Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/pe macOS și ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/pe Linux. Folderul denumit GUID omite intercalarea asc.utilizată în manifest.
Pentru a evita crearea unei noi arhive pentru fiecare modificare, dezvoltatorii pot închide aplicația, pot înlocui folderul plugin-urilor instalate cu un link simbolic către folderul sursă funcțional și pot redeschide documentul după editare. Acest lucru este opțional, iar comenzile exacte de link diferă în funcție de sistemul de operare. Urmați instrucțiunile oficiale de dezvoltare desktop înainte de a face acest lucru. Nu înlocuiți folderele plugin-urilor incluse/implicite și nu modificați pachetul aplicației macOS: furnizorul avertizează că eliminarea plugin-urilor implicite poate încălca integritatea pachetului și poate provoca blocări.
Verificați configurația de dezvoltare
Trei verificări indică faptul că fluxul de lucru este gata: pluginul personalizat apare sub Pluginuri , testul Hello World inserează text într-un document nou, iar DevTools se deschide după lansare cu semnalizatorul de depanare. Dacă interfața este goală sau instalarea eșuează, confirmați că manifestul analizează ca JSON, GUID-ul începe cu asc., index.htmlexistă la calea relativă declarată și toate resursele necesare sunt prezente. Ghidul oficial de erori al pluginurilor acoperă aceste erori comune. Un plugin instalat nu este o dovadă că fiecare funcție pe care o implementează funcționează; repetați aceeași verificare după fiecare modificare de cod.