Как включить разработку плагинов в настольных редакторах ONLYOFFICE

В документации ONLYOFFICE Desktop Editors отсутствует переключатель «Включить разработку плагинов». Поддерживаемый рабочий процесс заключается в установке собственного плагина через Менеджер плагинов, размещении его в локальной папке плагинов и, при необходимости, замене установленной копии символической ссылкой на рабочую папку с исходным кодом. Для проверки ошибок и использования точек останова запустите настольное приложение с указанным флагом отладки. Это отдельные шаги: режим отладки предоставляет доступ к инструментам разработчика, а установка или связывание плагина делает его доступным для редактора.

В текущей документации по API ONLYOFFICE описан тот же рабочий процесс для настольных компьютеров, а также указан флаг для сохранения режима отладки включенным при каждом запуске. Я не нашел официального уведомления о новом переключателе режима разработки, который изменяет эти шаги. Это руководство соответствует официальным инструкциям, доступным 6 октября 2026 года. Пути могут различаться в зависимости от типа установки, поэтому перед изменением файлов подтвердите путь для вашей платформы.

Выберите рабочий процесс разработки плагинов.

ПодходЛучше всего подходит дляКомпромисс
Установите .pluginархив в Менеджере плагинов.Первая установка, быстрые тесты или периодические изменения.Простой и поддерживаемый способ, но после каждого изменения исходного кода необходимо пересобирать и переустанавливать архив.
Создайте ссылку на папку с установленным плагином в папке с исходными файлами.Частые правки в процессе разработкиУдаляет повторяющиеся файлы упаковки, но требует указания правильного пути для каждого пользователя и перезагрузки или повторного открытия для применения изменений.
Запуск с флагом отладки.Проверка вывода консоли, кадров плагина или точек останова.Включает инструменты разработчика; не устанавливает плагин и не загружает автоматически ненадежный код.

Для большинства разработчиков лучше использовать архив один раз для регистрации плагина, а затем символическую ссылку для дальнейшей работы. Добавляйте флаг отладки только при диагностике кода. Его постоянный вариант оставляйте отключенным, если вам не нужны инструменты разработчика при каждом запуске.

Подготовьте файлы плагина.

Начните с локального каталога плагинов, содержащего как минимум необходимые для вашего плагина файлы, включая config.jsonи index.html. Файл конфигурации должен содержать действительный GUID плагина и указывать на главную страницу плагина и его ресурсы, используя схему плагинов ONLYOFFICE. Используйте официальные примеры плагинов или документацию API для получения полной схемы; некорректный GUID, неработающий путь или неверная конфигурация могут помешать отображению плагина.

GUID config.jsonобычно имеет вид asc.{YOUR-GUID}. Desktop Editors использует GUID в качестве имени папки плагина, но опускает asc.префикс. Сохраняйте один и тот же GUID в исходном каталоге, архиве и пути установки. Не используйте повторно GUID встроенного или другого установленного плагина.

Установите плагин в первый раз.

  1. Поместите файлы плагина и подпапки в ZIP-архив. Сами файлы должны находиться в корневом каталоге архива, а не внутри отдельной папки проекта.
  2. Измените расширение архива с .zipна .plugin.
  3. Откройте ONLYOFFICE Desktop Editors, выберите вкладку «Плагины» и нажмите «Менеджер плагинов» .
  4. Откройте «Мои плагины» , выберите «Установить плагин вручную» , выберите .pluginфайл и подтвердите.

После этого плагин должен появиться на вкладке «Плагины» в открытом редакторе и в редакторах, открытых позже. Установка через архив вручную работает без подключения к Интернету. Установка через Marketplace предназначена для готовых к использованию плагинов; она не заменяет загрузку собственной сборки для разработки.

Используйте символическую ссылку для ускорения итерации.

После первой установки Desktop Editors сохраняет копию в sdkjs-pluginsкаталоге. Замените эту копию символической ссылкой на вашу исходную папку, чтобы вы могли редактировать рабочие файлы напрямую. Закройте Desktop Editors перед изменением папки с установленным тестовым плагином. Сохраните резервную копию или убедитесь, что ваша исходная папка цела, и удалите только папку, соответствующую GUID вашего тестового плагина.

Операционная системаКаталог пользовательских плагинов
Windows%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\
macOS~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/
Linux~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/

Внутри каталога имя ссылки — это GUID в фигурных скобках без asc.префикса. Например, если GUID конфигурации равен asc.{91EAC419-EF8B-440C-A960-B451C7DF3A37}, то имя папки или ссылки будет {91EAC419-EF8B-440C-A960-B451C7DF3A37}.

Windows

Откройте командную строку от имени администратора, если этого требует ваша учетная запись Windows или политика. После закрытия редакторов и перемещения папки с установленным тестовым плагином создайте ссылку на каталог:

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

Замените оба заполнителя на GUID и полный путь к исходному каталогу. Целевая ссылка не должна существовать.

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

Используйте пути к установленной вами версии; в упакованных или изолированных сборках пользовательские данные могут храниться в других местах. После редактирования исходного кода откройте документ или перезагрузите плагин, если это необходимо. Символическая ссылка предотвращает пересборку архива, но изменения не обязательно будут учтены до тех пор, пока редактор не перезагрузит плагин.

Запускайте редакторы для настольных компьютеров с помощью инструментов разработчика.

Для отладки плагина полностью закройте Desktop Editors и запустите его с помощью команды --ascdesktop-support-debug-info`.`. Используйте команду, подходящую для вашей операционной системы; если вы установили приложение в другое место, измените путь к исполняемому файлу.

Windows

Выполните эту команду в командной строке:

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

В качестве альтернативы, отредактируйте поле «Цель» ярлыка, добавив пробел и флаг после пути к исполняемому файлу. Это повлияет на запуск файлов через этот ярлык.

Linux

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

macOS

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

После запуска приложения щелкните внутри документа и нажмите клавишу Enter F1, или щелкните правой кнопкой мыши по редактируемому полю панели инструментов и выберите «Просмотреть элемент» . В инструментах разработчика выберите iframe плагина, чтобы просмотреть его собственный JavaScript и логи. Код, передаваемый в callCommandфункцию, выполняется в редакторе с именем `<script>` frameEditor, поэтому его ошибки и точки останова могут отображаться в другом контексте, чем код пользовательского интерфейса плагина.

Этот необязательный флаг --ascdesktop-support-debug-info-keep=1позволяет сохранять режим отладки включенным при каждом запуске. Чтобы отключить постоянное состояние, запустите программу с параметром --ascdesktop-support-debug-info-keep=0; используйте --ascdesktop-support-debug-info-keep=defaultдля возврата к состоянию по умолчанию. Постоянно включенные инструменты разработчика удобны на выделенной тестовой машине, но их включение на общей рабочей станции создает беспорядок и сохраняет доступными инструменты проверки, когда они вам не нужны.

Убедитесь, что настройка среды разработки работает.

  • Плагин отображается под заданным именем на вкладке «Плагины».
  • После изменения источника данных повторное открытие документа или перезагрузка плагина отображают обновленное поведение.
  • Инструменты разработчика открываются с помощью функции «Просмотреть элемент»F1 или через нее после запуска приложения с флагом отладки.
  • Журналы кода пользовательского интерфейса плагина отображаются при выборе iframe плагина; команды документа проверяются в frameEditor.

Если плагин отсутствует, убедитесь, что config.jsonфайлы index.htmlнаходятся в корне архива, GUID действителен, и папка использует GUID без asc.префикса. Убедитесь, что ссылка указывает на исходный каталог, а не на родительский каталог, содержащий его. Если плагин отображается, но ведет себя как в более старой сборке, закройте и снова откройте документ, чтобы редактор перезагрузил связанные файлы.

Что эта настройка не позволяет

Флаг отладки для настольных приложений не является глобальным параметром прав доступа для разработки плагинов. Установка архива или размещение папки в каталоге поддерживаемых плагинов делает этот плагин доступным; флаг отладки предоставляет доступ к инструментам проверки. Аналогично, инструкции по загрузке плагина по URL-адресу в веб-редактор не применяются автоматически к настольным редакторам. Используйте описанный выше алгоритм установки и отладки, специфичный для настольных приложений.

Данные инструкции касаются плагинов для настольных редакторов ONLYOFFICE. Они не объясняют, как включить плагины в DocSpace, как настроить серверные плагины в ONLYOFFICE Docs или как опубликовать плагин на Marketplace. Для выполнения этих действий используйте соответствующую официальную документацию по продукту.

Официальные ссылки

Оставить комментарий

Как подключить настольные редакторы ONLYOFFICE к собственному облачному серверу

Как подключить настольные редакторы ONLYOFFICE к собственному облачному серверу

Подключите настольные редакторы ONLYOFFICE к своему облачному серверу, войдите в систему, открывайте файлы в облаке, управляйте подключением и устраняйте распространенные проблемы с настройкой.

Как исправить проблему с высокой загрузкой ЦП в Collabora Online из-за loolwsd / coolwsd

Как исправить проблему с высокой загрузкой ЦП в Collabora Online из-за loolwsd / coolwsd

Для устранения неполадок, связанных с высокой загрузкой ЦП в Collabora Online, необходимо выявить процессы, активно использующие комплект инструментов, проверить метрики и журналы, настроить параллелизм и очистку, а также безопасно проверить исправления.

How to Custom Brand ONLYOFFICE Docs with Your Logo and Colors

How to Custom Brand ONLYOFFICE Docs with Your Logo and Colors

Learn how to custom brand ONLYOFFICE Docs with a header logo and interface colors, including license limits, theme JSON setup, Docker paths, and testing.

Исправлены проблемы с видимостью текста в темном режиме в LibreOffice Calc.

Исправлены проблемы с видимостью текста в темном режиме в LibreOffice Calc.

Исправьте трудночитаемый текст в LibreOffice Calc, проверив тему приложения, шрифт и цвет заливки ячеек, стили и условное форматирование, а затем проверьте вывод на печать.

Исправлена ​​ошибка «Документ заблокирован неизвестным пользователем» в LibreOffice.

Исправлена ​​ошибка «Документ заблокирован неизвестным пользователем» в LibreOffice.

Безопасно устраните предупреждение LibreOffice о блокировке от неизвестного пользователя. Проверьте активные сеансы, защитите копию, удалите только проверенную устаревшую блокировку и протестируйте документ.

Исправление отображения текста на арабском и иврите справа налево в LibreOffice Writer

Исправление отображения текста на арабском и иврите справа налево в LibreOffice Writer

Исправьте некорректное отображение, выравнивание или смешивание арабского или ивритского текста с английским в LibreOffice Writer. Включите сложную компоновку текста, задайте направление абзаца и проверьте результат.

LibreOffice Calc VLOOKUP vs XLOOKUP: A Beginner-Friendly Functions Guide

LibreOffice Calc VLOOKUP vs XLOOKUP: A Beginner-Friendly Functions Guide

Learn VLOOKUP and XLOOKUP in LibreOffice Calc, including exact matches, left lookups, not-found results, reverse search, INDEX/MATCH alternatives, and common errors.

Как исправить ошибку «Проверка доказательства WOPI не удалась» в Collabora Online

Как исправить ошибку «Проверка доказательства WOPI не удалась» в Collabora Online

Для устранения неполадок, связанных с ошибками проверки подлинности WOPI в Collabora Online, проверьте ключи обнаружения, ротацию ключей, URL-адреса прокси-серверов, метки времени и списки разрешенных хостов.

Как включить отслеживание изменений по умолчанию в документах ONLYOFFICE

Как включить отслеживание изменений по умолчанию в документах ONLYOFFICE

Включите функцию отслеживания изменений для всех пользователей в документе ONLYOFFICE, сохраните её активность после повторного открытия и ознакомьтесь с ограничениями глобальных настроек по умолчанию.

Как настроить тайм-ауты простоя для сеансов редактирования в Collabora

Как настроить тайм-ауты простоя для сеансов редактирования в Collabora

Сравните значения таймаутов для каждого представления, нерезкости, простоя документа, автосохранения и прокси-сервера в Collabora Online, а затем выберите и проверьте настройки для вашей системы.