Плагины в ONLYOFFICE Desktop Editors: установка и использование

Введение

ONLYOFFICE Desktop Editors позволяет редактировать текстовые документы, таблицы и презентации в офлайн‑режиме с доступом к веб‑порталам ONLYOFFICE для эффективной совместной работы. Начиная с версии 4.1.2 приложение распространяется под лицензией AGPL v.3, а исходный код доступен на GitHub.

С версии 4.1.2 поддерживаются сторонние плагины. Это даёт возможность расширять функциональность редактора готовыми плагинами или разрабатывать свои с помощью API.

Важно: термин «плагин» здесь означает отдельный набор файлов (config.json, index.html, pluginCode.js), который подключается к редактору и предоставляет новую функцию.

Что понадобится

• Рабочая установка ONLYOFFICE Desktop Editors.
• Git (для клонирования репозитория) или ZIP‑архив плагинов.
• Минимальные навыки работы с файлами и архиватором.

Загрузка доступных плагинов

Исходный код всех плагинов доступен на GitHub под лицензией MIT.

Склонируйте репозиторий:

git clone https://github.com/ONLYOFFICE/sdkjs-plugins.git

Или скачайте ZIP‑архив репозитория с сайта GitHub через браузер.

Выбор плагина

Откройте папку с репозиторием и выберите нужный плагин. Каждый плагин расположен в отдельной папке и содержит как минимум три файла: config.json, index.html и pluginCode.js.

В данный момент доступны (выбор зависит от репозитория):

• Вставка видео с YouTube с помощью YouTube плагина.
• Распознавание текста на изображениях и скриншотах через OCR плагин.
• Преобразование выделенного фрагмента текста в речь с помощью Speech плагина.
• Вставка клипарта в документы через ClipArt.
• Игра в шахматы прямо в документе с Chess плагином.

Добавление выбранного плагина в редакторы

1. Откройте папку плагина.
2. Выделите все файлы (config.json, index.html, pluginCode.js и сопутствующие ресурсы).
3. Заархивируйте их (обычно ZIP).
4. Переименуйте расширение архива с .zip на .plugin.
5. Перетащите файл .plugin на главную страницу ONLYOFFICE Desktop Editors в окно приложения.

Важно: структура папки должна сохраняться. Если в плагине есть дополнительные подпапки (assets, img и т. п.), включите их в архив.

Использование плагинов

Откройте документ или создайте новый. На левой панели появится иконка Plugins. Нажмите её, чтобы увидеть список добавленных плагинов.

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

Пример: ClipArt — выберите место в документе, куда нужно вставить изображение, и кликните по миниатюре нужного клипарта. Картинка будет вставлена в текущую позицию курсора.

Краткая методология: шаги в цифрах

1. Склонировать репозиторий или скачать ZIP.
2. Найти папку нужного плагина.
3. Упаковать файлы плагина в архив и переименовать .plugin.
4. Перетащить .plugin в приложение.
5. Открыть документ и запустить плагин через панель Plugins.

Роль‑ориентированные чеклисты

Администратор:

• Убедиться, что версия Desktop Editors ≥ 4.1.2.
• Разрешить установку сторонних плагинов (если есть политика ИТ).
• Развернуть плагины централизованно при необходимости.

Пользователь:

• Скачать или получить файл .plugin.
• Перетащить файл в приложение.
• Проверить работу плагина в тестовом документе.

Частые проблемы и отладка

Если плагин не появляется или не работает:

• Проверьте структуру архива: в корне должны быть config.json, index.html, pluginCode.js.
• Убедитесь, что расширение файла — именно .plugin.
• Перезапустите ONLYOFFICE Desktop Editors.
• Проверьте консоль разработчика (если плагин не запускается, ошибки в браузерной консоли могут подсказать причину).

Если OCR или Speech даёт ошибки:

• Проверьте локальные зависимости (веб‑компоненты в плагине) и доступ к интернету (некоторые плагины используют внешние API).

Когда плагины не подходят (контрпример)

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

Альтернативные подходы

• Разработка собственных инструментов на стороне сервера с интеграцией через API ONLYOFFICE.
• Использование официальных модулей и расширений, поддерживаемых поставщиком.

Как создать свой плагин (кратко)

1. Изучите документацию ONLYOFFICE API.
2. Создайте структуру: config.json, index.html, pluginCode.js.
3. Тестируйте локально в браузере.
4. Упакуйте в .plugin и установите в Desktop Editors.

Полная документация по API доступна в официальном репозитории и на сайте ONLYOFFICE.

Совместимость и миграция

• Плагины поддерживаются с версии Desktop Editors 4.1.2 и выше. Для старых версий плагины не будут работать.
• При обновлении приложения проверяйте работоспособность критичных плагинов.

Краткий глоссарий

• Плагин — модуль расширения функциональности редактора.
• .plugin — архив с файлами плагина, переименованный из ZIP.
• config.json — файл конфигурации плагина.

Итог

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

Ресурсы:

• Официальная документация по установке ONLYOFFICE Desktop Editors.
• ONLYOFFICE API для разработки собственных плагинов.
• Поддержка и форумы: dev.onlyoffice.org.

Замечание: сохраняйте резервные копии важных документов перед массовой установкой новых плагинов.