Локализация модуля. Как переименовать действия в модуле
В данной статье мы разберем процесс локализации модуля, чтобы все действия модуля были переведены на более пользовательский формат, выглядя аккуратно и интуитивно понятно. Данная статья является дополнением к материалу — как создать свой первый модуль
Данная статья была подготовлена на основе старой версии интерфейса. Несмотря на возможные визуальные изменения, функциональность и последовательность действий остались актуальными
1. Краткая структура модуля
Описание структуры модуля и его файлов:
Модуль в BrowserAutomationStudio — это набор файлов, каждый из которых отвечает за определённую часть его работы. Эти файлы хранятся в папке модуля и обеспечивают его функциональность, внешний вид и взаимодействие с интерфейсом BAS
- manifest.json — данный файл отвечает за общие настройки модуля, его локализацию. Также к нему подключаются различные другие файлы, отвечающие за встроенный код в модуль
Файлы действий(созданные функции) — это файлы, которые содержат основную логику работы каждого конкретного действия в модуле
Каждое действие состоит из 3 файлов:
- имя_действия_code.js — файл с кодом, который добавляется в скрипт при использовании конкретного действия
- имя_действия_select.js — файл отвечающий за связь между интерфейсом и выполняемыми действиями, включая проверки переменных и другие функциональные аспекты
- имя_действия_interface.js — файл определяющий интерфейс действия, то есть его внешний вид и настройки в конструкторе
Для более углубленного разбора структуры модулей, файлов, можно прочитать руководство по ссылке ниже, мы переходим к следующему пункту статьи. Подробный разбор структуры модулей
Рассмотрим процесс локализации на примере модуля «EmulatorModule»
2. Переименовываем действия и параметры в модуле
В модуле, созданном в рамках другой статьи, действия пока не имеют корректных наименований, что свидетельствует о том, что работа над ним ещё не завершена
Локализация параметров и действий модуля: пошаговая инструкция (8 шагов)
- В верхнем меню BrowserAutomationStudio нажмите «Менеджер модулей»
- Найдите и кликните на название своего модуля (в примере EmulatorModule)
- Нажмите кнопку «Открыть папку содержащую модуль»
2. Папка модуля: содержит все файлы, отвечающие за работу модуля: его настройки, логику, интерфейс и вспомогательные компоненты
3. Откройте файл manifest.json
Для открытия файлов .json удобно использовать редактор кода Visual Studio Code4. В файле manifest.json вашего модуля найдите массив «actions» — он содержит список всех действий, которые использует модуль
5. Найдите объект «description» в файле manifest.json и измените значение, чтобы задать нужное название действия в модуле
Например, в модуле EmulatorModule предусмотрены два действия, которым мы зададим новые, более понятные наименования:
6. Сохраните файл manifest.json с помощью сочетания клавиш Ctrl + S. После этого изменения вступят в силу — действия в модуле будут отображаться с новыми названиями в интерфейсе BrowserAutomationStudio
7. Следующим шагом является переименование параметров, используемых в действиях модуля. Для этого переходим к другим файлам модуля:
- EmulatorModule_screenshot_and_save_screenshot_to_png_interface.js
- EmulatorModule_Load_site_await_emulation_interface.js
Поле «description» содержит описание параметров модуля
8. Готово 🎉. Перейдите в ваш проект с действиями модуля и проверьте результат
3. Результат модуля - «EmulatorModule»
Мы успешно переименовали наши действия, а так же параметры, теперь модуль выглядит более понятным и приятным для вас или ваших пользователей
Исходники для практики:
Благодарим за ваше внимание
В данной статье мы рассмотрели процесс локализации модуля в BrowserAutomationStudio: как перевести действия и параметры, а также настроить их для повышения удобства использования. Вы узнали, как работать с файловой структурой модуля, редактировать описания и адаптировать интерфейс под задачи пользователя, делая модуль более понятным и удобным в работе
Вы можете поделиться своим модулем, как это сделали десятки других авторов ❤️
Ветка модулей на форуме — RU | EN
Дополнительные материалы для изучения:
1. Пошаговое руководство о создании модуля в BrowserAutomationStudio
2. Функции в BrowserAutomationStudio
