Jak włączyć tworzenie wtyczek w edytorach pulpitu ONLYOFFICE

ONLYOFFICE Desktop Editors nie dokumentuje ani jednego przełącznika „Włącz tworzenie wtyczek”. Obsługiwany obieg pracy polega na zainstalowaniu własnej wtyczki za pomocą Menedżera wtyczek, umieszczeniu jej w lokalnym folderze wtyczek i opcjonalnie zastąpieniu zainstalowanej kopii dowiązaniem symbolicznym do działającego folderu źródłowego. Aby sprawdzić błędy i użyć punktów przerwania, uruchom aplikację desktopową z udokumentowaną flagą debugowania. Są to oddzielne kroki: tryb debugowania udostępnia narzędzia programistyczne, a instalacja lub linkowanie wtyczki udostępnia je edytorowi.

Aktualna dokumentacja API ONLYOFFICE opisuje ten sam przepływ pracy na komputerze stacjonarnym, a także dokumentuje flagę umożliwiającą utrzymanie włączonego trybu debugowania po każdym uruchomieniu. Nie znalazłem oficjalnego powiadomienia o nowym przełączniku trybu programistycznego, który zmieniałby te kroki. Niniejszy przewodnik jest zgodny z oficjalnymi instrukcjami dostępnymi 6 października 2026 r. Ścieżki mogą się różnić w zależności od typu instalacji, dlatego przed zmianą plików należy sprawdzić ścieżkę dla swojej platformy.

Wybierz przepływ pracy związany z tworzeniem wtyczek

Większość programistów korzysta z archiwum raz, aby zarejestrować wtyczkę, a następnie używa dowiązania symbolicznego do iteracji. Flagę debugowania należy dodawać tylko podczas diagnostyki kodu. Należy wyłączyć jej trwałą wersję, chyba że narzędzia programistyczne są potrzebne przy każdym uruchomieniu.

Przygotuj pliki wtyczki

Zacznij od lokalnego katalogu wtyczki zawierającego co najmniej pliki wymagane przez wtyczkę, w tym config.jsoni index.html. Plik konfiguracyjny musi mieć prawidłowy identyfikator GUID wtyczki i wskazywać stronę główną wtyczki oraz zasoby, korzystając ze schematu wtyczki ONLYOFFICE. Skorzystaj z oficjalnych przykładowych wtyczek lub dokumentacji API, aby zapoznać się z pełnym schematem; nieprawidłowy identyfikator GUID, uszkodzona ścieżka lub nieprawidłowa konfiguracja mogą uniemożliwić wyświetlenie wtyczki.

Identyfikator GUID w programie config.jsonzazwyczaj ma postać asc.{YOUR-GUID}. Desktop Editors używa identyfikatora GUID jako nazwy folderu wtyczki, ale pomija asc.prefiks. Zachowaj ten sam identyfikator GUID w katalogu źródłowym, archiwum i ścieżce instalacji. Nie używaj ponownie identyfikatora GUID wbudowanej ani innej zainstalowanej wtyczki.

Zainstaluj wtyczkę po raz pierwszy

1. Umieść pliki i podfoldery wtyczki w archiwum ZIP. Same pliki muszą znajdować się w katalogu głównym archiwum, a nie w dodatkowym, dołączonym folderze projektu.
2. Zmień rozszerzenie archiwum z .zipna .plugin.
3. Otwórz ONLYOFFICE Desktop Editors, wybierz kartę Wtyczki i kliknij Menedżer wtyczek .
4. Otwórz Moje wtyczki , wybierz Zainstaluj wtyczkę ręcznie , wybierz .pluginplik i potwierdź.

Wtyczka powinna pojawić się na karcie „Wtyczki” w otwartym edytorze oraz w edytorach otwieranych później. Ręczna ścieżka archiwizacji działa bez połączenia z internetem. Instalacja z Marketplace jest przeznaczona dla gotowych do użycia wtyczek i nie zastępuje wczytywania własnej wersji rozwojowej.

Użyj łącza symbolicznego dla szybszej iteracji

Po pierwszej instalacji Desktop Editors zapisuje kopię w sdkjs-pluginskatalogu. Zastąp tę kopię dowiązaniem symbolicznym do folderu źródłowego, aby móc bezpośrednio edytować pliki robocze. Zamknij Desktop Editors przed zmianą folderu zainstalowanej wtyczki testowej. Zachowaj kopię zapasową lub upewnij się, że folder źródłowy jest nienaruszony i usuń tylko folder odpowiadający identyfikatorowi GUID wtyczki testowej.

W katalogu nazwa łącza to identyfikator GUID w nawiasach klamrowych bez asc.prefiksu. Na przykład, jeśli identyfikator GUID konfiguracji to asc.{91EAC419-EF8B-440C-A960-B451C7DF3A37}, nazwa folderu lub łącza to {91EAC419-EF8B-440C-A960-B451C7DF3A37}.

Okna

Otwórz wiersz polecenia jako administrator, jeśli wymaga tego Twoje konto lub zasady systemu Windows. Po zamknięciu edytorów i przeniesieniu zainstalowanego folderu test-plugin w inne miejsce, utwórz łącze do katalogu:

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

Zastąp oba symbole zastępcze identyfikatorem GUID i pełną ścieżką do katalogu źródłowego. Cel łącza nie może już istnieć.

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}"

Użyj ścieżek do zainstalowanej edycji; kompilacje spakowane lub w trybie sandbox mogą przechowywać dane użytkownika w innym miejscu. Po edycji kodu źródłowego otwórz ponownie dokument lub przeładuj wtyczkę, w zależności od potrzeb. Dowiązanie symboliczne zapobiega przebudowie archiwum, ale zmiany nie zawsze zostaną uwzględnione, dopóki edytor nie przeładuje wtyczki.

Uruchom edytory pulpitu za pomocą narzędzi programistycznych

Aby debugować wtyczkę, zamknij całkowicie program Desktop Editors i uruchom go za pomocą polecenia --ascdesktop-support-debug-info. Użyj polecenia odpowiedniego dla swojego systemu operacyjnego. Jeśli aplikacja została zainstalowana w niestandardowej lokalizacji, dostosuj ścieżkę wykonywalną.

Okna

Uruchom to w wierszu poleceń:

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

Alternatywnie, edytuj pole „Cel” skrótu, dodając spację i flagę po ścieżce wykonywalnej. Ma to wpływ na uruchamianie za pośrednictwem tego skrótu.

Linux

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

macOS

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

Po uruchomieniu aplikacji kliknij wewnątrz dokumentu i naciśnij [ F1lub] lub kliknij prawym przyciskiem myszy edytowalne pole paska narzędzi i wybierz [zbadaj element] . W narzędziach programistycznych wybierz ramkę iframe wtyczki, aby zbadać jej własny kod JavaScript i logi. Przekazany kod jest callCommanduruchamiany w ramce edytora o nazwie [lub] frameEditor, więc jego błędy i punkty przerwania mogą pojawiać się w innym kontekście niż kod interfejsu użytkownika wtyczki.

Opcjonalna flaga --ascdesktop-support-debug-info-keep=1utrzymuje tryb debugowania włączony podczas uruchamiania. Aby wyłączyć stan trwały, uruchom program za pomocą --ascdesktop-support-debug-info-keep=0; --ascdesktop-support-debug-info-keep=defaultaby powrócić do stanu domyślnego. Trwałe narzędzia programistyczne są wygodne na dedykowanej maszynie testowej, ale pozostawienie ich włączonych na współdzielonej stacji roboczej wprowadza bałagan i sprawia, że ​​narzędzia inspekcyjne są dostępne, gdy nie są potrzebne.

Sprawdź, czy konfiguracja programistyczna działa

• Wtyczka jest wyświetlana pod skonfigurowaną nazwą w zakładce Wtyczki.
• Po zmianie źródła ponowne otwarcie dokumentu lub ponowne załadowanie wtyczki pokazuje zaktualizowane zachowanie.
• Narzędzia programistyczne otwierają się za pomocą F1narzędzia Inspect Element po uruchomieniu z flagą debugowania.
• Dzienniki z kodu interfejsu użytkownika wtyczki pojawiają się po wybraniu ramki iframe wtyczki; polecenia dokumentu są sprawdzane w frameEditor.

Jeśli wtyczka jest niedostępna, sprawdź, czy config.jsonznajdują index.htmlsię w katalogu głównym archiwum, czy identyfikator GUID jest prawidłowy, a folder używa identyfikatora GUID bez asc.prefiksu. Sprawdź, czy link prowadzi do katalogu źródłowego, a nie do katalogu nadrzędnego, w którym się znajduje. Jeśli wtyczka jest widoczna, ale zachowuje się jak starsza wersja, zamknij i ponownie otwórz dokument, aby edytor ponownie wczytał powiązane pliki.

Czego ta konfiguracja nie umożliwia

Flaga debugowania pulpitu nie jest globalnym przełącznikiem uprawnień do tworzenia wtyczek. Zainstalowanie archiwum lub umieszczenie folderu w obsługiwanym katalogu wtyczki powoduje jej udostępnienie; flaga debugowania udostępnia narzędzia inspekcyjne. Podobnie, instrukcje dotyczące ładowania wtyczki za pomocą adresu URL do edytora internetowego nie mają automatycznego zastosowania do edytorów pulpitu. Należy skorzystać z opisanego powyżej procesu instalacji i debugowania, specyficznego dla pulpitu.

Te instrukcje dotyczą wtyczek do edytorów pulpitu ONLYOFFICE. Nie wyjaśniają, jak włączyć wtyczki w DocSpace, jak skonfigurować wtyczki po stronie serwera w ONLYOFFICE Docs ani jak opublikować wtyczkę w Marketplace. W przypadku tych przepływów pracy należy skorzystać z odpowiedniej oficjalnej dokumentacji produktu.

Oficjalne referencje

• ONLYOFFICE: Tworzenie wtyczek
• ONLYOFFICE: Tworzenie wtyczek do edytorów pulpitu
• ONLYOFFICE: Instalowanie i testowanie wtyczek w edytorach pulpitu
• ONLYOFFICE: Uruchamianie edytorów pulpitu w trybie debugowania
• ONLYOFFICE: Debugowanie wtyczek w edytorach pulpitu
• ONLYOFFICE: Oficjalne przykłady wtyczek i repozytorium kodów źródłowych