|
Расширения файлов |
.csv |
|
Расширение API |
csv |
|
Импорт |
Да |
|
Экспорт |
Да |
|
Поддержка форм множественного числа |
Да |
|
Поддержка описания |
Да |
|
Варианты формата Эти параметры могут быть указаны при загрузке и/или скачивании файла. В зависимости от метода загрузки/скачивания (API, CLI, синхронизация репозитория и т.д.) они могут быть указаны в параметрах запроса |
key_index comment_index tag_column max_characters_allowed_column column_separator quote_char header_content_row enable_pluralization export_tags export_max_characters_allowed custom_metadata_columns export_key_id key_id_column |
CSV (значения, разделенные запятыми) — это популярный формат файла, используемый в основном для передачи данных в различных приложениях и программах. В файле CSV каждая строка является записью данных. Каждая запись состоит из нескольких полей, разделенных запятыми. Перед импортом убедитесь, что файлы CSV имеют три поля для одной строки, представляющей исходный контент, перевод и комментарии (по желанию).
Параметр locale_mapping (типа hashmap) необходим для указания, какой столбец в документе соответствует каждому языковому стандарту. Для примеров смотрите пример конфигурационного файла и документацию API для загрузок.
Параметры формата
|
Идентификатор |
key_index |
|
Тип |
integer |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
[empty] |
|
Описание |
Индекс столбца, содержащего имена ключей. Индексы столбцов начинаются с 1. |
|
Идентификатор |
comment_index |
|
Тип |
integer |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
[empty] |
|
Описание |
Индекс столбца, содержащего описание для ключа. Индексы столбцов начинаются с 1. |
|
Идентификатор |
tag_column |
|
Тип |
integer |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
[empty] |
|
Описание |
Индекс столбца, содержащего тег для ключа. Индексы столбцов начинаются с 1. |
|
Идентификатор |
max_characters_allowed_column |
|
Тип |
integer |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
[empty] |
|
Описание |
Индекс столбца, содержащего максимальное количество символов для ключа. Индексы столбцов начинаются с 1. |
|
Идентификатор |
column_separator |
|
Тип |
строка |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
, |
|
Описание |
Символ, используемый для разделения столбцов. |
|
Идентификатор |
quote_char |
|
Тип |
строка |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
" |
|
Описание |
Символ, используемый для кавычек новых строк и разделителей столбцов. |
|
Идентификатор |
header_content_row |
|
Тип |
булевский |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
false |
|
Описание |
Указывает, содержит ли первая строка только информацию заголовка и должна быть пропущена. |
|
Идентификатор |
enable_pluralization |
|
Тип |
булевский |
|
Загрузить |
Да |
|
Скачать |
Нет |
|
По умолчанию |
true |
|
Описание |
Позволяет обнаруживать ключи во множественном числе. Все совпадающие ключи будут сохраняться во множественном числе. |
|
Идентификатор |
export_tags |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
false |
|
Описание |
Экспортирует теги вместе с ключами и переводами. |
|
Идентификатор |
export_max_characters_allowed |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
false |
|
Описание |
Экспортирует идентификатор ключа вместе с ключами и переводами. |
|
Идентификатор |
custom_metadata_columns |
|
Тип |
хэш |
|
Загрузить |
Да |
|
Скачать |
Да |
|
По умолчанию |
[empty] |
|
Описание |
HashMap значений пользовательских метаданных, которые необходимо импортировать или экспортировать:
|
|
Идентификатор |
export_key_id |
|
Тип |
булевский |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
false |
|
Описание |
Экспортирует лимит символов ключа вместе с ключами и переводами. |
|
Идентификатор |
key_id_column |
|
Тип |
integer |
|
Загрузить |
Нет |
|
Скачать |
Да |
|
По умолчанию |
[empty] |
|
Описание |
Индекс столбца, содержащего идентификатор для ключа. Индексы столбцов начинаются с 1. |
Образец кода
boolean_key,"--- true " empty_string_translation,"" key_with_description,Check it out! This key has a description! (По крайней мере в некоторых форматах) Это удивительное описание для этого ключа! key_with_line-break,"This translations contains a line-break." nested.deeply.key,"Wow, this key is nested even deeper." nested.key,This key is nested inside a namespace. null_translation, pluralized_key.one, "Only one kitten found." pluralized_key.other,"Wow, you have %s kittens!" pluralized_key.zero,"You have no kittens." sample_collection,"--- - first item - second item - third item " simple_key,Just a simple key with a simple message. unverified_key,This translation is not yet verified and waits for it. (В некоторых форматах мы также экспортируем этот статус)
Структура файла
Типичная структура .CSV файла:
1 (Key column), 2 (Translation column), 3 (Comment column) app_title, My Software Project, This is the main title apples.zero, one apple, my comment ...
Пример конфигурации
Пример для секции push файла .phrase.yml для .CSV файлов:
push:
sources:
- file: "./multi.csv"
params:
update_translations: true
locale_mapping:
en: 2
de: 3
format_options:
comment_index: 4
tag_column: 5
В этом формате используются именованные категории для идентификации различных множественных чисел ключа. Следующие категории зарезервированы для форм множественного числа:
.zero | .one | .two | .few | .many | .other
Примеры имен для правильно идентифицированных, постоянных и помеченных ключей с множественным числом:
-
inbox.messages.notification.one
-
inbox.messages.notification.other
Файлы должны следовать этой структуре:
1 (Key column), 2 (Translation column), 3 (Comment column) messages.zero, No messages received, messages.one, One message received, messages.other, %s messages received,