So aktivieren Sie die Plugin-Entwicklung in ONLYOFFICE Desktop-Editoren

ONLYOFFICE Desktop Editors dokumentiert keine Option zum Aktivieren der Plugin-Entwicklung. Der empfohlene Workflow sieht vor, dass Sie Ihr eigenes Plugin über den Plugin-Manager installieren, es im lokalen Plugin-Ordner ablegen und optional die installierte Kopie durch einen symbolischen Link zu Ihrem Arbeitsverzeichnis ersetzen. Um Fehler zu untersuchen und Haltepunkte zu setzen, starten Sie die Desktop-Anwendung mit dem dokumentierten Debug-Flag. Dies sind separate Schritte: Der Debug-Modus stellt die Entwicklertools bereit, während die Installation oder Verknüpfung des Plugins es dem Editor zur Verfügung stellt.

Die aktuelle ONLYOFFICE-API-Dokumentation beschreibt denselben Desktop-Workflow und dokumentiert auch eine Option, um den Debug-Modus über mehrere Starts hinweg aktiviert zu lassen. Ich habe keine offizielle Ankündigung einer neuen Entwicklermodus-Option gefunden, die diese Schritte ändert. Diese Anleitung folgt den offiziellen Anweisungen vom 6. Oktober 2026. Pfade können je nach Installationstyp variieren. Überprüfen Sie daher den Pfad für Ihre Plattform, bevor Sie Dateien ändern.

Wählen Sie einen Workflow für die Plugin-Entwicklung.

Für die meisten Entwickler empfiehlt es sich, das Archiv einmalig zur Registrierung des Plugins zu verwenden und anschließend für weitere Iterationen einen symbolischen Link zu nutzen. Setzen Sie das Debug-Flag nur dann, wenn Sie Code diagnostizieren. Lassen Sie die persistente Variante deaktiviert, es sei denn, Sie benötigen die Entwicklertools bei jedem Start.

Bereiten Sie die Plugin-Dateien vor.

Erstellen Sie zunächst ein lokales Plugin-Verzeichnis, das mindestens die für Ihr Plugin erforderlichen Dateien enthält, einschließlich `.config.js` config.jsonund ` index.html.config.js`. Die Konfigurationsdatei muss eine gültige Plugin-GUID besitzen und gemäß dem ONLYOFFICE-Plugin-Schema auf die Einstiegsseite und die Assets des Plugins verweisen. Verwenden Sie die offiziellen Beispiel-Plugins oder die API-Dokumentation für das vollständige Schema. Eine fehlerhafte GUID, ein ungültiger Pfad oder eine ungültige Konfiguration können dazu führen, dass das Plugin nicht angezeigt wird.

Die GUID config.jsonhat üblicherweise die Form ` asc.{YOUR-GUID}.desktopeditors.php`. Desktop Editors verwendet die GUID als Plugin-Ordnernamen, lässt aber das asc.Präfix weg. Verwenden Sie dieselbe GUID im Quellverzeichnis, im Archiv und im Installationspfad. Verwenden Sie nicht die GUID eines integrierten oder eines anderen installierten Plugins wieder.

Installieren Sie das Plugin zum ersten Mal

1. Packen Sie die Dateien und Unterordner des Plugins in ein ZIP-Archiv. Die Dateien selbst müssen sich im Stammverzeichnis des Archivs befinden und nicht in einem zusätzlichen, übergeordneten Projektordner.
2. Ändern Sie die Archiv-Erweiterung von .zipin .plugin.
3. Öffnen Sie ONLYOFFICE Desktop Editors, wählen Sie die Registerkarte Plugins und klicken Sie auf Plugin-Manager .
4. Öffnen Sie „Meine Plugins“ , wählen Sie „Plugin manuell installieren“ , wählen Sie die .pluginDatei aus und bestätigen Sie.

Das Plugin sollte anschließend im Plugin-Tab des geöffneten Editors und in später geöffneten Editoren erscheinen. Die manuelle Archivierung funktioniert auch ohne Internetverbindung. Die Installation über den Marketplace ist für sofort einsatzbereite Plugins gedacht; sie ersetzt nicht das Laden einer eigenen Entwicklungsversion.

Verwenden Sie einen symbolischen Link für eine schnellere Iteration.

Nach der ersten Installation speichert Desktop Editors eine Kopie in einem sdkjs-pluginsVerzeichnis. Ersetzen Sie diese Kopie durch einen symbolischen Link zu Ihrem Quellordner, um die Arbeitsdateien direkt bearbeiten zu können. Schließen Sie Desktop Editors, bevor Sie den Ordner des installierten Test-Plugins ändern. Erstellen Sie eine Sicherungskopie oder stellen Sie sicher, dass Ihr Quellordner intakt ist, und entfernen Sie nur den Ordner, dessen GUID der Ihres Test-Plugins entspricht.

Innerhalb des Verzeichnisses ist der Linkname die GUID in geschweiften Klammern ohne asc.Präfix. Wenn die Konfigurations-GUID beispielsweise lautet asc.{91EAC419-EF8B-440C-A960-B451C7DF3A37}, ist der Ordner- oder Linkname {91EAC419-EF8B-440C-A960-B451C7DF3A37}.

Windows

Öffnen Sie die Eingabeaufforderung als Administrator, falls dies aufgrund Ihrer Windows-Kontoeinstellungen oder -Richtlinien erforderlich ist. Nachdem Sie die Editoren geschlossen und den installierten Test-Plugin-Ordner verschoben haben, erstellen Sie die Verzeichnisverknüpfung:

mklink /D "%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\{YOUR-GUID}" "C:\path\to\your\plugin"

Ersetzen Sie beide Platzhalter durch die GUID und den vollständigen Pfad zu Ihrem Quellverzeichnis. Das Linkziel darf noch nicht existieren.

macOS

ln -s "/path/to/your/plugin" "$HOME/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/{YOUR-GUID}"

Linux

ln -s "/path/to/your/plugin" "$HOME/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/{YOUR-GUID}"

Verwenden Sie die Pfade Ihrer installierten Edition; gepackte oder in einer Sandbox ausgeführte Builds speichern Benutzerdaten möglicherweise an einem anderen Ort. Öffnen Sie nach der Bearbeitung des Quellcodes das Dokument erneut oder laden Sie das Plugin gegebenenfalls neu. Der symbolische Link vermeidet das Neuerstellen des Archivs, Änderungen werden jedoch nicht unbedingt erst nach dem Neuladen des Plugins durch den Editor übernommen.

Desktop-Editoren mit Entwicklertools starten

Um ein Plugin zu debuggen, beenden Sie Desktop Editors vollständig und starten Sie es mit dem Befehl `npm run start` --ascdesktop-support-debug-info. Verwenden Sie den Befehl für Ihr Betriebssystem; wenn Sie die Anwendung an einem benutzerdefinierten Ort installiert haben, passen Sie den Ausführungspfad an.

Windows

Führen Sie folgenden Befehl in der Eingabeaufforderung aus:

"%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info

Alternativ können Sie das Zielfeld einer Verknüpfung bearbeiten, indem Sie nach dem Pfad der ausführbaren Datei ein Leerzeichen und das Flag hinzufügen. Dies betrifft Starts über diese Verknüpfung.

Linux

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

macOS

"/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info

Sobald die App ausgeführt wird, klicken Sie in ein Dokument und drücken Sie die Eingabetaste F1oder klicken Sie mit der rechten Maustaste auf ein bearbeitbares Symbolleistenfeld und wählen Sie „ Element untersuchen“ . Wählen Sie in den Entwicklertools den iFrame des Plugins aus, um dessen JavaScript-Code und Protokolle zu untersuchen. Der an die Anwendung übergebene Code wird callCommandim Editor-Frame mit dem Namen „“ ausgeführt frameEditor, daher können Fehler und Haltepunkte in einem anderen Kontext als der UI-Code des Plugins angezeigt werden.

Die optionale Option --ascdesktop-support-debug-info-keep=1hält den Debug-Modus über mehrere Starts hinweg aktiviert. Um den persistenten Zustand zu deaktivieren, starten Sie mit der Option `--debug-mode` --ascdesktop-support-debug-info-keep=0; verwenden Sie `--debug- --ascdesktop-support-debug-info-keep=defaultmode`, um zum Standardzustand zurückzukehren. Persistente Entwicklertools sind auf einem dedizierten Testrechner praktisch, aber auf einer gemeinsam genutzten Workstation führen sie zu unnötiger Unordnung und halten Inspektionstools verfügbar, obwohl sie nicht benötigt werden.

Überprüfen Sie, ob die Entwicklungsumgebung funktioniert.

• Das Plugin wird unter seinem konfigurierten Namen auf der Registerkarte „Plugins“ angezeigt.
• Nach einer Änderung der Quelle zeigt das erneute Öffnen des Dokuments oder das Neuladen des Plugins das aktualisierte Verhalten an.
• Die Entwicklertools öffnen sich mit F1oder über „Element untersuchen“, nachdem sie mit dem Debug-Flag gestartet wurden.
• Protokolle aus dem UI-Code des Plugins werden angezeigt, wenn der Plugin-iFrame ausgewählt wird; Dokumentbefehle werden in frameEditor.

Falls das Plugin fehlt, überprüfen Sie, ob config.jsonsich index.htmldie Dateien im Archivstammverzeichnis befinden, die GUID gültig ist und der Ordner die GUID ohne asc.Präfix verwendet. Stellen Sie sicher, dass der Link auf das Quellverzeichnis und nicht auf ein übergeordnetes Verzeichnis verweist, das dieses enthält. Falls das Plugin zwar angezeigt wird, sich aber wie eine ältere Version verhält, schließen Sie das Dokument und öffnen Sie es erneut, damit der Editor die verknüpften Dateien neu lädt.

Was diese Konfiguration nicht ermöglicht

Das Desktop-Debug-Flag ist keine globale Berechtigungseinstellung für die Plugin-Entwicklung. Durch die Installation eines Archivs oder das Ablegen eines Ordners im unterstützten Plugin-Verzeichnis wird das Plugin verfügbar; das Debug-Flag stellt lediglich die Inspektionswerkzeuge bereit. Ebenso gelten Anweisungen zum Laden eines Plugins per URL in einen Web-Editor nicht automatisch für Desktop-Editoren. Verwenden Sie den oben beschriebenen, desktopspezifischen Installations- und Debugging-Workflow.

Diese Anleitung bezieht sich auf Plugins für ONLYOFFICE Desktop-Editoren. Sie erklärt nicht, wie Plugins in DocSpace aktiviert, serverseitige Plugins in ONLYOFFICE Docs konfiguriert oder ein Plugin im Marketplace veröffentlicht werden. Informationen zu diesen Arbeitsabläufen finden Sie in der entsprechenden offiziellen Produktdokumentation.

Offizielle Referenzen

• ONLYOFFICE: Entwicklung von Plugins
• ONLYOFFICE: Entwicklung von Plugins für Desktop-Editoren
• ONLYOFFICE: Installation und Test von Plugins in Desktop-Editoren
• ONLYOFFICE: Desktop-Editoren im Debug-Modus ausführen
• ONLYOFFICE: Plugins in Desktop-Editoren debuggen
• ONLYOFFICE: Offizielle Plugin-Beispiele und Quellcode-Repository