Włącz tworzenie i debugowanie wtyczek pulpitu ONLYOFFICE

Nie musisz włączać osobnego przełącznika tworzenia wtyczek w edytorach pulpitu ONLYOFFICE. Utwórz wtyczkę, zainstaluj jej .pluginpakiet za pomocą Menedżera wtyczek i uruchom aplikację pulpitu, --ascdesktop-support-debug-infogdy potrzebujesz narzędzi do debugowania. Edytory pulpitu i przeglądarki korzystają z różnych procedur ładowania, więc zacznij od poniższego schematu przepływu pracy specyficznego dla pulpitu.

Przygotuj mały projekt wtyczki

Te instrukcje dotyczą edytorów pulpitu ONLYOFFICE w systemach Windows, macOS i Linux. Użyj aktualnej instalacji pulpitu i edytora kodu do plików tekstowych. Oficjalna dokumentacja traktuje ręczną instalację wtyczek i debugowanie programistyczne jako oddzielne funkcje; Plugin Marketplace nie jest wymagany do tworzenia i testowania lokalnej wtyczki. Przykład Hello World to przydatny pierwszy krok, ponieważ izoluje ładowanie wtyczek od bardziej złożonych usług.

1. Utwórz folder źródłowy

Utwórz folder o nazwie hello-world-plugin. Dodaj config.jsonmanifest i index.htmlpunkt wejścia. Opcjonalnie dodaj icon.pngobraz, jeśli manifest odwołuje się do niego. Zachowaj folder poza katalogiem zainstalowanej aplikacji, aby aktualizacje oprogramowania nie nadpisywały plików roboczych.

Eksplorator plików systemu Windows pokazujący pliki config.json, index.html i icon.png w folderze deweloperskim hello-world-plugin
Przechowuj manifest wtyczki i jej plik HTML punktu wejściowego w jednym folderze programistycznym; ikona lokalna jest opcjonalna.

2. Zdefiniuj manifest i wygeneruj własny GUID

Manifest informuje ONLYOFFICE, który plik HTML ma załadować i które edytory mogą uruchomić wtyczkę. Poniższy przykład obsługuje edytor dokumentów. Przed instalacją zastąp przykładowy identyfikator GUID nowo wygenerowanym identyfikatorem UUID: uruchom New-Guidw programie Windows PowerShell lub uuidgenw systemie macOS lub Linux, a następnie sformatuj wartość jako asc.{YOUR-UUID}. Każda odrębna wtyczka potrzebuje własnego identyfikatora.

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

Używaj poprawnego kodu JSON: bez przecinków na końcu, pasujących nawiasów klamrowych i prawdziwego pliku dla każdego punktu wejścia lub ikony, do którego się odwołujesz. W przypadku wtyczki arkusza kalkulacyjnego lub prezentacji użyj odpowiednich wartości, EditorsSupportzamiast zakładać, że wtyczka tylko do dokumentu pojawia się wszędzie. Porównaj strukturę z oficjalnym szybkim startem Hello World .

Edytor kodu pokazujący plik config.json wtyczki z nazwą, GUID, wersją, adresem URL punktu wejścia i obsługą edytora tekstu
Manifest config.json identyfikuje wtyczkę i ogranicza ją do edytorów, które obsługuje.

3. Wdrożenie punktu wejścia

W index.html[pliku] załaduj bibliotekę API wtyczki ONLYOFFICE, dodaj przycisk i wywołaj go . Przykład szybkiego startuwindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"]) producenta zawiera kompletny, działający kod HTML i adres URL biblioteki; skopiowanie tego przykładu jest bezpieczniejsze niż zgadywanie składni inicjalizacji lub API. Zapisz plik w formacie UTF-8. Jeśli planujesz pracować w trybie offline, pamiętaj, że strona importująca bibliotekę wtyczek lub inne zasoby z adresu URL online nadal potrzebuje tych zasobów do załadowania.

Edytor kodu wyświetlający punkt wejścia index.html z przyciskiem „Hello World” i wywołaniem API wtyczki PasteText
Plik punktu wejścia zawiera interfejs i wywołanie JavaScript, z których korzysta edytor po uruchomieniu wtyczki.

Zainstaluj i uruchom wtyczkę programistyczną

4. Zbuduj archiwum .plugin

Wybierz pliki w folderze źródłowym, skompresuj je do archiwum ZIP i zmień rozszerzenie pliku ZIP z .zipna .plugin. Katalog główny archiwum powinien zawierać znaki config.jsoni index.html, a nie drugi hello-world-pluginkatalog do niego dołączony. W systemie Windows włącz rozszerzenia nazw plików w Eksploratorze plików, aby przypadkowo nie utworzyć pliku hello-world.plugin.zip. Oficjalne instrukcje instalacji programu Desktop Editors wyraźnie wskazują na ręczną instalację bez połączenia z Marketplace.

Eksplorator plików systemu Windows z wybranymi plikami źródłowymi wtyczki do spakowania w formacie ZIP obok archiwum hello-world.plugin
Przed zmianą nazwy pliku ZIP na rozszerzenie .plugin zarchiwizuj zawartość folderu wtyczki, a nie folderu ją zawierającego.

5. Importuj pakiet z Menedżera wtyczek

Otwórz edytowalny dokument w edytorach ONLYOFFICE Desktop Editors. Wybierz Wtyczki > Menedżer wtyczek > Moje wtyczki > Zainstaluj wtyczkę ręcznie . Dokładny wygląd menedżera może różnić się w zależności od wersji, ale ta czynność jest udokumentowaną ścieżką instalacji ręcznej. Nie jest to osobne ustawienie adresu URL dla deweloperów w Marketplace.

Menedżer wtyczek ONLYOFFICE Desktop Editors w Moich wtyczkach z widoczną akcją Zainstaluj wtyczkę ręcznie
W dokumencie otwórz Wtyczki, następnie Menedżera wtyczek i przejdź do Moich wtyczek, aby przejść do instalacji ręcznej.

6. Wybierz plik i sprawdź jego wpis w menu

Wybierz hello-world.pluginarchiwum w oknie dialogowym pliku i otwórz je. Zainstalowana wtyczka powinna być dostępna w zakładce Wtyczki. Jeśli jej brakuje, przed zmianą ustawień aplikacji sprawdź manifest, identyfikator GUID, obsługiwany typ edytora i katalog główny archiwum. Spróbuj ponownie otworzyć dokument po instalacji, jeśli menu nie odświeży się natychmiast.

Otwórz okno dialogowe systemu Windows, wybierając pakiet hello-world.plugin z filtrem Pliki wtyczki
Wybierz archiwum .plugin w oknie dialogowym wyboru pliku; nie wybieraj oryginalnego folderu źródłowego.

7. Przetestuj wtyczkę w dokumencie jednorazowym

Otwórz pusty dokument testowy, uruchom Hello World z zakładki Wtyczki i użyj jego przycisku. Sprawdź, czy w dokumencie pojawiają się słowa Hello World! To sprawdza więcej niż tylko instalację: potwierdza, że ​​interfejs wtyczki został załadowany, a wywołanie API edytora dotarło do dokumentu. Nie testuj wtyczek zmieniających treść na niezastąpionym pliku.

Edytor tekstu ONLYOFFICE z panelem wtyczki Hello World i widocznym w dokumencie tekstem Hello World
Uruchom zainstalowaną wtyczkę w dokumencie jednorazowym i sprawdź zawartość powstałego dokumentu.

Włącz debugowanie w celu tworzenia wtyczek

8. Uruchom ponownie edytory pulpitu z flagą debugowania

Zamknij całkowicie edytory pulpitu ONLYOFFICE, a następnie uruchom aplikację w terminalu z oficjalną flagą debugowania. Użyj polecenia odpowiedniego dla swojego systemu operacyjnego i lokalizacji instalacji:

  • Wiersz polecenia systemu Windows: "%ProgramFiles%\ONLYOFFICE\DesktopEditors\DesktopEditors" --ascdesktop-support-debug-info
  • Linux (standardowa lokalizacja pakietu): "/opt/onlyoffice/desktopeditors/DesktopEditors" --ascdesktop-support-debug-info
  • macOS: "/Applications/ONLYOFFICE.app/Contents/MacOS/ONLYOFFICE" --ascdesktop-support-debug-info

Powyższe polecenie systemu Windows korzysta z rozszerzenia zmiennych wiersza poleceń, a nie ze składni programu PowerShell. W programie PowerShell wywołaj plik wykonywalny z jego pełną, rozwiązaną ścieżką. Jeśli aplikacja została zainstalowana w niestandardowej lokalizacji, zastąp ją rzeczywistą ścieżką do pliku wykonywalnego. Możesz również dodać flagę do pola „Cel” skrótu na pulpicie systemu Windows. Szczegóły dotyczące platformy znajdziesz w poleceniach trybu debugowania pulpitu programu ONLYOFFICE.

Po otwarciu dokumentu kliknij w jego obszarze edycji i naciśnij klawisz F1 lub kliknij prawym przyciskiem myszy edytowalne pole paska narzędzi i wybierz opcję „Zbadaj element” . W Narzędziach programistycznych wybierz ramkę iframe wtyczki, aby zbadać kod interfejsu wtyczki i logi. Kod przekazywany do callCommandwtyczki jest uruchamiany w frameEditorkontekście, więc w razie potrzeby należy przełączać ramki. Dokumentacja debugowania wtyczek wyjaśnia tę różnicę i sposób korzystania z punktów przerwania. Debugowanie może ujawnić zawartość dokumentu i szczegóły środowiska wykonawczego; nie udostępniaj surowych logów bez ich sprawdzenia.

Konsola narzędzi programistycznych z wybraną ramką iframe wtyczki i przykładowym wpisem dziennika inicjalizacji
Po włączeniu debugowania sprawdź odpowiednią ramkę iframe wtyczki w DevTools; komunikaty konsoli zamieszczone tutaj mają charakter poglądowy.

Skróć cykl edycji i testowania bez konieczności modyfikowania wbudowanych wtyczek

Po ręcznej instalacji ONLYOFFICE kopiuje wtyczkę do katalogu o nazwie GUID w Twoim profilu użytkownika. Udokumentowane lokalizacje znajdują się %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\w systemach Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/macOS i ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/Linux. Folder o nazwie GUID pomija nazwę wiodącą asc.używaną w manifeście.

Aby uniknąć tworzenia nowego archiwum dla każdej zmiany, programiści mogą zamknąć aplikację, zastąpić własny folder z zainstalowaną wtyczką dowiązaniem symbolicznym do działającego folderu źródłowego i ponownie otworzyć dokument po edycji. Jest to opcjonalne, a dokładne polecenia dowiązania różnią się w zależności od systemu operacyjnego. Przed wykonaniem tej czynności należy postępować zgodnie z oficjalnymi instrukcjami tworzenia aplikacji na komputery stacjonarne . Nie należy zastępować dołączonych/domyślnych folderów z wtyczkami ani modyfikować pakietu aplikacji na macOS: dostawca ostrzega, że ​​usunięcie domyślnych wtyczek może naruszyć integralność pakietu i spowodować awarie.

Zweryfikuj konfigurację programistyczną

Trzy sprawdzenia wskazują, że przepływ pracy jest gotowy: wtyczka niestandardowa pojawia się w sekcji „Wtyczki” , test „Hello World” wstawia tekst do nowego dokumentu, a narzędzia DevTools otwierają się po uruchomieniu z flagą debugowania. Jeśli interfejs jest pusty lub instalacja się nie powiedzie, należy sprawdzić, czy manifest jest parsowany jako JSON, identyfikator GUID zaczyna się od asc., index.htmlistnieje w zadeklarowanej ścieżce względnej i czy wszystkie wymagane zasoby są obecne. Oficjalny przewodnik po błędach wtyczek opisuje te typowe błędy. Zainstalowana wtyczka nie jest dowodem na to, że każda implementowana przez nią funkcja działa; należy powtórzyć to sprawdzenie po każdej zmianie kodu.

Zostaw komentarz

Zatrzymaj Element Desktop powodujący awarię na Wayland z Xwayland

Przetestuj Element Desktop za pomocą Xwayland, zachowaj lokalne dane i wyizoluj problemy z grafiką lub pakietami, gdy Linux Wayland spowoduje awarię aplikacji.

Otrzymuj powiadomienia Element Android bez usług Google

Skonfiguruj Element Android za pomocą UnifiedPush i ntfy, a następnie sprawdź samodzielnie hostowaną bramkę Matrix i ustawienia tła Androida, gdy alerty się nie powiodą.

Uruchom w tle funkcję przesyłania zdjęć na iPhone'a za pomocą NextCloud

Uruchom w tle funkcję przesyłania zdjęć na iPhone'a za pomocą NextCloud

Przywróć wykrywanie zdjęć w tle, sprawdzając ustawienia przesyłania Nextcloud, uprawnienia iOS, tryb baterii i ograniczenia harmonogramu działania iPhone'a w tle.

Wyraźniejszy tekst w aplikacji ONLYOFFICE Desktop: dostosuj podpowiedzi dotyczące czcionek w systemie Linux

Wyraźniejszy tekst w aplikacji ONLYOFFICE Desktop: dostosuj podpowiedzi dotyczące czcionek w systemie Linux

Porównaj tryby podpowiedzi czcionek ONLYOFFICE, sprawdź powiększenie i dostępność czcionek w systemie Linux oraz zweryfikuj, czy rozmycie jest ograniczone do edytora, czy też ma wpływ na cały pulpit.

Przekształć plik PDF w edytowalny plik DOCX w aplikacji ONLYOFFICE Desktop

Przekształć plik PDF w edytowalny plik DOCX w aplikacji ONLYOFFICE Desktop

Konwertuj plik PDF lokalnie w edytorach ONLYOFFICE Desktop Editors, a następnie sprawdź plik DOCX pod kątem zmian układu, zeskanowanych stron i tekstu wymagającego korekty.

Połącz edytory pulpitu ONLYOFFICE z plikami ownCloud

Dodaj swoje konto ownCloud do ONLYOFFICE Desktop Editors, dowiedz się, co umożliwia to połączenie, i wybierz pomiędzy dostępem bezpośrednim, synchronizacją i edycją w przeglądarce.

Napraw przekroczenia limitu czasu aplikacji mobilnej ONLYOFFICE, sprawdzając adres URL serwera

Napraw przekroczenia limitu czasu aplikacji mobilnej ONLYOFFICE, sprawdzając adres URL serwera

Użyj właściwego portalu lub adresu WebDAV, przetestuj dostępność protokołu HTTPS z telefonu i rozróżnij problemy związane z siecią prywatną, protokołem TLS i logowaniem.

Włącz tworzenie i debugowanie wtyczek pulpitu ONLYOFFICE

Włącz tworzenie i debugowanie wtyczek pulpitu ONLYOFFICE

Zbuduj i przetestuj niestandardową wtyczkę ONLYOFFICE Desktop Editors, zainstaluj jej archiwum .plugin i aktywuj narzędzia programistyczne do debugowania.

Uruchamianie Pythona w programie Calc za pomocą systemu makr pakietu LibreOffice

Uruchamianie Pythona w programie Calc za pomocą systemu makr pakietu LibreOffice

Udostępnij funkcję Pythona w programie Calc, uruchom ją w otwartym arkuszu kalkulacyjnym i rozwiąż problemy z brakującymi makrami lub importami, nie mieszając LibreOffice i systemowego Pythona.

Zabezpiecz wybrany tekst autora hasłem sekcji

Zabezpiecz wybrany tekst autora hasłem sekcji

Zablokuj konkretny fragment, uniemożliwiając jego edycję, jednocześnie zachowując użyteczność reszty dokumentu programu Writer, i dowiedz się, kiedy szyfrowanie plików jest lepszym wyborem.