Главная
» PC Советы
»
Включение разработки и отладки плагинов для настольных компьютеров ONLYOFFICE
Включение разработки и отладки плагинов для настольных компьютеров ONLYOFFICE
В редакторах ONLYOFFICE Desktop вам не нужно включать отдельный переключатель для разработки плагинов. Создайте плагин, установите его .pluginпакет через менеджер плагинов и запускайте настольное приложение, --ascdesktop-support-debug-infoкогда вам понадобятся инструменты отладки. Настольные и веб-редакторы используют разные процедуры загрузки, поэтому начните с описанного ниже рабочего процесса, специфичного для настольных версий.
Подготовьте небольшой проект плагина.
Эти инструкции относятся к настольным редакторам ONLYOFFICE для Windows, macOS и Linux. Используйте актуальную версию настольного редактора и редактор кода для текстовых файлов. В официальной документации ручная установка плагинов и отладка разработчиками рассматриваются как отдельные функции; для разработки и тестирования локального плагина не требуется использовать Plugin Marketplace. Пример "Hello World" — полезная первая проверка, поскольку он изолирует загрузку плагина от более сложных сервисов.
1. Создайте исходную папку.
Создайте папку с именем ` hello-world-plugin.`. Добавьте config.jsonманифест и index.htmlточку входа. При желании добавьте icon.pngобраз, если ваш манифест на него ссылается. Разместите папку вне каталога установленного приложения, чтобы обновления программного обеспечения не перезаписывали ваши рабочие файлы.
Храните манифест плагина и его HTML-файл точки входа в одной папке для разработки; локальная иконка необязательна.
2. Определите манифест и сгенерируйте собственный GUID.
Манифест указывает ONLYOFFICE, какой HTML-файл следует загрузить и какие редакторы могут запускать плагин. Следующий пример поддерживает редактор документов. Замените пример GUID на новый сгенерированный UUID перед установкой: запустите New-Guidв Windows PowerShell или uuidgenна macOS или Linux, затем отформатируйте значение как asc.{YOUR-UUID}. Каждому отдельному плагину нужен свой собственный идентификатор.
Используйте корректный JSON: без запятых в конце, с совпадающими фигурными скобками и отдельным файлом для каждой точки входа или значка. Для плагина для электронных таблиц или презентаций используйте соответствующие значения, EditorsSupportа не предполагайте, что плагин только для документов присутствует повсюду. Сравните структуру с официальным руководством по быстрому запуску Hello World .
В файле config.json содержится информация о плагине и указывается, к каким редакторам он предназначен.
3. Реализуйте точку входа.
В файле index.htmlзагрузите библиотеку API плагина ONLYOFFICE, добавьте кнопку и настройте ее на вызов функции . В примере быстрого запускаwindow.Asc.plugin.executeMethod("PasteText", ["Hello World!"]) от производителя представлен полный рабочий HTML-код и URL-адрес библиотеки; скопировать этот пример безопаснее, чем гадать о синтаксисе инициализации или API. Сохраните файл в кодировке UTF-8. Если вы планируете работать в автономном режиме, помните, что страница, которая импортирует свою библиотеку плагинов или другие ресурсы из онлайн-URL, все равно нуждается в этих ресурсах для загрузки.
Файл точки входа содержит интерфейс и вызов JavaScript, которые редактор использует при запуске плагина.
Установите и запустите свой плагин для разработки.
4. Создайте архив .plugin.
Выберите файлы в исходной папке, сожмите их в ZIP-архив и переименуйте расширение ZIP-архива с .zipна .plugin. Корневая директория архива должна содержать config.jsonи index.html, а не вторую содержащую hello-world-pluginдиректорию. В Windows включите отображение расширений файлов в проводнике, чтобы случайно не создать hello-world.plugin.zip. Официальные инструкции по установке Desktop Editors явно поддерживают ручную установку без подключения к Marketplace.
Перед переименованием ZIP-файла с расширением .plugin заархивируйте его содержимое, а не папку, в которую он встроен.
5. Импортируйте пакет из менеджера плагинов.
Откройте редактируемый документ в ONLYOFFICE Desktop Editors. Выберите «Плагины» > «Менеджер плагинов» > «Мои плагины» > «Установить плагин вручную» . Внешний вид менеджера может отличаться в зависимости от версии, но это действие соответствует описанному в документации пути ручной установки. Это не отдельная настройка URL-адреса разработчика в Marketplace.
В документе откройте «Плагины», затем «Менеджер плагинов» и перейдите в раздел «Мои плагины», чтобы выполнить установку вручную.
6. Выберите файл и проверьте его пункт в меню.
Выберите свой hello-world.pluginархив в диалоговом окне выбора файла и откройте его. Установленный плагин должен стать доступен на вкладке «Плагины». Если он отсутствует, проверьте манифест, GUID, поддерживаемый тип редактора и корневой каталог архива, прежде чем изменять настройки приложения. Если меню не обновляется сразу, попробуйте снова открыть документ после установки.
В диалоговом окне выбора файлов выберите архив .plugin; не выбирайте исходную папку.
7. Протестируйте плагин в одноразовом документе.
Откройте пустой тестовый документ, запустите плагин Hello World на вкладке «Плагины» и воспользуйтесь его кнопкой. Убедитесь, что в документе отображаются слова Hello World!. Это проверяет не только установку, но и то, что интерфейс плагина загружен и его вызов API редактора достиг документа. Не тестируйте плагины, изменяющие содержимое, на файле, который невозможно заменить.
Запустите установленный плагин внутри временного документа и проверьте содержимое полученного документа.
Включите отладку для разработки плагинов.
8. Перезапустите редакторы для настольных компьютеров с флагом отладки.
Полностью закройте ONLYOFFICE Desktop Editors, затем запустите приложение из терминала с официальным флагом отладки. Используйте команду, соответствующую вашей операционной системе и месту установки:
Приведённая выше команда Windows использует расширение переменных командной строки, а не синтаксис PowerShell; в PowerShell вызовите исполняемый файл, указав его полный путь. Если ваше приложение установлено в нестандартном месте, замените его фактическим путём к исполняемому файлу. Вы также можете добавить флаг в поле «Цель» ярлыка на рабочем столе Windows. Подробную информацию о платформах см. в описании команд режима отладки рабочего стола ONLYOFFICE.
После открытия документа щелкните в его области редактирования и нажмите F1 , или щелкните правой кнопкой мыши по редактируемому полю панели инструментов и выберите «Просмотреть элемент» . В инструментах разработчика выберите iframe плагина, чтобы просмотреть код интерфейса плагина и журналы. Код, передаваемый в функцию, callCommandвыполняется в frameEditorконтексте, поэтому переключайте фреймы при необходимости. В справочнике по отладке плагинов объясняется это различие и как использовать точки останова. Отладка может раскрыть содержимое документа и детали времени выполнения; не передавайте необработанные журналы, не проверив их.
После включения отладки проверьте соответствующий iframe плагина в инструментах разработчика; сообщения в консоли здесь носят иллюстративный характер.
Сократите цикл редактирования и тестирования без изменения встроенных плагинов.
После ручной установки ONLYOFFICE копирует плагин в каталог с GUID-именем в вашем профиле пользователя. Указанные расположения находятся %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\в Windows, ~/Library/Application Support/asc.onlyoffice.ONLYOFFICE/data/sdkjs-plugins/macOS и ~/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/Linux. В папке с GUID-именем отсутствует начальный символ, asc.используемый в манифесте.
Чтобы избежать создания нового архива для каждого изменения, разработчики могут закрыть приложение, заменить папку с установленными плагинами символической ссылкой на рабочую папку с исходным кодом и снова открыть документ после редактирования. Это необязательно, и точные команды для создания ссылок различаются в зависимости от операционной системы. Перед этим следуйте официальным инструкциям по разработке для настольных приложений . Не заменяйте папки со встроенными/стандартными плагинами и не изменяйте пакет приложения macOS: поставщик предупреждает, что удаление стандартных плагинов может нарушить целостность пакета и привести к сбоям.
Проверьте настройки разработки.
Три проверки указывают на готовность рабочего процесса: пользовательский плагин отображается в разделе «Плагины» , тест «Hello World» вставляет текст в новый документ, и инструменты разработчика открываются после запуска с флагом отладки. Если интерфейс пустой или установка не удалась, убедитесь, что манифест интерпретируется как JSON, GUID начинается с asc., index.htmlсуществует по указанному относительному пути и присутствуют все необходимые ресурсы. Официальное руководство по ошибкам плагинов описывает эти распространенные сбои. Установленный плагин не является доказательством того, что все реализованные им функции работают; повторяйте ту же проверку после каждого изменения кода.