Как локализовать интерфейс NOC¶
Выберите язык интерфейса через глобальный параметр language. NOC поддерживает en, ru и pt_BR. После изменения параметра перезапустите затронутые сервисы. Описание параметра приведено в справочнике конфигурации.
Добавление и изменение переводов Python¶
Переводы Python хранятся в YAML-каталогах со стабильными ключами: src/noc/i18n/en.yml, src/noc/i18n/ru.yml и src/noc/i18n/pt_BR.yml.
- Добавьте ключ и английский текст в
en.yml. - Добавьте тот же ключ с переводом в каждый каталог языка, который обновляете. Если ключа нет в каталоге языка, используется английский текст.
- Сохраняйте ключи в алфавитном порядке. Тесты каталога проверяют сортировку.
- Вызывайте перевод в Python через
t():
from noc.core.i18n import t
error = t("msg-prefix-not-found")
Выбирайте префикс ключа по назначению текста:
| Префикс | Назначение |
|---|---|
btn- |
Текст кнопки, например btn-print |
msg- |
Сообщения пользователю и ошибки |
label- |
Подписи полей форм и заголовки полей карточек |
help- |
Подсказки и всплывающие подсказки |
header- |
Заголовки колонок таблиц и отчётов |
app-title- |
Заголовки приложений |
app-group- |
Группы приложений |
nav- |
Пункты меню приложений |
В Jinja2-шаблонах карточек используйте t() без импорта:
<b>{{ t("label-name") }}</b>
Передавайте значения именованными аргументами. Для сообщений, форма которых зависит от числа, используйте ICU plural pattern; не соединяйте перевод с числительным при помощи конкатенации.
msg-item-count: "{count, plural, one {# предмет} few {# предмета} many {# предметов} other {# предмета}}"
t("msg-item-count", count=item_count)
Для русского языка указывайте формы one, few, many и other. Во всех каталогах используйте синтаксис ICU MessageFormat.
Перевод JavaScript-интерфейса¶
JavaScript UI использует t() и те же YAML-каталоги, что и Python: src/noc/i18n/{en,ru,pt_BR}.yml. Английский каталог служит основой, а при сборке поверх него накладывается выбранный язык.
- Добавьте стабильный ключ и английский текст в
en.yml. - Добавьте перевод под тем же ключом в языковые каталоги. Для динамических сообщений используйте именованные аргументы и ICU plural forms.
- Вызывайте перевод в JavaScript через
t("btn-save"). - Выбирайте префикс ключа по назначению:
app-title-,nav-,app-group-,msg-,label-,header-,help-илиbtn-.
Проверка каталогов¶
После изменения YAML-переводов запустите тесты каталогов:
./scripts/run-dev pytest tests/i18n/test_catalog.py
Тесты проверяют загрузку каждого настроенного каталога, отсутствие в русских и португальском каталогах ключей, которых нет в английском, и алфавитную сортировку. Локализованный каталог может не содержать некоторые ключи: для них используется английский текст.