Не найдено

manifestCreator

Плагин manifestCreator — это мощный инструмент, позволяющий разработчикам плагинов для экранного ридера NVDA легко создавать файлы manifest.ini и подготавливать пакеты плагинов NVDA (.nvda-addons). Он создаёт файлы манифестов с удобным интерфейсом, которые определяют метаданные, необходимые для корректной работы плагинов NVDA (имя плагина, версия, описание, информация о совместимости и т. д.). Он также упрощает работу разработчиков и снижает риск ошибок, автоматизируя процесс упаковки плагинов. Этот плагин предназначен как для начинающих, так и для опытных разработчиков плагинов NVDA и полностью совместим с функциями доступности NVDA.

Возможности:

Удобный интерфейс создания манифеста Плагин предоставляет диалоговое окно, доступное через опцию, добавленную в меню NVDA. В этом окне разработчики могут заполнить следующие поля манифеста: Имя дополнения: уникальный идентификатор плагина (например, myAddon). Краткое описание: краткое название или название плагина. Версия: номер версии плагина (например, 1.0.0). Описание: Текст, описывающий функциональность плагина (автоматически форматируется с помощью """). Автор: Имя разработчика и контактная информация. URL: Веб-адрес плагина (необязательно). DocumentFileName: Имя файла документации плагина (необязательно). UpdateChannel: Канал обновления плагина (необязательно). Минимальная версия NVDA: Минимальная версия NVDA, необходимая для работы плагина. Последняя протестированная версия NVDA: Максимальная версия NVDA, на которой был протестирован плагин. Эти поля заполняются в соответствии со стандартами хранилища плагинов NVDA, и если обязательные поля отсутствуют, пользователю выводится сообщение об ошибке. Гибкие параметры форматирования Подсветка имени и краткого содержания: Пользователь может включить опцию заключения имени плагина и полей краткого содержания в кавычки. Это улучшает читаемость файла манифеста и, в некоторых случаях, обеспечивает соответствие процессу обработки метаданных NVDA. Вставка пустой строки: Манифест. Возможность Добавьте пустую строку в конец файла. Это обеспечивает совместимость с рекомендуемым форматом файла NVDA. Если пустая строка отсутствует, пользователю отображается подтверждающее сообщение, предотвращая возможные ошибки.

Поддержка упаковки плагинов

Плагин может упаковать сгенерированный файл manifest.ini как пакет расширения NVDA (.nvda-addon). Пользователь может включить в пакет расширения следующие папки:

appModules: Модули, специфичные для приложения.

synthDrivers: Драйверы синтезатора речи.

brailleDisplayDrivers: Драйверы дисплея Брайля.

globalPlugins: Общие плагины NVDA.

doc: Файлы документации (например, руководство пользователя).

locale: Файлы перевода (например, каталоги сообщений для разных языков).

Для папок документации и перевода пользователь может дополнительно указать код языка (например, турецкий для tr). Это обеспечивает поддержку многоязычных плагинов.

Формирование отчётов об ошибках

Плагин может сохранять введенные пользователем данные и настройки. в виде подробного отчёта об ошибках. Этот отчёт содержит следующую информацию: Все заполненные поля манифеста (включая пустые). Выбранные папки (appModules, synthDrivers и т. д.). Языковые коды (для doc и локали). Дополнительные параметры (кавычки, пустая строка, настройки отчёта об ошибках). Отчёт сохраняется на рабочем столе как error_report.txt, а размер файла сообщается пользователю. Эта функция упрощает процесс устранения неполадок для разработчиков и позволяет им документировать ошибки, допущенные при создании манифеста. Проверка обязательных полей Плагин предотвращает генерацию или упаковку манифестов без заполнения обязательных полей (имя, краткое описание, версия, описание, автор). Если какие-либо поля отсутствуют, пользователю отображается сообщение об ошибке с указанием отсутствующих полей. Это предотвращает проблемы с установкой плагина NVDA.

Поддержка доступности

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

Параметры очистки полей и выхода

Очистить все поля: пользователь может сбросить все текстовые поля одной кнопкой, что позволяет быстро подготовиться к созданию нового файла манифеста.

Отмена и выход: пользователь может отменить операцию или закрыть диалоговое окно. Эти операции выполняются в соответствии со стандартами доступности NVDA.

Автоматическое сохранение файлов Сгенерированный файл manifest.ini сохраняется на рабочем столе, и пользователю сообщается размер файла.

При использовании опции упаковки пакет дополнения (.nvda-addon) сохраняется на рабочем столе. Пакет содержит выбранные папки и файл манифеста, что позволяет загрузить его непосредственно в NVDA.

Меню дополнительных параметров

Дополнение отображает окно «Дополнительные параметры». В этом окне пользователь может: Заключить поля имени и краткого содержания в кавычки i можно настроить. Включить или отключить функцию создания отчёта об ошибках. После сохранения настроек пользователь получает уведомление об успешном сохранении.

Сценарии использования

Новые разработчики: Те, кто только знакомится с разработкой дополнений NVDA, могут быстро создать файл с помощью этого дополнения, не изучая формат файла манифеста. Опытные разработчики: Разработчики нескольких дополнений могут сэкономить время, автоматизировав процесс создания и упаковки манифеста. Многоязычные дополнения: Разработчики, желающие добавить документацию и файлы перевода для разных языков, могут легко сделать это благодаря поддержке языкового кода. Отладка: Функция отчёта об ошибках помогает разработчикам быстро выявлять некорректные записи или ошибки конфигурации. Подготовка хранилища дополнений: NVDA создаёт файлы манифестов и пакеты, соответствующие стандартам, для отправки дополнений в хранилище дополнений.

Технические характеристики

Совместимость: Работает с NVDA версии 2020.4 и более поздних, протестировано до версии 2029.4. Зависимости: Использует встроенную среду Python NVDA (рекомендуется Python 3.11 или более поздняя версия). Дополнительные зависимости не требуются.

Выходные файлы:

manifest.ini: Файл манифеста, сохранённый на рабочем столе.

<имя_плагина>-<версия>.nvda-addon: Пакет дополнения NVDA, содержащий выбранные папки.

error_report.txt: Отчёт об ошибках (необязательно).

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

Преимущества: Экономия времени: Быстрое создание и упаковка без ручного написания файла манифеста.

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

Гибкость: Поддержка различных типов дополнений с возможностью выбора папки и языкового кода.

Доступность: Обеспечивает полную совместимость с NVDA для разработчиков с нарушениями зрения. Ограничения Плагин предназначен только для создания файла manifest.ini и базовой упаковки. Сложные конфигурации плагина (например, пользовательские таблицы Брайля или речевые символы) могут потребовать дополнительных инструментов. Процесс упаковки предполагает наличие выбранных папок и не проверяет их содержимое. Хотя поля с кодами языков необязательны, при вводе неверных кодов языков могут возникнуть ошибки упаковки.

Заключение

ManifestCreator — это доступный и мощный инструмент, упрощающий создание файла манифеста и упаковку плагинов для разработчиков плагинов NVDA. Его удобный интерфейс, функция отчётов об ошибках, обязательная проверка полей и гибкие настройки папок подходят как начинающим, так и опытным разработчикам. Это идеальное решение для создания файлов, подходящих для хранилища плагинов NVDA.