NVDA Add-on Scons Template

Данный пакет содержит базовую структуру шаблонов для разработки, сборки, распространения и локализации дополнений к NVDA. Подробнее о разработке дополнений к NVDA см. в Руководстве разработчика NVDA. Список разработчиков/обсуждающих аддонов NVDA находится здесь

Copyright (C) 2012-2014 Соавторы команды nvda addon.

Данный пакет распространяется на условиях Стандартной общественной лицензии GNU, версия 2 или более поздняя. Более подробная информация приведена в файле COPYING.txt.

Особенности

Данный шаблон предоставляет следующие возможности, которые вы можете использовать для разработки дополнений к NVDA:

• Автоматическое создание пакета дополнений с загрузкой имени и версии из централизованного файла переменных сборки (buildVars.py).
• Создание файла манифеста с использованием шаблона (manifest.ini.tpl). Переменные сборки заменяются на этот шаблон.
• Компиляция gettext mo-файлов перед распространением, когда это необходимо.
• Для генерации gettext pot-файла необходимо выполнить команду scons pot. Будет создан файл addon-name.pot, содержащий все gettext-сообщения для вашего дополнения. Необходимо проверить переменную buildVars.i18nSources на соответствие вашим требованиям.
• Автоматическая генерация файлов локализации манифеста непосредственно из gettext po файлов. Убедитесь, что buildVars.py включен в i18nFiles.
• Автоматическая генерация HTML-документов из файлов markdown (.md) для управления документацией на разных языках.

Требования

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

• дистрибутив Python (рекомендуется версия 2.7 или выше). Инсталляторы для Windows можно найти на сайте Python Website.
• Scons - Сайт - версия 2.1.0 или выше. Установите его с помощью easy_install или возьмите установщик для Windows с сайта.
• GNU Gettext tools, если вы хотите иметь поддержку локализации для вашего дополнения - Рекомендуется. Они установлены в любом дистрибутиве Linux или в cygwin. Сборки для windows можно найти [здесь] (http://gnuwin32.sourceforge.net/downlinks/gettext.php).
• Markdown-2.0.1 или выше, если вы хотите конвертировать файлы документации в HTML-документы. Вы можете Скачать инсталлятор Markdown-2.0.1 для Windows или получить его с помощью easy_install markdown.

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

Чтобы создать новое дополнение к NVDA, воспользуйтесь этим шаблоном:

• Создайте пустую папку для хранения файлов вашего дополнения.
• Создайте папку addon внутри этой новой папки. Внутри папки *addon создайте необходимые папки для модулей дополнения (например, appModules, synthDrivers и т.д.). Дополнение может иметь одну или несколько папок с модулями.
• Скопируйте в созданную папку файл buildVars.py, файлы manifest.ini.tpl, manifest-translated.ini.tpl, SCONSTRUCT, site_scons, .gitignore и .gitattributes.
• В файле buildVars.py измените переменную addon_info на информацию о вашем дополнении (название, краткое содержание, описание, версия, автор и url).
• Поместите свой код в папки, обычные для расширений NVDA, в папку addon. Например: globalPlugins, synthDrivers и т.д.
• Переводы Gettext должны быть помещены в addon\locale\/LC_MESSAGES\nvda.po.

Для управления файлами документации к вашему аддону:

• Скопируйте файл readme.md для вашего дополнения в первую созданную папку, куда вы скопировали buildVars.py. Вы также можете скопировать style.css для улучшения представления HTML-документов.
• Файлы документации (с именем readme.md) должны быть помещены в папку addon\doc\/.

Для упаковки дополнения для распространения:

• Откройте командную строку, перейдите в папку, в которой находится файл SCONSTRUCT (обычно это корень папки разработки дополнения), и выполните команду scons. Созданное дополнение, если не было ошибок, помещается в текущий каталог.
• Дополнительную настройку переменных можно произвести в файле buildVars.py.

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

Если у вас возникнут какие-либо проблемы, воспользуйтесь списком аддонов NVDA, приведенным выше.