ONLYOFFICE Desktop Plugin-ontwikkeling en -debugging inschakelen

Je hoeft in de ONLYOFFICE Desktop Editors geen aparte schakelaar voor plug-inontwikkeling in te schakelen. Maak een plug-in, installeer het .pluginpakket via Plugin Manager en start de desktop-app --ascdesktop-support-debug-infowanneer je debugtools nodig hebt. De desktop- en webeditors gebruiken verschillende laadprocedures, dus begin met de onderstaande workflow die specifiek is voor de desktopversie.

Bereid een klein pluginproject voor.

Deze instructies zijn van toepassing op ONLYOFFICE Desktop Editors op Windows, macOS en Linux. Gebruik een actuele desktopinstallatie en een code-editor voor platte tekstbestanden. De officiële documentatie beschouwt handmatige plug-ininstallatie en debuggen door ontwikkelaars als aparte functies; de Plugin Marketplace is niet vereist om een ​​lokale plug-in te ontwikkelen en te testen. Een "Hello World"-voorbeeld is een handige eerste controle, omdat het het laden van plug-ins isoleert van complexere services.

1. Maak de bronmap aan

Maak een map met de naam hello-world-plugin. Voeg een config.jsonmanifest en een index.htmlentry point toe. Voeg optioneel een icon.pngimage toe als uw manifest ernaar verwijst. Houd de map buiten de installatiemap van de applicatie, zodat software-updates uw werkbestanden niet overschrijven.

2. Definieer het manifest en genereer uw eigen GUID

Het manifest vertelt ONLYOFFICE welk HTML-bestand moet worden geladen en welke editors de plug-in mogen uitvoeren. Het volgende voorbeeld ondersteunt de documenteditor. Vervang de voorbeeld-GUID door een nieuw gegenereerde UUID vóór de installatie: voer de volgende opdracht uit New-Guidin Windows PowerShell of uuidgenop macOS of Linux en formatteer de waarde als asc.{YOUR-UUID}. Elke afzonderlijke plug-in heeft een eigen identificatiecode nodig.

{
  "name": "Hello World",
  "guid": "asc.{12345678-1234-1234-1234-1234567890AB}",
  "version": "1.0.0",
  "variations": [{
    "url": "index.html",
    "icons": ["icon.png"],
    "isViewer": false,
    "EditorsSupport": ["word"]
  }]
}

Gebruik geldige JSON: geen afsluitende komma's, overeenkomende accolades en een echt bestand voor elk referentiepunt of pictogram. Gebruik voor een spreadsheet- of presentatieplug-in de juiste waarden EditorsSupportin plaats van aan te nemen dat een documentplug-in overal verschijnt. Vergelijk de structuur met de officiële Hello World-snelstartgids .

3. Implementeer het toegangspunt

Laad in de index.htmlpagina de ONLYOFFICE plugin API-bibliotheek, voeg een knop toe en laat de knop de functie aanroepen window.Asc.plugin.executeMethod("PasteText", ["Hello World!"]). Het snelstartvoorbeeld van de fabrikant bevat de complete werkende HTML en de URL van de bibliotheek; het kopiëren van dat voorbeeld is veiliger dan het raden van de initialisatie of API-syntaxis. Sla het bestand op als UTF-8. Als u van plan bent offline te werken, vergeet dan niet dat een pagina die de pluginbibliotheek of andere elementen importeert vanaf een online URL, deze bronnen nog steeds nodig heeft om te laden.

Installeer en start uw ontwikkelingsplugin.

4. Maak het .plugin-archief aan.

Selecteer de bestanden in de bronmap, comprimeer ze tot een ZIP-archief en hernoem de ZIP-extensie van .zipnaar .plugin. De hoofdmap van het archief moet config.jsonen bevatten index.html, geen tweede, omringende hello-world-pluginmap. Schakel in Windows bestandsextensies in Verkenner in om te voorkomen dat u per ongeluk . maakt hello-world.plugin.zip. De officiële installatie-instructies voor Desktop Editors ondersteunen expliciet handmatige installatie zonder Marketplace-verbinding.

5. Importeer het pakket vanuit Plugin Manager.

Open een bewerkbaar document in ONLYOFFICE Desktop Editors. Kies Plugins > Pluginbeheer > Mijn plugins > Plugin handmatig installeren . Het exacte uiterlijk van het beheer kan per versie verschillen, maar dit is de gedocumenteerde procedure voor handmatige installatie. Het is niet de aparte instelling voor de ontwikkelaars-URL in de Marketplace.

6. Selecteer het bestand en controleer de menuoptie.

Selecteer uw hello-world.pluginarchief in het bestandsdialoogvenster en open het. De geïnstalleerde plug-in zou nu beschikbaar moeten zijn onder het tabblad Plug-ins. Als deze ontbreekt, controleer dan het manifest, de GUID, het ondersteunde editortype en de archiefmap voordat u de toepassingsinstellingen wijzigt. Probeer na de installatie een document opnieuw te openen als het menu niet direct wordt vernieuwd.

7. Test de plug-in in een wegwerpdocument.

Open een leeg testdocument, start Hello World vanuit het tabblad Plugins en gebruik de bijbehorende knop. Controleer of de woorden " Hello World!" in het document verschijnen. Dit controleert meer dan alleen de installatie: het bevestigt dat de plugininterface is geladen en dat de API-aanroep van de editor het document heeft bereikt. Test plugins die de inhoud wijzigen niet op een bestand dat niet kan worden vervangen.

Debuggen inschakelen voor pluginontwikkeling

8. Start Desktop Editors opnieuw op met de debug-vlag.

Sluit ONLYOFFICE Desktop Editors volledig af en start de applicatie vervolgens vanuit een terminal met de officiële debug-vlag. Gebruik de opdracht die geschikt is voor uw besturingssysteem en installatielocatie:

• Windows-opdrachtprompt: "%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
• Linux (standaard pakketlocatie): "/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
• macOS: "/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info

De bovenstaande Windows-opdracht maakt gebruik van variabele-expansie in de opdrachtprompt, niet van de PowerShell-syntaxis; in PowerShell roept u het uitvoerbare bestand aan met het volledige pad. Als uw app op een niet-standaardlocatie is geïnstalleerd, vervangt u dit door het daadwerkelijke pad naar het uitvoerbare bestand. U kunt de vlag ook toevoegen aan het veld 'Doel' van een Windows-snelkoppeling op het bureaublad. Zie de instructies voor debug-modus van ONLYOFFICE voor platformspecifieke informatie.

Zodra het document is geopend, klikt u in het bewerkingsgebied en drukt u op F1 , of klikt u met de rechtermuisknop op een bewerkbaar veld in de werkbalk en kiest u 'Element inspecteren' . Selecteer in de ontwikkelaarstools het iframe van de plug-in om de interfacecode en logboeken van de plug-in te inspecteren. Code die wordt doorgegeven, callCommandwordt uitgevoerd in de frameEditorcontext, dus schakel indien nodig tussen frames. De handleiding voor het debuggen van plug-ins legt dit onderscheid uit en hoe u breakpoints kunt gebruiken. Debuggen kan documentinhoud en runtime-details blootleggen; deel geen onbewerkte logboeken zonder ze eerst te controleren.

Verkort de bewerkings- en testcyclus zonder de ingebouwde plug-ins aan te passen.

Na handmatige installatie kopieert ONLYOFFICE een plug-in naar een map met een GUID-naam onder uw gebruikersprofiel. De gedocumenteerde locaties zijn te vinden %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\op Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/macOS en ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/Linux. De GUID-mapnaam laat de voorvoeging weg asc.die in het manifest wordt gebruikt.

Om te voorkomen dat er voor elke wijziging een nieuw archief wordt aangemaakt, kunnen ontwikkelaars de app sluiten, hun eigen geïnstalleerde plug-inmap vervangen door een symbolische link naar de bronmap en het document na bewerking opnieuw openen. Dit is optioneel en de exacte linkopdrachten verschillen per besturingssysteem. Volg de officiële instructies voor desktopontwikkeling voordat u dit doet. Vervang geen meegeleverde/standaard plug-inmappen en wijzig het macOS-apppakket niet: de leverancier waarschuwt dat het verwijderen van standaard plug-ins de pakketintegriteit kan aantasten en crashes kan veroorzaken.

Controleer de ontwikkelingsinstellingen.

Drie controles geven aan dat de workflow gereed is: de aangepaste plugin verschijnt onder Plugins , de Hello World-test voegt tekst in een nieuw document in en DevTools wordt geopend na het starten met de debug-vlag. Als de interface leeg is of de installatie mislukt, controleer dan of het manifest correct als JSON wordt geparseerd, of de GUID begint met asc., of het index.htmlbestand bestaat op het opgegeven relatieve pad en of alle vereiste resources aanwezig zijn. De officiële handleiding voor pluginfouten behandelt deze veelvoorkomende fouten. Een geïnstalleerde plugin is geen bewijs dat alle functionaliteiten die deze implementeert werken; herhaal dezelfde controle na elke codewijziging.