v1.1
|
|
Для добавления шаблона стиля в Renga необходимо собрать его с помощью консольной утилиты RstBuilder.exe, которая входит в Комплект разработчика шаблона стиля. При запуске RstBuilder.exe с необходимыми параметрами происходит проверка входных файлов и создание файла в формате RST, который можно импортировать в окне Категории в Renga Professional.
Чтобы запустить утилиту из командной строки, нужно указать параметры запуска, файл описания параметров и портов и файл скрипта в следующем виде:
Параметр | Описание |
---|---|
-h , --help | Получение справки по использованию утилиты. |
-v , --version | Вывод версии утилиты. |
--configuration path_to_configuration_file | Задание расположения файла параметров в формате JSON. |
--executable_lua path_to_executable_lua_file | Задание расположения исполняемого файла Lua-скрипта. |
-s stdl_version , --stdlVersion stdl_version | Задание версии STDL. |
-o path_to_output_file , --output path_to_output_file | Задание расположения создаваемого файла категории в формате RST. |
-i path_to_include_lua_file , --include path_to_include_lua_file | Задание расположения дополнительных lua-скриптов и библиотек. |
Примеры:
При запуске RstBuilder c разными параметрами вы получите разные результаты. Чтобы создать файл в формате RST, задайте параметры, определяющие:
Пример:
Параметр -s stdl_version или –stdlVersion stdl_version для задания версии STDL обязателен. Определяет правила проверки и версию STDL для шаблона стиля. При возможности используйте наиболее старшую версию STDL, чтобы сохранить прямую совместимость с Renga старших версий.
При запуске будет проведена проверка входных файлов. Если она не пройдёт, то результирующий файл не будет создан и будет показан результат проверки. Если проверка прошла успешно, то вы получите файл шаблона стиля category.rst, который можно добавить в проект Renga для дальнейшего тестирования.
Если параметр -o file или –output file не задан, вы получите только результат проверки. Например, при неправильном формате версии вы получите следующее сообщение об ошибке:
Если при написании Lua-скрипта были подключены сторонние модули с помощью функции require
, то для сборки шаблона скрипта с помощью RstBuilder необходимо добавить их c помощью параметра -i file или –include file. Имена модулей должны быть уникальными.
Например, если в скрипте модули добавлены следующим образом:
то строка вызова RstBuilder, для получения файла в формате RST будет следующей:
Обратите внимание, что при написании скрипта в функции require
не надо указывать путь, по которому лежит модуль, а для сборки шаблона путь указать необходимо.
При запуске RstBuilder:
Завершая работу, RstBuilder возвращает следующие значения:
Обратите внимание, что проверка с помощью RstBuilder не выявляет ошибок использования Renga Template API. Об отладке шаблона стиля см. Тестирование и отладка.
Для интеграции сборки из VS Code добавьте в папку .vscode текущего проекта файл tasks.json:
Чтобы собрать шаблон стиля, вызовите команду Terminal->Run Build Task... (Ctrl+Shift+B).