08.11.2016

Механизм быстрого частичного перевода ресурсов платформы

• Общая информация о механизме
• Получение исходных файлов ресурсов
• Локализация ресурсов
• Компиляция ресурсов
• Проверка созданной локализации
  Использование переведенных ресурсов веб-клиентом
• Выполнение повторной локализации
• Приложение. Таблица локалей

Общая информация о механизме

Данный механизм позволяет выполнить локализацию интерфейса платформы «1С:Предприятие», в той части, которая необходима для функционирования конкретного прикладного решения.

Такая локализация обладает следующими ограничениями:

• Не поддерживается возможность локализации картинок;
• Не предоставляется возможность сборки дистрибутива платформы;
• Не поддерживается перевод справочной информации.

Общая схема частичного перевода выглядит следующим образом:

• Платформа «1С:Предприятие» запускается в специальном режиме с выбранным прикладным решением.
• В процессе работы прикладного решения платформа формирует список ресурсов, которые необходимо локализовать.
• Выполняется перевод сформированных ресурсов.
• С помощью специальных утилит выполняется преобразование переведенных файлов с формат, понимаемый платформой «1С:Предприятие».

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

Механизм не поддерживает определение того факта, что ресурс платформы был изменен и требуется его повторный перевод. В связи с этим, при смене версии платформы (в том числе и при изменении 4-й цифры версии), рекомендуется выполнить перевод заново. В случае использования ресурсов, переведенных для любой предыдущей версии, работоспособность платформы не гарантируется.

При описании использования частичной локализации будут использоваться следующие термины:

• Локаль – это набор параметров (включая набор символов, язык пользователя, страну, часовой пояс, а также другие установки), которые пользователь ожидает увидеть в пользовательском интерфейсе. В контексте данного механизма под локалью понимается язык, на который осуществляется перевод. Каждая локаль имеет свое обозначение – код, например, для японского языка код японской локали будет ja. Коды локалей см. здесь.
• Исходные файлы ресурсов – файлы, генерируемые механизмом локализации (имеют расширения .rcb, .f, .lf, .txt, .html). Данные файлы еще не скомпилированы в ресурсные файлы (с расширением .res) с помощью специальных утилит компиляции ресурсов. Исходные файлы ресурсов могут быть прочитаны и отредактированы человеком, в то время как сами ресурсные файлы предназначены только для машинной обработки.
• Выходной каталог – каталог, в который после завершения работы механизма локализации, помещаются сгенерированные исходные данные для перевода:
  • Файлы ресурсов (с расширением .rcb);
  • Файлы форм (с расширением .f, .lf);
  • Другие файлы (с расширением .txt, .html и др.).

Получение исходных файлов ресурсов

Получение исходных файлов ресурсов поддерживается только при работе «1С:Предприятие» в файловом варианте при использовании тонкого или толстого клиентских приложений. Все тексты в исходных файлах ресурсов всегда приводятся на английском языке.

Для получения исходных файлов ресурсов необходимо выполнить следующие действия:

1. Запустить платформу в специальном режиме. Для этого в командной строке следует использовать параметр -DumpNotLocalized ключа командной строки запуска клиентского приложения /L. Параметром собственно ключа /L должен служить код языка, на который будет выполняться частичный перевод.

Пример командной строки запуска:

1cv8 /L<язык> -DumpNotLocalized <путь> /ClearCache

В данных примерах:

• <язык> – код локали, для которой будет выполняться сбор не переведенных ресурсов. Коды локалей см. здесь.
• <путь> – путь к выходному каталогу.

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

Пример запуска:

1cv8с /Lja -DumpNotLocalized c:\work\1c_resources /ClearCache

Платформа будет запущена в режиме перевода для японского языка (ja), при этом исходные данные для перевода будут помещены в каталог c:\work\1c_resources.

При работе системы в специальном режиме следует учитывать следующие особенности:

• Если каталог <путь> не существует, то он будет создан. Если каталог <путь> существует, то все его содержимое будет удалено.
• Если для языка <язык> существуют частично локализованные ресурсы, то при запуске системы в специальном режиме для этого языка (<язык>), в выходной каталог будут помещены исходные файлы ресурсов только для не локализованной части ресурсов (если таковые есть).
• Запуск следует выполнять с указанием параметра командной строки запуска клиентского приложения /ClearCache, иначе ресурсы будут браться из кэша ресурсов, а не загружаться заново. В результате будут обнаружены не все ресурсы, требующие локализации.

2. При работе с прикладным решением в специальном режиме запуска следует, по возможности, максимально полно использовать функциональные возможности конфигурации:

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

3. Завершить работу платформы.

После выполнения этих действий в выходном каталоге c:\work\1c_resources, будут сгенерированы исходные данные, требующие перевода:

• Файлы ресурсов (.rcb);
• Файлы форм (.f, .lf), и другие файлы (.txt, .html и др.), ссылки на которые встречаются в .rcb-файлах. Эти файлы размещаются в отдельном каталоге, имя которого соответствует имени .rcb-файла.

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

Локализация ресурсов

В процессе локализации не следует:

• изменять имена файлов и каталогов, а также структуру каталога с исходными файлами ресурсов.
• изменять структуру файла – удалять записи или добавлять новые.

Изменения сделают невозможной последующую компиляцию ресурсов.

Локализацию рекомендуется выполняться следующим образом:

1. Выполнить перевод строковых ресурсов:

• Открыть .rcb-файл, используя любой текстовый редактор;
• Найти секцию помеченную комментарием // Strings;
• Строка ресурсов имеет вид: IDS_ANY_IDENTIFIER:string{"Any text"}. Переводу подлежит текст, расположенный внутри "". В примере выше переводу подлежит текст Any text.

В строке могут встречаться последовательности символов - \u000A и \u0022. Это специальные последовательности символов. Эти последовательности не требуется переводить, а рекомендуется оставлять точно в тех же местах, где они располагаются в исходной строке (до локализации).

• В секции, помеченной комментарием // Forms ничего делать не надо.

2. Выполнить перевод форм (файлы .f, .lf) с помощью специализированного редактора – formdes.exe.

Перевод форм следует выполнять только с помощью утилиты  formdes.exe. Запрещается вносить изменения в файлы форм любым другим способом (в том числе и редактированием с помощью текстовых редакторов). Такое редактирование может привести к нарушению структуры формы, что, в свою очередь, приведет к невозможности компиляции ресурсов.

3. Выполнить перевод текстовых и гипертекстовых файлов (.txt и .html).

Текстовые файлы переводятся полностью за исключением специальных символов, если они встречаются в тексте.

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

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

Компиляция ресурсов

Компиляция ресурсов выполняется с помощью утилиты genrb. Для запуска компиляции служит пакетный файл res_compile.bat.

1. Скопировать пакетный файл res_compile.bat и утилиту genrb в каталог, содержащий переведенные исходные данные.
2. Запустить пакетный файл res_compile.bat в качестве параметра указав каталог, куда будут помещены скомпилированные ресурсы. В качестве каталога размещения скомпилированных ресурсов можно указать каталог исполняемых файлов требуемой версии платформы. В этом случае у пользователя, от имени которого выполняется компиляция ресурсов, должны быть права на запись в этот каталог и данная версия платформы не должна использоваться на компьютере, где выполняется компиляция.
3. Скопировать скомпилированные ресурсные файлы (.res) в каталог bin требуемой версии платформы "1С:Предприятие" (которая использовалась для формирования исходных файлов ресурсов). Если в качестве целевого каталога указывается каталог исполняемых файлов требуемой версии платформы, данный шаг можно опустить.

Пример:

res_compile.bat "C:\Program Files (x86)\1cv8\8.3.7.1000\bin"

Проверка созданной локализации

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

Пример для японского языка:

1Cv8c.exe /ClearCache /Lja

При проверке качества локализации рекомендуется всегда использовать параметр /ClearCache во избежание использования кеша ресурсов.

Использование переведенных ресурсов веб-клиентом

Чтобы использовать локализованные ресурсы в веб-клиенте, следует вручную скопировать файл vrscore_root.res с именем vrscore_<локаль>.res, где <локаль> - имя локали, для которой выполнялась локализация. Например: для японского языка файл должен иметь имя vrscore_ja.res.

При использовании ресурсов на веб-клиенте существует ограничение: Все сообщения об ошибках отображаются на английском языке.

Выполнение повторной локализации

При выполнении повторной локализации системы (например, в случае планируемого перехода на другую версию платформы), рекомендуется следовать следующему алгоритму:

1. Создать каталог (далее - базовый каталог), в который скопировать переведенные исходные данные для предыдущей версии платформы.
2. Запустить платформу в режиме перевода, указав выходной каталог, отличный от базового каталога.
3. Выполнить перевод полученных исходных данных. Их может не быть, если перевод не требуется.
4. Выполнить объединение исходных данных из базового каталога и выходного каталога:
   • Файлы ресурсов (.rcb) следует объединить, сохраняя их структуру. Результирующие файлы должны находиться в базовом каталоге. Для объединения файлов рекомендуется использование программных средств, для сравнения и объединения файлов: Araxis Merge, KDiff3, WinMerge или любого аналогичного.
   • Файлы форм (.f, .lf) и другие файлы (.txt, .html) следует скопировать в каталог соответствующей компоненты базового каталога из каталога исходных файлов, при необходимости выполнив замену файлов.
5. Скомпилировать ресурсы, используя в качестве исходных файлы из базового каталога.
6. Скопировать скомпилированные ресурсные файлы в каталог требуемой версии платформы.
7. Проверить качество локализации.

Приложение. Таблица локалей