Configuração do arquivo

Nota: Se você estiver usando a versão antiga do Crowdin CLI (0.5.5 ou menos) consulte Crowdin Github para mais detalhes.

Introdução

O Crowdin CLI usas um arquivo de configuração YAML, que contém uma descrição dos recursos para gerenciar: os arquivos para serem carregados para o Crowdin e os locais das traduções correspondentes.

Para usar o Crowdin CLI, deve primeiro gerar o seu arquivo de configuração e depois, executar a ferramenta. Por padrão, o Crowdin CLI procura por um arquivo de configuração nomeado por crowdin.yaml (para que não precise de especificar o nome do arquivo, a menos que seja diferente de crowdin.yaml).

Para criar o arquivo de configuração, execute o seguinte comando:

$ crowdin generate

Estrutura do arquivo de configuração

Um arquivo de configuração YAML do Crowdin CLI, tem a seguinte estrutura, por isso, certifique-se de preencher todas as informações necessárias:

  • O cabeçalho do arquivo com as credenciais do projeto, preferências, e informações de acesso
  • Um elemento de array de arquivos que descreve um conjunto de arquivos de origem e de tradução que você vai administrar
  • Campos obrigatórios no array de arquivos: Origem que define filtros para os arquivos de origem e Tradução com instruções sobre onde armazenar os arquivos traduzidos ou onde procurar as traduções que você já tem, se quiser enviá-las ao configurar o CLI

Vê o artigo Configurar a Integração API para saber onde encontrar as credenciais do projeto.

Escrevendo um arquivo de configuração simples

Um típico arquivo de configuração de YAML semelhante, ao seguinte:

"project_identifier": "o-teu-project-identifier"
"api_key": "54e01e81--a-tua-chave-api--f6a2724a"          #pode ser encontrado na sua páginas de congigurações de projeto
 "base_path": "/home/office/source-code"

"files": [
  {
    "source" : "/resources/en/*.json",                                          #filtro de arquivos de origem
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #onde as traduções são armazenadas
  }
]

Nota: No Windows, se você usa o separador de diretório no estilo do Windows, ele deverá ser duplicado de acordo com a sintaxe YAML:

{
"source" : "\\resources\\en\\*.json",
"translation" : "\\resources\\%two_letters_code%\\%original_file_name%"
}

Para executar o arquivo de configuração acima, e enviar os arquivos de origem para o Crowdin:

$ crowdin upload sources

Obter as traduções do Crowdin e colocá-las nos lugares certos:

$ crowdin download

Credenciais da API de variáveis de ambiente

Você pode carregar as Credenciais da API de uma variável de ambiente, por exemplo:

"api_key_env": CHAVE_API_CROWDIN
"project_identifier_env": ID_DO_PROJETO_DO_CROWDIN
"base_path_env": CAMINHO_BASE_DO_CROWDIN

Se misturado, api_key e projeto_identifier são priorizados:

"api_key_env": CCHAVE_API_CROWDIN         # Baixa prioridade
"project_identifier_env": PROJETO_CROWDIN # Baixa prioridade
"base_path_env": CAMINHO_BASE_DO_CROWDIN  # Baixa prioridade
"api_key": "xxx"                          # Alta prioridade
"project_identifier": "yyy"               # Alta prioridade
"base_path": "zzz"                        # Alta prioridade

Dividir configuração de projeto e credenciais de API

O arquivo crowdin.yaml contém uma descrição dos recursos para gerenciar e credenciais API (api_key, project_identifier, base_path). Isto significa que, não é seguro enviar (commit) este arquivo no repositório do código, porque a chave API pode ser acessada por outros usuários. O Crowdin CLI suporta 2 tipos de arquivos de configuração: + uma descrição dos recursos para gerenciar, residindo no diretório do projeto + credenciais API, provavelmente, residindo em $HOME/.crowdin.yaml

Nota: As credenciais API do arquivo de configuração .crowdin.yaml, são de maior prioridade do que as credenciais do diretório do projeto (crowdin.yaml).

Se você precisa de executar um comando com as credenciais específicas do usuário (por exemplo, upload sources), então executa o seguinte comando:

$ crowdin upload sources --identity 'caminho-para-o-arquivo-das-credenciais-do-usuário'

Mas se o arquivode credenciais específicas do usuário, residir em $HOME/.crowdin.yaml, podes simplesmente executar:

$ crowdin upload sources

Configuração geral

O exemplo de configuração fornecido acima, possui atributos de origem e tradução, ao conter caracteres especiais (wildcards) padrão(também conhecidos como globalizar padrões) para facilitar o trabalho com vários arquivos.

Aqui estão os padrões que você pode usar:

* (asterisco)

Representa qualquer caractere no no do arquivo ou diretório. Se especificares um “*.json”, ele incluirá todos os arquivo s, como “messages.json”, “about_us.json” e qualquer coisa que acabe com “.json”.

** (duplo asterisco)

Corresponde a qualquer texto recursivo (incluindo subdiretórios). Nota que podes usa ** nos padrões de origem e tradução. Ao usar ** no padrão de tradução, ele sempre conterá um subdiretório da origem para um determinado arquivo. Por exemplo, pode usar a origem: ‘/en/*/.po’ para enviar todos os arquivos .po para o Crowdin, recursivamente. O padrão de tradução será ‘/%two_letters_code%/*/%original_file_name%’.

? (ponto de interrogação)

Corresponde a qualquer caractere único.

[set]

Corresponde a qualquer caractere único num conjunto. Comporta-se exatamente, como conjuntos de caracteres no Regexp, incluindo a negação de conjuntos ([^a-z]).

** (barra invertida)

Escapa o próximo metacaractere.

Espaços reservados

O Crowdin CLI permite usar os seguintes espaços reservados para colocar as variáveis apropriadas no nome do arquivo resultante:

Nome Descrição
%language% Nome do idioma (exemplo, Ukrainian)
%two_letters_code% Código do idioma ISO 639-1 (exemplo uk)
%three_letters_code% Código do idioma ISO 639-2/T (exemplo ukr)
%locale% Localidade (como uk-UA)
%locale_with_underscore% Região (exemplo, uk_UA)
%original_file_name% Nome do arquivo original
%android_code% Identificador de localidade do Android usado para nomear diretórios "values-"
%osx_code% Identificador de localidade do OS X usado para nomear diretórios ".lproj"
%original_path% Use nomes das pastas pai no projeto do Crowdin para criar um caminho de arquivo no pacote resultante
%file_extension% Extensão do arquivo original
%file_name% Nome do arquivo sem extensão

Também pode definir o caminho para os arquivos no arquivamento resultante, ao colocar uma barra (/) no início do padrão.

A sua opção translation pode se parecer como: “/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%”.

Uso de caracteres especiais

Estrutura de arquivos e diretórios na máquina local:

- caminho_base
      |
      |-- pasta
      |     |
      |     |-- 1.xml
      |     |-- 1.txt
      |     |-- 123.txt
      |     |-- 123_test.txt
      |     |-- a.txt
      |     |-- a1.txt
      |     |-- crowdin?test.txt
      |     |-- crowdin_test.txt
      |
      |-- 1.xml
      |-- 1.txt
      |-- 123.txt
      |-- 123_test.txt
      |-- a.txt
      |-- a1.txt
      |-- crowdin?test.txt
      |-- crowdin_test.txt
      |-- 3.txt

Exemplo 1. Utilização de carateres especiais no caminho fonte:

#........a sua configuração de projeto........
"files" : [
  {
    "source" : "/**/?[0-9].txt", #upload a1.txt, folder/a1.txt
    "translation" : "/**/%two_letters_code%_%original_file_name%"
  },
  {
    "source" : "/**/*\\?*.txt", #upload crowdin?test.txt, folder/crowdin?test.txt
    "translation" : "/**/%two_letters_code%_%original_file_name%"
  },
  {
    "source" : "/**/[^0-2].txt", #upload 3.txt, folder/3.txt, a.txt, folder/a.txt (ignore 1.txt, folder/1.txt)
    "translation" : "/**/%two_letters_code%_%original_file_name%"
  }
]

Exemplo 2. Uso de caracteres especiais para ignorar arquivos:

#........a sua configuração de projeto........

"files": [
  {
    "source" : "/**/*.*", #enviar todos os ficheiros que contém o base_path
    "translation" : "/**/%two_letters_code%_%original_file_name%",
    "ignore" : [
      "/**/%two_letters_code%_%original_file_name%", #ignorar os ficheiros traduzidos
      "/**/?.txt",                                   #ignora 1.txt, a.txt, folder/1.txt, folder/a.txt
      "/**/[0-9].txt",                               #ignora 1.txt, folder/1.txt
      "/**/*\\?*.txt",                               #ignora crowdin?test.txt, folder/crowdin?test.txt
      "/**/[0-9][0-9][0-9].txt",                     #ignora 123.txt , folder/123.txt
      "/**/[0-9]*_*.txt"                             #ignora 123_test.txt, folder/123_test.txt
    ]
  }
]

Mapeamento do Idioma

Geralmente, os projetos de software têm nomes personalizados para diretórios de localidade. Crowdin CLI permite que você mapeie seus próprios idiomas para ser reconhecido pelo Crowdin.

Digamos que seus diretórios de localidade sejam chamado ‘en’, ‘uk’, ‘fr’, ‘de’. Todos eles podem ser representados pelo espaço reservado %two_letters_code%. Ainda assim, você tem um diretório chamado “zh_CH’. Para fazer com que o Crowdin CLI funcione sem alterações no teu projeto, podes adicionar uma secção de languages_mapping ao teu conjunto de arquivos.

Amostra de configuração:

#........a sua configuração de projeto........

"files" : [
  {
    "source" : "/locale/en/**/*.po",
    "translation" : "/locale/%two_letters_code%/**/%original_file_name%",
    "languages_mapping" : {
      "two_letters_code" : {
        "ru" : "ros",
        "uk" : "ukr"
      }
    }
  }
]

O formato de Mapear é o seguinte: “crowdin_language_code” : “o_codigo_que_usas”. Verifica a lista completa dos códigos de idioma do Crowdin que podem ser usados para mapeamento.

Também pode substituir os códigos de idioma de outros marcadores como %android_code%, %locale% etc.

Renomear arquivo de traduções

Se você precisar renomear um arquivo com traduções após a exportação, você pode facilmente fazer isso com a ajuda do parâmetro translation_replace.

Por exemplo, se o arquivo tiver o nome “strings_en.xml”, ele poderá ser renomeado para “strings.xml”. Para isto, adiciona um novo parâmetro (no mesmo nível do parâmetro de tradução) para o arquivo de configuração (crowdin.yaml):

"files" : [
  {
    "source" : "/locale/**/en_*.po",
    "translation" : "/locale/**/%two_letters_code%_%original_file_name%",
    "translation_replace": {
        "en_" : ""
    }
  }
]

Neste caso, “_en” será, simplesmente, apagado do nome do arquivo.

Ignorar arquivos e diretórios

De vez em quando, há arquivos e diretórios que não precisas traduzir no Crowdin. Nesses casos, as regras locais por arquivo, podem ser adicionadas ao ficheiro de configuração no seu projeto.

"files": [
  {
    "source" : "/**/*.properties",
    "translation" : "/**/%file_name%_%two_letters_code%.%file_extension%",
    "ignore" : [
      "/test/file.properties",
      "/example.properties"
    ]
  },
  {
    "source" : "/locale/en/**/*.po",
    "translation" : "/locale/%two_letters_code%/**/%original_file_name%",
    "ignore" : [
      "/locale/en/templates",
      "/locale/en/workflow"
    ]
  }
]

CSV com Multicolunas

Se um arquivo CSV contiver as traduções para todos os idiomas de destino, deverá especificar os códigos de idioma apropriados no esquema.

Exemplo de arquivo CSV:

identifier,source_phrase,context,Ukrainian,Russian,French
ident1,Source 1,Context 1,,,
ident2,Source 2,Context 2,,,
ident3,Source 3,Context 3,,,

Exemplo de arquivo de configuração:

"files" : [
  {
    "source" : "multicolumn.csv",
    "translation" : "multicolumn.csv",
    "first_line_contains_header" : true,
    "scheme" : "identifier,source_phrase,context,uk,ru,fr"
  }
]

Salvar a estrutura de diretórios no servidor

"preserve_hierarchy": true

Exemplo de arquivo de configuração ao usar a opção preserve_hierarchy:

"project_identifier": "test"
"api_key": "KeepTheAPIkeySecret"
"base_url": "https://api.crowdin.com"
"base_path": "/path/to/your/project"
"preserve_hierarchy": true

"files" : [
  {
    "source" : "/locale/en/**/*.po",
    "translation" : "/locale/%two_letters_code%/**/%original_file_name%"
  }
]

Por padrão, os diretórios que não contêm arquivos para tradução, não serão criados no Crowdin. Por exemplo:

- localidade
    |
    |-- en
        |
        |-- foo.po
        |-- bar.po

Por padrão, os arquivos do projeto serão representados no Crowdin da seguinte forma:

- foo.po
- bar.po

Ao usar a opção preserve_hierarchy, a estrutura do arquivo no Crowdin será a seguinte:

- en
  |
  |-- foo.po
  |-- bar.po

Enviar arquivos para o caminho especificado com o tipo especificado

Este recurso adiciona suporte para 2 parâmetros opcionais na secção do arquivo yaml: dest e type. Isto é, normalmente, usado para projetos, onde o nome enviado deve ser diferente, para que o Crowdin possa excluir, corretamente, o tipo. O parâmetro dest permite que especifiques um nome de arquivo no Crowdin.

Nota! O parâmetro dest funciona apenas para arquivos únicos

Exemplo do arquivo de configuração com os dois parâmetros:

"project_identifier": "your-project-identifier"
"api_key": "54e01e81--your-api-key--f6a2724a"           #pode ser encontrado na sua página de configurações do projeto
"base_path": "/home/office/source-code"

"files" : [
  {
    "source" : "/conf/messages",
    "dest" : "/messages.properties",
    "translation" : "/conf/messages.%two_letters_code%",
    "type" : "properties"
  },
  {
  "source" : "/app/strings.xml",
  "dest" : "/strings.xml",
  "translation" : "/res/values-%android_code%/%original_file_name%"
  }
]

Atualizar frases alteradas

O parâmetro update_option é opcional. Se não estiver definido, as traduções para as frases alteradas serão perdidas. É útil para correções de digitação e pequenas alterações nos textos fonte.

Dependendo do valor, update_option será usado para preservar as traduções e preservar/remover as validações de frases alteradas durante a atualização do arquivo.

Os valores são: * update_as_unapproved - preservar as traduções das frases alteradas e remover as validações dessas traduções se elas existirem * update_without_changes - preservar traduções e validações de frases alteradas

Exemplo do arquivo de configuração com o parâmetro update_option:

"project_identifier": "o-seu-project-identifier"
"api_key": "54e01e81--a-sua-chave-api--f6a2724a"           #pode ser encontrado na sua páginas de configurações do projeto
"base_path": "/home/office/source-code"

"files" : [
  {
    "source" : "/*.csv",
    "translation" : "/%three_letters_code%/%file_name%.csv",
    "first_line_contains_header" : true,
    "scheme" : "identifier,source_phrase,translation,context",
    "update_option" : "update_as_unapproved"
  },
  {
    "source": "/**/*.xlsx",
    "translation" : "/%three_letters_code%/folder/%file_name%.xlsx",
    "update_option" : "update_without_changes"
  }
]

Carregamento de traduções

O comando upload translations carrega as traduções existentes para o Crowdin. Se nenhuma opção for especificada, as traduções enviadas não serão importadas, mesmo se forem duplicadas ou se forem iguais às frases fonte e não serão aprovadas.

Os valores são:

  • -l, –language=language_code - define as traduções do idioma que devem ser enviadas para o Crowdin. Por padrão, as traduções são enviadas para todos os idiomas de destino do projeto. (Códigos de idioma do Crowdin)
  • –[no-]import-duplicates - define se deve adicionar tradução se houver a mesma já existente no projeto do Crowdin
  • –[no-]import-eq-suggestions - define se deve adicionar tradução se for igual ao texto de origem no projeto do Crowdin
  • –[no-]auto-approve-imported - aprova automaticamente, as traduções enviadas

Opções adicionais para arquivos XML

translate_content
opcional
bool Define se deve traduzir textos colocados dentro das etiquetas. Os valores aceitáveis são: 0 ou 1. O padrão é 1.
translate_attributes
opcional
bool Define se os atributos das etiquetas devem ser traduzidos. Os valores aceitáveis são: 0 ou 1. O padrão é 1.
content_segmentation
opcional
bool Define se os textos longos devem ser divididos em segmentos de textos menores. Os valores aceitáveis são: 0 ou 1. O padrão é 1.
Importante! Esta opção desativa a possibilidade de carregar traduções existentes para arquivos XML quando ativada.
translatable_elements
opcional
array Este é um array de frases, onde cada item é o XPaths para elemento DOM que deve ser importado.
Exemplo de caminho: /path/to/node ou /path/to/attribute[@attr]
Nota! se definido. os parâmetros translate_content e translate_attributes não são considerados durante a importação.

Exemplo do arquivo de configuração com parâmetros adicionais:

"project_identifier": "o-teu-project-identifier"
"api_key": "54e01e81--your-api-key--f6a2724a"           #pode ser encontrado na sua página de 
"base_path": "/home/office/source-code"                   #configurações do projeto

"files" : [
  {
    "source" : "/app/sample1.xml",
    "translation" : "/app/%locale%/%original_file_name%",
    "translate_attributes" : 1,
    "translate_content" : 0
  },
  {
    "source" : "/app/sample2.xml",
    "translation" : "/app/%locale%/%original_file_name%",
    "translatable_elements" : [
      "/content/text",             # textos traduzíveis são armazenados em nós "text" de nós pai "content"
      "/content/text[@value]"      # textos traduzíveis são armazenados em atributos "value" de nós  "text"
    ]
  }
]

Opções de cotas de escape para formato de arquivo .properties

Define se uma aspa simples deve ser ignorada por outra ou barra invertida em traduções exportadas. Podes adicionar escape_quote por opção de arquivo. Os valores aceitáveis são: 0, 1, 2, 3. O padrão é 3.

Os valores são:

  • 0 - não escapar da citação simples
  • 1 - escapar duma citação simples por uma outra
  • 2 - escapar de aspas simples por uma barra invertida
  • 3 - escapar de aspas simples por outra apenas em textos que contenham variáveis ( {0} )

Escapar de caracteres especiais
Define se algum caractere especial (=, :, ! e #) devem ser escapados por barras invertidas nas traduções exportadas. Podes adicionar escape_special_characters por opção de arquivo.

Os valores aceitáveis são: 0, 1. O padrão é 0.

  • 0 - não escapar dde caracteres especiais
  • 1 - escapar de caracteres especiais por uma barra invertida

Exemplo de arquivo de configuração:

"project_identifier": "your-project-identifier"
"api_key”: "54e01e81--your-api-key--f6a2724a"           #pode ser encontrado na sua página de configurações do projeto
"base_path”: "/home/office/source-code"

"files" : [
  {
    "source" : "/en/strings.properties",
    "translation" : "/%two_letters_code%/%original_file_name%",
    "escape_quotes" : 1,
    "escape_special_characters: 0"
  }
]

Exemplo de configurações

Carregar arquivos CSV através de API

"project_identifier": "test"
"api_key": "KeepTheAPIkeySecret"
"base_url": "https://api.crowdin.com"
"base_path": "/path/to/your/project"

"files" : [
  {
    "source" : "/*.csv",
    "translation" : "/%two_letters_code%/%original_file_name%",
    # Define se a primeira linha deve ser importada ou contém os cabeçalhos das colunas
    "first_line_contains_header" : true,
    # Apenas usado quando ao enviar arquivos CSV para definir o mapeamento de colunas
 de dados.
    "scheme" : "identifier,source_phrase,translation,context,max_length"
  }
]

Projeto GetText

"project_identifier": "o-teu-project-identifier"
"api_key": "54e01e81--a-tua-chave-api--f6a2724a"          #pode ser encontrado na sua páginas de configurações do projeto
"base_path": "/home/website"

"files" : [
  {
    "source" : "/locale/en/**/*.po",
    "translation" : "/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%",
    "languages_mapping" : {
      "two_letters_code" : {
        "zh-CN" : "zh_CH",
        "fr-QC": "fr"
      }
    }
  }
]

Projeto Android

"project_identifier": "o-teu-project-identifier"
"api_key": "54e01e81--a-sua-chave-api--f6a2724a"          #pode ser encontrado na sua páginas de configurações do projeto
"base_path": "/home/android-app"

"files" : [
  {
    "source" : "/res/values/*.xml",
    "translation" : "/res/values-%android_code%/%original_file_name%",
    "languages_mapping" : {
      "android_code" : {
        "de" : "de",
        "ru" : "ru"
      }
    }
  }
]

Arquivo de configuração para integrações de VCS

As integrações VCS requerem o mesmo arquivo de configuração como a ferramenta CLI, o que significa que, a mesma estrutura é suportada. A única diferença, é que as credenciais do projeto, não devem ser armazenadas no cabeçalho do arquivo por razões de segurança. Além disso, podem ser utilizados dois parâmetros adicionais.

Enviar parâmetro de mensagem para Integrações VCS

Cada vez que as traduções são enviadas, a mensagem padrão “Novas traduções {fileName} ({languageName})”, é mostrada. Podes usar o parâmetro commit_message para adicionar etiquetas de Git, para ignorar compilações, adicionar testes, e muito mais.

Exemplo:

"base_path": "/home/office/source-code"
"commit_message": "[ci skip]"                
"files": [
  {
    "source" : "/resources/en/*.json",                                          #filtro de arquivos fonte
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #onde as traduções são armazenadas
  }
]

Para substituir a mensagem de confirmação padrão, use o parâmetro append_commit_message com o valor false. Também podes adicionar dois espaços reservados: %original_file_name% e %language% para usar o nome de arquivo e variáveis de idioma apropriados.

Exemplo:

"commit_message": "Corrigir: Novas traduções %original_file_name% do Crowdin"                
"append_commit_message": false
"files": [
  {
    "source" : "/resources/en/*.json",                                          #filtro de arquivos de origem
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #onde as traduções são armazenadas
  }
]

Exportar parâmetro de idiomas para integrações VCS

Por padrão, todos os idiomas são exportados. Se precisa de exportar alguns idiomas específicos, use o parâmetro export_languages para especificá-los.

Exemplo:

"base_path": "/home/office/source-code"
"export_languages": [                                   
    "ru", 
    "uk", 
    "ja"
  ]
"files": [
  {
    "source" : "/resources/en/*.json",                                          #filtro de arquivos de origem
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #onde as traduções são armazenadas
  }
]

Procurando ajuda

Precisa de ajuda para trabalhar com Crowdin CLI ou tem alguma dúvida? Entre em contato com a equipe de suporte.

Veja também

Este artigo foi útil?