gslocalization

Локализация iOS и Android с использованием Google Sheets

Основная идея

1. Экспортируйте свои файлы локализации в Google Sheets .
2. Переведите недостающие локализации или обновите существующие в таблицах Google .
3. Запустите сценарий еще раз, чтобы импортировать локализацию из электронной таблицы в ваш проект .

Установка

Python 2.7 или предпочтительно Python 3 должны быть установлены на вашем компьютере с помощью команды pip также доступны.

Клонировать репозиторий и запустить pip install -r requirements.txt .

Авторизация gslocalization с помощью Google Sheets

1. Получите service account key JSON File от вашей консоли разработчика Google
   • Войдите в https://console.developers.google.com
   • Выберите свой проект (или создайте новый)
   • Убедитесь, что Google Drive API и Google Sheets API включены
   • Перейдите в Credentials и в меню Create credentials выберите Service account key
   • Выберите свою учетную запись службы (или создайте новую с роли App Engine Admin )
   • Убедитесь, что JSON выбран в параметрах Key type .
   • Нажмите Create
   • Файл JSON начнет загрузку. Сохраните этот файл и используйте его позже для аутентификации.

ios-gslocalization.py

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

python ios-gslocalization.py -x {PATH_TO_XCODEPROJ} -o {XLIFF_OUTPUT_DIR} -a {JSON_AUTH_FILE_PATH} -e {SHARE_EMAIL_ADDRESS} -l {LOCALIZATION_LANGUAGES} -d {DEV_LANGUAGE}

1. PATH_TO_XCODEPROJ - Путь к вашему файлу .xcodeproj
   • Используется для вызова xcodebuild (экспорт и импорт локализации)
   • Сгенерированные файлы xliff сохраняются в XLIFF_OUTPUT_DIR
2. XLIFF_OUTPUT_DIR - выходной каталог для сгенерированных файлов Xliff
3. JSON_AUTH_FILE_PATH - Путь к Service account key Google Sheets
4. SHARE_EMAIL_ADDRESS - адрес электронной почты, чтобы поделиться созданными электронными таблицами
   • Поскольку мы используем Service account key , все электронные таблицы создаются и принадлежат Сервисной учетной записи (Ex. [email protected])
   • После того, как учетная запись сервиса создает электронные таблицы, она передает владение файлами на предоставленный адрес электронной почты
   • Предоставьте ваш адрес электронной почты, чтобы иметь возможность визуализировать результаты в таблицах Google
5. LOCALIZATION_LANGUAGES ​​- строка, содержащая несколько языковых кодов, используемых для локализации
   • Пример: "es, ru, Ja" для испанского, русского и японского
   • Это не позволяет локализации для нового языка в вашем проекте XCode
   • Предоставьте языки, которые уже существуют в вашем проекте
6. DEV_LANGUAGE (необязательно, по умолчанию en ) - языковой код для языка разработчика проекта

Примечания

• Этот скрипт экспортирует текущие локализации для вашего проекта с использованием xcodebuild .

• Он анализирует полученные файлы Xliff и загружает их в Google Sheets.

• Существует одна электронная таблица для каждого языка, со следующим форматом имени: {PROJECT_NAME}_{LANGUAGE_NAME}_localizations (Ex. MyProject_Spanish_localizations , MyProject_Russian_localizations и т. Д.). В каждой таблице есть один рабочий лист на платформу (Ex. ios_strings , android_strings ). {PROJECT_NAME} выведен из имени файла xcodeproj .

• Все струны добавляются к их соответствующей таблице, со следующим заголовком:

  Source: SOURCE_LANGUAGE | Target: TARGET_LANGUAGE | Example | Comment | String Key | File Path

  • Source: SOURCE_LANGUAGE = текст на исходном языке
  • Target: TARGET_LANGUAGE = текст, переведенный на целевом языке
  • Example = пусто, если строка содержит заполнители ( %@, %d, etc. ). Это место для примера для переводчиков.
  • Comment = NSLocalisedString Комментарии
  • String Key = идентификатор строки
  • File Path = относительный путь к исходному файлу строки ( .strings File или .storyboard )

• После обновления перевода в Google Sheets снова запустите тот же сценарий, чтобы импортировать новые строки в свой проект XCode.

Android-gslocalization.py

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

python android-gslocalization.py -p {PROJECT_NAME} -r {PATH_TO_RES_FOLDER} -a {JSON_AUTH_FILE_PATH} -e {SHARE_EMAIL_ADDRESS} -l {DEVELOPMENT_LANGUAGE}

1. PROJECT_NAME - имя проекта (используется для префикса названия электронной таблицы)
2. PATH_TO_RES_FOLDER - Путь к папке Android res
   • Посмотреть в этой папке для всех файлов strings.xml
   • Для любого файла strings.xml целевой язык обнаруживается по имени папки Parrent (Ex. values-es для испанского)
3. JSON_AUTH_FILE_PATH - Путь к Service account key Google Sheets
4. SHARE_EMAIL_ADDRESS - адрес электронной почты, чтобы поделиться созданными электронными таблицами
   • Поскольку мы используем Service account key , все электронные таблицы создаются и принадлежат Сервисной учетной записи (Ex. [email protected])
   • После того, как учетная запись сервиса создает электронные таблицы, она передает владение файлами на предоставленный адрес электронной почты
   • Предоставьте ваш адрес электронной почты, чтобы иметь возможность визуализировать результаты в таблицах Google
5. DEVELOPMENT_LANGUAGE - языковой код вашего языка развития (default = en )

Примечания

• Этот скрипт загружает все файлы strings.xml внутри PATH_TO_RES_FOLDER .

• Он анализирует полученные файлы XML и загружает их в Google Sheets.

• Существует одна электронная таблица для каждого языка, со следующим форматом имени: {PROJECT_NAME}_{LANGUAGE_NAME}_localizations (Ex. MyProject_Spanish_localizations , MyProject_Russian_localizations и т. Д.). В каждой таблице есть один рабочий лист на платформу (Ex. ios_strings , android_strings ).

• Все струны добавляются к их соответствующей таблице, со следующим заголовком:

  Source: SOURCE_LANGUAGE | Target: TARGET_LANGUAGE | String ID

  • Source: SOURCE_LANGUAGE = текст на исходном языке
  • Target: TARGET_LANGUAGE = текст, переведенный на целевом языке
  • String ID = идентификатор строки

• После обновления перевода в Google Sheets снова запустите тот же сценарий, чтобы перезаписать файлы strings.xml в папке ресурсов.

Зависимости

 # parsing arguments
argparse

# provides access to Google Sheets API
pygsheets

# XML parsing for XML/XLIFF files
lxml

# type hinting
typing

# colored output in consolde
colorama

# conversion between language code and language name
langcodes; python_version>'3'
langcodes-py2; python_version<'3'

Общие советы

1. Держите свой проект под управлением источника.

IOS советы

1. Используйте значение по умолчанию для локализованных строк. Делая это, у вас будет значение по умолчанию (обычно строку в языке разработки) в столбце исходного языка, а не в ключке строки.
   • Для Objective C используйте NSLocalizedStringWithDefaultValue(@"KEY", nil, [NSBundle mainBundle], @"DEFAULT_VALUE", @"COMMENT")] вместо NSLocalizedString(@"KEY", @"COMMENT")]
   • Для Swift используйте NSLocalizedString("KEY", tableName: nil, bundle: Bundle.main, value: "DEFAULT_VALUE", comment: "COMMENT") вместо NSLocalizedString("KEY", comment: "COMMENT")
   • Используйте этот скрипт Python, чтобы преобразовать вызовы NSLocalizedString , чтобы включить значение по умолчанию